为你的 Laravel 验证器加上多验证场景的实现


Posted in PHP onApril 07, 2020

前言

在我们使用 laravel 框架的验证器,有的时候需要对表单等进行数据验证,当然 laravel 也为我们提供了
Illuminate\Http\Request 对象提供的 validate 方法 以及 FormRequest 和 Validator。

FormRequest 通过新建文件将我们的验证部分单独分开,来避免控制器臃肿。如果验证失败,就会生成一个让用户返回到先前的位置的重定向响应。这些错误也会被闪存到 Session 中,以便这些错误都可以在页面中显示出来。如果传入的请求是 AJAX,会向用户返回具有 422 状态代码和验证错误信息的 JSON 数据的 HTTP 响应。如果是接口请求或 ajax, 那么我们可能还需要将返回的 json 数据修改成我们想要的格式。

当我们实际开发中,可能一个模块需要有多个验证场景,如果为每一个验证场景都新建一个 FormRequest 不就太过繁琐了。
那么给 laravel 加上一个验证场景通过一个验证类一个模块或多个模块来适应不同的场景不就方便很多了。

开始

首先 我们封装了一个基类 BaseValidate.php 并将其放在 app\Validate 下,当然你也可以放在其他地方,只要修改好命名空间就好。

<?php
namespace App\Validate;

use Illuminate\Support\Facades\Validator;
/**
 * 扩展验证器
 */
class BaseValidate {

  /**
   * 当前验证规则
   * @var array
   */
  protected $rule = [];

  /**
   * 验证提示信息
   * @var array
   */
  protected $message = [];

  /**
   * 验证场景定义
   * @var array
   */
  protected $scene = [];

  /**
   * 设置当前验证场景
   * @var array
   */
  protected $currentScene = null;

  /**
   * 验证失败错误信息
   * @var array
   */
  protected $error = [];

  /**
   * 场景需要验证的规则
   * @var array
   */
  protected $only = [];


  /**
   * 设置验证场景
   * @access public
   * @param string $name 场景名
   * @return $this
   */
  public function scene($name)
  {
    // 设置当前场景
    $this->currentScene = $name;

    return $this;
  }

  /**
   * 数据验证
   * @access public
   * @param array   $data 数据
   * @param mixed   $rules 验证规则
   * @param array  $message 自定义验证信息
   * @param string  $scene 验证场景
   * @return bool
   */
  public function check($data, $rules = [], $message = [],$scene = '')
  {
    $this->error =[];
    if (empty($rules)) {
      //读取验证规则
      $rules = $this->rule;
    }
    if (empty($message)) {
      $message = $this->message;
    }

    //读取场景
    if (!$this->getScene($scene)) {
      return false;
    }

    //如果场景需要验证的规则不为空
    if (!empty($this->only)) {
      $new_rules = [];
      foreach ($this->only as $key => $value) {
        if (array_key_exists($value,$rules)) {
          $new_rules[$value] = $rules[$value];
        }  
      }
      $rules = $new_rules;
    }
    // var_dump($rules);die;
    $validator = Validator::make($data,$rules,$message);
    //验证失败
    if ($validator->fails()) {
      $this->error = $validator->errors()->first();
      return false;
    }

    return !empty($this->error) ? false : true;
  }

  /**
   * 获取数据验证的场景
   * @access protected
   * @param string $scene 验证场景
   * @return void
   */
  protected function getScene($scene = '')
  {
    if (empty($scene)) {
      // 读取指定场景
      $scene = $this->currentScene;
    }
    $this->only = [];

    if (empty($scene)) {
      return true;
    }

    if (!isset($this->scene[$scene])) {
      //指定场景未找到写入error
      $this->error = "scene:".$scene.'is not found';
      return false;
    }
    // 如果设置了验证适用场景
    $scene = $this->scene[$scene];
    if (is_string($scene)) {
      $scene = explode(',', $scene);
    }
    //将场景需要验证的字段填充入only
    $this->only = $scene;
    return true;
  }

