Laravel如何实现适合Api的异常处理响应格式

前言

laravel全局捕获异常后，会把异常转为相应的数据格式返回给用户。如果想要规定的数据格式相应，那我们只需重写异常捕获后的处理方法即可。

异常处理流程

illuminate\foundation\exception\handler 中的 render 方法用来将异常转化为响应。

public function render($request, exception $e)
{
 if (method_exists($e, 'render') && $response = $e->render($request)) {
 return router::toresponse($request, $response);
 } elseif ($e instanceof responsable) {
 return $e->toresponse($request);
 }

 $e = $this->prepareexception($e);

 if ($e instanceof httpresponseexception) {
 return $e->getresponse();
 } elseif ($e instanceof authenticationexception) {
 return $this->unauthenticated($request, $e);
 } elseif ($e instanceof validationexception) {
 return $this->convertvalidationexceptiontoresponse($e, $request);
 }

 return $request->expectsjson()
   ? $this->preparejsonresponse($request, $e)
   : $this->prepareresponse($request, $e);
}

render() 中又调用了 prepareexception() 对部分异常进行预处理，但并未执行转化为响应的操作。

modelnotfoundexception 一般在模型查找不到抛出，prepareexception() 中它被转为 symfony 包中notfoundhttpexception，默认状态码404；

authorizationexception 在 policy 权限未通过时抛出，prepareexception() 中它被转为 symfony 包中 accessdeniedhttpexception，默认状态码403；

tokenmismatchexception 在 csrf 验证未通过时抛出，prepareexception() 中它被转为 symfony 包中 httpexception，给定状态码419；

其他异常直接返回。

protected function prepareexception(exception $e)
{
 if ($e instanceof modelnotfoundexception) {
 $e = new notfoundhttpexception($e->getmessage(), $e);
 } elseif ($e instanceof authorizationexception) {
 $e = new accessdeniedhttpexception($e->getmessage(), $e);
 } elseif ($e instanceof tokenmismatchexception) {
 $e = new httpexception(419, $e->getmessage(), $e);
 }

 return $e;
}

在回到 render() ，预处理异常之后，又分别对 httpresponseexception、authenticationexception 和 validationexception 单独处理，并转为响应返回。

除此以外的异常，都在 preparejsonresponse() 或 prepareresponse() 处理，expectsjson() 用来判断返回 json 响应还是普通响应。

修改异常响应格式

了解了异常处理流程，接下来就处理异常响应格式。

修改登录认证异常格式

由上文可知，authenticationexception 被捕获后，调用 unauthenticated() 来处理。

protected function unauthenticated($request, authenticationexception $exception)
{
 return $request->expectsjson()
    ? response()->json(['message' => $exception->getmessage()], 401)
    : redirect()->guest($exception->redirectto() ?? route('login'));
}

在 appexceptionshandler.php 中重写 unauthenticated() 使其返回我们想要的数据格式。

protected function unauthenticated($request, authenticationexception $exception)
{
 return $request->expectsjson()
  ? response()->json([
   'code' => 0,
   'data' => $exception->getmessage(),
  ], 401)
  : redirect()->guest($exception->redirectto() ?? route('login'));
}

修改验证异常格式

同样由上文可知，validationexception 被捕获后交由 convertvalidationexceptiontoresponse() 处理，进入此方法后我们需要继续追踪，若是需要 json 响应，最终交由 invalidjson() 处理。

protected function convertvalidationexceptiontoresponse(validationexception $e, $request)
{
 if ($e->response) {
  return $e->response;
 }

 return $request->expectsjson()
    ? $this->invalidjson($request, $e)
    : $this->invalid($request, $e);
}

protected function invalidjson($request, validationexception $exception)
{
 return response()->json([
  'message' => $exception->getmessage(),
  'errors' => $exception->errors(),
 ], $exception->status);
}

我们继续在 appexceptionshandler.php 重写 invalidjson() 即可自定义返回格式。

protected function invalidjson($request, validationexception $exception)
{
 return response()->json([
  'code' => 0,
  'data' => $exception->errors(),
 ], $exception->status);
}

修改其他异常格式

其他异常是调用 preparejsonresponse() 来处理，此方法又调用 convertexceptiontoarray() 来处理响应格式。

protected function preparejsonresponse($request, exception $e)
{
 return new jsonresponse(
  $this->convertexceptiontoarray($e),
  $this->ishttpexception($e) ? $e->getstatuscode() : 500,
  $this->ishttpexception($e) ? $e->getheaders() : [],
  json_pretty_print | json_unescaped_slashes
 );
}

protected function convertexceptiontoarray(exception $e)
{
 return config('app.debug') ? [
  'message' => $e->getmessage(),
  'exception' => get_class($e),
  'file' => $e->getfile(),
  'line' => $e->getline(),
  'trace' => collect($e->gettrace())->map(function ($trace) {
   return arr::except($trace, ['args']);
  })->all(),
 ] : [
  'message' => $this->ishttpexception($e) ? $e->getmessage() : 'server error',
 ];
}

在 appexceptionshandler.php 中重写 convertexceptiontoarray() 来自定义其他异常响应格式。

protected function convertexceptiontoarray(exception $e)
{
 return config('app.debug') ? [
  'code' => 0,
  'data' => $e->getmessage(),
  'exception' => get_class($e),
  'file' => $e->getfile(),
  'line' => $e->getline(),
  'trace' => collect($e->gettrace())->map(function ($trace) {
   return arr::except($trace, ['args']);
  })->all(),
 ] : [
  'code' => 0,
  'data' => $this->ishttpexception($e) ? $e->getmessage() : 'server error',
 ];
}

强制 json 响应

代码中多次出现了 expectsjson() ，此方法是用来判断返回 json 响应还是普通响应。

public function expectsjson()
{
 return ($this->ajax() && ! $this->pjax() && $this->acceptsanycontenttype()) || $this->wantsjson();
}

以下两种条件下，会返回json响应。

非xml请求、非pjax并且 headers 中 accept 设置为接收所有格式响应；

headers accept 设置为 /json、+json。如：accept:application/json。

除此之外的情况，将不会响应json。我们可以利用中间件强制追加 accept:application/json，使异常响应时都返回json。（参考教程 l03 6.0 中提到的方法）

创建中间件 acceptheader

<?php

namespace app\http\middleware;

use closure;

class acceptheader
{
 public function handle($request, closure $next)
 {
  $request->headers->set('accept', 'application/json');

  return $next($request);
 }
}

在 app/http/kernel.php 中，将中间件加入路由组即可。

protected $middlewaregroups = [
 'web' => [
  .
  .
  .
 'api' => [
  \app\http\middleware\acceptheader::class,
  'throttle:60,1',
  'bindings',
 ],
];

大功告成。

总结

到此这篇关于laravel如何实现适合api的异常处理响应格式的文章就介绍到这了,更多相关laravel适合api的异常处理响应格式内容请搜索www.887551.com以前的文章或继续浏览下面的相关文章希望大家以后多多支持www.887551.com！

黄山市民网：https://www.huangshanshimin.com/