Superstruct 数据强制转换指南：从默认值到自定义处理

Superstruct 数据强制转换指南：从默认值到自定义处理

superstruct A simple and composable way to validate data in JavaScript (and TypeScript). 项目地址: https://gitcode.com/gh_mirrors/su/superstruct

什么是数据强制转换

在数据验证过程中，我们经常需要对输入数据进行某种形式的转换，使其符合验证规则。Superstruct 提供了强大的"强制转换"(coercion)机制，允许我们在验证前对数据进行预处理。这种机制特别适用于以下场景：

1. 为缺失字段设置默认值
2. 将数据从一种格式转换为另一种格式
3. 清理不一致的数据格式

默认值处理

设置默认值是数据强制转换中最常见的需求。Superstruct 提供了专门的 defaulted 辅助函数来简化这一过程。

基本用法

import { create, defaulted, number, object, string } from 'superstruct'

let i = 0

const User = object({
  id: defaulted(number(), () => i++),
  email: string(),
  name: string(),
})

const data = {
  name: 'Jane',
  email: 'jane@example.com',
}

const user = create(data, User)

在这个例子中，当输入数据缺少 id 字段时，Superstruct 会自动调用我们提供的函数生成一个自增的 ID 值。需要注意的是，这里使用的是 create 方法而非 assert，因为我们需要获取经过转换后的新数据。

对象级默认值

defaulted 也可以直接应用于整个对象：

const User = defaulted(
  object({
    id: number(),
    name: string(),
    email: string(),
  }),
  {
    id: () => i++,
  }
)

这种写法在需要为多个字段设置默认值时更加简洁。

自定义强制转换

除了设置默认值外，Superstruct 还允许我们定义更复杂的转换逻辑。

类型转换示例

假设我们需要确保一个数字是从字符串解析而来：

import { coerce, number, string, create } from 'superstruct'

const MyNumber = coerce(number(), string(), (value) => parseFloat(value))

这里我们使用 coerce 函数创建了一个自定义类型：

1. 第一个参数 number() 指定目标类型
2. 第二个参数 string() 指定输入类型
3. 第三个参数是转换函数

使用自定义转换

import { create } from 'superstruct'

const data = '3.14'
const output = create(data, MyNumber)
// 输出: 3.14

如果输入数据无法转换或验证失败，Superstruct 会抛出错误。

实际应用场景

1. 日期处理：将各种日期字符串统一转换为 Date 对象
2. 数字格式化：去除货币符号、千位分隔符等
3. 数据标准化：统一不同来源的数据格式
4. 空值处理：将 null 或空字符串转换为 undefined

最佳实践

1. 始终使用 create 方法来获取转换后的数据
2. 在转换函数中添加适当的错误处理
3. 保持转换逻辑简单明确
4. 为复杂的转换编写单元测试
5. 考虑转换性能，避免在转换函数中进行复杂计算

Superstruct 的强制转换机制为数据验证提供了极大的灵活性，使得我们可以在保持严格类型检查的同时，处理各种现实世界中的不规范数据。

superstruct A simple and composable way to validate data in JavaScript (and TypeScript). 项目地址: https://gitcode.com/gh_mirrors/su/superstruct