共计 1030 个字符,预计需要花费 3 分钟才能阅读完成。
在最近的开发开发项目中,我使用了 Dingo/Api 这个第三方 Api 库。Dingo 是个很强大的 Api 库,但在开发的过程中,需要自定义响应字段。
刚开始使用 Ding/Api 时,返回如下:
{
“message”: “422 Unprocessable Entity”,
“errors”: {
“mobile”: [
“ 手机号格式不正确 ”
]
},
“status_code”: 422
}
这是输入字段验证错误时,Dingo 返回的结果。
这样看上去没什么问题。因为这边 status_code 是比较规范的。对于 PHP 来说,直接 json_decode 之后,并没有什么难办的地方。但是对面安卓和 IOS 则是使用的强类型语言。尤其是 Java,需要对每一个 Json 对象进行新建,然后序列化。所以,这种格式不统一的返回结果,是无法接受的
解决方法:我们需要将所有的异常信息归总到一个地方,在 AppServiceProvider 的 boot() 方法中添加
// 将所有的 Exception 全部交给 App\Exceptions\Handler 来处理
app(‘api.exception’)->register(function (Exception $exception) {
$request = Illuminate\Http\Request::capture();
return app(‘App\Exceptions\Handler’)->render($request, $exception);
});
然后在 App\Exceptions\Handler.php 中的 render() 方法中:
$class = get_class($exception);
switch ($class) {
case ‘Dingo\Api\Exception\ValidationHttpException’:
if ($request->expectsJson())
return $this->errorRespond($exception->getErrors()->first(), $exception->getStatusCode());
break;
default:
if ($request->expectsJson())
return $this->errorRespond(‘ 系统休息了 ’, 500000);
break;
}
再次访问接口:
{
“response_status_code”: 422,
“response_message”: “ 请填写手机号 ”,
“data”: []
}