VonaJS如何实现序列化与数据脱敏？
摘要：VonaJS 提供了序列化能力，可以对 API 的响应数据进行转换，比如：排除密码字段，对 Email 和 Mobile 进行脱敏处理，等等。先介绍通用的序列化机制，再介绍一组工具函数。通过工具函数可以更加便利的使用序列化能力
序列化/数据脱敏
VonaJS 提供了序列化能力，可以对 API 的响应数据进行转换，比如：排除密码字段，对 Email 和 Mobile 进行脱敏处理，等等
先介绍通用的序列化机制，再介绍一组工具函数。通过工具函数可以更加便利的使用序列化能力
创建Serializer Transform
比如，在模块 demo-student 中创建一个 Serializer Transform: upper，将字段值转化为大写
1. Cli命令
$ vona :create:bean serializerTransform upper --module=demo-student
2. 菜单命令
::: tip
右键菜单 - [模块路径]: Vona Bean/Serializer Transform
:::
Serializer Transform定义
export type TypeSerializerTransformUpperValue = string;
export type TypeSerializerTransformUpperData = unknown;
export type TypeSerializerTransformUpperResult = TypeSerializerTransformUpperValue;
export interface ISerializerTransformOptionsUpper extends IDecoratorSerializerTransformOptions {}
@SerializerTransform<ISerializerTransformOptionsUpper>()
export class SerializerTransformUpper extends BeanBase {
async transform(
value: TypeSerializerTransformUpperValue,
_data: TypeSerializerTransformUpperData,
_options: ISerializerTransformOptionsUpper,
): Promise<TypeSerializerTransformUpperResult> {
return value.toUpperCase();
}
}
TypeSerializerTransformUpperValue: 定义字段类型
TypeSerializerTransformUpperData: 定义外层 object 对象类型
TypeSerializerTransformUpperResult: 定义结果类型
transform: 将字段值转为大写
使用Serializer Transform
比如学生 APIfindOne方法返回的结果类型是EntityStudent。下面将EntityStudent的name字段转为大写
1. 开启序列化
需要为 API 开启序列化
class ControllerStudent {
@Web.get(':id')
@Api.body(v.optional(), v.object(EntityStudent))
+ @Serializer.enable()
async findOne(id) {
return await this.scope.service.student.findOne(id);
}
}
@Serializer.enable: 开启序列化
2. 设置字段
class EntityStudent {
+ @Serializer.transform('demo-student:upper')
@Api.field(v.title($locale('Name')), v.default(''), v.min(3))
name: string;
}
@Serializer.transform: 传入 Serializer Transform 名称demo-student:upper
Filter参数
可以为 Serializer Transform 传入 Filter 参数。