laravel中Dingo api如何Custom ExceptionHandler

背景在近期使用Dingo api处理接口时,发现laravel本身appExceptionsHandler中无法捕获异常。后来查阅资料发现,Dingo api接管了api请求的异常处理。导致无法自定义错误返回,很是头疼。最后在dingo的issues找到了处理方法。方法创建一个自定义异常处理 继承自Dingo\Api\Exception\Handler,重写handle方法 app/Exceptions/ApiHandler.php<?phpnamespace App\Exceptions;use Exception;use Dingo\Api\Exception\Handler as DingoHandler;class ApiHandler extends DingoHandler{ public function handle(Exception $exception) { if ($exception instanceof \Illuminate\Auth\AuthenticationException) { return response()->json([‘message’ => ‘Unauthorized’, ‘status_code’ => 401], 401); } return parent::handle($exception); }}创建一个服务容器 app/Providers/DingoServiceProvider.php<?phpnamespace App\Providers;use Dingo\Api\Provider\DingoServiceProvider as DingoServiceProviders;use App\Exceptions\ApiHandler as ExceptionHandler;class DingoServiceProvider extends DingoServiceProviders{ protected function registerExceptionHandler() { $this->app->singleton(‘api.exception’, function ($app) { return new ExceptionHandler($app[‘Illuminate\Contracts\Debug\ExceptionHandler’], $this->config(’errorFormat’), $this->config(‘debug’)); }); }}将服务容器添加到config/app.php中…‘providers’ => [… App\Providers\DingoServiceProvider::class,…];结语参考issues链接:https://github.com/dingo/api/… @shanginn 提供的方法会存在接口返回500,且没有任何数据返回。

March 4, 2019 · 1 min · jiezi

Laravel+Dingo/Api 自定义响应

在最近的开发开发项目中,我使用了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”: []}

February 16, 2019 · 1 min · jiezi

laravel5.5+dingo+JWT开发后台API

