php - 如何在 Laravel 5.1 中强制 FormRequest 返回 json？

Question

我正在使用 FormRequest验证从我的智能手机应用程序的 API 调用中发送的内容。所以，我希望 FormRequest 在验证失败时总是返回 json。

看到下面Laravel框架的源码，FormRequest的默认行为是reqeust是ajax或者wantJson返回json。

//Illuminate\Foundation\Http\FormRequest class
/**
 * Get the proper failed validation response for the request.
 *
 * @param  array  $errors
 * @return \Symfony\Component\HttpFoundation\Response
 */
public function response(array $errors)
{
    if ($this->ajax() || $this->wantsJson()) {
        return new JsonResponse($errors, 422);
    }

    return $this->redirector->to($this->getRedirectUrl())
                                    ->withInput($this->except($this->dontFlash))
                                    ->withErrors($errors, $this->errorBag);
}

我知道我可以在请求 header 中添加 Accept= application/json。 FormRequest 将返回 json。但我想提供一种更简单的方法来通过默认支持 json 来请求我的 API，而无需设置任何 header 。因此，我试图在 Illuminate\Foundation\Http\FormRequest 类中找到一些强制 FormRequest 响应 json 的选项。但我没有找到默认支持的任何选项。

解决方案 1:覆盖请求抽象类

我试图覆盖我的应用程序请求抽象类，如下所示:

<?php

namespace Laravel5Cg\Http\Requests;

use Illuminate\Foundation\Http\FormRequest;
use Illuminate\Http\JsonResponse;

abstract class Request extends FormRequest
{
    /**
     * Force response json type when validation fails
     * @var bool
     */
    protected $forceJsonResponse = false;

    /**
     * Get the proper failed validation response for the request.
     *
     * @param  array  $errors
     * @return \Symfony\Component\HttpFoundation\Response
     */
    public function response(array $errors)
    {
        if ($this->forceJsonResponse || $this->ajax() || $this->wantsJson()) {
            return new JsonResponse($errors, 422);
        }

        return $this->redirector->to($this->getRedirectUrl())
            ->withInput($this->except($this->dontFlash))
            ->withErrors($errors, $this->errorBag);
    }
}

我添加了 protected $forceJsonResponse = false; 来设置是否需要强制响应 json。并且，在每个从 Request 抽象类扩展的 FormRequest 中。我设置了那个选项。

例如:我创建了一个 StoreBlogPostRequest 并为此 FormRequest 设置 $forceJsoResponse=true 并使其响应 json。

<?php

namespace Laravel5Cg\Http\Requests;

use Laravel5Cg\Http\Requests\Request;

class StoreBlogPostRequest extends Request
{

    /**
     * Force response json type when validation fails
     * @var bool
     */

     protected $forceJsonResponse = true;
    /**
     * 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' => 'required|unique:posts|max:255',
            'body' => 'required',
        ];
    }
}

解决方案2:添加中间件并强制更改请求 header

我构建了一个中间件，如下所示:

namespace Laravel5Cg\Http\Middleware;

use Closure;
use Symfony\Component\HttpFoundation\HeaderBag;

class AddJsonAcceptHeader
{
    /**
     * Add Json HTTP_ACCEPT header for an incoming request.
     *
     * @param  \Illuminate\Http\Request  $request
     * @param  \Closure  $next
     * @return mixed
     */
    public function handle($request, Closure $next)
    {
        $request->server->set('HTTP_ACCEPT', 'application/json');
        $request->headers = new HeaderBag($request->server->getHeaders());
        return $next($request);
    }
}

这是工作。但我想知道这个解决方案好吗？在这种情况下有什么 Laravel 方法可以帮助我吗？

Answer 1

令我感到困惑的是，为什么这在 Laravel 中如此难以做到。最后，根据您重写 Request 类的想法，我想到了这个。

app/Http/Requests/ApiRequest.php

<?php

namespace App\Http\Requests;


class ApiRequest extends Request
{
    public function wantsJson()
    {
        return true;
    }
}

然后，在每个 Controller 中只需传递 \App\Http\Requests\ApiRequest

公共(public)函数索引(ApiRequest $request)