utsjsonobject.md 6.4 KB
Newer Older
D
DCloud_LXH 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40
# UTSJSONObject

UTSJSONObject 是 UTS 语言的内置类型,主要用来操作[匿名对象](../object.md#anonymous-object)

注意:UTSJSONObject类型的数据暂不支持响应式

## 创建实例

UTSJSONObject 对象的实例目前主要通过两种方式来创建:

* 通过[对象字面量](../literal.md#object-literal)

```ts
const person: UTSJSONObject = {
    name: 'Tom',
    printName: () => {
      // ...
    }
}
```

* 通过 JSON 字符串

```ts

// 写法1 推荐
const person: UTSJSONObject = JSON.parseObject('{"name":"Tom"}')!

// 写法2 推荐
const person: UTSJSONObject = JSON.parse<UTSJSONObject>('{"name":"Tom"}')!


// 写法3  如果 as 转换的实际类型不匹配 会导致 crash,建议先通过 `instanceof` 判断类型再进行as转换。
const parseRet = JSON.parse('{"name":"Tom"}')
if(parseRet instanceof UTSJSONObject){
  const person = parseRet as UTSJSONObject
}

```

杜庆泉's avatar
杜庆泉 已提交
41 42 43 44
## 静态方法

### keys(object: UTSJSONObject): Array<String>

杜庆泉's avatar
杜庆泉 已提交
45 46 47 48 49 50 51
<!-- UTSJSON.UTSJSONObject.keys.description -->

<!-- UTSJSON.UTSJSONObject.keys.param -->

<!-- UTSJSON.UTSJSONObject.keys.returnValue -->

<!-- UTSJSON.UTSJSONObject.keys.compatibility -->
杜庆泉's avatar
杜庆泉 已提交
52

杜庆泉's avatar
杜庆泉 已提交
53 54 55 56 57 58 59

```ts
let obj = {
  name:"zhangsan",
  age:11
}
// 执行结果: 2
D
DCloud_LXH 已提交
60
UTSJSONObject.keys(obj).size
杜庆泉's avatar
杜庆泉 已提交
61 62

```
杜庆泉's avatar
杜庆泉 已提交
63

D
DCloud_LXH 已提交
64
### assign(...items): UTSJSONObject
杜庆泉's avatar
杜庆泉 已提交
65

杜庆泉's avatar
杜庆泉 已提交
66 67 68
<!-- UTSJSON.UTSJSONObject.assign.description -->

<!-- UTSJSON.UTSJSONObject.assign.param -->
杜庆泉's avatar
杜庆泉 已提交
69

杜庆泉's avatar
杜庆泉 已提交
70 71 72
<!-- UTSJSON.UTSJSONObject.assign.returnValue -->

<!-- UTSJSON.UTSJSONObject.assign.compatibility -->
杜庆泉's avatar
杜庆泉 已提交
73

杜庆泉's avatar
杜庆泉 已提交
74
> 注意: 与js中的`Object.assign`不同, 这里每次返回的都是一个新的对象
杜庆泉's avatar
杜庆泉 已提交
75

杜庆泉's avatar
杜庆泉 已提交
76 77 78 79 80 81 82
```ts
const target = { a: 1, b: 2 };
const source = { b: 4, c: 5 };
// 得到一个UTSJSONObject对象
const returnedTarget = UTSJSONObject.assign(target, source);
```

D
DCloud_LXH 已提交
83
### assign<T>(...items: T[]): T
杜庆泉's avatar
杜庆泉 已提交
84

D
DCloud_LXH 已提交
85
<!-- UTSJSON.UTSJSONObject.assign_1.description -->
杜庆泉's avatar
杜庆泉 已提交
86

D
DCloud_LXH 已提交
87
<!-- UTSJSON.UTSJSONObject.assign_1.param -->
杜庆泉's avatar
杜庆泉 已提交
88

D
DCloud_LXH 已提交
89
<!-- UTSJSON.UTSJSONObject.assign_1.returnValue -->
杜庆泉's avatar
杜庆泉 已提交
90

D
DCloud_LXH 已提交
91
<!-- UTSJSON.UTSJSONObject.assign_1.compatibility -->
杜庆泉's avatar
杜庆泉 已提交
92

杜庆泉's avatar
杜庆泉 已提交
93
> 注意: 与js中的`Object.assign`不同, 这里每次返回的都是一个新的对象
杜庆泉's avatar
杜庆泉 已提交
94

杜庆泉's avatar
杜庆泉 已提交
95 96 97 98 99 100 101 102 103 104 105
```ts
type User = {
  a:number
  b:number
}
const target = { a: 1, b: 2 };
const source = { b: 4, c: 5 };
// 得到一个User对象
const returnedTarget = UTSJSONObject.assign<User>(target, source);
```

D
DCloud_LXH 已提交
106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220
## 实例方法

### get(key: string): any | null

返回指定键对应的值,如果对象中不存在此键则返回 null。

```ts
const name: string = person.get('name') as string
```

get 方法可以简化为使用下标运算符 `[]` 访问

```ts
const name: string = person['name'] as string
```

### set(key: string, value: any | null)

增加或更新指定键对应的值。

```ts
person.set('name', 'Tom')
```

set 方法可以简化为使用下标运算符 `[]` 赋值

```ts
person['name'] = 'Tom'
```
### getAny(key): any | null

<!-- UTSJSON.UTSJSONObject.getAny.description -->

<!-- UTSJSON.UTSJSONObject.getAny.param -->

<!-- UTSJSON.UTSJSONObject.getAny.returnValue -->

<!-- UTSJSON.UTSJSONObject.getAny.compatibility -->

### getBoolean(key): boolean | null

<!-- UTSJSON.UTSJSONObject.getBoolean.description -->

<!-- UTSJSON.UTSJSONObject.getBoolean.param -->

<!-- UTSJSON.UTSJSONObject.getBoolean.returnValue -->

<!-- UTSJSON.UTSJSONObject.getBoolean.compatibility -->

### getNumber(key): number | null

<!-- UTSJSON.UTSJSONObject.getNumber.description -->

<!-- UTSJSON.UTSJSONObject.getNumber.param -->

<!-- UTSJSON.UTSJSONObject.getNumber.returnValue -->

<!-- UTSJSON.UTSJSONObject.getNumber.compatibility -->

### getString(key): string | null

<!-- UTSJSON.UTSJSONObject.getString.description -->

<!-- UTSJSON.UTSJSONObject.getString.param -->

<!-- UTSJSON.UTSJSONObject.getString.returnValue -->

<!-- UTSJSON.UTSJSONObject.getString.compatibility -->

### getJSON(key): UTSJSONObject | null

<!-- UTSJSON.UTSJSONObject.getJSON.description -->

<!-- UTSJSON.UTSJSONObject.getJSON.param -->

<!-- UTSJSON.UTSJSONObject.getJSON.returnValue -->

<!-- UTSJSON.UTSJSONObject.getJSON.compatibility -->

### getArray(key): Array<any> | null

<!-- UTSJSON.UTSJSONObject.getArray.description -->

<!-- UTSJSON.UTSJSONObject.getArray.param -->

<!-- UTSJSON.UTSJSONObject.getArray.returnValue -->

<!-- UTSJSON.UTSJSONObject.getArray.compatibility -->

### getArray(key): Array<T> | null

<!-- UTSJSON.UTSJSONObject.getArray_1.description -->

<!-- UTSJSON.UTSJSONObject.getArray_1.param -->

<!-- UTSJSON.UTSJSONObject.getArray_1.returnValue -->

<!-- UTSJSON.UTSJSONObject.getArray_1.compatibility -->

这个方法用来获取指定元素类型的数组

```uts

let obj = JSON.parseObject('{"name":"tom","tag":["student","user"]}')

// 这里得到是 Array<*>
let noGenericArray = obj!.getArray("tag")
console.log(noGenericArray)

// 这里得到是 Array<string>
let genericArray = obj!.getArray<string>("tag")
console.log(genericArray)

```

杜庆泉's avatar
杜庆泉 已提交
221

D
DCloud_LXH 已提交
222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240
### toMap(): Map<string, any>

<!-- UTSJSON.UTSJSONObject.toMap.description -->

<!-- UTSJSON.UTSJSONObject.toMap.param -->

<!-- UTSJSON.UTSJSONObject.toMap.returnValue -->

```ts
person.toMap().forEach((value, key) => {
    console.log(key)
    console.log(value)
})
```

<!-- UTSJSON.UTSJSONObject.toMap.compatibility -->

<!-- UTSJSON.UTSJSONObject.tutorial -->

杜庆泉's avatar
杜庆泉 已提交
241 242 243



杜庆泉's avatar
杜庆泉 已提交
244
## 常见问题
杜庆泉's avatar
杜庆泉 已提交
245

杜庆泉's avatar
杜庆泉 已提交
246
#### UTSJSONObject 与 type 相互转换
杜庆泉's avatar
杜庆泉 已提交
247

杜庆泉's avatar
杜庆泉 已提交
248
可以使用下面的代码,进行 `UTSJSONObject``type` 转换
杜庆泉's avatar
杜庆泉 已提交
249

杜庆泉's avatar
杜庆泉 已提交
250
```ts
杜庆泉's avatar
杜庆泉 已提交
251 252 253 254 255 256 257 258 259 260 261 262 263 264 265
type User = {
	name:string,
	age:number
}
let jsonObj = {
  name:"张三",
  age:12
}
// UTSJSONObject => 自定义type
let userA = JSON.parse<User>(jsonObj.toJSONString())
console.log(userA!.name)
// 自定义type => UTSJSONObject
let utsJsonA = JSON.parseObject(JSON.stringify(userA))
console.log(utsJsonA)

杜庆泉's avatar
杜庆泉 已提交
266
```
杜庆泉's avatar
杜庆泉 已提交
267 268


269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306
## Android 平台方法

* 目前 UTSJSONObject 类型编译到 kotlin 为 io.dcloud.uts.UTSJSONObject


::: preview

> UTS

```ts
// 创建一个kotlin hashmap
let kotlinMap = new kotlin.collections.HashMap<string,number>()
kotlinMap.put("a",111)
kotlinMap.put("b",2)
// 转换为UTSJSONObject
let utsObj = new UTSJSONObject(kotlinMap)
console.log(utsObj)
// UTSJSONObject 转换为 Map
let nextMap = utsObj.toMap()
console.log(nextMap)
```

> Kotlin

```kotlin
// 创建一个kotlin hashmap
var kotlinMap = kotlin.collections.HashMap<String, Number>();
kotlinMap.put("a", 111);
kotlinMap.put("b", 2);
// 转换为UTSJSONObject
var utsObj = UTSJSONObject(kotlinMap, UTSSourceMapPosition("utsObj", "pages/index/helloView.uvue", 33, 8));
console.log(utsObj);
// UTSJSONObject 转换为 Map
var nextMap = utsObj.toMap();
console.log(nextMap);
```

:::