Laravel框架表单验证格式化输出的方法


Posted in Python onSeptember 25, 2019

最近在公司的项目开发中使用到了 laravel 框架,采用的是前后端开发的模式。接触过前后端开发模式的小伙伴应该都知道,后端返回的数据格式需要尽可能搞得保证一致性,这样前端在处理时也方便处理。我们先通过观看下面的两张接口返回的效果图吧,这样或许会更加的直观一些。

Laravel框架表单验证格式化输出的方法

laravel默认的输出格式(图一)

Laravel框架表单验证格式化输出的方法

修改后的输出格式(图二)

或许通过上面两张图,你还是未看出有什么区别的话。这里我用文字描述一下吧。 这种情况是发生在laravel做表单验证的情况下发生的。前端向我后端接口发送一个POST请求时,发送了一个title和body的字段。我后端需要对两个字段做一些非空验证。按照框架手册来进行的话,输出的格式就是图一的格式。然后后端统一的输出格式是图二中的格式,如果按照图一的格式输出肯定是不行,这样就需要我们做一个特殊处理。

问题排查

首先我们可以通过文档参看到如下信息。下面划线的部分,提到的返回信息是将所有未验证通过的数据都返回给前端,就如图一中的数据格式。

Laravel框架表单验证格式化输出的方法

laravel默认的输出格式(图三)

预期效果

通过图三我们知道了 laravel 默认的是返回一个带 422 的 http 状态码并且将所有的验证错误信息都返回。

然而我们需要的只是如图二的格式,单个的输出错误信息。大致的解决思路就是在输出的时候,我们去默认显示第一个未通过的验证信息,当通过之后,之前第二个未严重通过的就变成了第一个,这样依次循环下去,我们的每个数据就得到了验证。验证的地方我们选择框架异常统一处理的地方,这样每次验证都自动的进行处理。

解决方案

该框架是 laravel5.8 的情况下进行编写,如果版本不同,或许还需要特殊的处理,不过处理的思路可以参考下面的。

1.创建一个表单验证器。执行下面的命令之后,我们在php app/Http/Requests目录下面就可以看到该类文件了。

php artisan make:request ProjectValidate

2.定义验证规则。rules 方法是定义验证规则,而 messages 方法则是定义返回的错误信息,该方法也可以省略掉,这样提示的信息就是英文而不是图一或图二看到的中文了。

namespace App\Http\Requests;
use Illuminate\Foundation\Http\FormRequest;
class ProjectValidate extends FormRequest
{
  /**
   * Determine if the user is authorized to make this request.
   *
   * @return bool
   */
  public function authorize()
  {
    return true;
  }
  /**
   * Get the validation rules that apply to the request.
   *
   * @return array
   */
  public function rules()
  {
    return [
      'title' => 'bail|required',
      'body' => 'required',
    ];
  }
  /**
   * define the validation message
   *
   * @return array
   */
  public function messages()
  {
    return [
      'title.required' => '文章标题必填',
      'body.required' => '文章内容必填',
    ];
  }
}

3.使用验证器。这里我定义了一个控制器,在 addData 方法中,使用依赖注入的方式去实现数据的验证。记住,该方法体在未通过数据验证的情况下是不会去执行的。

namespace App\Http\Controllers\Backend\Project;

use App\Http\Requests\ProjectValidate;
use App\Http\Controllers\Backend\UCenter;

class Index extends UCenter
{
  public function index()
  {
    return success();
  }
  public function addData(ProjectValidate $request)
  {
    $validated = $request->validated();
    return success($validated);
  }
}

4.统一处理数据格式。找到php App\Exceptions\Handler.php文件,找到下面的方法,修改为如下内容。这时候在做表单验证就会显示图二的格式信息了。

public function render($request, Exception $exception)
  {
    if ($exception instanceof ValidationException) {
      // 只读取错误中的第一个错误信息
      $errors = $exception->errors();
      $message = '';
      // 框架返回的是二维数组,因此需要去循环读取第一个数据
      foreach ($errors as $key => $val) {
        $keys  = array_key_first($val);
        $message = $val[$keys];
        break;
      }
      return response()->json(['code' => 1001, 'message' => $message, 'data' => []], 422);
    }
    return parent::render($request, $exception);
  }

总结

1.优势

输出固定的格式,前端在处理数据的时候,不需要做特别的格式上面调整。

2.劣势

