ThinkPHP6.0学习笔记-验证器
ThinkPHP6.0学习笔记-验证器
验证器
By:Mirror王宇阳
验证器定义
验证器的使用，必须定义它；系统提供了一条命令直接生产一个验证器类：
php think make:validate User自动再应用目录下生成一个
validate文件夹，并生成User.php类
namespace app\validate;
use think\Validate;
class User extends Validate
{
/**
* 定义验证规则
* 格式：'字段名' => ['规则1','规则2'...]
* '字段名' => '规则1|规则2...'
*
* @var array
*/
protected $rule = [
'name' => 'require|max:20',
'price' => 'number|between:1,100',
'email' => 'email'
];
/**
* 定义错误信息
* 格式：'字段名.规则名' => '错误信息'
*
* @var array
*/
protected $message = [
'name.require' => '姓名不得为空',
'name.max' => '姓名不得大于20位',
'price.number' => '价格必须是数字',
'price.between' => '价格位于1~100之间',
'email' => '邮箱格式错误'
];
}自动生成的两个属性：
$rule：定义规则$message：定义错误信息 ，如果不定义错误信息提示默认的错误信息
验证器定义之后，进行调用测试，创建一个Verify.php控制器：
namespace app\controller;
use app\validate\User;
use think\exception\ValidateException;
class Verify
{
public function index()
{
try {
validate(User::class)->check([
'name' => '蜡笔小新',
'price' => 90,
'email' => 'xiaoxin@qq.com'
]);
} catch (ValidateException $err){
dump($err->getError());
}
}
}当验证规则出现一个错误后就会停止之后字段的判断
批量验证
class Verify
{
public function index()
{
try {
$result = validate(User::class)
->batch(true)->check([
'name' => '蜡笔小新',
'price' => 90,
'email' => 'xiaoxin@qq.com'
]);
if(true !== $result){
dump($result);
}
} catch (ValidateException $err){
dump($err->getError());
}
}
}自定义规则
系统内置提供了部分常用的规则；同时也允许开发者自定义规则：
protected function checkName($value,$rule)
{
return $rule != $value ? true : '存在非法字符';
}自定义规则支持传入五个参数：
- 验证数据
- 验证规则
- 全部数据(数组)
- 字段名
- 字段描述
验证规则
规则定义
protected $rule = [
'name' => 'require|max:20',
'price' => 'number|between:1,100',
'email' => 'email'
];不仅仅支持字符串模式，也支持数组模式
protected $rule = [
'name' => [
'require',
'max' => 10
],
'price' => [
'number',
'between' => '1,100'
],
'email' => ['email']
];数组模式是在规则复杂的时候使用
独立验证：
上述的各种验证规则都需要调用
validate目录下的验证器文件，而Think支持在控制器文件下独立验证；这种不依赖验证器文件的调用方式是一种独立、唯一的调用方式
namespace app\controller;
use think\facade\Validate;
class Verify
{
public function index()
{
$validate = Validate::rule([
'name' => 'require|max:20',
'price' => 'number|between:1,100',
'email' => 'email'
]);
$result = $validate->chech([
'name' => '蜡笔小新',
'price' => 90,
'email' => 'xiaoxin@qq.com'
]);
if (!$result){
dump($validate->getError());
}
}
}独立验证支持对象化的定义方式，但不支持属性方法的定义： namespace app\controller; use think\facade\Validate; use think\facade\ValidateRule as Rule; class Verify { public function index() { $validate = Validate::rule([ 'name' => 'Rule::isRequire()->max(20)', 'price' => 'Rule::isNumber()->between([1,100])', 'email' => 'Rule::isEmail()' ]); $result = $validate->chech([ 'name' => '蜡笔小新', 'price' => 90, 'email' => 'xiaoxin@qq.com' ]); if (!$result){ dump($validate->getError()); } } }
独立验证支持闭包自定义方法：（不支持字段多规则）
$validate = Validate::rule([
'name'=> function($value){
return $value != '' ? true : '姓名不得为空';
},
'price'=> function($value){
return $value > 0 ? true:'不得低于零';
}
]);错误信息
单独定义提示信息
在验证器类中定义message属性:
protected $message = [
'name.require' => '姓名不得为空',
'name.max' => '姓名不得大于20位',
'price.number' => '价格必须是数字',
'price.between' => '价格位于1~100之间',
'email' => '邮箱格式错误'
];错误信息支持数组定义，并通过JSON方式交给前端
protected $message = [
'name.require' => ['code' => 1001, 'msg' => '名称必须'],
'name.max' => ['code' => 1002, 'msg' => '名称最多不能超过25个字符'],
'age.number' => ['code' => 1003, 'msg' => '年龄必须是数字'],
'age.between' => ['code' => 1004, 'msg' => '年龄必须在1~120之间'],
'email' => ['code' => 1005, 'msg' =>'邮箱格式错误'],
];独立验证定义错误提示
ValidateRule::isEmail(null,'格式不正确')参数一：验证规则 参数二：自定义错误提示
也可以独立使用
message()方法: Validate->[……]->message([……])
验证场景
验证场景设置：即特定的场景写是否进行验证，独立验证不存在场景验证；
新增数据需要验证邮箱信息，而修改数据不需要验证邮箱信息
namespace app\validate;
use think\Validate;
class User extends Validate
{
protected $rule = [
'name' => 'require|max:20',
'price' => 'number|between:1,100',
'email' => 'email'
];
protected $message = [
'name.require' => '姓名不得为空',
'name.max' => '姓名不得大于20位',
'price.number' => '价格必须是数字',
'price.between' => '价格位于1~100之间',
'email' => '邮箱格式错误'
];
protected $scene = [
// 新增数据验证三个字段
'insert' => ['name','price','email'],
// 更新数据验证两个字段
'edit' => ['name','price']
];
}try {
validate(User::class)->scene('edit')->check([
'name' => '蜡笔小新',
'price' => 90,
'email' => 'xiaoxinqq.com'
]);
} catch (ValidateException $err){
dump($err->getError());
}在控制端设置
scene()就成功的限制只验证name和price两个字段
scene支持为单个场景单独定义方法，方法的命名规范是scene+场景名，采用驼峰写法；
同时在验证类中支持公共方法对场景中的细节进行定义：
public function sceneEdit()
{
return $this->only(['name','price'])
->append('name','min:5')
->remove('price','between')
->append('price','require|max:20');
}
append追加remove移除 （不要对一个字段多次操作，会导致覆盖；可以同时操作）only约束字段
路由验证
路由验证：在路由参数调用验证类进行验证
protected $rule = [
'id' => 'number|between:1,10'
];
protected $message = [
'id.between' => 'id介于1~10之间',
'id.number' => 'id必须是数字'
];
protected $scene = [
'route' => ['id'];
];Route::rule('vr/:id','Verify/route')->validate(User::class,'route');//只执行route场景也支持使用独立的验证方式，这里不赘述……
内置规则
静态方法支持两种形式：::number() 、isNumber()方法验证
格式验证类
属性/方法 | 描述 |
|---|---|
require/::isRequire | 不得为空 |
number/::isNumber | 验证字段是否为纯数字 |
integer/::isInteger | 验证字段是否为整数 |
float/::isFloat | 验证字段是否为浮点数 |
boolean/::isBoolean | 验证字段是否为布尔值 |
email/::isEmail | 验证字段是否为邮箱格式 |
array/isArray | 验证字段是否为数组 |
accepted/isAccepted | 验证字段是否为yes/on |
date/isDate | 验证字段是否为有效日期 |
alpha/isAlpha | 验证字段是否为纯字母 |
alphaNum/isAlphaNum | 验证字段是否为纯字母数字组合 |
alphaDash/isAlphaDash | 验证字段是否为字母数字下划线破折号组好 |
chs/isChs | 验证字段是否为汉字 |
chsAlpha/isChsAlpha | 验证字段是否为汉字字母 |
chsAlphaNum/isChsAlphaNum | 验证字段是否为汉字字母和数字 |
chsDash/isChsDash | 验证字段是否为字母数字下划线破折号组好和汉字 |
cntrl/isCntrl | 验证字段是否为控制字符（空格、缩进） |
graph/isGraph | 验证字段是否为可打印字符（不包括空格） |
print/isPrint | 验证字段是否为可打印字符（包括空格） |
lower/isLower | 验证字段是否为小写 |
upper/isUpper | 验证字段是否为大写 |
space/isSpace | 验证字段是否为空白字符 |
xdigit/isXdigit | 验证字段是否为十六进制 |
activeUrl/isActiveUrl | 验证字段是否为有效域名 |
url/isUrl | 验证字段是否为有效URL地址 |
ip/isIp | 验证字段是否为有效IP地址 |
deteFormat:format | 验证字段的日期时间格式 |
mobile | 验证字段是否为有效手机号 |
idCard | 验证身份证格式 |
macAddr | 验证MAC地址格式 |
zip | 验证有效邮政编码 |
长度和区间验证类
属性 | 描述 |
|---|---|
in | 验证字段是否在某个范围 |
notIn | 验证字段是否不再某个范围 |
between | 验证字段是否在某个区间 |
notBetween | 验证字段是否不在某个区间 |
length | 验证长度是否在某个范围或指定长度 |
max/min | 验证最大/最小长度（大小） |
after | 验证是否在某个日期之后 |
before | 验证是否在某个日期之前 |
expire | 验证当前值是否在某个时间区间内 |
allowip | 验证当前值是否在某个IP段范围内 |
denyIp | 验证当前值IP是否为禁止访问的IP |
字段比较类
属性 | 描述 |
|---|---|
confirm:field | 验证字段的值是否和其它的值一致 |
different:field | 验证字段的值是否和其它的值不一致 |
eq/same/= | 验证是否等于某个值 |
egt / >= | 验证是否大于等于某个值 |
gt/> | 验证是否大于某个值 |
elt/<= | 验证是否小于等于某个值 |
lt/< | 验证是否小于某个值 |
上传验证类
属性 | 描述 |
|---|---|
file | 验证上传的是否是一个文件 |
image | 验证是否是一个图像文件（可以约束width height type） |
fileExt | 验证文件后缀（可以允许后缀名单） |
fileMime | 验证文件类型（可以允许文件类型） |
fileSize | 验证文件大小（可以允许的字节大小） |
其他验证类
filter验证：
支持使用filter_var进行验证，例如：
'ip'=>'filter:validate_ip'正则验证：regex
支持使用正则表达式进行验证：
'data' => '\d{6}';
'data' => 'regex:\d{6}';若表达式中包含或逻辑，需要使用数组方式定义
'data' => ['regex'=>'/^(yes|on|1)$/i']同时也可以预定义
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',表单令牌验证：token
参考连接：https://www.kancloud.cn/manual/thinkphp6_0/1037632
验证请求字段唯一：unique
可以验证当前请求的字段值是否为唯一的
unique:[table],[field],[except],[pk]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',require：
属性 | 描述 |
|---|---|
requireIf:field,value | 验证某个字段的值等于某个值的时候必须 |
requireWith:field | 验证某个字段有值的时候必须 |
requireWithout:field | 验证某个字段没有值的时候必须 |
requireCallback:callable | 验证当某个callable为真时候字段必须 |
静态调用验证
静态调用：使用facade模式进行调用验证，适合验证单个数据
引入facade中的Validate时候可能会发生冲突，需要留意；
dump(Validate::isEmail('xiaoxin@qq.com'));静态调用支持多规则验证：checkRule()
Validate::checkRule(10, 'number|between:1,10');注解验证
参考官方：https://www.kancloud.cn/manual/thinkphp6_0/1375936
安装额外的扩展：
composer require topthink/think-annotation