laravel dingo Api结合jwt 处理token校验
声明：
1.由于时间有限，本文有很多不足之处，望评论下方留言指正！
2.本文中代码仅做参考使用，不做实际项目运用，主要是思路，红色部分的注意项要留意！
3.篇幅较长，注意捡重点看，思路！思路！思路！
开拔~~~~~~
一、环境说明：
采用laravel5.8框架，php版本7.2.1
二、安装
两种方式，依赖包版本可根据自己实际情况进行调整
1.在项目目录下composer.json添加依赖包
#composer.json中
"require": { #…….
"dingo/api": "^2.0",
"tymon/jwt-auth": "~1.0.0-rc.1",
#……
}
2.直接require 依赖包
composer requiredingo/api 2.0 composer require tymon/jwt-auth 1.0.0-rc.1
三、发布配置文件
1.发布dingo配置文件
php artisan vendor:publish --provider="Dingo\Api\Provider\LaravelServiceProvider"
此命令会在 config 目录下生成一个 api.php 配置文件，你可以在此进行自定义配置。
四、配置调整
1.添加配置（config/app.php）
‘providers‘ => [ ……
Dingo\\Api\\Provider\\LaravelServiceProvider::class,Tymon\JWTAuth\Providers\LaravelServiceProvider::class, ],
‘aliases‘ => [
……
‘JWTAuth‘ => Tymon\\JWTAuth\\Facades\\JWTAuth::class,
‘JWTFactory‘ => Tymon\\JWTAuth\\Facades\\JWTFactory::class,]
2.修改auth.php
‘guards‘ => [ ‘web‘ => [ ‘driver‘ => ‘session‘,
‘provider‘ => ‘users‘, ],
‘api‘ => \[ ‘driver‘ => ‘jwt‘,#把此处驱动改为jwt，默认为laravel框架自带的驱动token
‘provider‘ => ‘users‘,//注意此处根据自己的实际情况进行调整 ], ],
‘providers‘ => [
‘users‘ => [
‘driver‘ => ‘eloquent‘,
‘model‘ => App\Models\User::class,//注意此处根据自己的实际情况进行调整
],
// ‘users‘ => \[
// ‘driver‘ => ‘database‘,
// ‘table‘ => ‘users‘,
// \], ],
3 .env文件
#Dingo
# 公开的及商业项目用 vnd
API_STANDARDS_TREE=prs
#项目简称
API_SUBTYPE=dingo-demo
#域名
API_DOMAIN=
# 前缀
API_PREFIX=api
#不提供版本时使用的版本号
API_VERSION=v3
#开启 debug 模式
API_DEBUG=true
API_DEFAULT_FORMAT=json
#Jwt
#jwt秘钥
JWT_SECRET=HSKxIUfwCdJj5ewdbqfQo5im9zj3r5g9
#jwt有效时间，单位：分钟 JWT_TTL=60
五、更新 User 模型
使用默认的 User 表来生成 token
JWT 需要在 User 模型中实现 Tymon\JWTAuth\Contracts\JWTSubject 接口。 此接口需要实现两个方法 getJWTIdentifier 和 getJWTCustomClaims。使用以下内容更新 app/User.php 。
<?php
namespace App; use Illuminate\Foundation\Auth\User as Authenticatable; use Illuminate\Notifications\Notifiable; use Tymon\JWTAuth\Contracts\JWTSubject; class User extends Authenticatable implements JWTSubject
{ use Notifiable; /**
* The attributes that are mass assignable.
*
* @var array */
protected $fillable = [ ‘name‘, ‘email‘, ‘password‘, ]; /**
* The attributes that should be hidden for arrays.
*
* @var array */
protected $hidden = [ ‘password‘, ‘remember_token‘, ]; /**
* 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 [];
}
}
六、JWT 身份验证逻辑
使用 JWT 身份验证在 laravel 中写 Restful API 的逻辑。
用户注册时需要姓名，邮箱和密码。那么，让我们创建一个表单请求来验证数据。通过运行以下命令创建名为AuthorizationRequest的表单请求：
php artisan make:request Api\AuthorizationRequest
它将在 app/Http/Requests/Api 目录下创建 AuthorizationRequest文件。
<?php
namespace App\Http\Requests\Api; class AuthorizationRequest extends Request
{ /**
* 确定是否授权用户发出此请求
*
* @return bool */
public function authorize()
{ return true;
} /**
\* 获取应用于请求的验证规则
\* Get the validation rules that apply to the request.
\*
\* @return array \*/
public function rules()
{ return \[ ‘username‘ => ‘required|string‘,
‘password‘ => ‘required|string|min:6‘, \];
}}
七、控制器创建
官方案例，稍作了修改: login登录，me获取用户信息，logout退出登录，refresh刷新token，respondWithToken返回token
<?php
namespace App\Http\Controllers;
use use App\Http\Requests\Api\AuthorizationRequest; class AuthController extends Controller
{ /**
* Create a new AuthController instance.
* 要求附带email和password（数据来源users表）
* @return void */
public function __construct()
{ // 这里额外注意了：官方文档样例中只除外了『login』
// 这样的结果是，token 只能在有效期以内进行刷新，过期无法刷新
// 如果把 refresh 也放进去，token 即使过期但仍在刷新期以内也可刷新
// 不过刷新一次作废
$this->middleware(‘auth:api‘, [‘except‘ => [‘login‘]]); // 另外关于上面的中间件，官方文档写的是『auth:api』
// 但是我推荐用 『jwt.auth』，效果是一样的，但是有更加丰富的报错信息返回
} /**
* Get a JWT via given credentials.
* @param AuthorizationRequest $request
* @return \Illuminate\Http\JsonResponse */
public function login(AuthorizationRequest $request)
{ $credentials = request([‘email‘, ‘password‘]); if (! $token = auth(‘api‘)->attempt($credentials)) { return response()->json([‘error‘ => ‘Unauthorized‘], 401);
} return $this->respondWithToken($token);
} /**
* Get the authenticated User.
*
* @return \Illuminate\Http\JsonResponse */
public function me()
{ return response()->json(auth(‘api‘)->user());
} /**
* Log the user out (Invalidate the token).
*
* @return \Illuminate\Http\JsonResponse */
public function logout()
{
auth(‘api‘)->logout(); return response()->json([‘message‘ => ‘Successfully logged out‘]);
} /**
* Refresh a token.
* 刷新token，如果开启黑名单，以前的token便会失效。
* 值得注意的是用上面的getToken再获取一次Token并不算做刷新，两次获得的Token是并行的，即两个都可用。
* @return \Illuminate\Http\JsonResponse */
public function refresh()
{ return $this->respondWithToken(auth(‘api‘)->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‘ => auth(‘api‘)->factory()->getTTL() * 60 ]);
}
}
注意：
jwt使用
jwt koken两种使用方式
1.加到 url 中：?token=你的token
2.加到 header 中，建议用这种，因为在 https 情况下更安全：Authorization:Bearer 你的token
八、自定义Dingo Api 响应格式
1.新建Json.php文件，App\Components\Response\Format\Json.php, 代码示例如下：
主要思路就是继承Dingo\Api\Http\Response\Format\Json类，并进行重写
<?php
namespace App\Components\Response\Format; use App\Components\Results\Code\SuccessCode; use Dingo\Api\Http\Response\Format\Json as DingoJson; class Json extends DingoJson
{ /**
* Encode the content to its JSON representation.
*
* @param mixed $content
*
* @return string */
protected function encode($content)
{ $jsonEncodeOptions = []; // Here is a place, where any available JSON encoding options, that
// deal with users‘ requirements to JSON response formatting and
// structure, can be conveniently applied to tweak the output.
if ($this\->isJsonPrettyPrintEnabled()) { $jsonEncodeOptions\[\] = JSON\_PRETTY\_PRINT; $jsonEncodeOptions\[\] = JSON\_UNESCAPED\_UNICODE;
}
#主要在此处进行调整
$newContent = \[ ‘code‘ => $content\[‘code‘\] ?? SuccessCode::SUCCESS,
‘data‘ => $content\[‘data‘\] ?? \[\],
‘message‘ => $content\[‘message‘\] ?? SuccessCode::SUCCESS\_MSG, \]; $encodedString = $this\->performJsonEncoding($newContent, $jsonEncodeOptions); if ($this\->isCustomIndentStyleRequired()) { $encodedString = $this\->indentPrettyPrintedJson( $encodedString,
$this\->options\[‘indent\_style‘\]
);
} return $encodedString;
}}
注意：由于自定义了响应返回，所以"七、控制器创建"的示例代码中需要调整格式为，需要有data键
/**
* 响应 Token 结构体
*
* @param $token
* @return mixed */
protected function respondWithToken($token)
{ $res = [ ‘data‘ => [ ‘token‘ => $token,
‘token_type‘ => ‘Bearer‘,
‘expires_in‘ => \Auth::guard(‘api‘)->factory()->getTTL()
]
]; return $this->response->array($res);
}
2.在config/api.php文件中，调整json返回类
#config/api.php
‘formats‘ => [ //‘json‘ => Dingo\Api\Http\Response\Format\Json::class,
#json 返回自定义
‘json‘ => App\Components\Response\Format\Json::class, ],
九、自定义Dingo 异常返回
1.新建API异常处理文件App\Exceptions\ApiHandler，具体实现根据自己需要，此处代码仅做参考，注意：文件里面有自定义的code码，另外该文件只是示例，可根据自己需要进行调整
<?php
namespace App\Exceptions; use App\Components\Results\Code\AuthCode; use App\Components\Results\Code\CommonCode; use App\Components\Results\Code\ErrorCode; use Exception; use Illuminate\Foundation\Exceptions\Handler as ExceptionHandler; use Intervention\Image\Exception\NotFoundException; use Symfony\Component\HttpKernel\Exception\UnauthorizedHttpException; use Symfony\Component\HttpKernel\Exception\MethodNotAllowedHttpException; use App\Components\Results\Exception\ServiceErrorException; use App\Components\Results\Exception\ServiceException; use App\Components\Results\Exception\ServiceLogicException; use App\Components\Results\Exception\ServiceValidException; use Tymon\JWTAuth\Exceptions\JWTException; use Tymon\JWTAuth\Exceptions\TokenBlacklistedException;
#该目录下面的几个文件，在下面有示例，可根据情况自行调整 use App\Components\Results\Results; class ApiHandler extends ExceptionHandler
{ /**
* A list of the exception types that are not reported.
*
* @var array */
protected $dontReport = [ //
]; /**
* A list of the inputs that are never flashed for validation exceptions.
*
* @var array */
protected $dontFlash = [ ‘password‘,
‘password_confirmation‘, ]; /**
* Report or log an exception.
*
* @param \Exception $exception
* @return void */
public function report(Exception $exception)
{
parent::report($exception);
} /**
* Render an exception into an HTTP response.
*
* @param \Illuminate\Http\Request $request
* @param \Exception $exception
* @return \App\Components\Results\Result | \Illuminate\Http\Response
* @see https://learnku.com/docs/dingo-api/2.0.0/Errors-And-Error-Responses/1447 */
public function render($request, Exception $exception)
{
if ($request->isJson()) { $class = get_class($exception); switch ($class) { case ‘Dingo\Api\Exception\ValidationHttpException‘:
return Results::failure(AuthCode::MISSING_ACCESS_TOKEN_MSG, AuthCode::MISSING_ACCESS_TOKEN); case ‘Symfony\Component\HttpKernel\Exception\UnauthorizedHttpException‘:
case ‘Tymon\JWTAuth\Exceptions\JWTException‘://Token could not be parsed from the request.
case ‘Tymon\JWTAuth\Exceptions\TokenBlacklistedException‘://The token has been blackliste
return Results::failure(AuthCode::MISSING_ACCESS_TOKEN_MSG, AuthCode::MISSING_ACCESS_TOKEN); case ‘Symfony\Component\HttpKernel\Exception\NotFoundHttpException‘:
return Results::failure(CommonCode::URL_NOT_FOUND_MSG, CommonCode::URL_NOT_FOUND); case ‘App\Components\Results\Exception\ServiceValidException‘:
case ‘App\Components\Results\Exception\ServiceLogicException‘:
case ‘App\Components\Results\Exception\ServiceErrorException‘:
case ‘App\Components\Results\Exception\ServiceException‘:
return Results::failure($exception->getMessage(), $exception->getErrorCode()); case ‘Symfony\Component\HttpKernel\Exception\MethodNotAllowedHttpException‘:
return Results::failure($exception->getMessage(), $exception->getCode()); case ‘Dingo\Api\Exception\RateLimitExceededException‘:
return Results::failure(CommonCode::IRATE_LIMIT_REQUEST_MSG, CommonCode::RATE_LIMIT_REQUEST); default:
return Results::error(ErrorCode::UNKNOWN_ERROR_MSG, ErrorCode::UNKNOWN_ERROR);
}
} if(config(‘app.debug‘)){ return parent::render($request, $exception);
} if (method_exists($exception, ‘getStatusCode‘)) { $statusCode = $exception->getStatusCode(); switch ($statusCode) { case 400:
case 403:
case 405:
return response()->view(‘errors.404‘, [‘message‘=>$exception->getMessage()], $exception->getStatusCode()); break; case 500:
case 501:
case 502:
return response()->view(‘errors.500‘, [‘message‘=>$exception->getMessage()], $exception->getStatusCode()); break; default:
return response()->view(‘errors.404‘, [‘message‘=>$exception->getMessage()], $exception->getStatusCode()); break;
}
} return parent::render($request, $exception);
}
}
CommonCode.php代码示例：
<?php
namespace App\Components\Results\Code; /**
* 公共的业务异常错误码
* Class CommonCode
* @package App\Components\Results\Code */
class CommonCode
{ const INVALID_ARGS = "C_1"; const INVALID_ARGS_MSG = "参数无效"; const DATA_NOT_FOUND = "C_2"; const DATA_NOT_FOUND_MSG = "无数据"; //……
}
Results.php文件示例：
<?php
namespace App\Components\Results; use App\Components\Results\Code\CommonCode; use App\Components\Results\Code\ErrorCode; use App\Components\Results\Code\SuccessCode; final class Results
{ /**
* 成功
* @param mixed data 并设置data参数
* @param string $code 错误码
* @return Result */
public static function success($data = null,$code=SuccessCode::SUCCESS)
{ return new Result(SuccessCode::SUCCESS_MSG, $code, $data);
}
/**
* 失败
* @param string $message 失败信息
* @param string $code 失败编码
* @return Result 返回对象
*/
public static function failure(string $message, string $code) {
return new Result($message, $code);
}
}
Result.php文件示例
<?php
namespace App\Components\Results; use App\Components\Results\Code\ErrorCode; use App\Components\Results\Code\SuccessCode; use App\Components\Results\Code\ErrorCode; /**
* Class Result */
class Result
{ public $code; public $message; public $data; public function __construct($message, $code, $data = null)
{ $this->message = $message; $this->code = $code; $this->data = $data;
} /**
* 获取错误码
* @return string 错误码 */
function getCode(): string { return $this->code;
} /**
* 获取成功或错误的信息
* @return string 成功或错误的信息 */
function getMessage(): string { return $this->message;
} /**
* 获取数据
* @return object 数据 */
function getData()
{ return $this->data;
} /**
* 设置错误码
* @param string code 错误码
* @return Result Result对象 */
function setCode(string $code): Result
{ $this->code = $code; return $this;
} /**
* 设置成功或错误的信息
* @param string message 成功或错误的信息
* @return Result */
function setMessage(string $message): Result
{ $this->message = $message; return $this;
} /**
* 设置数据
* @param mixed data 数据
* @return Result */
function setData($data): Result
{ $this->data = $data; return $this;
} function __toString()
{ return json_encode($this, Constants::DEFAULT_ENCODING_OPTIONS | JSON_UNESCAPED_UNICODE | JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES);
} function jsonSerialize()
{ return $this;
}
}
2.在 App/Providers/AppServiceProvider中注册新的异常处理
<?php
namespace App\Providers; use Illuminate\Support\ServiceProvider; class AppServiceProvider extends ServiceProvider
{ /**
* Bootstrap any application services.
*
* @return void */
public function boot()
{
app(‘api.exception‘)->register(function (\Exception $exception) { $request = \Illuminate\Http\Request::capture(); return app(‘App\Exceptions\ApiHandler‘)->render($request, $exception);
});
} /**
* Register any application services.
*
* @return void */
public function register()
{ //……
}
}
参考文档：
https://learnku.com/docs/dingo-api/2.0.0/Configuration/1444#6cdca8
https://learnku.com/docs/laravel/5.8/api-authentication/3952
手机扫一扫
移动阅读更方便
你可能感兴趣的文章