OpenHarmony开发者论坛

标题: OpenHarmony中的fastjson gson应该这样用 [打印本页]
作者: 马迪    时间: 2024-2-4 14:50
标题: OpenHarmony中的fastjson gson应该这样用
【问题背景】

随着越来越多的开发者开始投入北向应用的开发，无数的人开始问我：鸿蒙三方库是否有fastjson，是否有gson，当前json和对象的转换要怎么搞。

作为老牌java程序员，我的每个项目都逃不掉fastjson/gson等三方库，关键是看当前项目已经用了哪个，一般我也不会再自己新引入json库。 那么在OpenHarmony/HarmonyOS应用开发中，我的第一直觉告诉我，之前做网页/node开发时，貌似也没说有个fastjson/gson三方库。于是当时我找了下，其实在arkts开发时，沿用了js里自带的JSON,parse和JSON,stringify方法可以实现json和对象的转换，我也看了下早期确实有个开源三方库https://gitee.com/openharmony-sig/ohos_gson，我也看了下源代码，实现方式是参考gson的java代码，使用js重写。有人做过验证ohos_gson与JSON的转换的时间评测，结果是ohos_gson花费的时间是JSON的20倍以上。为了避免更多的应用入坑，因此ohos_gson到目前一直没发布到ohpm中心仓，所以别人一问我fastjson/gson的三方库的事情，我都答复用JSON去解决问题。

但是似乎问题没有完全解决，开发者越多，场景就越多。还是有很同学在反馈，说JSON并不能像fastjson/gson满足所有的需求，主要是以下几问题：
1.JSON.parse转过来的对象，不能带方法。比如class 中有个getName(){return this.firstName + this.lastName}，这个方法就不能调用
2.JSON接收的json字段名称必须与本地对象属性名一致，能否重命名。
3.对象转JSON的时候，能否控制某些敏感字段不对外暴露。
4.属性是map或其他复杂结构体时，无法转换实现json与对象的互转



【解决方案】
对着上述的问题，我尝试google了一把，毕竟上述这些问题应该在web/node的开发场景下也会遇到。于是在更多的回复中，我看到业界建议更多的是用class-transformer来解决。这个库本身在OpenHarmony/HarmonyOS上正常跑，一行代码不用改，在三方库中心仓上可以直接下载到最新的0.51版本。
针对上述几个问题，我尝试了写了几段代码，验证了下，结果都是OK的。当然首先，需要

  1. ohpm install class-transformer
复制代码
那么接下来，我将给出代码，如何使用class-transformer来解决:
问题1：JSON.parse转过来的对象，不能带方法。
如以下代码所示，plainToClass可以把json转成对象后，可以调用getFullName的自定义方法
  1. import { plainToClass } from 'class-transformer';
  2.       class User {
  3.         id: number;
  4.         firstName: string;
  5.         lastName: string;
  6.         constructor() {
  7.           this.id=0
  8.           this.firstName=""
  9.           this.lastName=""
  10.         }
  11.         getFullName() {
  12.           return this.firstName + ' ' + this.lastName;
  13.         }
  14.       }

  16.       let json = "{"id": 3,"firstName": "Tracy","lastName": "Mcgrady"}"
  17.       JSON.parse(json)
  18.       let user:User = plainToClass(User, JSON.parse(json))
  19.       console.info(user.getFullName())   //输出Tracy Mcgrady
复制代码


问题2：JSON接收的json字段名称必须与本地对象属性名一致，能否重命名。

