abovesky/think-jwt

ThinkPHP Jwt Component

dev-master 2020-03-05 15:08 UTC

Requires

• php: >=7.1.0
• ext-json: *
• ext-mbstring: *
• lcobucci/jwt: ^3.3
• nette/php-generator: ^3.2
• topthink/framework: ^5.1.39 || ^6.0.2

Requires (Dev)

• friendsofphp/php-cs-fixer: ^2.15
• mockery/mockery: ^1.2
• phpstan/phpstan: ^0.12.0
• phpunit/phpunit: ^7.0

MIT

• abovesky

• php
• jwt
• thinkphp

README

安装

$ composer require abovesky/think-jwt:dev-master

使用

1. 命令生成签名 key

$ php think jwt:make

1. 配置 config/jwt.php

• sso 是否单点登录
• ssoCacheKey 缓存前缀
• ssoKey 用户唯一标识(多点登录 设置失效)
• signerKey 密钥
• notBefore 时间前不能使用 默认生成后直接使用
• expiresAt Token 有效期（秒）
• signer 加密算法
• type 获取 Token 途径
• injectUser 是否注入用户模型
• userModel 用户模型
• hasLogged 开启单点登录时，多点登录抛异常 code = 50401
• tokenExpired Token 过期抛异常 code = 50402

abovesky\Exception\HasLoggedException， abovesky\Exception\TokenExpiredException 以上两个异常都会抛一个 HTTP 异常 StatusCode = 401

1. Token 生成

use abovesky\Facade\Jwt;

public function login()
{
    //...登录判断逻辑

    return json([
        'token' => Jwt::token(['uid' => 1]),
        'token_type' => Jwt::type(),
        'expires_in' => Jwt::ttl()
    ]);
}

1. Token 验证(手动)

use abovesky\Facade\Jwt;
use abovesky\Exception\HasLoggedException;
use abovesky\Exception\TokenExpiredException;

class User {

    public function test()
    {
        try {
            Jwt::verify($token);
        } catch (HasLoggedException $e) {
            // 已在其它终端登录
        } catch (TokenExpiredException $e) {
            // Token已过期
        }

        // 验证成功

        // 如 开启用户注入功能 可获取当前用户信息
        dump(Jwt::user());
    }
}

1. Token 验证(中间件)

use abovesky\Jwt;
use app\model\User;

class UserController {
    protected $middleware = ['JwtMiddleware'];

    public function test(Jwt $jwt)
    {
        var_dump($jwt->getClaims());
    }

    // 开启用户模型注入
    public function user(User $user)
    {
        var_dump($user->name);
    }
}

1. 自动获取验证

支持以下方式自动获取

• Bearer
• Cookie
• Url

赋值方式

类型	途径	标识
Bearer	Authorization	Bearer
Cookie	Cookie	token
Url	Request	token

# config/jwt.php

<?php

return [

    // ...其它配置
    'type' => 'Bearer',

    // 'type' => 'Cookie',
    // 'type' => 'Url',
];

# UserController.php

use abovesky\Facade\Jwt;

class User
{
    public function index()
    {
        // 自动获取并验证
        try {
            Jwt::verify();
        } catch (HasLoggedException $e) {
            // 已在其它终端登录
        } catch (TokenExpiredException $e) {
            // Token已过期
        }

        $uid = Jwt::userId();
    }

}