这样的方式验证,每验证一次,就会向后端发送一个 http 请求。

以上所述是小编给大家介绍的Laravel框架表单验证格式化输出的方法,希望对大家有所帮助,如果大家有任何疑问请给我留言,小编会及时回复大家的。在此也非常感谢大家对三水点靠木网站的支持!
如果你觉得本文对你有帮助,欢迎转载,烦请注明出处,谢谢!

Python 相关文章推荐
Python基于PycURL自动处理cookie的方法
Jul 25 Python
python中os模块详解
Oct 14 Python
python中正则的使用指南
Dec 04 Python
Python使用QRCode模块生成二维码实例详解
Jun 14 Python
Python协程的用法和例子详解
Sep 09 Python
python实现抖音视频批量下载
Jun 20 Python
python绘制立方体的方法
Jul 02 Python
使用EduBlock轻松学习Python编程
Oct 08 Python
pytorch 在网络中添加可训练参数,修改预训练权重文件的方法
Aug 17 Python
Numpy与Pytorch 矩阵操作方式
Dec 27 Python
Python列表操作方法详解
Feb 09 Python
Python如何将模块打包并发布
Aug 30 Python
pyqt5 QScrollArea设置在自定义侧(任何位置)
Sep 25 #Python
python 用户交互输入input的4种用法详解
Sep 24 #Python
python getpass实现密文实例详解
Sep 24 #Python
使用Python的turtle模块画国旗
Sep 24 #Python
给你一面国旗 教你用python画中国国旗
Sep 24 #Python
Python MongoDB 插入数据时已存在则不执行,不存在则插入的解决方法
Sep 24 #Python
Python获取时间戳代码实例
Sep 24 #Python
You might like
Linux下安装PHP MSSQL扩展教程
2014/10/24 PHP
分享PHP守护进程类
2015/12/30 PHP
PHP加密技术的简单实现
2016/09/04 PHP
PHP Primary script unknown 解决方法总结
2019/08/22 PHP
关于JavaScript的一些看法
2009/05/27 Javascript
jQuery 类twitter的文本字数限制带提示效果插件
2010/04/16 Javascript
兼容FF和IE的动态table示例自写
2013/10/21 Javascript
JS 如何获取radio选中后的值及不选择取radio的值
2013/10/28 Javascript
封装了一个支持匿名函数的Javascript事件监听器
2014/06/05 Javascript
js使用for循环与innerHTML获取选中tr下td值
2014/09/26 Javascript
基于dropdown.js实现的两款美观大气的二级导航菜单
2015/09/02 Javascript
详解JavaScript编程中的数组结构
2015/10/24 Javascript
jQuery简单实现仿京东分类导航层效果
2016/06/07 Javascript
jQuery弹出下拉列表插件(实现kindeditor的@功能)
2016/08/16 Javascript
js实现自动轮换选项卡
2017/01/13 Javascript
js实现音乐播放控制条
2017/09/09 Javascript
解决vue项目使用font-awesome,build后路径的问题
2018/09/01 Javascript
javascript设计模式 ? 抽象工厂模式原理与应用实例分析
2020/04/09 Javascript
[49:20]2014 DOTA2国际邀请赛中国区预选赛5.21 CIS VS TongFu
2014/05/22 DOTA
[01:01]青春无憾,一战成名——DOTA2全国高校联赛开启
2018/02/25 DOTA
讲解Python中运算符使用时的优先级
2015/05/14 Python
python实现用户登录系统
2016/05/21 Python
python命令行解析之parse_known_args()函数和parse_args()使用区别介绍
2018/01/24 Python
python简单验证码识别的实现方法
2019/05/10 Python
Django中间件基础用法详解
2019/07/18 Python
快速解决vue.js 模板和jinja 模板冲突的问题
2019/07/26 Python
Python用dilb提取照片上人脸的示例
2020/10/26 Python
linux面试题参考答案(8)
2015/08/11 面试题
个人简历自我评价八例
2013/10/31 职场文书
文明风采获奖感言
2014/02/18 职场文书
工程负责人任命书
2014/06/06 职场文书
大学生万能检讨书范例
2014/10/04 职场文书
秋冬农业生产标语
2014/10/09 职场文书
2015年艾滋病防治工作总结
2015/05/22 职场文书
MySQL REVOKE实现删除用户权限
2021/06/18 MySQL
在Oracle表中进行关键词搜索的过程
2022/06/10 Oracle