feat: 生成令牌可以指定客户端 client 字段，自定义客户端单点登录（默认为WEB，即网页端），如：MOBILE、APP、WECHAT、WEB、ADMIN、API、OTHER等等

Author: Tinywan

README.md

@@ -102,6 +102,18 @@ $exp = Tinywan\Jwt\JwtToken::getTokenExp();
 ```php
 'is_single_device' => true,
 ```
+
+生成令牌可以指定客户端 `client` 字段，自定义客户端单点登录（默认为`WEB`，即网页端），如：`MOBILE`、`APP`、`WECHAT`、`WEB`、`ADMIN`、`API`、`OTHER`等等
+```php
+$user = [
+    'id'  => 2022,
+    'name'  => 'Tinywan',
+    'client' => 'MOBILE',
+];
+$token = Tinywan\Jwt\JwtToken::generateToken($user);
+var_dump(json_encode($token));
+```
+
 > 7、获取当前用户信息（模型）
 
 ```php

src/JwtToken.php

@@ -35,10 +35,14 @@ class JwtToken
      */
     private const REFRESH_TOKEN = 2;
 
+    public const TOKEN_CLIENT_WEB = 'WEB';
+
+    public const TOKEN_CLIENT_MOBILE = 'MOBILE';
+
     /**
      * @desc: 获取当前登录ID
-     * @throws JwtTokenException
      * @return mixed
+     * @throws JwtTokenException
      * @author Tinywan(ShaoBo Wan)
      */
     public static function getCurrentId()
@@ -116,12 +120,8 @@ public static function refreshToken(): array
             $newToken['refresh_token'] = self::makeToken($payload['refreshPayload'], $refreshSecretKey, $config['algorithms']);
         }
         if ($config['is_single_device']) {
-            RedisHandler::generateToken([
-                'id' => $extend['extend']['id'],
-                'access_token' => $newToken['access_token'],
-                'cache_token_ttl' => $extend['exp'],
-                'cache_token_pre' => $config['cache_token_pre']
-            ]);
+            $client = $extend['extend']['client'] ?? self::TOKEN_CLIENT_WEB;
+            RedisHandler::generateToken($config['cache_token_pre'], $client, $extend['extend']['id'], $extend['exp'], $newToken['access_token']);
         }
         return $newToken;
     }
@@ -152,12 +152,8 @@ public static function generateToken(array $extend): array
             $token['refresh_token'] = self::makeToken($payload['refreshPayload'], $refreshSecretKey, $config['algorithms']);
         }
         if ($config['is_single_device']) {
-            RedisHandler::generateToken([
-                'id' => $extend['id'],
-                'access_token' => $token['access_token'],
-                'cache_token_ttl' => $config['cache_token_ttl'],
-                'cache_token_pre' => $config['cache_token_pre']
-            ]);
+            $client = $extend['extend']['client'] ?? self::TOKEN_CLIENT_WEB;
+            RedisHandler::generateToken($config['cache_token_pre'], $client, $extend['id'], $config['access_exp'], $token['access_token']);
         }
         return $token;
     }
@@ -195,7 +191,7 @@ public static function verify(int $tokenType = self::ACCESS_TOKEN, string $token
      */
     private static function getTokenExtend(): array
     {
-        return (array) self::verify()['extend'];
+        return (array)self::verify()['extend'];
     }
 
     /**
@@ -205,7 +201,7 @@ private static function getTokenExtend(): array
      */
     public static function getTokenExp(int $tokenType = self::ACCESS_TOKEN): int
     {
-        return (int) self::verify($tokenType)['exp'] - time();
+        return (int)self::verify($tokenType)['exp'] - time();
     }
 
     /**
@@ -255,16 +251,17 @@ private static function verifyToken(string $token, int $tokenType): array
         $decoded = JWT::decode($token, new Key($publicKey, $config['algorithms']));
         $decodeToken = json_decode(json_encode($decoded), true);
         if ($config['is_single_device'] && self::ACCESS_TOKEN == $tokenType) {
-            RedisHandler::verifyToken($config['cache_token_pre'], (string) $decodeToken['extend']['id'], $token);
+            $client = $decodeToken['extend']['client'] ?? self::TOKEN_CLIENT_WEB;
+            RedisHandler::verifyToken($config['cache_token_pre'], $client, (string)$decodeToken['extend']['id'], $token);
         }
         return $decodeToken;
     }
 
     /**
      * @desc: 生成令牌.
      *
-     * @param array  $payload    载荷信息
-     * @param string $secretKey  签名key
+     * @param array $payload 载荷信息
+     * @param string $secretKey 签名key
      * @param string $algorithms 算法
      * @return string
      */
@@ -361,13 +358,14 @@ private static function _getConfig(): array
 
     /**
      * @desc: 注销令牌
+     * @param string $client
      * @return bool
      */
-    public static function clear(): bool
+    public static function clear(string $client = self::TOKEN_CLIENT_WEB): bool
     {
         $config = self::_getConfig();
         if ($config['is_single_device']) {
-            return RedisHandler::clearToken($config['cache_token_pre'], (string) self::getCurrentId());
+            return RedisHandler::clearToken($config['cache_token_pre'], $client, (string)self::getCurrentId());
         }
         return true;
     }

src/RedisHandler.php

@@ -16,52 +16,58 @@
 class RedisHandler
 {
     /**
-     * @desc: 生成设备缓存令牌
+     * @desc: 生成缓存令牌
      * （1）登录时，判断该账号是否在其它设备登录，如果有，就请空之前key清除，
-     * （2）重新设置key 。然后存储用户信息和ip地址拼接为key，存储在redis当中
-     * @param array $args
+     * （2）重新设置key，然后存储用户信息在redis当中
+     * @param string $pre
+     * @param string $client
+     * @param string $uid
+     * @param int $ttl
+     * @param string $token
      * @author Tinywan(ShaoBo Wan)
      */
-    public static function generateToken(array $args): void
+    public static function generateToken(string $pre, string $client, string $uid, int $ttl, string $token): void
     {
-        $cacheKey = $args['cache_token_pre'] . $args['id'];
+        $cacheKey = $pre . $client. ':'. $uid;
         $key = Redis::keys($cacheKey . ':*');
         if (!empty($key)) {
             Redis::del(current($key));
         }
-        Redis::setex($cacheKey . ':' . request()->getRealIp(), $args['cache_token_ttl'], $args['access_token']);
+        Redis::setex($cacheKey, $ttl, $token);
     }
 
     /**
      * @desc: 检查设备缓存令牌
      * @param string $pre
+     * @param string $client
      * @param string $uid
      * @param string $token
      * @return bool
      * @author Tinywan(ShaoBo Wan)
      */
-    public static function verifyToken(string $pre, string $uid, string $token): bool
+    public static function verifyToken(string $pre, string $client, string $uid, string $token): bool
     {
-        $cacheKey = $pre . $uid . ':' . request()->getRealIp();
+        $cacheKey = $pre . $client. ':'. $uid;
         if (!Redis::exists($cacheKey)) {
             throw new JwtCacheTokenException('该账号已在其他设备登录，强制下线');
         }
         if (Redis::get($cacheKey) != $token) {
-            throw new JwtCacheTokenException('身份验证令牌已失效');
+            throw new JwtCacheTokenException('身份验证会话已过期，请再次登录！');
         }
         return true;
     }
 
     /**
      * @desc: 清理缓存令牌
      * @param string $pre
+     * @param string $client
      * @param string $uid
      * @return bool
      * @author Tinywan(ShaoBo Wan)
      */
-    public static function clearToken(string $pre, string $uid): bool
+    public static function clearToken(string $pre, string $client, string $uid): bool
     {
-        $token = Redis::keys($pre . $uid . ':*');
+        $token = Redis::keys($pre . $client. ':'. $uid . ':*');
         if ($token) {
             Redis::del(current($token));
         }