VonaJS: 序列化/数据脱敏(下)

VonaJS 提供了序列化能力,可以对 API 的响应数据进行转换,比如:排除密码字段,对 Email 和 Mobile 进行脱敏处理,等等

前文介绍了序列化的一般用法。这里再介绍一组工具函数。通过工具函数可以更加便利的使用序列化能力

工具清单

工具: @Serializer 工具: v 说明
@Serializer.transform v.serializerTransform 使用Serializer Transform,参见: 序列化
@Serializer.exclude v.serializerExclude 排除字段
@Serializer.replace v.serializerReplace 对字段值进行脱敏处理
@Serializer.getter v.serializerGetter 采用getter机制生成新的字段值
@Serializer.custom v.serializerCustom 使用自定义函数对字段值进行处理
bash 复制代码
既然`@Serializer`工具非常简洁,直观,为什么还要提供`v`工具?

1. `v`工具可以实现通过 App Config 修改配置
2. `v`工具和`@Serializer`工具底层逻辑是一致的

@Serializer.transform/v.serializerTransform

比如,将EntityStudent中的name字段值转化为大写

我们直接使用序列化中创建的 Serializer Transform upper

1. @Serializer.transform

diff 复制代码
class EntityStudent {
+ @Serializer.transform('demo-student:upper')
  @Api.field(v.title($locale('Name')))
  name: string;
}

2. v.serializerTransform

diff 复制代码
class EntityStudent {
+ @Api.field(v.serializerTransform('demo-student:upper'), v.title($locale('Name')))
  name: string;
}

3. App Config

可以在 App Config 中修改配置

src/backend/config/config/config.ts

  • 方法 1: 直接修改 Openapi 参数
typescript 复制代码
// onions
config.onions = {
  entity: {
    'demo-student:student': {
      fields: {
        name: {
          serializerTransforms: {
            'demo-student:upper': {},
          },
        },
      },
    },
  },
};
  • 方法 2: 构造一个新的 schema
typescript 复制代码
import { $makeSchema, v } from 'vona-module-a-openapi';

// onions
config.onions = {
  entity: {
    'demo-student:student': {
      fields: {
        name: $makeSchema(v.serializerTransform('demo-student:upper'), z.string()),
      },
    },
  },
};

@Serializer.exclude/v.serializerExclude

比如,排除EntityStudent中的name字段

1. @Serializer.exclude

diff 复制代码
class EntityStudent {
+ @Serializer.exclude()
  @Api.field(v.title($locale('Name')))
  name: string;
}

2. v.serializerExclude

diff 复制代码
class EntityStudent {
+ @Api.field(v.serializerExclude(), v.title($locale('Name')))
  name: string;
}

3. App Config

可以在 App Config 中修改配置

src/backend/config/config/config.ts

  • 方法 1: 直接修改 Openapi 参数
typescript 复制代码
// onions
config.onions = {
  entity: {
    'demo-student:student': {
      fields: {
        name: { exclude: false },
      },
    },
  },
};
  • 方法 2: 构造一个新的 schema
typescript 复制代码
import { $makeSchema, v } from 'vona-module-a-openapi';

// onions
config.onions = {
  entity: {
    'demo-student:student': {
      fields: {
        name: $makeSchema(v.serializerExclude(), z.string()),
      },
    },
  },
};

@Serializer.replace/v.serializerReplace

比如,将EntityStudent中的name字段值进行脱敏处理

比如,name 原始值为tom,脱敏之后为t***m

1. @Serializer.replace

diff 复制代码
class EntityStudent {
+ @Serializer.replace({ patternFrom: /(\w)(\w+)(\w)/, patternTo: '$1***$3' })
  @Api.field(v.title($locale('Name')))
  name: string;
}

2. v.serializerReplace

diff 复制代码
class EntityStudent {
  @Api.field(
+   v.serializerReplace({ patternFrom: /(\w)(\w+)(\w)/, patternTo: '$1***$3' }),
    v.title($locale('Name')),
  )
  name: string;
}

3. App Config

可以在 App Config 中修改配置

src/backend/config/config/config.ts

  • 方法 1: 直接修改 Openapi 参数
typescript 复制代码
// onions
config.onions = {
  entity: {
    'demo-student:student': {
      fields: {
        name: {
          serializerTransforms: {
            'a-serialization:replace': {
              patternFrom: /(\w)(\w+)(\w)/,
              patternTo: '$1***$3',
            },
          },
        },
      },
    },
  },
};
  • a-serialization:replace: a-serialization模块提供的 Serializer Transform
  • 方法 2: 构造一个新的 schema
typescript 复制代码
import { $makeSchema, v } from 'vona-module-a-openapi';

// onions
config.onions = {
  entity: {
    'demo-student:student': {
      fields: {
        name: $makeSchema(
          v.serializerReplace({ patternFrom: /(\w)(\w+)(\w)/, patternTo: '$1***$3' }),
          z.string(),
        ),
      },
    },
  },
};