  // 获取错误信息
  public function getError()
  {
    return $this->error;
  } 
}

使用

接下来我们来验证一个文章的提交信息,首先我们新建一个文章验证类 ArticleValidate.php 并填充一些内容

<?php
namespace App\Validate;

use App\Validate\BaseValidate;
/**
 * 文章验证器
 */
class ArticleValidate extends BaseValidate {
  //验证规则
  protected $rule =[
    'id'=>'required',
    'title' => 'required|max:255',
    'content' => 'required',
  ];
  //自定义验证信息
  protected $message = [
    'id.required'=>'缺少文章id',
    'title.required'=>'请输入title',
    'title.max'=>'title长度不能大于 255',
    'content.required'=>'请输入内容',
  ];

  //自定义场景
  protected $scene = [
    'add'=>"title,content",
    'edit'=> ['id','title','content'],
  ];
}

如上所示,在这个类中我们定义了验证规则 rule,自定义验证信息 message,以及验证场景 scene

非场景验证

我们只需要定义好规则

public function update(){

    $ArticleValidate = new ArticleValidate;

    $request_data = [
      'id'=>'1',
      'title'=>'我是文章的标题',
      'content'=>'我是文章的内容',
    ];

    if (!$ArticleValidate->check($request_data)) {
      var_dump($ArticleValidate->getError());
    }
  }

check 方法中总共有四个参数,第一个要验证的数据,第二个验证规则,第三个自定义错误信息,第四个验证场景,其中 2,3,4 非必传。
如果验证未通过我们调用 getError() 方法来输出错误信息,getError()暂不支持返回所有验证错误信息 。

场景验证

我们需要提前在验证类中定义好验证场景

如下,支持使用字符串或数组,使用字符串时,要验证的字段需用 , 隔开

//自定义场景
  protected $scene = [
    'add'=>"title,content",
    'edit'=> ['id','title','content'],
  ];

然后在我们的控制器进行数据验证

public function add(){

    $ArticleValidate = new ArticleValidate;

    $request_data = [
      'title'=>'我是文章的标题',
      'content'=>'我是文章的内容',
    ];

    if (!$ArticleValidate->scene('add')->check($request_data)) {
      var_dump($ArticleValidate->getError());
    }

  }

控制器内验证

当然我们也允许你不创建验证类来验证数据,

public function add(){

    $Validate = new BaseValidate;

    $request_data = [
      'title'=>'我是文章的标题',
      'content'=>'我是文章的内容',
    ];

    $rule =[
      'id'=>'required',
      'title' => 'required|max:255',
      'content' => 'required',
    ];
    //自定义验证信息
    $message = [
      'id.required'=>'缺少文章id',
      'title.required'=>'请输入title',
      'title.max'=>'title长度不能大于 255',
      'content.required'=>'请输入内容',
    ];

    if (!$Validate->check($request_data,$rule,$message)) {
      var_dump($Validate->getError());
    }
  }

通过验证场景,既减少了控制器代码的臃肿,又减少了 FormRequest 文件过多,还可以自定义 json 数据是不是方便多了呢,

参考文档

laravel 表单验证 :表单验证《Laravel 5.5 中文文档》
thinkphp 验证场景 :https://www.kancloud.cn/manual/thinkphp5_1/354104

到此这篇关于为你的 Laravel 验证器加上多验证场景的实现的文章就介绍到这了,更多相关Laravel 验证器内容请搜索三水点靠木以前的文章或继续浏览下面的相关文章希望大家以后多多支持三水点靠木!

本文为杨攀遥原创文章,如若转载,无需和我联系,但请注明出处 [杨攀遥的博客]:https://www.yangpanyao.com/archives/120.html

