thinkphp6 验证器

单应用模式下生成验证器命令

php think make:validate Admin

多应用模式下生成验证器命令：

php think make:validate admin@Admin

第一步，生成验证器，一般命名与需要验证的模型名称一致；

<?php
declare (strict_types = 1);
namespace app\validate;
use think\Validate;

class Admin extends Validate
{
    /**
     * 定义验证规则
     * 格式：'字段名' =>  ['规则1','规则2'...]
     *
     * @var array
     */
    protected $rule = [
        //格式：'字段|中文名' => '规则1|规则2|规则3'
        'realname|真实姓名' =>  'require|chsDash|unique:admin',
        'mobile|手机号码'   =>  'require|mobile|unique:admin',
        'email|电子邮箱'    =>  'require|email|unique:admin',
        'password|密码'     =>  'require|alphaDash'
    ];

    /**
     * 定义错误信息
     * 格式：'字段名.规则名' =>  '错误信息'
     *
     * @var array
     */
    protected $message = [];
}

第二步，使用验证器，在需要验证的控制器中调用验证器，使用try{}cacth(){}表达式验证。

<?php
declare (strict_types = 1);
namespace app\controller;

use app\model\Admin as ModelAdmin;
use app\validate\Admin as ValidataAdmin;
use think\exception\ValidateException;
use think\Request;

class Admin extends Common//继承公共控制器Common
{
    /**
     * 保存新建的资源
     *
     * @param  \think\Request  $request
     * @return \think\Response
     */
    public function save(Request $request)
    {
        //通过param()方法请求客户端传过来的数据
        $data = $request->param();
        //通过Admin验证器验证客户端传过来的数据是否合法
        try {
            //通过验证器验证数据,如果通过执行下一句代码，如果不通过返回异常
            validate(ValidataAdmin::class)->check($data);
        } catch (ValidateException $error) {
            //捕获验证器异常并以标准api格式返回
            return $this->ReturnApi([],$error->getError(),400,'json');
        }
        //通过静态方法把数据添加到admin数据表
        $admin = ModelAdmin::create($data);
        //以标准api格式返回新增的数据
        return $this->ReturnApi($admin,'添加用户成功！',200,'json');
    }
}

验证场景

由于统一设置的验证规则有时候可能不太适用于某个场景，所以tp6也提供了不同场景的验证。

场景一：字段限制

有的场景可能并不需要验证那么多字段，可以通过定义$scene来限制字段，如在在$rule已经设定如下规则：

class Admin extends Validate
{
    /**
     * 定义验证规则
     * 格式：'字段名' =>  ['规则1','规则2'...]
     *
     * @var array
     */
    protected $rule = [
        //格式：'字段|中文名' => '规则1|规则2|规则3'
        'realname|真实姓名' =>  'require|chsDash|unique:admin',
        'mobile|手机号码'   =>  'require|mobile|unique:admin',
        'email|电子邮箱'    =>  'require|email|unique:admin',
        'password|密码'     =>  'require|alphaDash'
    ];