@Serializer.getter/v.serializerGetter

比如,EntityStudent中的fullName字段由firstName和lastName字段组合而成

1. getter

diff 复制代码
class EntityStudent {
  @Api.field()
  firstName: string;

  @Api.field()
  lastName: string;

  @Api.field()
+ get fullName(): string | undefined {
+   return `${this.firstName} ${this.lastName}`;
+ }
}

2. @Serializer.getter

diff 复制代码
class EntityStudent {
+ @Serializer.getter((data: EntityStudent) => {
+   return `${data.firstName} ${data.lastName}`;
+ })
  @Api.field()
  fullName: string;
}

3. v.serializerGetter

diff 复制代码
class EntityStudent {
+ @Api.field(v.serializerGetter((data: EntityStudent) => {
+   return `${data.firstName} ${data.lastName}`;
+ }))
  fullName: string;
}

4. App Config

可以在 App Config 中修改配置

src/backend/config/config/config.ts

  • 方法 1: 直接修改 Openapi 参数
typescript 复制代码
// onions
config.onions = {
  entity: {
    'demo-student:student': {
      fields: {
        fullName: {
          serializerTransforms: {
            'a-serialization:getter': {
              getter: (data: EntityStudent) => {
                return `${data.firstName} ${data.lastName}`;
              },
            },
          },
        },
      },
    },
  },
};
  • a-serialization:getter: a-serialization模块提供的 Serializer Transform
  • 方法 2: 构造一个新的 schema
typescript 复制代码
import { $makeSchema, v } from 'vona-module-a-openapi';

// onions
config.onions = {
  entity: {
    'demo-student:student': {
      fields: {
        fullName: $makeSchema(
          v.serializerGetter((data: EntityStudent) => {
            return `${data.firstName} ${data.lastName}`;
          }),
          z.string(),
        ),
      },
    },
  },
};

@Serializer.custom/v.serializerCustom

比如,将EntityStudent中的name字段值转换为大写

1. @Serializer.custom

diff 复制代码
class EntityStudent {
+ @Serializer.custom((value: string) => {
+   return value.toUpperCase();
+ })
  @Api.field(v.title($locale('Name')))
  name: string;
}

2. v.serializerCustom

diff 复制代码
class EntityStudent {
  @Api.field(
+   v.serializerCustom((value: string) => {
+     return value.toUpperCase();
+   }),
    v.title($locale('Name')),
  )
  name: string;
}

3. App Config

可以在 App Config 中修改配置

src/backend/config/config/config.ts

  • 方法 1: 直接修改 Openapi 参数
typescript 复制代码
// onions
config.onions = {
  entity: {
    'demo-student:student': {
      fields: {
        name: {
          serializerTransforms: {
            'a-serialization:custom': {
              custom: (value: string) => {
                return value.toUpperCase();
              },
            },
          },
        },
      },
    },
  },
};
  • a-serialization:custom: a-serialization模块提供的 Serializer Transform
  • 方法 2: 构造一个新的 schema
typescript 复制代码
import { $makeSchema, v } from 'vona-module-a-openapi';

// onions
config.onions = {
  entity: {
    'demo-student:student': {
      fields: {
        name: $makeSchema(
          v.serializerCustom((value: string) => {
            return value.toUpperCase();
          }),
          z.string(),
        ),
      },
    },
  },
};

资源

相关推荐
濮水大叔1 天前
Cabloy/Zova 与 Next.js 的 SSR 水合差异
前端·typescript·next.js
深兰科技2 天前
走出进博展馆寻AI方案,巴西政商联合体参访深兰科技洽商中巴产业数字化合作
人工智能·typescript·深兰科技·中巴产业数字化·巴西政商联合体·ai方案·进博会
FungLeo3 天前
成为全栈·Vue 管理后台篇·Biome、类型检查、构建和API 代理如何组成质量门禁
前端·javascript·vue.js·typescript·vite·前端工程化·biome
泯泷4 天前
改一个字,整段都红了?——中文内容差异对比的算法与协议设计
前端·javascript·typescript
4cos904 天前
pi学习笔记-AgentLoop
typescript
afumu5 天前
让本机 Agent 指挥浏览器里的多个网页 AI:一套 127.0.0.1 控制协议的设计取舍
chrome·typescript
濮水大叔5 天前
Cabloy/Vona 为什么不需要 NestJS 的 Dynamic Module
typescript·node.js·nestjs
浪遏6 天前
recruitment-cli:让 AI 接手求职招聘,从架构到一次发送超时
架构·typescript·node.js
律宏阔7 天前
微信小程序 + Taro 从 ESLint 迁移到 Oxlint 让项目代码检查速度提升近 12 倍
前端·typescript·eslint
瓦瓦gogo7 天前
从一个 TypeScript 函数开始理解 MCP 协议
linux·ubuntu·typescript