这种场景还是很常见，比如网络传送的数据与应用本身持久化或者显示的数据，名字就是可能存在不同。这里需要用到@Expose注解来重命名，如以下代码可以把id转成uid，同时可以更改自定义方法getFullName的名字
  1. import { classToPlain, Expose, plainToClass } from 'class-transformer';
  2.      interface tranUser {
  3.         uid: number,
  4.         firstName: string,
  5.         lastName: string
  6.       }


  9.        class User {
  10.         constructor() {
  11.           this.id= 0
  12.           this.firstName= ""
  13.           this.lastName= ""
  14.         }

  16.         @Expose({ name: 'uid' })
  17.         id: number;
  18.         firstName: string;
  19.         lastName: string;

  21.         @Expose({ name: 'fullName' })
  22.         getFullName() {
  23.           return this.firstName + ' ' + this.lastName;
  24.         }
  25.       }

  27.       let json = "{"uid": 10,"firstName": "CCC","lastName": "Khudoiberdiev"}"

  29.       let fromPlainUser:tranUser = JSON.parse(json)
  30.       let user:User = plainToClass(User,fromPlainUser)
  31.       console.info(JSON.stringify(user))
  32.      // 输出{"id":10,"firstName":"CCC","lastName":"Khudoiberdiev"}
  33.       console.info(JSON.stringify(classToPlain(user,{})))
  34.      //输出{"uid":10,"firstName":"CCC","lastName":"Khudoiberdiev","fullName":"CCC Khudoiberdiev"}
复制代码


3.对象转JSON的时候，能否控制某些敏感字段不对外暴露。

使用exclude注解可以搞定
  1. import { classToPlain, Exclude } from 'class-transformer';

  3.       class User {
  4.         id: number;
  5.         firstName: string;
  6.         lastName: string;
  7.         @Exclude()
  8.         password: string;

  10.         constructor() {
  11.           this.id = 0
  12.           this.firstName = "Tracy"
  13.           this.lastName = "Macgrady"
  14.           this.password = "12345"
  15.         }
  16.       }

  18.       let user: User = new User()
复制代码


4.属性是map或其他复杂结构体时，无法转换实现json与对象的互转

使用transform注解自定义方法转换搞定
  1. import { classToPlain, plainToClass, Transform, TransformationType, TransformFnParams } from 'class-transformer';

  3. //关键方法：把对象转成Map
  4.   trans(value: TransformFnParams): Map<string, string> | object {
  5.     if (value.type === TransformationType.PLAIN_TO_CLASS) {
  6.       let map: Map<string, string> = new Map()
  7.       for (let x of Object.keys(value.value)) {
  8.         map.set(x, value.value[x])
  9.       }
  10.       return map
  11.     }
  12.     else {
  13.       return value.value
  14.     }
  15.   }


  18.       class User {
  19.         id: number;
  20.         firstName: string;
  21.         lastName: string;
  22.         @Transform((value: TransformFnParams) => this.trans(value), {})
  23.         tags: Map<string, string> = new Map()

  25.         constructor() {
  26.           this.id = 0
  27.           this.firstName = ""
  28.           this.lastName = ""
  29.         }
  30.       }

  32.       let json = "{"id": 3,"firstName": "Tracy","lastName": "Mcgrady","tags":{"key1":"value1","key2":"value2"}}"
  33.       JSON.parse(json)
  34.       let user: User = plainToClass(User, JSON.parse(json))
  35.       console.info(user.tags.size.toString())\\输出2


  38.       console.info(user.tags.get("key2"))\\输出value2

  40.       console.info(JSON.stringify(user))\\输出 {"tags":{},"id":3,"firstName":"Tracy","lastName":"Mcgrady"}
  41.       console.info(JSON.stringify(classToPlain(user, {})))\\输出{"tags":{"key1":"value1","key2":"value2"},"id":3,"firstName":"Tracy","lastName":"Mcgrady"}
复制代码


【总结】
目前来看，使用系统自带JSON+三方库class-transformer，是可以满足类似gson/fastjson绝大部分的需求，还有更多的用法，可以参考https://github.com/typestack/class-transformer 的文档学会使用。

此外，建议大家审视下自己设计的类和json是否合理，尽量避免使用复杂的转换。当然也欢迎大家贡献更多的开源三方库或者其他的解决方案。
作者: tokiii    时间: 2024-3-12 11:46
ts语言还是方法比较匮乏，没Java精致一些



欢迎光临 OpenHarmony开发者论坛 (https://forums.openharmony.cn/) Powered by Discuz! X3.5