验证器

ThinkPHP推荐使用验证器来解决各种验证场景和需求，验证器的使用方式主要包括：

路由定义中调用validate方法验证
控制器中调用validate助手函数
自己实例化验证器进行验证

验证器定义

为具体的验证场景或者数据表定义好验证器类，直接调用验证类的check方法即可完成验证，下面是一个例子：

我们定义一个\app\validate\User验证器类用于User的验证，使用下面的指令快速生成User验证器。

php think make:validate User

在验证器类中定义验证规则

namespace app\validate;

use think\Validate;

class User extends Validate
{
protected $rule =   [
'name'  => 'require|max:25',
'age'   => 'number|between:1,120',
'email' => 'email',
];
}

可以直接在验证器类中使用message属性定义错误提示信息，例如：

namespace app\validate;

use think\Validate;

class User extends Validate
{
protected $rule =   [
'name'  => 'require|max:25',
'age'   => 'number|between:1,120',
'email' => 'email',
];

protected $message  =   [
'name.require' => '名称必须',
'name.max' => '名称最多不能超过25个字符',
'age.number'   => '年龄必须是数字',
'age.between'  => '年龄只能在1-120之间',
'email'=> '邮箱格式错误',
];

}

如果没有定义错误提示信息，则使用系统默认的提示信息

数据验证

这里以控制器验证为例（这也是推荐的验证方式）进行说明验证器的用法，在需要进行User验证的控制器方法中，添加如下代码即可：

<?php
namespace app\controller;

use app\validate\User;
use think\exception\ValidateException;

class Index
{
public function index()
{
try {
validate(User::class)->check([
'name'  => 'thinkphp',
'email' => 'thinkphp@qq.com',
]);
} catch (ValidateException $e) {
// 验证失败 
dump($e->getError()); // 输出错误信息
dump($e->getKey()); // 验证错误的字段名
}
}
}

如果你没有定义验证器，也可以通过validate方法进行自定义验证规则

<?php
namespace app\controller;

use think\exception\ValidateException;

class Index
{
public function index()
{
try {
validate([
'name'  => 'require|max:25',
'age'   => 'number|between:1,120',
'email' => 'email',
])->message([
'name.require' => '名称必须',
'name.max' => '名称最多不能超过25个字符',
'age.number'   => '年龄必须是数字',
'age.between'  => '年龄只能在1-120之间',
'email'=> '邮箱格式错误',
])->check([
'name'  => 'thinkphp',
'email' => 'thinkphp@qq.com',
]);
} catch (ValidateException $e) {
// 验证失败 
dump($e->getError()); // 输出错误信息
dump($e->getKey()); // 验证错误的字段名
}
}
}

数组验证

V8.1.0+版本开始，支持对数组元素进行验证

<?php
namespace app\validate;

use think\Validate;

class User extends Validate
{
protected $rule = [
  'name'  => 'require|max:25',
  'age'   => 'number|between:1,120',
  // info是一个索引数组 
  'info.email' => 'email',
  'info.score' => 'number',
];
}

支持多维数组验证

<?php
namespace app\validate;

use think\Validate;

class User extends Validate
{
protected $rule = [
  'name'  => 'require|max:25',
  'age'   => 'number|between:1,120',
  // info是一个二维数组 
  'info.*.email' => 'email',
  'info.*.score' => 'number',
];
}

批量验证

默认情况下，一旦有某个数据的验证规则不符合，就会停止后续数据及规则的验证，如果希望批量进行验证，可以设置：

<?php
namespace app\controller;

use app\validate\User;
use think\exception\ValidateException;

class Index
{
public function index()
{
try {
validate(User::class)->batch(true)->check([
'name'  => 'thinkphp',
'email' => 'thinkphp@qq.com',
]);
} catch (ValidateException $e) {
// 验证失败 输出错误信息
// 错误信息是一个包括字段名和错误信息的数组
dump($e->getError());
}
}
}

自定义验证规则

系统内置了一些常用的规则（参考后面的内置规则），如果不能满足需求，可以在验证器单独添加额外的验证方法，例如：

<?php
namespace app\validate;

use think\Validate;

class User extends Validate
{
protected $rule = [
'name'  =>  'checkName:thinkphp',
'email' =>  'email',
];

protected $message = [
'name'  =>  '用户名必须',
'email' =>  '邮箱格式错误',
];

// 自定义验证规则
protected function checkName($value, $rule, $data=[])
{
return $rule == $value ? true : '名称错误';
}
}

验证方法可以传入的参数共有5个（后面三个根据情况选用），依次为：

验证数据
验证规则
全部数据（数组）
字段名
字段描述

自定义的验证规则方法名不能和已有的规则冲突，并且必须使用驼峰命名规范。

独立验证

可以对数据进行相关规则的验证，不需要使用验证器。

use think\facade\Validate;

Validate::checkRule('thinkphp@qq.com', 'email');

checkRule方法返回布尔值，验证成功返回true，否则false，可以支持传入多个验证规则