Git --NB Framework 中文教程
目录 ▾ 数据校验

最后更新于:2018-10-30 17:24
53次阅读0条评论

数据校验

数据校验主要是对表单数据或其它不确定数据进行安全过滤,由nb\Validate类进行处理。

验证器

所有继承了nb\Validate的类都称作验证器。

定义

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

我们定义一个appvalidateUser验证器类用于User的验证。

namespace validate;

use nb\Validate;

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

    //直接在验证器类中使用message属性定义错误提示信息
    protected $message  =   [
        'name.require' => '名称必须',
        'name.max'     => '名称最多不能超过25个字符',
        'age.number'   => '年龄必须是数字',
        'age.between'  => '年龄只能在1-120之间',
        'email'        => '邮箱格式错误',    
    ];
}

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

数据验证

在需要进行User验证的控制器方法中,添加如下代码即可:

namespace controller;

class Valid {

    public function index() {
        $data = [
            'name'  => 'nbframework',
            'email' => 'admin@nb.cx'
        ];

        $validate = new \validate\User;

        if (!$validate->check($data)) {
            ed($validate->error);
        }
    }
}

批量验证

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

public function batch() {
    $data = [
        'name'  => 'nbframework',
        'email' => 'admin@nb.cx.'
    ];
    $validate = new \validate\User;
    //开启批量验证
    $validate->batch(true);
    if ($validate->check($data)) {
        ex('验证成功');
    }
    else {
        ex($validate->error);
    }
}

批量验证如果验证不通过,返回的是一个错误信息的数组。

自定义验证规则

框架内置了一些常用的规则(参考后面的内置规则),如果不能满足需求,可以在验证器重添加额外的验证方法,例如:

namespace validate;

class User extends Validate {
    protected $rule = [
        'name'  =>  'checkName:nbframework',
        'email' =>  'email',
    ];
    
    protected $message = [
        'name'  =>  '用户名必须',
        'email' =>  '邮箱格式错误',
    ];
    
    // 自定义验证规则
    protected function checkName($value,$rule,$data=[]) {
        return $rule == $value ? true : '名称错误';
    }
}

验证方法可以传入的参数共有5个(后面三个根据情况选用),依次为:
*验证数据
*验证规则
*全部数据(数组)
*字段名
*字段描述

自定义的验证规则方法名不能和已有的规则冲突。

验证规则

验证规则的定义通常有两种方式,如果你使用了验证器的话,通常通过rule属性定义验证规则,而如果使用的是独立验证的话,则是通过rule方法进行定义。

属性定义

属性定义方式仅限于验证器,通常类似于下面的方式:

namespace validate;

use nb\Validate;

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

因为一个字段可以使用多个验证规则(如上面的age字段定义了numberbetween两个验证规则),在一些特殊的情况下,为了避免混淆可以在rule属性中使用数组定义规则。

<?php
namespace validate;

use nb\Validate;

class User extends Validate {
    protected $rule = [
      'name'  => ['require', 'max' => 25, 'regex' => '/^[\w|\d]\w+/'],
      'age'   => ['number', 'between' => '1,120'],
      'email' => 'email',
    ];

}

方法定义

如果使用的是独立验证(即手动调用验证类进行验证)方式的话,通常使用rule方法进行验证规则的设置,举例说明如下。

$validate = new \nb\Validate;
$validate->rule('age', 'number|between:1,120')
->rule([
    'name'  => 'require|max:25',
    'email' => 'email'
]);

$data = [
    'name'  =>  'checkName:nbframework',
    'email' =>  'email',
];

if (!$validate->check($data)) {
    ex($validate->error);
}

可以对某个字段使用闭包验证,例如:

$validate = new \nb\Validate;
$validate->rule([
    'name'  => function($value) { 
        return 'nbframework' == strtolower($value) ? true : false;
    },
]);

闭包支持传入两个参数,第一个参数是当前字段的值(必须),第二个参数是所有数据(可选)。

如果使用了闭包进行验证,则不再支持对该字段使用多个验证规则。

闭包函数如果返回true则表示验证通过,返回false表示验证失败并使用系统的错误信息,如果返回字符串,则表示验证失败并且以返回值作为错误提示信息。

