anik/form-request

Form request 是一个为 Lumen 服务的包,允许开发者像 Laravel 一样验证表单请求。

v5.0 2023-07-26 23:59 UTC

This package is auto-updated.

Last update: 2024-09-07 00:02:07 UTC


README

Form-Request codecov Total Downloads Latest Stable Version

一个帮助开发者将验证逻辑从控制器分离到独立类别的包。Lumen 没有像 Laravel 中的 FormRequest 类。这将允许你做到这一点。

安装

  1. 在项目目录中运行 composer require anik/form-request 安装该包。
  2. \Anik\Form\FormRequestServiceProvider::class 注册到你的 bootstrap/app.php 文件作为服务提供者。
// bootstrap/app.php
$app->register(\Anik\Form\FormRequestServiceProvider::class);

如何使用?

  • 创建一个继承自 Anik\Form\FormRequest 类的类。
  • 你必须重写 Anik\Form\FormRequest 类的 rules 方法。在它里面定义你的验证规则。必须返回一个 数组
  • 你可以通过重写 messages 方法来定义验证 消息。默认是 []
  • 你可以通过重写 attributes 方法来定义自定义的漂亮 属性 名称。默认是 []
  • 你可以重写 authorize 方法来定义授权逻辑,如果客户端有权提交表单。必须返回一个布尔值。默认是 true。当返回 false 时,它将抛出 \Illuminate\Auth\Access\AuthorizationException 异常。
  • 如果验证失败,它将抛出 Illuminate\Validation\ValidationException
    • 默认情况下,它以 {"message": "The given data was invalid.", "errors": []} 格式返回响应,状态码为 422。如果你想要修改响应,可以在 app/Exceptions/Handler.phprender 方法中处理异常。
    • 重写 statusCode 方法来返回你选择的状态。必须返回 int。默认是 422
    • 重写 errorMessage 方法来返回你选择的消息。必须返回 string。默认是 The given data was invalid.
    • 重写 errorResponse 方法来返回验证失败时的响应。必须返回类型为 \Symfony\Component\HttpFoundation\Responsenull
  • 现在你可以通过方法注入注入你的 Request 类。所有 Laravel\Lumen\Http\Request 类的方法都在你的请求类中可用。
  • 当验证通过时,FormRequest::validated() 方法将返回验证后的数据。