Laravel 中JWT做用户认证的使用

﹏ヽ暗。殇╰゛Y 2022-12-04 09:18 213阅读 0赞

### 文章目录 ###

*  JWT
 *  用户认证的使用
 *   *   *   *   *  1.jwt安装
                 *  2.生成配置文件
                 *  3.生成秘钥
                 *  4.修改auth配置（config/auth.php）
                 *  5.User模型修改（app/User.php）
                 *  6.生成Auth控制器
                 *  7.路由编写（routes/api.php）
 *  测试
 *   *   *   *   *  1.token的获取
                 *  2.使用token获取用户信息

# JWT #

> JWT 全称叫 JSON Web Token, 是一个非常轻巧的规范。这个规范允许我们使用 JWT 在用户和服务器之间传递安全可靠的信息。

前段时间，一个群里有人私聊问这个问题，我说随后写个基础的用户认证教程。下面也不多说废话，直接上例子，相关知识去以下链接查看。  
该篇文章是在Laravel最新的LTS6.X版本中实验。

*  [Laravel官方JWT安装使用文档][Laravel_JWT]
 *  [JWT文档][JWT]
 *  [GitHub-wiki][]

# 用户认证的使用 #

##### 1.jwt安装 #####

composer require tymon/jwt-auth:dev-develop --prefer-source

##### 2.生成配置文件 #####

php artisan vendor:publish --provider="Tymon\JWTAuth\Providers\LaravelSer viceProvider"

##### 3.生成秘钥 #####

php artisan jwt:secret

##### 4.修改auth配置（config/auth.php） #####

'guards' => [
        'web' => [
            'driver' => 'session',
            'provider' => 'users',
        ],
    
        'api' => [
            'driver' => 'jwt',        // 原来是 token 改成jwt
            'provider' => 'users',
        ],
    ],

##### 5.User模型修改（app/User.php） #####

我在这里直接使用的框架默认的User表和模型来生成token

<?php
    
    namespace App;
    
    use Illuminate\Contracts\Auth\MustVerifyEmail;
    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',
        ];
    
        /** * The attributes that should be cast to native types. * * @var array */
        protected $casts = [
            'email_verified_at' => 'datetime',
        ];
    
    	/** * 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 [];
    	}
    }

##### 6.生成Auth控制器 #####

php artisan make:controller AuthController

修改Auth控制器

<?php
    
    namespace App\Http\Controllers;
    
    use Illuminate\Support\Facades\Auth;
    use App\Http\Controllers\Controller;
    
    class AuthController extends Controller
    { 
    	/** * AuthController constructor. */
    	public function __construct()
    	{ 
    		$this->middleware('jwt.auth', ['except' => ['login']]);
    	}
    
    	/** * Get a JWT via given credentials. * * @return \Illuminate\Http\JsonResponse */
    	public function login()
    	{ 
    		$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']);
    	}
    
    	/** * @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
    		]);
    	}
    
    }

##### 7.路由编写（routes/api.php） #####

Route::group(['prefix' => 'auth'], function () { 
    	Route::post('login', 'AuthController@login');
    	Route::post('logout', 'AuthController@logout');
    	Route::post('refresh', 'AuthController@refresh');
    	Route::post('me', 'AuthController@me');
    });

# 测试 #

##### 1.token的获取 #####

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2d1X3dlbl9qaWU_size_16_color_FFFFFF_t_70_pic_center]

##### 2.使用token获取用户信息 #####

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2d1X3dlbl9qaWU_size_16_color_FFFFFF_t_70_pic_center 1]  
`JWT`的相关用途和只是还是很多的，这里只是做了一个简单的单表用户认证功能。  
比如：有效期内`token`的刷新、多用户认证等等，如果你有需要可以自行看下文档或者google，百度一下。

[Laravel_JWT]: https://jwt-auth.readthedocs.io/en/docs/laravel-installation/
[JWT]: https://jwt.io/introduction/
[GitHub-wiki]: https://github.com/tymondesigns/jwt-auth/wiki/Installation
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2d1X3dlbl9qaWU_size_16_color_FFFFFF_t_70_pic_center]: /images/20221123/265858eeab214fe999395f025e1ac7ff.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2d1X3dlbl9qaWU_size_16_color_FFFFFF_t_70_pic_center 1]: /images/20221123/ed9994bd367b4dcebfc0dd6097692c7f.png