$validate = new \nb\Validate;
$validate->rule([
    'name'  => function($value) { 
        return 'nbframework' == strtolower($value) ? true : '用户名错误';
    },
]);

属性方式定义验证规则不支持闭包定义

错误信息

验证规则的错误提示信息有三种方式可以定义,如下:

使用默认的错误提示信息

如果没有定义任何的验证提示信息,系统会显示默认的错误信息,例如:

namespace validate;

use nb\Validate;

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

在控制器里执行:

$data = [
    'name'  => 'nbframework',
    'age'   => 121,
    'email' => 'admin@nb.cx',
];

$validate = new \app\index\validate\User;
$result = $validate->check($data);

if(!$result){
    echo $validate->getError();
}

会输出age只能在 1 - 120之间。

可以给age字段设置中文名,例如:

namespace validate;

use nb\Validate;

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

会输出年龄只能在 1 - 120之间。

单独定义提示信息

如果要输出自定义的错误信息,有两种方式可以设置。一种是验证器里面定义,前面已经介绍过。
下面的一种方式是通过方法来定义:

$data = [
    'name'  => 'nbframework',
    'email' => 'admin@nb.cx.'
];

$validate = new \validate\Custom();
$validate->message('name.require','名称必须');
$validate->message([
    'name.require' => '名称是必须的',
    'name.max'     => '名称最多不能超过25个字符',
    'email'        => '邮箱格式有错误哦',
]);
if ($validate->check($data)) {
    ex('验证成功');
}
else {
    ex($validate->error);
}

使用多语言

TODO

验证场景

验证器重支持定义场景,并且验证不同场景的数据,例如:

namespace validate;

use nb\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'        => '邮箱格式错误',    
    ];
    
    protected $scene = [
        'edit'  =>  ['name','age'],
    ];
}

然后可以在验证方法中制定验证的场景

$data = [
    'name'  => 'nbframework',
    'age'   => 10,
    'email' => 'admin@nb.cx.'
];
$validate = new \validate\User();
$validate->scene('edit')->check($data);

内置规则

系统内置了一些常用的验证规则,可以完成大部分场景的验证需求,包括:

规则名称
格式验证类
长度和区间验证类
字段比较类
filter验证
正则验证
上传验证
行为验证
其它验证

验证规则严格区分大小写

格式验证类

格式验证类在使用静态方法调用的时候支持两种方式调用(以number验证为例,可以使用number() 或者 isNumber())。

require

验证某个字段必须,例如:

'name'=>'require'

如果验证规则没有添加require就表示没有值的话不进行验证

number

验证某个字段的值是否为纯数字(采用ctype_digit验证,不包含负数和小数点),例如:

'num'=>'number'
integer

验证某个字段的值是否为整数(采用filter_var验证),例如:

'num'=>'integer'
float

验证某个字段的值是否为浮点数字(采用filter_var验证),例如:

'num'=>'float'
boolean 或者 bool

验证某个字段的值是否为布尔值(采用filter_var验证),例如:

'num'=>'boolean'
email

验证某个字段的值是否为email地址(采用filter_var验证),例如:

'email'=>'email'
array

验证某个字段的值是否为数组,例如:

'info'=>'array'
accepted

验证某个字段是否为为 yes, on, 或是 1。这在确认"服务条款"是否同意时很有用,例如:

'accept'=>'accepted'
date

验证值是否为有效的日期,例如:

'date'=>'date'

会对日期值进行strtotime后进行判断。

alpha

验证某个字段的值是否为纯字母,例如:

'name'=>'alpha'
alphaNum

验证某个字段的值是否为字母和数字,例如:

'name'=>'alphaNum'
alphaDash

验证某个字段的值是否为字母和数字,下划线_及破折号-,例如:

'name'=>'alphaDash'
chs

验证某个字段的值只能是汉字,例如:

'name'=>'chs'
chsAlpha

验证某个字段的值只能是汉字、字母,例如:

'name'=>'chsAlpha'
chsAlphaNum

验证某个字段的值只能是汉字、字母和数字,例如:

'name'=>'chsAlphaNum'
chsDash

验证某个字段的值只能是汉字、字母、数字和下划线_及破折号-,例如:

'name'=>'chsDash'
cntrl(V5.1.17+)

验证某个字段的值只能是控制字符(换行、缩进、空格),例如:

'name'=>'cntrl'
graph (V5.1.17+)

验证某个字段的值只能是可打印字符(空格除外),例如:

'name'=>'graph'
print (V5.1.17+)

验证某个字段的值只能是可打印字符(包括空格),例如:

'name'=>'print'
lower (V5.1.17+)

验证某个字段的值只能是小写字符,例如:

'name'=>'lower'
upper (V5.1.17+)

验证某个字段的值只能是大写字符,例如:

'name'=>'upper'

space (V5.1.17+)
验证某个字段的值只能是空白字符(包括缩进,垂直制表符,换行符,回车和换页字符),例如:

'name'=>'space'
xdigit (V5.1.17+)

验证某个字段的值只能是十六进制字符串,例如:

'name'=>'xdigit'
activeUrl

验证某个字段的值是否为有效的域名或者IP,例如:

'host'=>'activeUrl'
url

验证某个字段的值是否为有效的URL地址(采用filter_var验证),例如:

'url'=>'url'
ip

验证某个字段的值是否为有效的IP地址(采用filter_var验证),例如:

'ip'=>'ip'

支持验证ipv4和ipv6格式的IP地址。

dateFormat:format

验证某个字段的值是否为指定格式的日期,例如:

'create_time'=>'dateFormat:y-m-d'
mobile

验证某个字段的值是否为有效的手机,例如:

'mobile'=>'mobile'
idCard

验证某个字段的值是否为有效的身份证格式,例如:

'id_card'=>'idCard'
macAddr

验证某个字段的值是否为有效的MAC地址,例如:

'mac'=>'macAddr'
zip

验证某个字段的值是否为有效的邮政编码,例如:

'zip'=>'zip'

长度和区间验证类

in

验证某个字段的值是否在某个范围,例如:

'num'=>'in:1,2,3'
notIn

验证某个字段的值不在某个范围,例如:

'num'=>'notIn:1,2,3'
between

验证某个字段的值是否在某个区间,例如:

'num'=>'between:1,10'
notBetween

验证某个字段的值不在某个范围,例如:

'num'=>'notBetween:1,10'
length:num1,num2

验证某个字段的值的长度是否在某个范围,例如:

'name'=>'length:4,25'

或者指定长度

'name'=>'length:4'

如果验证的数据是数组,则判断数组的长度。
如果验证的数据是File对象,则判断文件的大小。

max:number

验证某个字段的值的最大长度,例如:

'name'=>'max:25'

如果验证的数据是数组,则判断数组的长度。
如果验证的数据是File对象,则判断文件的大小。

min:number

验证某个字段的值的最小长度,例如:

'name'=>'min:5'

如果验证的数据是数组,则判断数组的长度。
如果验证的数据是File对象,则判断文件的大小。

after:日期

验证某个字段的值是否在某个日期之后,例如:

'begin_time' => 'after:2016-3-18',
before:日期

验证某个字段的值是否在某个日期之前,例如:

'end_time'   => 'before:2016-10-01',
expire:开始时间,结束时间

验证当前操作(注意不是某个值)是否在某个有效日期之内,例如:

'expire_time'   => 'expire:2016-2-1,2016-10-01',
allowIp:allow1,allow2,...

验证当前请求的IP是否在某个范围,例如:

'name'   => 'allowIp:114.45.4.55',

该规则可以用于某个后台的访问权限,多个IP用逗号分隔

denyIp:allow1,allow2,...

验证当前请求的IP是否禁止访问,例如:

'name'   => 'denyIp:114.45.4.55',

多个IP用逗号分隔

字段比较类

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'

filter验证

支持使用filter_var进行验证,例如:

'ip'=>'filter:validate_ip'

正则验证

支持直接使用正则验证,例如:

'zip'=>'\d{6}',
// 或者
'zip'=>'regex:\d{6}',

如果你的正则表达式中包含有|符号的话,必须使用数组方式定义。

'accepted'=>['regex'=>'/^(yes|on|1)$/i'],

也可以实现预定义正则表达式后直接调用,例如在验证器类中定义regex属性

namespace validate;

use nb\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:允许的文件字节大小

验证上传文件大小

其它验证

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'
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字段是必须的,并且会进行后续的其它验证。

上一篇:响应输出
下一篇:重定向

相关评论

您需要登录后才可以发表评论