分享每一天-laravel5 Api接口 JWT认证使用详解 tymon/jwt-auth

laravel5 Api接口 JWT认证使用详解 tymon/jwt-auth

PHP 2482 0 创建时间：2020-06-09 10:18:23

jwt token "tymon/jwt-auth"

组件包地址：https://packagist.org/packages/tymon/jwt-auth

#### 使用 composer 安装
```php
composer require tymon/jwt-auth:1.0.0
```
#### 添加到provider
添加service provider到config/app.php文件的providers数组中：
```php
'providers' => [
    ...
    Tymon\JWTAuth\Providers\LaravelServiceProvider::class,
]
```
#### 发布配置
```php
php artisan vendor:publish --provider="Tymon\JWTAuth\Providers\LaravelServiceProvider"
```
执行后会在config目录下生成jwt.php文件。

#### 生成密钥
```php
php artisan jwt:secret
```
执行后会在.env文件最后生成JWT_SECRET，
如：JWT_SECRET=158S2Rhux6DLJDwPVZdspU59c7YnIyBJ

#### 开始使用
##### 修改User.php

让User.php实现Tymon\JWTAuth\Contracts\JWTSubject类

实现两个方法：getJWTIdentifier()和getJWTCustomClaims()

修改后的User.php如下：
```php
<?php

namespace App;

use Illuminate\Notifications\Notifiable;
use Illuminate\Foundation\Auth\User as Authenticatable;
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()
    {
        // TODO: Implement getJWTIdentifier() method.
        return $this->getKey();
    }

/**
     * Return a key value array, containing any custom claims to be added to the JWT.
     *
     * @return array
     */
    public function getJWTCustomClaims()
    {
        // TODO: Implement getJWTCustomClaims() method.
        return [];
    }
}
```
##### 配置auth.php
修改config/auth.php文件中default及guards如下：
```php
'defaults' => [
    'guard' => 'api',
    'passwords' => 'users',
],

...

'guards' => [
    'api' => [
        'driver' => 'jwt',
        'provider' => 'users',
    ],
],
```
##### 添加路由
在routes/api.php中添加路由如下：
```php
Route::group([

'middleware' => 'api',
    // 'namespace' => 'App\Http\Controllers',// 这一行不需要加，AuthController中已配置namespace，否则运行时会在App\Http\Controllers\App\Http\Controllers\AuthController 下寻找AuthController，从而报找不到控制器的错
    'prefix' => 'auth'

], function ($router) {

Route::post('login', 'AuthController@login');
    Route::post('logout', 'AuthController@logout');
    Route::post('refresh', 'AuthController@refresh');
    Route::post('me', 'AuthController@me');

});
```
##### 创建控制器AuthController
```php
php artisan make:controller AuthController
```
```php
<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;
use Illuminate\Support\Facades\Auth;
use App\Http\Controllers\Controller;

class AuthController extends Controller
{

/**
     * AuthController constructor.
     */
    public function __construct()
    {
        $this->middleware('auth:api', ['except' => ['login']]);
    }

/**
     * 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');

$token = $this->guard()->attempt($credentials);
        if ($token) {
            return $this->respondWithToken($token);
        }

return response()->json(['error' => 'Unauthorized'], 401);
    }

/**
     * Get the authenticated User
     *
     * @return \Illuminate\Http\JsonResponse
     */
    public function me()
    {
        return response()->json($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']);
    }

/**
     * 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();
    }
}
```
#### 四、附录
##### 1.1 JWTAuth
token 生成#
根据 user 对象生成一个 token。后者是前者别名。
```php
$user = User::find(1);
$token = JWTAuth::fromUser($user);
```
可以自己写登录逻辑，返回token。

#### token 控制

##### refresh

更新 token。
```php
$newToken = JWTAuth::parseToken()->refresh();
```
##### invalidate
让一个 token 无效。
```php
JWTAuth::parseToken()->invalidate();
```
##### check

检验 token 的有效性。
```php
if(JWTAuth::parseToken()->check()) {
    dd("token是有效的");
}
```
##### token 解析

authenticate or toUser or user

这三个效果是一样的，toUser 是 authenticate 的别名，而 user 比前两者少一个 user id 的校验，但并没有什么影响。
```php
$user = JWTAuth::parseToken()->toUser();
```
##### parseToken

从 request 中解析 token 到对象中，以便进行下一步操作。
```php
JWTAuth::parseToken();
```
##### getToken

从 request 中获取 token。
```php
$token = JWTAuth::getToken();  // 这个不用 parseToken ，因为方法内部会自动执行一次
```
就先这么多吧！

laravel5 Api接口 JWT认证使用详解 tymon/jwt-auth

商品推荐

广告推荐

推荐文章