JSON

静态方法

parse

JSON.parse() 方法用来解析 JSON 字符串，构造由字符串描述的对象。可能返回值是： UTSJSONObject/Array/number/boolean/string 等基本数据类型

JSON.parse 在App平台仅支持第一个参数

::: preview

UTS

      const json = `{"result":true, "count":42}`;
      const obj = JSON.parse(json) as UTSJSONObject;
      console.log(obj["count"]);
      // expected output: 42

      console.log(obj["result"]);
      // expected output: true

:::

注意

• JSON.parse 解析出来的对象（不是数组），在App平台使用方括号[]访问，即数组下标方式。并且支持第一层对象属性通过.运算符访问（推荐使用HBuilderX 5.0+）
• 如果输入的字符串不是合法的json格式，则会返回 null
• JSON.parse 接口内部通过特殊方式读取了范型类型，不支持传入动态的泛型：比如将外层方法的普通泛型参数传入 JSON.parse。

parse(text, reviver?)

JSON.parse() 方法用来解析 JSON 字符串，构造由字符串描述的 JavaScript 值或对象。提供可选的 reviver 函数用以在返回之前对所得到的对象执行变换 (操作)。

参数

返回值

::: preview

UTS

      const json = `{"result":true, "count":42}`;
      const obj = JSON.parse(json) as UTSJSONObject;
      console.log(obj["count"]);
      // expected output: 42

      console.log(obj["result"]);
      // expected output: true

:::

兼容性

uni-app x 兼容性

uni-app 兼容性

parse<T>(text: string)

JSON.parse() 方法用来解析 JSON 字符串，构造由字符串描述的值或者对象，其类型由泛型参数T决定 如果输入的是一个合法的json值或者对象，返回一个对应的T值或者对象，如果json描述的值或对象和 T 指定的类型不符，将返回null

参数

返回值

::: preview

UTS

      const json2 = '{"string":"Hello","number":42,"boolean":true,"nullValue":null,"array":[1,2,3],"object":{"nestedKey":"nestedValue"}}';
      const obj2 = JSON.parse<UTSJSONObject>(json2)!;

:::

JSON.parse支持传入泛型，parse结果可以直接返回类型化数据，而不是UTSJSONObject。

与不带泛型的JSON.parse 相比，多了一个<Persion> 尖括号 用来指定返回类型。

目前带泛型的 parse函数，访问性能高于不带泛型的。

兼容性

uni-app x 兼容性

uni-app 兼容性

stringify(value, replacer?, space?)

注意：JSON.stringify 目前仅支持第一个参数

JSON.stringify() 方法将一个 JavaScript 对象或值转换为 JSON 字符串，如果指定了一个 replacer 函数，则可以选择性地替换值，或者指定的 replacer 是数组，则可选择性地仅包含数组指定的属性

参数

返回值

::: preview

UTS

      console.log(JSON.stringify({ x: 5, y: 6 }));
      // expected output: "{"x":5,"y":6}"

      console.log(JSON.stringify(new Date(2006, 0, 2, 15, 4, 5)));
      // expected output: ""2006-01-02T15:04:05.000Z""

:::

序列化规则说明:

parseObject(text: string)

注意： 此函数需要 HBuilderX 3.9x 以上版本

JSON.parseObject() 方法用来解析 JSON 字符串，构造由字符串描述的对象。 如果输入的是一个合法的json对象，返回一个对应的UTSJSONObject，如果是json array 或者其他格式的字符串返回null

参数

返回值

::: preview

UTS

      const json = `{"result":true, "count":42}`;
      const obj = JSON.parseObject(json);
      console.log(obj?.["count"])//42

:::

兼容性

uni-app x 兼容性

uni-app 兼容性

parseObject<T>(text: string)

注意： 此函数需要 HBuilderX 3.9x 以上版本

JSON.parseObject() 方法用来解析 JSON 字符串，构造由字符串描述的对象，该对象的类型由泛型参数T决定 如果输入的是一个合法的json对象，返回一个对应的T对象，如果是json array 或者其他格式的字符串返回null

