JsonModify

Solution about Typescript in JsonSerializable

Version 1.0.1

Fix修复了转formdata 数组对象不支持的问题
Add 添加了JsonList 接口类型用来扩展序列化问题
Add 添加了支持对Array<JsonSerializable>数组对象的支持批量序列化和批量对象还原

安装

npm i @zhusj/jsonmodify -S

代码环境

需要配置NG2的core和Rxjs 加载环境进行npm i/install 恢复代码依赖

文件结构

_base

jsonModify.ts 核心操作类

demo

responseModel.ts 实例响应实体
demo.ts 操作类操作响应实体，实现实例代码

工具使用说明

抽象类

JsonSerializable


   export abstract class JsonSerializable {

    public $call: EventEmitter = new EventEmitter();

    public $watch: Function;

    constructor() {
        /** 表层触发回调 */
        this.$call.subscribe(data => {
            if (data.$watch != null) {
                data.$watch(data);
            }
        });
    }

    public $check(): void {
        let submit: EventEmitter = Reflect.get(this, "$call");
        submit.emit(this);
    }

    public Serializable(): string {
    };

    private Subline(item: JsonSerializable): any {
    }

    private static pullBuffer(item: any, standard: any): any {
        
    }

    public static InstanceOf(json: string, T: any): JsonSerializable {
        
    }

}

$call 默认每一个Json序列化对象都有一个观察者事件，改变通过set访问器触发$call.emit()
$watch 订阅后提交触发自己的回调函数若为null 则不触发。
$check() 手动触发$call的提交事件，PS一般作用在数组属性或递归子数组属性有长度内容变化时手动提交对象自检。
json_object.Serializable() 转化装饰器构建的JSON字符串 PS： json_object instanceof JsonSerializable ==true
ModelClass.InstanceOf<ModelClass>(json,ModelClass) 用于还原JSON对象包含JS原型静态方法
调用实例还原类型.InstanceOf(json字符串，还原类型)=>ModelClass.InstanceOf(json,ModelClass)
注意：ModelClass extends JsonSerializable<ModelClass> 还原类型必须继承本抽象类！

抽象类使用实例代码

responseModel.ts


export class TestMoel extends JsonSerializable {

    constructor() {
        super();
    }

    .... .....
    .... .....
}

装饰器

包含4种装饰器：

JSON对象简值装饰器 JsonProp(check) =>check默认为true 可以设置false
用来控制属性的改变是否触发对象的原有的$watch事件 (PS:一般设在string number 这种值类型非结构化属性访问器上)

responseModel.ts


export class TestMoel extends JsonSerializable {

    constructor() {
        super();
    }

    private _name: string;
    
    /** 标识为一般值类型的属性用JsonProp */
    @JsonProp()
    public get name(): string {
        return this._name;
    }
    public set name(value: string) {
        this._name = value;
    }

    ...... ......
    ...... ......
}

JSON对象引用装饰器 @JsonModel(T,check,recursion) => 装饰器要求传入引用对象的Class类型
该 T 必须继承 JsonSerializable
check默认为true 可以设置false 用来控制属性的改变是否触发对象的原有的$watch事件 object.json_object = new jsonClass() 触发
recursion 递归默认为true修改子属性对象上的属性值则会触发父对象的$watch

example:
```
  test.inner = new TestMoel();
  test.inner.name = "666"; //触发test.$watch
  test.inner.age = 888; //触发test.$watch
```
(PS:一般设在object 这种引用类型结构化属性访问器上)

responseModel.ts


export class TestMoel extends JsonSerializable {

    constructor() {
        super();
    }

    /** 标识为引用类型的属性用JsonModel PS: 该引用类型必须继承 JsonSerializable 且加载访问器上  */
    @JsonModel(TestMoel)
    public get inner(): TestMoel {
        return this._inner;
    }

    public set inner(value: TestMoel) {
        this._inner = value;
    }

    private _inner: TestMoel;

    ...... ......
    ...... ......
}

JSON简值数组引用装饰器 @JsonPropArray() => 数组修改必须手动调用object.$check()方法目前尚待改进 (PS: 一般作用在简单的string[] / number[])

responseModel.ts


export class TestMoel extends JsonSerializable {

    constructor() {
        super();
    }

    /** 标识为值类型数组 一般为string[] number[] */
    @JsonPropArray()
    public get array(): number[] {
        return this._array;
    }
    public set array(value: number[]) {
        this._array = value;
    }

    private _array: number[];

    ...... ......
    ...... ......
}

JSON对象引用数组装饰器 @JsonModelArray(T)
该 T 必须继承 JsonSerializable
目前只支持单一类型对象的数组数组内容有修改时，同样需要工程师手动调用 object.$check()

responseModel.ts


export class TestMoel extends JsonSerializable {

    constructor() {
        super();
    }

    /** 标识为引用类型数组 PS：目前只支持单一类型数组，且该类型同样需要继承 JsonSerializable  */
    @JsonModelArray(TestMoel)
    public get modelarray(): TestMoel[] {
        return this._modelarray;
    }

    public set modelarray(value: TestMoel[]) {
        this._modelarray = value;
    }
    private _modelarray: TestMoel[];

    ...... ......
    ...... ......
}

生成JSON字符串/还原对象

example:

demo.ts


    /** 根据注解器转成需要的JSON格式 */
    let a = test.Serializable();
    /** 根据JSON字符串 和类型 生成带有原型实体的对象 */
    let obj = JsonConvert.InstanceOf(TestMoel, '{"name":"123","age":12,....}');

数组生成JSON字符串/还原对象数组

example:

demo.ts


    /** 新增数组特性 */
    this.list.push(test);
    /** 批量序列化 */
    let objlist = this.list.SerializableList();
    let str = this.list.SerializableListStringify();
    /** 数组批量还原 */
    this.list = JsonConvert.ListOf(TestMoel, str);

zhusjfaker/JsonModify

JsonModify

Version 1.0.1

安装

代码环境

推荐插件

文件结构

_base

demo

工具使用说明

抽象类

抽象类使用实例代码

装饰器

生成JSON字符串/还原对象

数组生成JSON字符串/还原对象数组