为你的 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 相关文章推荐
php设计模式 Composite (组合模式)
Jun 26 PHP
Codeigniter的一些优秀特性总结
Jan 21 PHP
PHP 9 大缓存技术总结
Sep 17 PHP
php验证手机号码
Nov 11 PHP
php源码之将图片转化为data/base64数据流实例详解
Nov 27 PHP
PHP自动补全表单的两种方法
Mar 06 PHP
php传值方式和ajax的验证功能
Mar 27 PHP
PHP实现上传多图即时显示与即时删除的方法
May 09 PHP
PHP框架laravel的.env文件配置教程
Jun 07 PHP
PHP实现用户异地登录提醒功能的方法【基于thinkPHP框架】
Mar 15 PHP
PHP数组对象与Json转换操作实例分析
Oct 22 PHP
PHP数组基本用法与知识点总结
Jun 02 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判断浏览器的类型和语言的函数代码
2013/02/28 PHP
PHP通过串口实现发送短信
2015/07/08 PHP
jQuery lazyload 的重复加载错误以及修复方法
2010/11/19 Javascript
JavaScript版DateAdd和DateDiff函数代码
2012/03/01 Javascript
根据json字符串生成Html的一种方式
2013/01/09 Javascript
nodejs 提示‘xxx’ 不是内部或外部命令解决方法
2014/11/20 NodeJs
javascript获取元素离文档各边距离的方法
2015/02/13 Javascript
60行js代码实现俄罗斯方块
2015/03/31 Javascript
常用jQuery代码分享
2015/07/14 Javascript
JavaScript实现下拉列表框数据增加、删除、上下排序的方法
2015/08/11 Javascript
BootStrap 动态添加验证项和取消验证项的实现方法
2016/09/28 Javascript
angularJs的ng-class切换class
2017/06/23 Javascript
Electron中实现大文件上传和断点续传功能
2018/10/28 Javascript
Vue2.x通用编辑组件的封装及应用详解
2019/05/28 Javascript
JS学习笔记之数组去重实现方法小结
2019/05/29 Javascript
Vue+ElementUI项目使用webpack输出MPA的方法
2019/08/27 Javascript
JavaScript进阶(二)词法作用域与作用域链实例分析
2020/05/09 Javascript
纯JS开发baguetteBox.js响应式画廊插件
2020/06/28 Javascript
解决vuecli3中img src 的引入问题
2020/08/04 Javascript
[56:13]DOTA2-DPC中国联赛定级赛 LBZS vs Phoenix BO3第一场 1月10日
2021/03/11 DOTA
Python中一些自然语言工具的使用的入门教程
2015/04/13 Python
Python的Flask框架中实现登录用户的个人资料和头像的教程
2015/04/20 Python
尝试使用Python多线程抓取代理服务器IP地址的示例
2015/11/09 Python
Python和Java的语法对比分析语法简洁上python的确完美胜出
2019/05/10 Python
Django中的cookie和session
2019/08/27 Python
JetBrains PyCharm(Community版本)的下载、安装和初步使用图文教程详解
2020/03/19 Python
利用Python的folium包绘制城市道路图的实现示例
2020/08/24 Python
HTML5 拖拽批量上传文件的示例代码
2018/03/28 HTML / CSS
HTML5 Canvas 旋转风车绘制
2017/08/18 HTML / CSS
荷兰在线啤酒店:Beerwulf
2019/08/26 全球购物
什么是TCP/IP
2014/07/27 面试题
优秀教师的感人事迹
2014/02/04 职场文书
公证委托书
2014/08/01 职场文书
谢师宴答谢词
2015/01/05 职场文书
婚宴父亲致辞
2015/07/27 职场文书
Python采集股票数据并制作可视化柱状图
2022/04/04 Python