表单验证器使用说明文档

1. 表单验证器基本概念和作用

AMIS 表单验证器是用于验证用户输入数据的有效性和合规性的功能模块。它能够帮助开发者确保用户提交的数据符合预设的规则和要求，从而提高数据质量和系统的可靠性。

验证器的主要作用包括：

• 数据完整性检查：确保必需字段不为空
• 格式校验：验证数据格式是否正确（如邮箱、手机号等）
• 范围限制：验证数值或字符串长度是否在合理范围内
• 业务规则校验：根据特定业务需求验证数据

2. 如何在表单中添加验证规则

在AMIS中，可以通过以下两种方式添加验证规则：

方式一：使用 addValidate 方法

在积木云框架中，可通过 addValidate 方法添加验证规则：

InputText::make()
    ->name('email')
    ->label('邮箱')
    ->addValidate('isEmail', true, '请输入正确的邮箱格式')
    ->get()

方式二：直接设置 required 属性

对于简单的必填验证，可以直接设置 required 属性：

InputText::make()
    ->name('username')
    ->label('用户名')
    ->required(true)
    ->get()

3. 验证规则的配置方式和参数说明

验证规则基本结构

验证规则通常包含三个参数：

1. rule：规则名称（如 isRequired, isEmail, isNumeric 等）
2. value：规则参数（通常是布尔值或具体数值）
3. message：验证失败时的错误提示信息

配置参数详解

4. 验证失败时的错误提示机制

当验证失败时，AMIS会根据配置的错误信息进行提示：

• 验证错误信息存储在 validationErrors 字段中
• 对应的验证规则存储在 validations 字段中
• 错误信息会在表单项下方显示，提醒用户修正输入
• 只有在用户修改表单值或提交表单时才会触发验证

5. 所有支持的内置验证规则完整列表

基础格式验证

长度验证

数值范围验证

相等性验证

日期时间验证

其他常用验证规则

使用示例

以下是一个综合使用多种验证规则的示例：

use plugin\xbCode\builder\Components\Form\InputText;
use plugin\xbCode\builder\Components\Form\InputPassword;

[
    InputText::make()
        ->name('username')
        ->label('用户名')
        ->addValidate('isRequired', true, '用户名不能为空')
        ->addValidate('minLength', 3, '用户名长度不能少于3个字符')
        ->addValidate('maxLength', 20, '用户名长度不能超过20个字符')
        ->get(),
    
    InputText::make()
        ->name('email')
        ->label('邮箱')
        ->addValidate('isRequired', true, '邮箱不能为空')
        ->addValidate('isEmail', true, '请输入正确的邮箱格式')
        ->get(),
    
    InputText::make()
        ->name('phone')
        ->label('手机号')
        ->addValidate('isRequired', true, '手机号不能为空')
        ->addValidate('pattern', '^1[3-9]\\d{9}$', '请输入正确的手机号码')
        ->get(),
    
    InputPassword::make()
        ->name('password')
        ->label('密码')
        ->addValidate('isRequired', true, '密码不能为空')
        ->addValidate('minLength', 6, '密码长度不能少于6位')
        ->get(),
    
    InputPassword::make()
        ->name('confirm_password')
        ->label('确认密码')
        ->addValidate('isRequired', true, '请确认密码')
        ->addValidate('equal', 'password', '两次密码输入不一致')
        ->get()
]

验证器参数详细说明

以下表格列出了各个验证器的具体参数信息，以便更准确地使用它们：