参数

返回值

::: preview

UTS

      const json1 = `{
			    "name": "John",
			    "id": "30"
			  }`;
      let obj2 = JSON.parseObject<UserJSON>(json1);
      console.log(obj2!.id) //30

:::

兼容性

uni-app x 兼容性

uni-app 兼容性

parseArray(text: string)

注意： 此函数需要 HBuilderX 3.9x 以上版本

JSON.parseArray() 方法用来解析 JSON 字符串，构造由字符串描述的数组。数组元素类型为any 如果输入的是一个合法的json数组，返回一个对应的Array，如果是json object 或者其他格式的字符串返回null

参数

返回值

::: preview

UTS

      const json1 = `[1,2,3]`;
      const array1 = JSON.parseArray(json1);
      console.log(array1)//[1, 2, 3]

:::

兼容性

uni-app x 兼容性

uni-app 兼容性

parseArray<T>(text: string)

注意： 此函数需要 HBuilderX 3.9x 以上版本

JSON.parseArray() 方法用来解析 JSON 字符串，构造由字符串描述的数组。数组元素类型由泛型T决定 如果输入的是一个合法的json数组，返回一个对应的Array，如果是json object 或者其他格式的字符串返回null

参数

返回值

::: preview

UTS

      const json3 = `[{"name":"John","id":"30"},{"name":"jack","id":"21"}]`;
      const array3 = JSON.parseArray<UTSJSONObject>(json3);
      console.log((array3![0])["name"])//"John"

:::

兼容性

uni-app x 兼容性

uni-app 兼容性

参见

相关 Bug

IJSONStringify

支持开发者自定义class序列化结果，此函数的返回值就是实现了此接口的class的序列化返回值

返回值

兼容性

uni-app x 兼容性

uni-app 兼容性

自定义序列化规则说明

默认的情况下，类型的序列化规则是固定的。如上表所列，JSON.stringify的序列化行为由UTS内部实现。

class Person {
    // 声明属性类型（必须显式初始化或在构造函数中赋值）
    name: string;
    age: number;

    // 构造函数
    constructor(name: string, age: number) {
    this.name = name;
    this.age = age;
    }

    // 方法
    greet(): string {
    return `Hello, I'm ${this.name} and I'm ${this.age} years old.`;
    }
}

// 使用类
const alice = new Person("Alice", 30);
// 此时只能得到 '{}'
console.log("data",JSON.stringify(alice))

但有些场景下开发者需要自定义class的序列化规则，所以从HBuilder X 4.53开始，新增了一个接口IJSONStringify，用于支持开发者实现自定义序列化

class Person implements IJSONStringify {
    // 声明属性类型（必须显式初始化或在构造函数中赋值）
    name: string;
    age: number;

    // 构造函数
    constructor(name: string, age: number) {
    this.name = name;
    this.age = age;
    }
    
    // 自定义序列化规则
    toJSON():any{
        let jsonRet = UTSJSONObject()
        jsonRet["name"] = this.name
        jsonRet["age"] = this.age
        return jsonRet
    }
    // 方法
    greet(): string {
        return `Hello, I'm ${this.name} and I'm ${this.age} years old.`;
    }
}

// 使用类
const alice = new Person("Alice", 30);
// {"name":"Alice","age":30}
console.log("data",JSON.stringify(alice))

IJSONStringify 接口内部仅包含一个待实现方法 toJSON():any|null

该方法的返回值会成为当前class序列化后的值。该方法声明的返回值类型为any|null

实际支持下面的几种类型

• JSON协议中支持的基本数据类型

string,number,boolean,null

• JSON协议中支持的容器数据类型

Array 对应 Array

UTSJSONObject 对应 object

• IJSONStringify

如果toJSON函数的返回值是另外一个 IJSONStringify对象，则序列化逻辑会继续调用该对象的 toJSON方法，直到一个不为 IJSONStringify的值。换句话说就是toJSON函数支持嵌套。