Laravel使用JWT并指定用户表和字段

作者:陈进坚
CSDN:https://blog.csdn.net/c_jian
简书:https://www.jianshu.com/u/8ba9ac5706b6
声明:有错欢迎纠正,转载请注明出处。

1.安装依赖

composer安装依赖

composer require tymon/jwt-auth 1.*@rc

对于 Laravel 版本 低于 5.5 的应用,还要在 config/app.php 文件中设置服务提供者和别名

'providers' => [
    ....
    Tymon\JWTAuth\Providers\JWTAuthServiceProvider::class,
    ....
],
'aliases' => [
    ....
    'JWTAuth' => Tymon\JWTAuth\Facades\JWTAuth::class,
    'JWTFactory' => 'Tymon\JWTAuth\Facades\JWTFactory',
    ....
],

2.发布配置文件

在命令执行下面的命令, 会生成 config/jwt.php 配置文件

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

3.生成加密密钥

在命令执行下面的命令,会在.env文件下生成一个加密密钥,如:JWT_SECRET=**********

php artisan jwt:secret

4.创建模型

创建你的用户表模型

php artisan make:model Models/User

创建完成后不要继承Model,而是继承UserJWTSubject,并实现getJWTIdentifier()getJWTCustomClaims()方法,需要修改如下:

<?php

namespace App\Models;

use Illuminate\Notifications\Notifiable;
use Illuminate\Foundation\Auth\User as Authenticatable;
use Tymon\JWTAuth\Contracts\JWTSubject;

class User extends Authenticatable implements JWTSubject
{
    use Notifiable;

    public function getJWTIdentifier()
    {
        return $this->getKey();
    }

    public function getJWTCustomClaims()
    {
        return [];
    }
}

5.设置表和字段

在上面创建的模型中设置你的用户表名称和验证字段

<?php

namespace App\Models;

use Illuminate\Notifications\Notifiable;
use Illuminate\Foundation\Auth\User as Authenticatable;
use Tymon\JWTAuth\Contracts\JWTSubject;

class User extends Authenticatable implements JWTSubject
{
    use Notifiable;

    protected $table = 'member';    //用户表
    protected $primaryKey = 'member_id';

    //表字段
    protected $fillable = [
        'name', 'email', 'password',
    ];

    protected $hidden = [
        'password', 
    ];

    public function getJWTIdentifier()
    {
        return $this->getKey();
    }

    public function getJWTCustomClaims()
    {
        // TODO: Implement getJWTCustomClaims() method.
    }
}

6.修改 auth.php

修改config/auth.php认证方式为jwt,用户模型改为上面创建的模型

'guards' => [
    'web' => [
        'driver' => 'session',
        'provider' => 'users',
    ],

    'api' => [
        'driver' => 'jwt',        // 原来是 token 改成jwt
        'provider' => 'users',
    ],
],
...
'providers' => [
        'users' => [
            'driver' => 'eloquent',
            'model' =>  App\Models\User::class, //这里修改为上面创建的模型
        ],
    ],

7.注册路由

route/api.php注册登录和注销接口的路由

Route::group([
    'prefix' => 'auth'
], function ($router) {
    $router->post('login', 'AuthController@login');
    $router->get('logout', 'AuthController@logout');
    $router->post('refresh', 'AuthController@refresh');
    $router->get('userInfo', 'AuthController@userInfo');
});

8.创建控制器

在命令执行下面的命令创建认证控制器

php artisan make:controller AuthController

创建完控制器后实现路由中的几个方法

<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;
use Illuminate\Support\Facades\Hash;
use Tymon\JWTAuth\Facades\JWTAuth;

class AuthController extends Controller
{
    public function __construct()
    {
        $this->middleware('auth:api', ['except' => ['login']]);
    }

    //登录
    public function login(Request $request)
    {
        $credentials = $request->only('email', 'password');

        //$password = Hash::make('123456'); //密码加密
        if (! $token = JWTAuth::attempt($credentials)) { //验证传入字段,注意你的密码必须是Hash::make()或者bcrypt()方式加密的才可以,否则会一直返回false
            return response()->json(['error' => '用户不存在或密码错误'], 401);
        }

        return $this->respondWithToken($token); //验证成功
    }

    //获取用户信息
    public function userInfo()
    {
        return response()->json(auth('api')->user());
    }

    //注销
    public function logout()
    {
        auth('api')->logout();

        return response()->json(['message' => 'Successfully logged out']);
    }

    //刷新token
    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
        ]);
    }
}

控制器创建完之后在postman等工具请求/index.php/api/auth/login方法即可返回access_token等数据

需要注意的是请求的Header需要添加参数Accept,值为application/json,不然的话如果不登录或者token失效情况下请求获取用户信息等接口会出现Route [login] not defined的报错。

9.路由中间件

如果你希望接口需要经过登录验证后才可以访问,那么可以在route/api.php设置路由使用中间件auth:api,这样每次接口被访问就会自动判断是否登录,未登录的接口会返回Unauthenticated,示例:

//使用auth:api中间件
Route::group(['namespace' => 'Api','middleware'=>'auth:api'], function(){
    //将需要登录验证的接口放到这个路由组里面
    Route::get('getUserId','UserController@getUserId'); 
});
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,294评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,493评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,790评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,595评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,718评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,906评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,053评论 3 410
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,797评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,250评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,570评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,711评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,388评论 4 332
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,018评论 3 316
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,796评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,023评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,461评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,595评论 2 350

推荐阅读更多精彩内容