 当我在edit场景下只需要验证真实姓名和电话号码字段的时候，我就可以通过$scene变量来限定，如下：

protected $scene = [
        'edit'  =>  ['realname','mobile'],
    ];  

然后在需要验证的控制器中调用$scene(‘edit’) 来完成验证：

try {
    validate(ValidateAdmin::class)
        ->scene('edit')
        ->check($data);
} catch (ValidateException $error) {
    // 验证失败 输出错误信息
    dump($error->getError());
}

场景二：规则限制

有时候统一设置的规则不符合某些场景的使用，tp6也提供根据不同场景下自定义规则的方法，一般自定义规则命名规范为：scene+场景名，如sceneUpdate()

主要方法说明如下：

方法名	描述
only	场景需要验证的字段
remove	移除场景中的字段的部分验证规则
append	给场景中的字段需要追加验证规则

如果对同一个字段进行多次规则补充（包括移除和追加），必须使用下面的方式：

remove('field', ['rule1','rule2'])
// 或者
remove('field', 'rule1|rule2')

所以当我在更新用户信息的时候自定义验证场景方法为：sceneUpdate()，通过remove()方法把统一规则里面的必须验证去掉

/**
     * 自定义场景验证之用户更新
     */
    public function sceneUpdate(){
        return $this->remove('realname','require')
                    ->remove('mobile','require')
                    ->remove('email','require')
                    ->remove('password','require');
    }

在需要验证的控制器内直接调用sceneUpdate()即可

try{
            //如果通过验证，执行下一步代码
            validate(ValidateAdmin::class)->sceneUpdate()->check($data);
        }catch (ValidateException $error) {
            //如果验证不通过，捕获验证器异常
            return $this->ReturnApi([],$error->getError(),400,'json');
        }

thinkphp6内置验证规则之格式验证

一、格式验证类
1、'name'=>'require' 	//验证某个字段必须
2、'num'=>'number' 	//验证某个字段的值是否为纯数字
3、'num'=>'integer'		//验证某个字段的值是否为整数
4、'num'=>'float'		//验证某个字段的值是否为浮点数字
5、'num'=>'boolean'	//验证某个字段的值是否为布尔值
6、'email'=>'email'		//验证某个字段的值是否为email地址
7、'info'=>'array'		//验证某个字段的值是否为数组
8、'accept'=>'accepted'	//验证某个字段是否为为 yes, on, 或是 1
9、'date'=>'date'		//验证值是否为有效的日期
10、'name'=>'alpha'		//验证某个字段的值是否为纯字母
11、'name'=>'alphaNum'	//验证某个字段的值是否为字母和数字
12、'name'=>'alphaDash'	//验证某个字段的值是否为字母和数字以及下划线和破折号
13、'name'=>'chs'		//验证某个字段的值只能是汉字
14、'name'=>'chsAlpha'		//验证某个字段的值只能是汉字、字母
15、'name'=>'chsAlphaNum'		//验证某个字段的值只能是汉字、字母和数字
16、'name'=>'chsDash'	//验证某个字段的值只能是汉字、字母、数字和下划线_及破折号-
17、'name'=>'cntrl'		//验证某个字段的值只能是控制字符（换行、缩进、空格）
18、'name'=>'graph'	//验证某个字段的值只能是可打印字符（空格除外）
19、'name'=>'print'		//验证某个字段的值只能是可打印字符（包括空格）
20、'name'=>'lower'		//验证某个字段的值只能是小写字符
21、'name'=>'upper'	//验证某个字段的值只能是大写字符
22、'name'=>'space'	//验证某个字段的值只能是空白字符（包括缩进，垂直制表符，换行符，回车和换页字符）
23、'name'=>'xdigit'		//验证某个字段的值只能是十六进制字符串
24、'host'=>'activeUrl'	//验证某个字段的值是否为有效的域名或者IP
25、'url'=>'url'	//验证某个字段的值是否为有效的URL地址
26、'ip'=>'ip'	//验证某个字段的值是否为有效的IP地址
27、'create_time'=>'dateFormat:y-m-d'	//验证某个字段的值是否为指定格式的日期
28、'mobile'=>'mobile'	//验证某个字段的值是否为有效的手机
29、'id_card'=>'idCard'	//验证某个字段的值是否为有效的身份证格式
30、'mac'=>'macAddr'	//验证某个字段的值是否为有效的MAC地址
31、'zip'=>'zip'	//验证某个字段的值是否为有效的邮政编码

thinkphp6内置验证规则之长度和区间验证类

长度和区间验证
1、'num'=>'in:1,2,3'		//验证某个字段的值是否在某个范围
2、'num'=>'notIn:1,2,3'	//验证某个字段的值不在某个范围
3、'num'=>'between:1,10'	//验证某个字段的值是否在某个区间
4、'num'=>'notBetween:1,10'	//验证某个字段的值不在某个范围
5、'name'=>'length:4,25'	//验证某个字段的值的长度是否在某个范围
6、'name'=>'length:4'	//验证指定长度
7、'name'=>'max:25'	//验证某个字段的值的最大长度（数据是数组，判断数组的长度；数据是File对象，判断文件的大小）
8、'name'=>'min:5'		//验证某个字段的值的最小长度（数据是数组，判断数组的长度；数据是File对象，判断文件的大小）
9、'begin_time' => 'after:2021-12-18'	//验证某个字段的值是否在某个日期之后
10、'end_time' => 'before:2021-12-18'	//验证某个字段的值是否在某个日期之前
11、'expire_time' => 'expire:2021-12-18,2021-12-18'	//验证当前操作（注意不是某个值）是否在某个有效日期之内
12、'name' => 'allowIp:114.45.4.55'	//验证当前请求的IP是否在某个范围
13、'name' => 'denyIp:114.45.4.55'	//验证当前请求的IP是否禁止访问（多个IP用逗号分隔）