PHP 相关文章推荐
Smarty安装配置方法
Apr 10 PHP
php下删除字符串中HTML标签的函数
Aug 27 PHP
php新建文件自动编号的思路与实现
Jun 27 PHP
PHP 杂谈《重构-改善既有代码的设计》之四 简化条件表达式
Apr 09 PHP
解析php dirname()与__FILE__常量的应用
Jun 24 PHP
PHP中对缓冲区的控制实现代码
Sep 29 PHP
使用PHP破解防盗链图片的一个简单方法
Jun 07 PHP
Yii列表定义与使用分页方法小结(3种方法)
Jul 15 PHP
ThinkPHP简单使用memcache缓存的方法
Nov 15 PHP
Python中使用django form表单验证的方法
Jan 16 PHP
ThinkPHP实现静态缓存和动态缓存示例代码
May 02 PHP
深入理解PHP中mt_rand()随机数的安全
Oct 12 PHP
再谈Yii Framework框架中的事件event原理与应用
Apr 07 #PHP
Yii框架组件的事件机制原理与用法分析
Apr 07 #PHP
Yii框架多语言站点配置方法分析【中文/英文切换站点】
Apr 07 #PHP
php设计模式之适配器模式实例分析【星际争霸游戏案例】
Apr 07 #PHP
php设计模式之迭代器模式实例分析【星际争霸游戏案例】
Apr 07 #PHP
解决Laravel5.x的php artisan migrate数据库迁移创建操作报错SQLSTATE[42000]
Apr 06 #PHP
4种Windows系统下Laravel框架的开发环境安装及部署方法详解
Apr 06 #PHP
You might like
PHP include_path设置技巧分享
2011/07/03 PHP
php获取英文姓名首字母的方法
2015/07/13 PHP
一文看懂PHP进程管理器php-fpm
2020/06/01 PHP
通过身份证号得到出生日期和性别的js代码
2009/11/23 Javascript
关于javascript中this关键字(翻译+自我理解)
2010/10/20 Javascript
js bind 函数 使用闭包保存执行上下文
2011/12/26 Javascript
利用js的Node遍历找到repeater的一个字段实例介绍
2013/04/25 Javascript
使用JavaScript 实现对象 匀速/变速运动的方法
2013/05/08 Javascript
js加入收藏以及使用Jquery更改透明度
2014/01/26 Javascript
JavaScript监听和禁用浏览器回车事件实例
2015/01/31 Javascript
jquery实现动态操作select选中
2015/02/11 Javascript
全面解析Bootstrap表单样式的使用
2016/09/09 Javascript
jQuery事件用法详解
2016/10/06 Javascript
微信小程序之网络请求简单封装实例详解
2017/06/28 Javascript
vue axios整合使用全攻略
2018/05/24 Javascript
vue 监听某个div垂直滚动条下拉到底部的方法
2018/09/15 Javascript
Vuex中的State使用介绍
2019/01/19 Javascript
使用javascript做时间倒数读秒功能的实例
2019/01/23 Javascript
vue实现简单学生信息管理
2020/05/30 Javascript
解决python写的windows服务不能启动的问题
2014/04/15 Python
Python使用smtplib模块发送电子邮件的流程详解
2016/06/27 Python
Python实现Linux的find命令实例分享
2017/06/04 Python
使用Python实现微信提醒备忘录功能
2018/12/04 Python
利用PyCharm Profile分析异步爬虫效率详解
2019/05/08 Python
python 爬取学信网登录页面的例子
2019/08/13 Python
Python语法之精妙的十个知识点(装B语法)
2020/01/18 Python
利用scikitlearn画ROC曲线实例
2020/07/02 Python
CSS3 函数技巧 用css 实现js实现的事情(clac Counters Tooltip)
2017/08/15 HTML / CSS
H5仿微信界面教程(一)
2017/07/05 HTML / CSS
启动一个线程是用run()还是start()
2016/12/25 面试题
党校培训思想汇报
2013/12/30 职场文书
珍惜水资源建议书
2014/03/12 职场文书
主题教育活动总结
2014/05/05 职场文书
签约仪式策划方案
2014/06/02 职场文书
小学生反邪教心得体会
2016/01/15 职场文书
基于Go语言构建RESTful API服务
2021/07/25 Golang