这篇文章主要给大家介绍了关于Laravel如何实现适合Api的异常处理响应格式的相关资料，文中通过示例代码介绍的非常详细，对大家学习或者使用Laravel具有一定的参考学习价值，需要的朋友们下面来一起学习学习吧

前言

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

异常处理流程

Illuminate\Foundation\Exception\Handler 中的 render 方法用来将异常转化为响应。

1. public function render($request, Exception $e) 
2. { 
3.  if (method_exists($e, 'render') && $response = $e->render($request)) { 
4.  return Router::toResponse($request, $response); 
5.  } elseif ($e instanceof Responsable) { 
6.  return $e->toResponse($request); 
7.  } 
8.  
9.  $e = $this->prepareException($e); 
10.  
11.  if ($e instanceof HttpResponseException) { 
12.  return $e->getResponse(); 
13.  } elseif ($e instanceof AuthenticationException) { 
14.  return $this->unauthenticated($request, $e); 
15.  } elseif ($e instanceof ValidationException) { 
16.  return $this->convertValidationExceptionToResponse($e, $request); 
17.  } 
18.  
19.  return $request->expectsJson() 
20.    ? $this->prepareJsonResponse($request, $e) 
21.    : $this->prepareResponse($request, $e); 
22. } 

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

ModelNotFoundException 一般在模型查找不到抛出，prepareException() 中它被转为 Symfony 包中NotFoundHttpException，默认状态码404；

AuthorizationException 在 Policy 权限未通过时抛出，prepareException() 中它被转为 Symfony 包中 AccessDeniedHttpException，默认状态码403；

TokenMismatchException 在 CSRF 验证未通过时抛出，prepareException() 中它被转为 Symfony 包中 HttpException，给定状态码419；

其他异常直接返回。

1. protected function prepareException(Exception $e) 
2. { 
3.  if ($e instanceof ModelNotFoundException) { 
4.  $e = new NotFoundHttpException($e->getMessage(), $e); 
5.  } elseif ($e instanceof AuthorizationException) { 
6.  $e = new AccessDeniedHttpException($e->getMessage(), $e); 
7.  } elseif ($e instanceof TokenMismatchException) { 
8.  $e = new HttpException(419, $e->getMessage(), $e); 
9.  } 
10.  
11.  return $e; 
12. } 

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

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

修改异常响应格式

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

修改登录认证异常格式

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

1. protected function unauthenticated($request, AuthenticationException $exception) 
2. { 
3.  return $request->expectsJson() 
4.     ? response()->json(['message' => $exception->getMessage()], 401) 
5.     : redirect()->guest($exception->redirectTo() ?? route('login')); 
6. } 

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

1. protected function unauthenticated($request, AuthenticationException $exception) 
2. { 
3.  return $request->expectsJson() 
4.   ? response()->json([ 
5.    'code' => 0, 
6.    'data' => $exception->getMessage(), 
7.   ], 401) 
8.   : redirect()->guest($exception->redirectTo() ?? route('login')); 
9. } 

修改验证异常格式

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

1. protected function convertValidationExceptionToResponse(ValidationException $e, $request) 
2. { 
3.  if ($e->response) { 
4.   return $e->response; 
5.  } 
6.  
7.  return $request->expectsJson() 
8.     ? $this->invalidJson($request, $e) 
9.     : $this->invalid($request, $e); 
10. } 
11.  
12. protected function invalidJson($request, ValidationException $exception) 
13. { 
14.  return response()->json([ 
15.   'message' => $exception->getMessage(), 
16.   'errors' => $exception->errors(), 
17.  ], $exception->status); 
18. } 

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

1. protected function invalidJson($request, ValidationException $exception) 
2. { 
3.  return response()->json([ 
4.   'code' => 0, 
5.   'data' => $exception->errors(), 
6.  ], $exception->status); 
7. } 

修改其他异常格式

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

1. protected function prepareJsonResponse($request, Exception $e) 
2. { 
3.  return new JsonResponse( 
4.   $this->convertExceptionToArray($e), 
5.   $this->isHttpException($e) ? $e->getStatusCode() : 500, 
6.   $this->isHttpException($e) ? $e->getHeaders() : [], 
7.   JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES 
8.  ); 
9. } 
10.  
11. protected function convertExceptionToArray(Exception $e) 
12. { 
13.  return config('app.debug') ? [ 
14.   'message' => $e->getMessage(), 
15.   'exception' => get_class($e), 
16.   'file' => $e->getFile(), 
17.   'line' => $e->getLine(), 
18.   'trace' => collect($e->getTrace())->map(function ($trace) { 
19.    return Arr::except($trace, ['args']); 
20.   })->all(), 
21.  ] : [ 
22.   'message' => $this->isHttpException($e) ? $e->getMessage() : 'Server Error', 
23.  ]; 
24. } 

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

1. protected function convertExceptionToArray(Exception $e) 
2. { 
3.  return config('app.debug') ? [ 
4.   'code' => 0, 
5.   'data' => $e->getMessage(), 
6.   'exception' => get_class($e), 
7.   'file' => $e->getFile(), 
8.   'line' => $e->getLine(), 
9.   'trace' => collect($e->getTrace())->map(function ($trace) { 
10.    return Arr::except($trace, ['args']); 
11.   })->all(), 
12.  ] : [ 
13.   'code' => 0, 
14.   'data' => $this->isHttpException($e) ? $e->getMessage() : 'Server Error', 
15.  ]; 
16. } 

强制 json 响应

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

1. public function expectsJson() 
2. { 
3.  return ($this->ajax() && ! $this->pjax() && $this->acceptsAnyContentType()) || $this->wantsJson(); 
4. } 

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

非XML请求、非pjax并且 Headers 中 Accept 设置为接收所有格式响应；

Headers Accept 设置为 /json、+json。如：Accept:application/json。

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

创建中间件 AcceptHeader

1. <?php 
2.  
3. namespace App\Http\Middleware; 
4.  
5. use Closure; 
6.  
7. class AcceptHeader 
8. { 
9.  public function handle($request, Closure $next) 
10.  { 
11.   $request->headers->set('Accept', 'application/json'); 
12.  
13.   return $next($request); 
14.  } 
15. } 

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

1. protected $middlewareGroups = [ 
2.  'web' => [ 
3.   . 
4.   . 
5.   . 
6.  'api' => [ 
7.   \App\Http\Middleware\AcceptHeader::class, 
8.   'throttle:60,1', 
9.   'bindings', 
10.  ], 
11. ]; 

大功告成。

Tags: Laravel异常处理响应 Api

分享到：