Yup 实用技巧：在 Web 开发中实现可靠的数据验证
前言
在现代 Web 开发中，数据的准确性和完整性至关重要。无论是在前端表单数据提交阶段，还是后端 API 接收到的数据，都需要进行严格的校验，以确保数据的可靠性和安全性。Yup 是一个功能强大且易用的 JavaScript 验证库，它能以声明式的方式对数据结构进行验证，广泛应用于 React、Vue 等前端框架以及其他 JavaScript 应用中。本文将详细介绍 Yup 的功能及其在实际项目中的应用，帮助开发者更高效地进行数据校验。
什么事Yup
Yup 是一个 JavaScript 对象模式验证库，使用简单、功能强大，非常适合在 React、Vue 等框架中进行数据校验。
- 声明式校验：Yup 允许你声明一个对象模式，并对模式中的每个字段进行详细的校验。
- 强大的类型支持：它支持字符串、数字、布尔值、数组、对象等多种数据类型。
- 可扩展性：你可以自定义校验规则，以满足特定的业务需求。
基础功能
Yup 的使用非常直观。我们通过定义一个模式(schema)来描述数据结构，然后对数据进行校验。下面是一个简单的例子：
import * as yup from 'yup';
const schema = yup.object().shape({
name: yup.string().required('Name is required').min(3, 'Name should be at least 3 characters long'),
age: yup.number().required('Age is required').positive('Age must be a positive number').integer('Age must be an integer'),
email: yup.string().email('Invalid email format').required('Email is required')
});
const data = {
name: 'John',
age: 25,
email: 'john.doe@example.com'
};
schema.validate(data)
.then(() => {
console.log('Validation succeeded');
})
.catch((err) => {
console.log('Validation failed:', err.errors);
});
在这个例子中，我们定义了一个包含 name、age 和 email 三个字段的对象模式，并对每个字段进行了详细的校验规则设置。然后，我们使用 .validate 方法对数据进行校验，并处理校验结果。
常见数据校验
下面我们来看看 Yup 提供的一些常见数据校验方法：
字符串校验
yup.string() .required('This field is required')
.min(5, 'Must be at least 5 characters')
.max(100, 'Must be at most 100 characters')
.matches(/^[a-zA-Z0-9]+$/, 'Only alphanumeric characters are allowed')
.email('Must be a valid email')
.url('Must be a valid URL')
数字校验
yup.number()
.required('This field is required')
.positive('Must be a positive number')
.integer('Must be an integer')
.min(0, 'Must be greater than or equal to 0')
.max(100, 'Must be less than or equal to 100')
布尔值校验
yup.boolean()
.required('This field is required')
数组校验
yup.array()
.of(yup.string().required('Array items must be strings'))
.min(1, 'Must have at least 1 item')
.max(10, 'Must have at most 10 items')
对象校验
yup.object()
.shape({
street: yup.string().required('Street is required'),
city: yup.string().required('City is required'),
zipCode: yup.string().required('Zip Code is required')
})
进阶功能
除了基本的校验，Yup 还提供了一些进阶功能，使得数据校验更加灵活和强大。
1. 自定义校验
有时我们需要定义一些复杂的校验规则，这时可以使用 .test 方法：
const schema = yup.string().test(
'is-palindrome',
'${path} must be a palindrome',
value => value === value.split('').reverse().join('')
);
schema.validate('madam')
.then(() => console.log('Validation succeeded'))
.catch(err => console.log('Validation failed:', err.errors));
2. 条件校验
有时我们需要根据某个字段的值来动态调整其他字段的校验规则，这时可以使用 Yup 的 .when 方法：
const schema = yup.object().shape({
isMarried: yup.boolean().required('Marriage status is required'),
spouseName: yup.string().when('isMarried', {
is: true, // 当 isMarried 为 true 时，spouseName 字段是必填项
then: yup.string().required('Spouse name is required'),
otherwise: yup.string().notRequired()
})
});
const data = {
isMarried: true,
spouseName: ''
};
schema.validate(data)
.then(() => console.log('Validation succeeded'))
.catch(err => console.log('Validation failed:', err.errors));
在这个例子中，当 isMarried 为 true 时，spouseName 字段是必填的；否则，spouseName 字段是可选的。
3. 默认值
Yup 允许你为字段设置默认值，这样在校验时如果字段缺失，Yup 会自动填充默认值：
const schema = yup.object().shape({
name: yup.string().default('Anonymous'),
age: yup.number().default(18)
});
const data = {};
const validatedData = schema.cast(data);
console.log(validatedData); // { name: 'Anonymous', age: 18 }
4. 异步校验
有时候，我们可能需要进行异步校验，比如检查用户名是否已经存在。这时可以使用 Yup 的 .test 方法并返回一个 Promise：
const schema = yup.object().shape({
username: yup.string().required('Username is required').test(
'checkUsername',
'Username already exists',
async (value) => {
const response = await fetch(/api/check-username?username=${value});
const isAvailable = await response.json();
return isAvailable;
}
)
});
const data = {
username: 'john_doe'
};
schema.validate(data)
.then(() => console.log('Validation succeeded'))
.catch(err => console.log('Validation failed:', err.errors));
5. 联合类型
Yup 还支持联合类型校验，可以通过 .oneOf 方法来定义一个字段可以接受的多种类型的值：
const schema = yup.object().shape({
status: yup.mixed().oneOf(['active', 'inactive', 'pending'], 'Invalid status')
});
const data = {
status: 'active'
};
schema.validate(data)
.then(() => console.log('Validation succeeded'))
.catch(err => console.log('Validation failed:', err.errors));
6. 自定义错误信息
在实际开发中，默认的错误信息可能无法满足需求。我们可以通过 Yup 的 .message 方法来自定义错误信息：
const schema = yup.object().shape({
age: yup.number().required('Age is required').positive().integer().min(18, 'You must be at least 18 years old')
});
const data = {
age: 16
};
schema.validate(data)
.then(() => console.log('Validation succeeded'))
.catch(err => console.log('Validation failed:', err.errors));
在这个例子中，当用户年龄小于 18 时，会返回自定义的错误信息。
实战应用
Yup 与 React 结合
Yup 在与 React 项目结合使用时表现得尤为出色，特别是与表单管理库如 Formik 一起使用，可以极大地简化表单校验的流程。下面我们来看看如何在 React 项目中结合 Yup 和 Formik 进行表单校验。
安装 Formik
首先，我们需要安装 Formik：
npm install formik
或者
yarn add formik
创建一个简单的表单
我们将创建一个包含用户名、邮箱和密码的简单注册表单，并使用 Formik 和 Yup 进行表单管理和校验。
import React from 'react';
import { Formik, Field, Form, ErrorMessage } from 'formik';
import * as yup from 'yup';
const validationSchema = yup.object().shape({
username: yup.string().required('Username is required').min(3, 'Username must be at least 3 characters'),
email: yup.string().email('Invalid email format').required('Email is required'),
password: yup.string().required('Password is required').min(6, 'Password must be at least 6 characters')
});
const SignupForm = () => {
return (
<Formik
initialValues={{ username: '', email: '', password: '' }}
validationSchema={validationSchema}
onSubmit={(values, { setSubmitting }) => {
console.log('Form data', values);
setSubmitting(false);
}}
>
{({ isSubmitting }) => (
<Form>
<div>
<label htmlFor="username">Username</label>
<Field type="text" name="username" />
<ErrorMessage name="username" component="div" />
</div>
<div>
<label htmlFor="email">Email</label>
<Field type="email" name="email" />
<ErrorMessage name="email" component="div" />
</div>
<div>
<label htmlFor="password">Password</label>
<Field type="password" name="password" />
<ErrorMessage name="password" component="div" />
</div>
<button type="submit" disabled={isSubmitting}>Submit</button>
</Form>
)}
</Formik>
);
};
export default SignupForm;
在这个例子中，我们：
- 使用 Formik 的 组件来管理表单状态和处理提交。
- 定义了一个 Yup 校验模式 validationSchema，用于对表单数据进行校验。
- 使用 组件来渲染输入字段，并使用 组件来显示校验错误信息。
实时校验
Formik 和 Yup 的结合不仅能在表单提交时进行校验，还可以实现实时校验。我们只需要在 组件中设置 validateOnChange 和 validateOnBlur 属性：
<Formik
initialValues={{ username: '', email: '', password: '' }}
validationSchema={validationSchema}
validateOnChange={true}
validateOnBlur={true}
onSubmit={(values, { setSubmitting }) => {
console.log('Form data', values);
setSubmitting(false);
}}
</Formik>
这样，每当用户更改输入字段的值或失去焦点时，Formik 会自动调用 Yup 进行校验，并在输入字段下显示相应的错误信息。
自定义表单组件
为了使代码更加模块化和可复用，我们可以创建自定义的表单字段组件：
const TextField = ({ label, ...props }) => {
return (
<div>
<label htmlFor={props.name}>{label}</label>
<Field {...props} />
<ErrorMessage name={props.name} component="div" />
</div>
);
};
const SignupForm = () => {
return (
<Formik
initialValues={{ username: '', email: '', password: '' }}
validationSchema={validationSchema}
onSubmit={(values, { setSubmitting }) => {
console.log('Form data', values);
setSubmitting(false);
}}
>
{({ isSubmitting }) => (
<Form>
<TextField label="Username" name="username" type="text" />
<TextField label="Email" name="email" type="email" />
<TextField label="Password" name="password" type="password" />
<button type="submit" disabled={isSubmitting}>Submit</button>
</Form>
)}
</Formik>
);
};
export default SignupForm;
通过创建自定义的 TextField 组件，我们可以将表单字段的渲染逻辑封装起来，使得表单代码更加简洁和易于维护。
总结
Yup 是一个功能强大且灵活的 JavaScript 数据校验库，适用于各种场景。通过声明式的方式定义模式和校验规则，开发者可以轻松确保数据的正确性和完整性。从基础校验到自定义复杂校验，Yup 都能很好地满足需求。在与 React 及表单管理库如 Formik 结合使用时，Yup 的优势更加明显，极大地简化了表单校验的流程。
原文地址：https://blog.csdn.net/m0_37890289/article/details/143753028
免责声明：本站文章内容转载自网络资源，如本站内容侵犯了原著者的合法权益，可联系本站删除。更多内容请关注自学内容网（zxcms.com）！