Superstruct进阶指南：使用Refining实现精细化数据校验-CSDN博客

本文链接：https://blog.csdn.net/gitblog_00612/article/details/148464852

Superstruct进阶指南：使用Refining实现精细化数据校验

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

在数据校验领域，我们经常需要处理比基本类型更复杂的验证场景。Superstruct作为一款强大的TypeScript数据校验库，提供了refining（精细化校验）功能，可以帮助开发者实现更精确的数据验证。

什么是Refining？

Refining是Superstruct提供的一种高级校验机制，它允许我们在已有数据结构的基础上添加额外的验证规则。与基本类型校验不同，refining能够对数据进行更细粒度的控制，比如：

验证字符串是否符合特定正则表达式
确保数字在指定范围内
检查数组长度是否符合要求
实现自定义业务规则验证

内置Refining校验器

Superstruct内置了多种常用的refining校验器，开发者可以直接使用：

1. 正则表达式校验

import { assert, pattern, string } from 'superstruct'

const Section = pattern(string(), /\d+(\.\d+/)?/)

assert('2', Section)    // 通过
assert('2.1', Section)  // 通过
assert('string', Section) // 抛出错误

这个例子验证字符串是否符合"数字+可选小数点+数字"的格式，非常适合验证章节编号等场景。

2. 长度范围校验

import { assert, size, string } from 'superstruct'

const Name = size(string(), 1, 100)

assert('Alex', Name)  // 通过
assert('', Name)      // 抛出错误

size校验器可以验证字符串、数组等可测量长度的数据，确保其长度在指定范围内。

3. 数值范围校验

import { assert, min, integer } from 'superstruct'

const Index = min(integer(), 0)

assert(42, Index)    // 通过
assert(0, Index)     // 通过
assert(3.14, Index)  // 抛出错误（非整数）
assert(-1, Index)    // 抛出错误（小于0）

min和max校验器常用于验证数值范围，特别适合验证数组索引、年龄等场景。

自定义Refining校验器

除了内置校验器，Superstruct允许开发者创建完全自定义的refining规则：

import { refine, string } from 'superstruct'

const MyString = refine(string(), 'MyString', (value) => {
  return value.startsWith('The') && value.length > 20
})

这个自定义校验器要求字符串：

必须以"The"开头
长度必须大于20个字符

当校验失败时，错误对象会包含error.refinement属性，明确指出是哪个refining规则导致了失败。

Refining的高级应用

组合使用多个校验器

import { refine, size, string } from 'superstruct'

const Password = refine(
  size(string(), 8, 64), 
  'Password',
  (value) => /[A-Z]/.test(value) && /[0-9]/.test(value)
)

这个例子先确保密码长度在8-64之间，然后通过自定义refining确保包含至少一个大写字母和一个数字。

业务对象校验

import { object, refine } from 'superstruct'

const User = object({
  id: string(),
  role: string()
})

const AdminUser = refine(User, 'AdminUser', (user) => {
  return user.role === 'admin'
})

这里我们创建了一个专门校验管理员用户的refining，确保用户角色为'admin'。