 thinkphp6内置验证规则之字段比较类

字段比较类
confirm
验证某个字段是否和另外一个字段的值一致，例如：
'repassword'=>'require|confirm:password'
支持字段自动匹配验证规则，如password和password_confirm是自动相互验证的，只需要使用
'password'=>'require|confirm'
会自动验证和password_confirm进行字段比较是否一致，反之亦然。

different
验证某个字段是否和另外一个字段的值不一致，例如：
'name'=>'require|different:account'

eq 或者 = 或者 same
验证是否等于某个值，例如：
'score'=>'eq:100'
'num'=>'=:100'
'num'=>'same:100'

egt 或者 >=
验证是否大于等于某个值，例如：
'score'=>'egt:60'
'num'=>'>=:100'

gt 或者 >
验证是否大于某个值，例如：
'score'=>'gt:60'
'num'=>'>:100'

elt 或者 <=
验证是否小于等于某个值，例如：
'score'=>'elt:100'
'num'=>'<=:100'

lt 或者 <
验证是否小于某个值，例如：
'score'=>'lt:100'
'num'=>'<:100'

字段比较
验证对比其他字段大小（数值大小对比），例如：
'price'=>'lt:market_price'
'price'=>'<:market_price'

thinphp6内置验证规则之其他常用验证

filter验证
支持使用filter_var进行验证，例如：
'ip'=>'filter:validate_ip'

正则验证
支持直接使用正则验证，例如：
'zip'=>'\d{6}',
// 或者
'zip'=>'regex:\d{6}',
如果你的正则表达式中包含有|符号的话，必须使用数组方式定义。

'accepted'=>['regex'=>'/^(yes|on|1)$/i'],
也可以实现预定义正则表达式后直接调用，例如在验证器类中定义regex属性

namespace app\index\validate;
use think\Validate;
class User extends Validate
{
    protected $regex = [ 'zip' => '\d{6}'];   
    protected $rule = [
        'name'  =>  'require|max:25',
        'email' =>  'email',
    ];
}
然后就可以使用
'zip'	=>	'regex:zip',

上传验证
file
验证是否是一个上传文件

image:width,height,type
验证是否是一个图像文件，width height和type都是可选，width和height必须同时定义。

fileExt:允许的文件后缀
验证上传文件后缀

fileMime:允许的文件类型
验证上传文件类型

fileSize:允许的文件字节大小
验证上传文件大小

其它验证
token:表单令牌名称
表单令牌验证

unique:table,field,except,pk
验证当前请求的字段值是否为唯一的，例如：
// 表示验证name字段的值是否在user表（不包含前缀）中唯一
'name'   => 'unique:user',
// 验证其他字段
'name'   => 'unique:user,account',
// 排除某个主键值
'name'   => 'unique:user,account,10',
// 指定某个主键值排除
'name'   => 'unique:user,account,10,user_id',
如果需要对复杂的条件验证唯一，可以使用下面的方式：
// 多个字段验证唯一验证条件
'name'   => 'unique:user,status^account',
// 复杂验证条件
'name'   => 'unique:user,status=1&account='.$data['account'],

requireIf:field,value
验证某个字段的值等于某个值的时候必须，例如：
// 当account的值等于1的时候 password必须
'password'=>'requireIf:account,1'

requireWith:field
验证某个字段有值的时候必须，例如：
// 当account有值的时候password字段必须
'password'=>'requireWith:account'

requireWithout:field
验证某个字段没有值的时候必须，例如：
// mobile和phone必须输入一个
'mobile' => 'requireWithout:phone',
'phone'  => 'requireWithout:mobile'

requireCallback:callable
验证当某个callable为真的时候字段必须，例如：
// 使用check_require方法检查是否需要验证age字段必须

'age'=>'requireCallback:check_require|number'
用于检查是否需要验证的方法支持两个参数，第一个参数是当前字段的值，第二个参数则是所有的数据。

function check_require($value, $data){
    if(empty($data['birthday'])){
    	return true;
    }
}
只有check_require函数返回true的时候age字段是必须的，并且会进行后续的其它验证。