Laravel中使用FormRequest进行表单验证方法及问题汇总

Laravel中使用FormRequest进行表单验证方法及问题汇总,第1张

概述介绍《PHP实战:Laravel中使用FormRequest进行表单验证方法及问题汇总》开发教程,希望对您有用。

《PHP实战:Laravel中使用FormRequest进行表单验证方法及问题汇总》要点:
本文介绍了PHP实战:Laravel中使用FormRequest进行表单验证方法及问题汇总,希望对您有用。如果有疑问,可以联系我们。

PHP应用在`Laravel`中,每一个请求都会被封装为一个`Request`对象,`Form Request`对象就是包含了额外验证逻辑(以及访问权限控制)的自定义`Request`类. 本文分析了FormRequest异常的处理流程并提出了自定义处理FormRequest验证失败的思路.

所有示例基于Laravel 5.1.39 (LTS)

今天天气不错,我们来说说表单验证.

Controller中做表单验证

有的同学把表单验证逻辑写在Controller中,例如这个对用户提交评论内容的验证:

<?PHP// ... use ValIDator;class CommentController{  public function poststoreComment(Request $request)  {    $valIDator = ValIDator::make($request->all(),[      'comment' => 'required',// 只是实例,就写个简单的规则,你的网站要是这么写欢迎在评论里贴网址    ]);    if ($valIDator->fails()) {      return redirect()        ->back()        ->withErrors($valIDator)        ->withinput();    }  }

这样写的话,表单验证和业务逻辑挤在一起,我们的Controller中就会有太多的代码,而且重复的验证规则基本也是复制粘贴.

我们可以利用Form Request来封装表单验证代码,从而精简Controller中的代码逻辑,使其专注于业务.而独立出去的表单验证逻辑甚至可以复用到其它请求中,例如修改评论.

什么是Form Request

在Laravel中,每一个请求都会被封装为一个Request对象,Form Request对象就是包含了额外验证逻辑(以及访问权限控制)的自定义Request类.

如何使用Form Request做表单验证

Laravel提供了生成Form Request的Artisan命令:

<code>$ PHP artisan make:request StoreCommentRequest</code>

于是就生成了app/http/Requests/StoreCommentRequest.PHP,让我们来分析一下内容:

<?PHPnamespace App\http\Requests;use App\http\Requests\Request; // 可以看到,这个基类是在我们的项目中的,这意味着我们可以修改它class StoreCommentRequest extends Request{  /**   * Determine if the user is authorized to make this request.   *   * @return bool   */  public function authorize() // 这个方法可以用来控制访问权限,例如禁止未付费用户评论…  {    return false; // 注意!这里默认是false,记得改成true  }  /**   * Get the valIDation rules that apply to the request.   *   * @return array   */  public function rules() // 这个方法返回验证规则数组,也就是ValIDator的验证规则  {    return [      //    ];  }}

那么很容易,我们除了让authorize方法返回true之外,还得让rules方法返回我们的验证规则:

<?PHP// ...  public function rules()  {    return [    ];  }// ...

接着修改我们的Controller:

<?PHP// ...  // 之前:public function poststoreComment(Request $request)  public function poststoreComment(\App\http\Requests\StoreCommentRequest $request)  {    // ...  }// ...

这样Laravel便会自动调用StoreCommentRequest进行表单验证了.

异常处理

如果表单验证失败,Laravel会重定向到之前的页面,并且将错误写到Session中,如果是AJAX请求,则会返回一段http状态为422的JsON数据,类似这样:

<code>{comment: ["The comment fIEld is required."]}</code>

这里就不细说提示信息怎么修改了,如果有人想看相关教程,可以留言.

我们主要来说说怎么定制错误处理.

通常来说,Laravel中的错误都是异常(Exception),我们都可以在app\Exceptions\handler.PHP中进行统一处理.Form Request确实也抛出了一个Illuminate\http\Exception\httpResponseException异常,但这个异常是在路由逻辑中就被特殊处理了.

首先我们来看看Form Request是如何被执行的:

Illuminate\ValIDation\ValIDationServiceProvIDer:

<?PHPnamespace Illuminate\ValIDation;use Illuminate\Support\ServiceProvIDer;use Illuminate\Contracts\ValIDation\ValIDatesWhenResolved;class ValIDationServiceProvIDer extends ServiceProvIDer{  /**   * Register the service provIDer.   *   * @return voID   */  public function register()  {    $this->registerValIDationResolverHook(); // 看我看我看我    $this->registerPresenceVerifIEr();    $this->registerValIDationFactory();  }  /**   * Register the "ValIDatesWhenResolved" container hook.   *   * @return voID   */  protected function registerValIDationResolverHook() // 对,就是我  {    // 这里可以看到对`ValIDatesWhenResolved`的实现做了一个监听    $this->app->afterResolving(function (ValIDatesWhenResolved $resolved) {      $resolved->valIDate(); // 然后调用了它的`valIDate`方法进行验证    });  }// ...

你猜对了,Form Request就实现了这个Illuminate\Contracts\ValIDation\ValIDatesWhenResolved接口:

<?PHP namespace Illuminate\Foundation\http;use Illuminate\http\Request;use Illuminate\http\Response;use Illuminate\http\JsonResponse;use Illuminate\Routing\Redirector;use Illuminate\Container\Container;use Illuminate\Contracts\ValIDation\ValIDator;use Illuminate\http\Exception\httpResponseException;use Illuminate\ValIDation\ValIDatesWhenResolvedTrait;use Illuminate\Contracts\ValIDation\ValIDatesWhenResolved; // 是你use Illuminate\Contracts\ValIDation\Factory as ValIDationFactory;// 我们`app\http\Requests\Request`便是继承于这个`FormRequest`类class FormRequest extends Request implements ValIDatesWhenResolved // 就是你{  use ValIDatesWhenResolvedTrait; // 这个我们待会儿也要看看  // ...

FormRequest基类中的valIDate方法是由这个Illuminate\ValIDation\ValIDatesWhenResolvedTrait实现的:

Illuminate\ValIDation\ValIDatesWhenResolvedTrait:

<?PHPnamespace Illuminate\ValIDation;use Illuminate\Contracts\ValIDation\ValIDationException;use Illuminate\Contracts\ValIDation\UnauthorizedException;/** * ProvIDes default implementation of ValIDatesWhenResolved contract. */trait ValIDatesWhenResolvedTrait{  /**   * ValIDate the class instance.   *   * @return voID   */  public function valIDate() // 这里实现了`valIDate`方法  {    $instance = $this->getValIDatorInstance(); // 这里获取了`ValIDator`实例    if (! $this->passesAuthorization()) {      $this->FailedAuthorization(); // 这是调用了访问授权的失败处理    } elseif (! $instance->passes()) {      $this->FailedValIDation($instance); // 这里调用了验证失败的处理,我们主要看这里    }  }  // ...

在valIDate里,如果验证失败了就会调用$this->FailedValIDation(),继续:

Illuminate\Foundation\http\FormRequest:

<?PHP// ...  /**   * Handle a Failed valIDation attempt.   *   * @param \Illuminate\Contracts\ValIDation\ValIDator $valIDator   * @return mixed   */  protected function FailedValIDation(ValIDator $valIDator)  {    throw new httpResponseException($this->response( // 这里抛出了传说中的异常      $this->formatErrors($valIDator)    ));  }

终于看到异常了!可是这个异常在另一个地方被处理了:

Illuminate\Routing\Route:

<?PHP  // ...  /**   * Run the route action and return the response.   *   * @param \Illuminate\http\Request $request   * @return mixed   */  public function run(Request $request)  {    $this->container = $this->container ?: new Container;    try {      if (! is_string($this->action['uses'])) {        return $this->runcallable($request);      }      if ($this->customdispatcherIsBound()) {        return $this->runWithCustomdispatcher($request);      }      return $this->runcontroller($request);    } catch (httpResponseException $e) { // 就是这里      return $e->getResponse(); // 这里直接返回了Response给客户端    }  }  // ...

至此,整个思路已然清晰,不过我们还是看看这里生成的httpResponseException异常中的Response是怎么生成的:

Illuminate\Foundation\http\FormRequest:

<?PHP// ...  // 132行:  if ($this->AJAX() || $this->wantsJson()) { // 对AJAX请求的处理    return new JsonResponse($errors,422);  }  return $this->redirector->to($this->getRedirectUrl()) // 对普通表单提交的处理                  ->withinput($this->except($this->dontFlash))                  ->withErrors($errors,$this->errorBag);// ...

相信你都看明白了.

如何实现自定义错误处理,这里提供两个思路,都需要重写app\http\Requests\Request的FailedValIDation:

抛出一个新异常,继承httpResponseException异常,重新实现getResponse方法,这个异常类我们可以放到app/Exceptions/下便于管理,错误返回依然交给Laravel;

抛出一个我们自定义的异常,在app\Exceptions\handler中处理.

具体实现这里就不写啦(参阅Laravel文档中关于错误处理部分,中文文档传送门),如果你有别的方法或者想法可以在评论中和我交流.

补充

如果你的Controller使用Illuminate\Foundation\ValIDation\ValIDatesRequests这个Trait的valIDate方法进行验证,同样的,这里验证失败也会抛出Illuminate\http\Exception\httpResponseException异常,可以参考上面的解决方案进行处理.

总结

以上是内存溢出为你收集整理的Laravel中使用FormRequest进行表单验证方法及问题汇总全部内容,希望文章能够帮你解决Laravel中使用FormRequest进行表单验证方法及问题汇总所遇到的程序开发问题。

如果觉得内存溢出网站内容还不错,欢迎将内存溢出网站推荐给程序员好友。

欢迎分享,转载请注明来源:内存溢出

原文地址:https://54852.com/langs/1266665.html

(0)
打赏 微信扫一扫微信扫一扫 支付宝扫一扫支付宝扫一扫
上一篇 2022-06-08
下一篇2022-06-08

发表评论

登录后才能评论

评论列表(0条)

    保存