在thinkphp框架当中推荐使用验证器进行数据验证(也支持使用\think\Validate
类进行独立验证)
在和controller层 创建validate模块即可创建验证模块:
验证器定义
为具体的验证场景或者数据表定义好验证器类,直接调用验证类的check
方法即可完成验证,下面是一个例子:
我们定义一个\app\index\validate\User
验证器类用于User
的验证。
namespace app\index\validate;
use think\Validate;
class User extends Validate
{
protected $rule = [
'name' => 'require|max:25',
'email' => 'email',
];
}
V5.1.15+
版本开始,可以使用下面的指令快速生成User
验证器。
php think make:validate index/User
可以直接在验证器类中使用message
属性定义错误提示信息,例如:
namespace app\index\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
验证的控制器方法中,添加如下代码即可:此处调用的是check方法
namespace app\index\controller;
use think\Controller;
class Index extends Controller
{
public function index()
{
$data = [
'name' => 'thinkphp',
'email' => 'thinkphp@qq.com',
];
$validate = new \app\index\validate\User;
if (!$validate->check($data)) {
dump($validate->getError());
}
}
}
事实上控制器类提供了一个validate
方法可以更方便的进行验证,如下:
namespace app\index\controller;
use think\Controller;
class Index extends Controller
{
public function index()
{
$result = $this->validate(
[
'name' => 'thinkphp',
'email' => 'thinkphp@qq.com',
],
'app\index\validate\User');
if (true !== $result) {
// 验证失败 输出错误信息
dump($result);
}
}
}
批量验证
默认情况下,一旦有某个数据的验证规则不符合,就会停止后续数据及规则的验证,如果希望批量进行验证,可以设置:
namespace app\index\controller;
use think\Controller;
class Index extends Controller
{
// 是否批量验证
protected $batchValidate = true;
public function index()
{
$result = $this->validate(
[
'name' => 'thinkphp',
'email' => 'thinkphp@qq.com',
],
'app\index\validate\User');
if (true !== $result) {
// 验证失败 输出错误信息
dump($result);
}
}
}
该验证方法在model层也可以正常调用
该模块参考博客来源:https://blog.csdn.net/shangtaosoft/article/details/78549611
在controller中采取批量验证还可以采用;
控制器中使用批量验证的话,我木有试额,批量验证不通过返回的是一个错误数组:
$validate = new Validate($rule, $msg);
$result = $validate->batch()->check($data);
没使用验证器的话,采用extend()方法定义
$validate->extend('checkName', function ($value, $rule) {
return $rule == $value ? true : '名称错误';
});
还支持批量注册规则,同样是使用数组。
定义字段信息,可以给对应的字段添加描述:
protected $field = [ 'user_name' => '用户名', 'password' => '密码', 'real_name' => '姓名', 'email' => '邮箱', 'qq' => 'QQ', 'phone' => '手机' ];
在使用场景中,直接定义字段,来限制当前验证的字段。
在验证器中定义$scene:
protected $scene = [ 'register' => ['user_name','real_name','password','phone','email'], ];
场景使用时,就需要加上scene()方法:
$validate->scene('register')->check($data)
显然,我没把qq字段写进去,设定的qq验证规则木有生效。
在scene里还可以重写规则,
protected $scene = [
'edit' => ['name','age'=>'require|number|between:1,120'],
];
动态设置的话采用匿名函数:$validate->scene('edit', function($key,$data){
return 'email'==$key && isset($data['id'])? true : false;
});
该模块参考博客来源:https://blog.csdn.net/hxh5801050/article/details/78600077
验证规则还可以自定义,调用对应的自定义的方法即可
自定义验证规则
系统内置了一些常用的规则(参考后面的内置规则),如果不能满足需求,可以在验证器重添加额外的验证方法,例如:
namespace app\index\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 : '名称错误';
}
}