如何使用 Yup 实现数据清洗与无效字段自动剥离

老芳姑娘_7238

老芳姑娘_7238

2026-05-16

348人浏览

原创

yup 本身不直接提供“自动剥离无效字段”的内置功能,但可通过捕获校验错误并手动过滤原始数据,安全地保留合法字段、移除校验失败的键值对。

yup 本身不直接提供“自动剥离无效字段”的内置功能,但可通过捕获校验错误并手动过滤原始数据,安全地保留合法字段、移除校验失败的键值对。

在实际表单处理或 API 数据清洗场景中,我们常需要“尽最大努力保留有效数据”,而非因单个字段(如 age: -1)校验失败就整体拒绝整个对象。Yup 的 .validate() 默认在遇到任何错误时抛出异常,返回完整错误列表(含 path 字段),这恰好为按路径精准剔除无效字段提供了可靠依据。

以下是一个健壮、可复用的剥离方案:

import { object, string, number, date, ValidationError } from 'yup';

const userSchema = object({
  name: string().required(),
  age: number().required().positive().integer(),
  email: string().email().optional(),
  website: string().url().nullable().optional(),
  createdOn: date().default(() => new Date()),
});

// ✅ 安全剥离函数:返回仅含通过校验字段的纯净对象
async function stripInvalid<t>(schema: any, data: unknown): Promise<t> {
  try {
    // 若全部字段有效,直接返回标准化后的数据(含默认值、类型转换等)
    return await schema.validate(data, { abortEarly: false });
  } catch (err) {
    if (err instanceof ValidationError) {
      // 浅拷贝原始数据(注意:仅适用于扁平对象;嵌套需深克隆)
      const stripped = { ...data } as Record<string unknown>;
      // 遍历所有校验错误,按 path 删除对应字段
      err.inner.forEach(({ path }) => {
        if (path && Object.prototype.hasOwnProperty.call(stripped, path)) {
          delete stripped[path];
        }
      });
      return stripped as T;
    }
    throw err; // 非校验错误,重新抛出
  }
}

// 使用示例
const input = {
  name: 'jimmy',
  age: -1,
  email: 'invalid-email',
  website: 'https://example.com',
};

stripInvalid(userSchema, input).then(console.log);
// 输出:{ name: 'jimmy', website: 'https://example.com' }
// ✅ name(有效)、website(有效)被保留;
// ❌ age(-1 不满足 positive)、email(格式错误)被剥离。</string></t></t>

⚠️ 关键注意事项:

Design
Design

Design.com是一款提供 AI Logo、品牌素材和多场景设计模板的在线设计平台。

下载
  • abortEarly: false 必须显式传入 validate() 选项,否则仅返回首个错误,导致其他无效字段无法被识别和剥离;
  • 此方案操作的是原始输入对象的浅拷贝,不修改源数据,符合函数式编程原则;
  • 对于嵌套对象(如 address.city),path 为字符串路径(如 'address.city'),当前实现仅支持一级键删除;如需深度剥离,建议配合 Lodash 的 unset() 或递归解析 path;
  • 剥离后结果不包含 Yup 的默认值或类型转换(如 date().default(...)),因为这些逻辑仅在完整校验成功时生效。若需默认值,应在剥离后对剩余字段单独应用 .cast() 或分步处理。

总结:Yup 的错误结构设计天然适配数据清洗需求。通过 ValidationError.inner 获取精确失效路径,并结合对象操作,即可实现声明式 Schema 驱动的智能字段剥离——既保持验证逻辑集中可控,又赋予数据处理足够的灵活性。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

数据清洗

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
js获取数组长度的方法
js获取数组长度的方法

在js中,可以利用array对象的length属性来获取数组长度,该属性可设置或返回数组中元素的数目,只需要使用“array.length”语句即可返回表示数组对象的元素个数的数值,也就是长度值。php中文网还提供JavaScript数组的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

5566

5

js刷新当前页面
js刷新当前页面

js刷新当前页面的方法:1、reload方法,该方法强迫浏览器刷新当前页面,语法为“location.reload([bForceGet]) ”;2、replace方法,该方法通过指定URL替换当前缓存在历史里(客户端)的项目,因此当使用replace方法之后,不能通过“前进”和“后退”来访问已经被替换的URL,语法为“location.replace(URL) ”。php中文网为大家带来了js刷新当前页面的相关知识、以及相关文章等内容

2023.07.04

1349

3

js四舍五入
js四舍五入

js四舍五入的方法:1、tofixed方法,可把 Number 四舍五入为指定小数位数的数字;2、round() 方法,可把一个数字舍入为最接近的整数。php中文网为大家带来了js四舍五入的相关知识、以及相关文章等内容

2023.07.04

5484

6

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

2023.09.01

1020

4

JavaScript转义字符
JavaScript转义字符

JavaScript中的转义字符是反斜杠和引号,可以在字符串中表示特殊字符或改变字符的含义。本专题为大家提供转义字符相关的文章、下载、课程内容,供大家免费下载体验。

2023.09.04

1976

5

js生成随机数的方法
js生成随机数的方法

js生成随机数的方法有:1、使用random函数生成0-1之间的随机数;2、使用random函数和特定范围来生成随机整数;3、使用random函数和round函数生成0-99之间的随机整数;4、使用random函数和其他函数生成更复杂的随机数;5、使用random函数和其他函数生成范围内的随机小数;6、使用random函数和其他函数生成范围内的随机整数或小数。

2023.09.04

3845

4

如何启用JavaScript
如何启用JavaScript

JavaScript启用方法有内联脚本、内部脚本、外部脚本和异步加载。详细介绍:1、内联脚本是将JavaScript代码直接嵌入到HTML标签中;2、内部脚本是将JavaScript代码放置在HTML文件的`<script>`标签中;3、外部脚本是将JavaScript代码放置在一个独立的文件;4、外部脚本是将JavaScript代码放置在一个独立的文件。

2023.09.12

5033

6

Js中Symbol类详解
Js中Symbol类详解

javascript中的Symbol数据类型是一种基本数据类型,用于表示独一无二的值。Symbol的特点:1、独一无二,每个Symbol值都是唯一的,不会与其他任何值相等;2、不可变性,Symbol值一旦创建,就不能修改或者重新赋值;3、隐藏性,Symbol值不会被隐式转换为其他类型;4、无法枚举,Symbol值作为对象的属性名时,默认是不可枚举的。

2023.09.20

3320

5

java访问控制修饰符介绍
java访问控制修饰符介绍

java访问控制修饰符有四种,分别是public、protected、private、默认访问修饰符。详细介绍:1、public,public是最宽松的访问控制修饰符,被修饰的类、方法和变量可以被任何其他类访问,当一个类、方法或变量被声明为public时,它们可以在任何地方被访问,无论是同一个包中的类还是不同包中的类;2、protected修饰符等等。

2023.09.20

1068

7

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.7万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 134.1万人学习