dingo api 中文文档: https://www.bookstack.cn/read...Laravel中使用JWT:https://laravel-china.org/art…辅助文章: https://www.jianshu.com/p/62b…参考https://www.jianshu.com/p/62b… 这篇文章基本就能搭建出环境,我使用的版本跟他一样 “dingo/api”: “2.0.0-alpha1”,“tymon/jwt-auth”: “^1.0.0-rc.1”,不知道别的版本有啥大的区别,但是网上找的其他一些文章使用的是旧的版本,jwt封装的东西路径可能不一样,可能会保错,有些文档还说要手动添加TymonJWTAuthProvidersLaravelServiceProvider::class和DingoApiProviderLaravelServiceProvider::class,其实新版本不需要。1. composer.json引入包,执行composer update: “require”: { …… “dingo/api”: “2.0.0-alpha1”, “tymon/jwt-auth”: “^1.0.0-rc.1” },2. 执行下面两个语句自动生成dingo和jwt的配置文件:php artisan vendor:publish –provider=“Dingo\Api\Provider\LaravelServiceProvider”//config文件夹中生成dingo配置文件—> api.phpphp artisan vendor:publish –provider=“Tymon\JWTAuth\Providers\LaravelServiceProvider”//config文件夹中生成dingo配置文件—> jwt.php3. 配置 .env具体配置可参考 文档https://www.bookstack.cn/read… ,我的配置是API_STANDARDS_TREE=vndAPI_PREFIX=apiAPI_VERSION=v1API_DEBUG=trueAPI_SUBTYPE=myapp 还需在命令行执行 php artisan jwt:secret,会在.env自动添加JWT_SECRET,其他若需要,可以到各种的配置文件中看,在.env添加即可4. 关键处理’defaults’ => [ ‘guard’ => ‘web’, ‘passwords’ => ‘users’, ], ‘guards’ => [ ‘web’ => [ ‘driver’ => ‘session’, ‘provider’ => ‘users’, ], ‘api’ => [ ‘driver’ => ‘jwt’, ‘provider’ => ‘users’, ], ],这里需要把api原本的driver => session 改为使用jwt机制,provider对应你要用的用户认证表,一般就是登录注册那张表<?phpnamespace App\Models;use Tymon\JWTAuth\Contracts\JWTSubject;use Illuminate\Notifications\Notifiable;use Illuminate\Foundation\Auth\User as Authenticatable;class User extends Authenticatable implements JWTSubject { use Notifiable; /** * The attributes that are mass assignable. * * @var array / protected $fillable = [ ’name’, ’email’, ‘password’, ‘unionid’ ]; /* * The attributes that should be hidden for arrays. * * @var array / protected $hidden = [ ‘password’, ‘remember_token’, ]; // Rest omitted for brevity /* * Get the identifier that will be stored in the subject claim of the JWT. * * @return mixed / public function getJWTIdentifier() { return $this->getKey(); } /* * Return a key value array, containing any custom claims to be added to the JWT. * * @return array / public function getJWTCustomClaims() { return []; }}5. 设置控制器考虑到可能后面需要开发不同版本api,所以在app/Http/Controller下建立了V1,V2目录,根据你自己的需求来,只要写好命名空间就ok <?php/* * Date: 17/10/12 * Time: 01:07 /namespace App\Http\Controllers\V1;use App\Http\Controllers\Controller;use Illuminate\Http\Request;use Illuminate\Support\Facades\Auth;use Validator;use App\User;class AuthController extends Controller{ protected $guard = ‘api’;//设置使用guard为api选项验证,请查看config/auth.php的guards设置项,重要! /* * Create a new AuthController instance. * * @return void / public function __construct() { $this->middleware(‘refresh’, [’except’ => [’login’,‘register’]]); } public function test(){ echo “test!!”; } public function register(Request $request) { $rules = [ ’name’ => [‘required’], ’email’ => [‘required’], ‘password’ => [‘required’, ‘min:6’, ‘max:16’], ]; $payload = $request->only(’name’, ’email’, ‘password’); $validator = Validator::make($payload, $rules); // 验证格式 if ($validator->fails()) { return $this->response->array([’error’ => $validator->errors()]); } // 创建用户 $result = User::create([ ’name’ => $payload[’name’], ’email’ => $payload[’email’], ‘password’ => bcrypt($payload[‘password’]), ]); if ($result) { return $this->response->array([‘success’ => ‘创建用户成功’]); } else { return $this->response->array([’error’ => ‘创建用户失败’]); } } /* * Get a JWT token via given credentials. * * @param \Illuminate\Http\Request $request * * @return \Illuminate\Http\JsonResponse / public function login(Request $request) { $credentials = $request->only(’email’, ‘password’); if ($token = $this->guard()->attempt($credentials)) { return $this->respondWithToken($token); } return $this->response->errorUnauthorized(‘登录失败’); } /* * Get the authenticated User * * @return \Illuminate\Http\JsonResponse / public function me() { //return response()->json($this->guard()->user()); return $this->response->array($this->guard()->user()); } /* * Log the user out (Invalidate the token) * * @return \Illuminate\Http\JsonResponse / public function logout() { $this->guard()->logout(); //return response()->json([‘message’ => ‘Successfully logged out’]); return $this->response->array([‘message’ => ‘退出成功’]); } /* * Refresh a token. * * @return \Illuminate\Http\JsonResponse / public function refresh() { return $this->respondWithToken($this->guard()->refresh()); } /* * Get the token array structure. * * @param string $token * * @return \Illuminate\Http\JsonResponse / protected function respondWithToken($token) { return response()->json([ ‘access_token’ => $token, ’token_type’ => ‘bearer’, ’expires_in’ => $this->guard()->factory()->getTTL() * 60 ]); } /* * Get the guard to be used during authentication. * * @return \Illuminate\Contracts\Auth\Guard / public function guard() { return Auth::guard($this->guard); }}控制器中命名空间namespace需要设置好,路由的时候需要用到, $this->middleware(‘refresh’, [’except’ => [’login’,‘register’]]);这里的中间件使用的是网上找的,用于无痛刷新jwt的token,具体可以参考这篇文章:https://www.jianshu.com/p/9e9…6. refresh中间件<?phpnamespace App\Http\Middleware;use Closure;use Tymon\JWTAuth\Exceptions\JWTException;use Tymon\JWTAuth\Http\Middleware\BaseMiddleware;use Tymon\JWTAuth\Exceptions\TokenExpiredException;use Symfony\Component\HttpKernel\Exception\UnauthorizedHttpException;class RefreshToken extends BaseMiddleware{ /* * @author: zhaogx * @param $request * @param Closure $next * @return \Illuminate\Http\JsonResponse|\Illuminate\Http\Response|mixed * @throws JWTException */ public function handle($request, Closure $next) { // 检查此次请求中是否带有 token,如果没有则抛出异常。 $this->checkForToken($request); // 使用 try 包裹,以捕捉 token 过期所抛出的 TokenExpiredException 异常 try { // 检测用户的登录状态,如果正常则通过 if ($this->auth->parseToken()->authenticate()) { return $next($request); } throw new UnauthorizedHttpException(‘jwt-auth’, ‘未登录’); } catch (TokenExpiredException $exception) { // 此处捕获到了 token 过期所抛出的 TokenExpiredException 异常,我们在这里需要做的是刷新该用户的 token 并将它添加到响应头中 try { // 刷新用户的 token $token = $this->auth->refresh(); // 使用一次性登录以保证此次请求的成功 \Auth::guard(‘api’)->onceUsingId($this->auth->manager()->getPayloadFactory()->buildClaimsCollection()->toPlainArray()[‘sub’]); } catch (JWTException $exception) { // 如果捕获到此异常,即代表 refresh 也过期了,用户无法刷新令牌,需要重新登录。 throw new UnauthorizedHttpException(‘jwt-auth’, $exception->getMessage()); } } return $next($request)->withHeaders([ ‘Authorization’=> ‘Bearer ‘.$token, ]); }}写好中间件后需要在app/Http/Kernel.php中注入 protected $routeMiddleware = [ …… ‘refresh’ => RefreshToken::class, ];7. routes/api.php 设置路由$api = app(‘Dingo\Api\Routing\Router’);$api->version(‘v1’, [’namespace’ => ‘App\Http\Controllers\V1’], function ($api) { $api->post(‘register’, ‘AuthController@register’); $api->post(’login’, ‘AuthController@login’); $api->post(’logout’, ‘AuthController@logout’); $api->post(‘refresh’, ‘AuthController@refresh’); $api->post(‘me’, ‘AuthController@me’); $api->get(’test’, ‘AuthController@test’);});这里有个坑,不要这样写$api->post(‘me’,[‘middleware’ =>‘refresh’], ‘AuthController@me’);这样虽然能执行这个中间件但执行到$next($request)这里会出错,貌似是一个回调报错 Function name must be a string ,不太清楚具体原因,可以这样写$api->post(‘me’,, ‘AuthController@me’)->middleware(‘refresh’);根据以上几个步骤就可以建立起简单的api后台基础,获取api路由列表可以使用命令行: php artisan api:routesroutes:list貌似无法显示以上api路由,需要在api.php那里再写一遍原始的laravel路由定义才可以显示:比如这样Route::post(‘api/test’, ‘AuthController@test’);后续会用另一篇幅来记录postman和小程序相关知识,可以关注我的博客:https://zgxxx.github.io ...

November 8, 2018 · 3 min · jiezi