Merge branch 'master' of https://gitee.com/y_project/RuoYi-Vue into dev

疯狂的狮子li

2021-08-02 cfdeada3fdb415ea451fb3fb76b96a2e7977752c

 ruoyi-framework/src/main/java/com/ruoyi/framework/web/service/TokenService.java

@@ -1,219 +1,197 @@
package com.ruoyi.framework.web.service;



import java.util.HashMap;

import java.util.Map;

import java.util.concurrent.TimeUnit;

import javax.servlet.http.HttpServletRequest;

import org.springframework.beans.factory.annotation.Autowired;

import org.springframework.beans.factory.annotation.Value;

import org.springframework.stereotype.Component;

import com.ruoyi.common.constant.Constants;

import com.ruoyi.common.core.domain.model.LoginUser;

import com.ruoyi.common.core.redis.RedisCache;

import com.ruoyi.common.utils.ServletUtils;

import com.ruoyi.common.utils.StringUtils;

import com.ruoyi.common.utils.ip.AddressUtils;

import com.ruoyi.common.utils.ip.IpUtils;

import com.ruoyi.common.utils.uuid.IdUtils;

import eu.bitwalker.useragentutils.UserAgent;

import io.jsonwebtoken.Claims;

import io.jsonwebtoken.Jwts;

import io.jsonwebtoken.SignatureAlgorithm;



/**

 * token验证处理

 *

 * @author ruoyi

 */

@Component

public class TokenService

{

    // 令牌自定义标识

    @Value("${token.header}")

    private String header;



    // 令牌秘钥

    @Value("${token.secret}")

    private String secret;



    // 令牌有效期（默认30分钟）

    @Value("${token.expireTime}")

    private int expireTime;



    protected static final long MILLIS_SECOND = 1000;



    protected static final long MILLIS_MINUTE = 60 * MILLIS_SECOND;



    private static final Long MILLIS_MINUTE_TEN = 20 * 60 * 1000L;



    @Autowired

    private RedisCache redisCache;



    /**

     * 获取用户身份信息

     *

     * @return 用户信息

     */

    public LoginUser getLoginUser(HttpServletRequest request)

    {

        // 获取请求携带的令牌

        String token = getToken(request);

        if (StringUtils.isNotEmpty(token))

        {

            Claims claims = parseToken(token);

            // 解析对应的权限以及用户信息

            String uuid = (String) claims.get(Constants.LOGIN_USER_KEY);

            String userKey = getTokenKey(uuid);

            LoginUser user = redisCache.getCacheObject(userKey);

            return user;

        }

        return null;

    }



    /**

     * 设置用户身份信息

     */

    public void setLoginUser(LoginUser loginUser)

    {

        if (StringUtils.isNotNull(loginUser) && StringUtils.isNotEmpty(loginUser.getToken()))

        {

            refreshToken(loginUser);

        }

    }



    /**

     * 删除用户身份信息

     */

    public void delLoginUser(String token)

    {

        if (StringUtils.isNotEmpty(token))

        {

            String userKey = getTokenKey(token);

            redisCache.deleteObject(userKey);

        }

    }



    /**

     * 创建令牌

     *

     * @param loginUser 用户信息

     * @return 令牌

     */

    public String createToken(LoginUser loginUser)

    {

        String token = IdUtils.fastUUID();

        loginUser.setToken(token);

        setUserAgent(loginUser);

        refreshToken(loginUser);



        Map<String, Object> claims = new HashMap<>();

        claims.put(Constants.LOGIN_USER_KEY, token);

        return createToken(claims);

    }



    /**

     * 验证令牌有效期，相差不足20分钟，自动刷新缓存

     *

     * @param loginUser

     * @return 令牌

     */

    public void verifyToken(LoginUser loginUser)

    {

        long expireTime = loginUser.getExpireTime();

        long currentTime = System.currentTimeMillis();

        if (expireTime - currentTime <= MILLIS_MINUTE_TEN)

        {

            refreshToken(loginUser);

        }

    }



    /**

     * 刷新令牌有效期

     *

     * @param loginUser 登录信息

     */

    public void refreshToken(LoginUser loginUser)

    {

        loginUser.setLoginTime(System.currentTimeMillis());

        loginUser.setExpireTime(loginUser.getLoginTime() + expireTime * MILLIS_MINUTE);

        // 根据uuid将loginUser缓存

        String userKey = getTokenKey(loginUser.getToken());

        redisCache.setCacheObject(userKey, loginUser, expireTime, TimeUnit.MINUTES);

    }



    /**

     * 设置用户代理信息

     *

     * @param loginUser 登录信息

     */

    public void setUserAgent(LoginUser loginUser)

    {

        UserAgent userAgent = UserAgent.parseUserAgentString(ServletUtils.getRequest().getHeader("User-Agent"));

        String ip = IpUtils.getIpAddr(ServletUtils.getRequest());

        loginUser.setIpaddr(ip);

        loginUser.setLoginLocation(AddressUtils.getRealAddressByIP(ip));

        loginUser.setBrowser(userAgent.getBrowser().getName());

        loginUser.setOs(userAgent.getOperatingSystem().getName());

    }



    /**

     * 从数据声明生成令牌

     *

     * @param claims 数据声明

     * @return 令牌

     */

    private String createToken(Map<String, Object> claims)

    {

        String token = Jwts.builder()

                .setClaims(claims)

                .signWith(SignatureAlgorithm.HS512, secret).compact();

        return token;

    }



    /**

     * 从令牌中获取数据声明

     *

     * @param token 令牌

     * @return 数据声明

     */

    private Claims parseToken(String token)

    {

        return Jwts.parser()

                .setSigningKey(secret)

                .parseClaimsJws(token)

                .getBody();

    }



    /**

     * 从令牌中获取用户名

     *

     * @param token 令牌

     * @return 用户名

     */

    public String getUsernameFromToken(String token)

    {

        Claims claims = parseToken(token);

        return claims.getSubject();

    }



    /**

     * 获取请求token

     *

     * @param request

     * @return token

     */

    private String getToken(HttpServletRequest request)

    {

        String token = request.getHeader(header);

        if (StringUtils.isNotEmpty(token) && token.startsWith(Constants.TOKEN_PREFIX))

        {

            token = token.replace(Constants.TOKEN_PREFIX, "");

        }

        return token;

    }



    private String getTokenKey(String uuid)

    {

        return Constants.LOGIN_TOKEN_KEY + uuid;

    }

}

package com.ruoyi.framework.web.service;

import cn.hutool.core.lang.Validator;
import cn.hutool.core.util.IdUtil;
import cn.hutool.http.useragent.UserAgent;
import cn.hutool.http.useragent.UserAgentUtil;
import com.ruoyi.common.constant.Constants;
import com.ruoyi.common.core.domain.model.LoginUser;
import com.ruoyi.common.core.redis.RedisCache;
import com.ruoyi.common.utils.ServletUtils;
import com.ruoyi.common.utils.ip.AddressUtils;
import com.ruoyi.framework.config.properties.TokenProperties;
import io.jsonwebtoken.Claims;
import io.jsonwebtoken.Jwts;
import io.jsonwebtoken.SignatureAlgorithm;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;

import javax.servlet.http.HttpServletRequest;
import java.util.HashMap;
import java.util.Map;
import java.util.concurrent.TimeUnit;

/**
 * token验证处理
 *
 * @author Lion Li
 */
@Component
public class TokenService {

    protected static final long MILLIS_SECOND = 1000;

    protected static final long MILLIS_MINUTE = 60 * MILLIS_SECOND;

    private static final Long MILLIS_MINUTE_TEN = 20 * 60 * 1000L;

    @Autowired
    private RedisCache redisCache;

    @Autowired
    private TokenProperties tokenProperties;

    /**
     * 获取用户身份信息
     *
     * @return 用户信息
     */
    public LoginUser getLoginUser(HttpServletRequest request) {
        // 获取请求携带的令牌
        String token = getToken(request);
        if (Validator.isNotEmpty(token)) {
         try {
            Claims claims = parseToken(token);
            // 解析对应的权限以及用户信息
            String uuid = (String) claims.get(Constants.LOGIN_USER_KEY);
            String userKey = getTokenKey(uuid);
            LoginUser user = redisCache.getCacheObject(userKey);
            return user;
            catch (Exception e) {
         }
        }
        return null;
    }

    /**
     * 设置用户身份信息
     */
    public void setLoginUser(LoginUser loginUser) {
        if (Validator.isNotNull(loginUser) && Validator.isNotEmpty(loginUser.getToken())) {
            refreshToken(loginUser);
        }
    }

    /**
     * 删除用户身份信息
     */
    public void delLoginUser(String token) {
        if (Validator.isNotEmpty(token)) {
            String userKey = getTokenKey(token);
            redisCache.deleteObject(userKey);
        }
    }

    /**
     * 创建令牌
     *
     * @param loginUser 用户信息
     * @return 令牌
     */
    public String createToken(LoginUser loginUser) {
        String token = IdUtil.fastUUID();
        loginUser.setToken(token);
        setUserAgent(loginUser);
        refreshToken(loginUser);

        Map<String, Object> claims = new HashMap<>();
        claims.put(Constants.LOGIN_USER_KEY, token);
        return createToken(claims);
    }

    /**
     * 验证令牌有效期，相差不足20分钟，自动刷新缓存
     *
     * @param loginUser
     * @return 令牌
     */
    public void verifyToken(LoginUser loginUser) {
        long expireTime = loginUser.getExpireTime();
        long currentTime = System.currentTimeMillis();
        if (expireTime - currentTime <= MILLIS_MINUTE_TEN) {
            refreshToken(loginUser);
        }
    }

    /**
     * 刷新令牌有效期
     *
     * @param loginUser 登录信息
     */
    public void refreshToken(LoginUser loginUser) {
        loginUser.setLoginTime(System.currentTimeMillis());
        loginUser.setExpireTime(loginUser.getLoginTime() + tokenProperties.getExpireTime() * MILLIS_MINUTE);
        // 根据uuid将loginUser缓存
        String userKey = getTokenKey(loginUser.getToken());
        redisCache.setCacheObject(userKey, loginUser, tokenProperties.getExpireTime(), TimeUnit.MINUTES);
    }

    /**
     * 设置用户代理信息
     *
     * @param loginUser 登录信息
     */
    public void setUserAgent(LoginUser loginUser) {
        UserAgent userAgent = UserAgentUtil.parse(ServletUtils.getRequest().getHeader("User-Agent"));
        String ip = ServletUtils.getClientIP();
        loginUser.setIpaddr(ip);
        loginUser.setLoginLocation(AddressUtils.getRealAddressByIP(ip));
        loginUser.setBrowser(userAgent.getBrowser().getName());
        loginUser.setOs(userAgent.getOs().getName());
    }

    /**
     * 从数据声明生成令牌
     *
     * @param claims 数据声明
     * @return 令牌
     */
    private String createToken(Map<String, Object> claims) {
        String token = Jwts.builder()
                .setClaims(claims)
                .signWith(SignatureAlgorithm.HS512, tokenProperties.getSecret()).compact();
        return token;
    }

    /**
     * 从令牌中获取数据声明
     *
     * @param token 令牌
     * @return 数据声明
     */
    private Claims parseToken(String token) {
        return Jwts.parser()
                .setSigningKey(tokenProperties.getSecret())
                .parseClaimsJws(token)
                .getBody();
    }

    /**
     * 从令牌中获取用户名
     *
     * @param token 令牌
     * @return 用户名
     */
    public String getUsernameFromToken(String token) {
        Claims claims = parseToken(token);
        return claims.getSubject();
    }

    /**
     * 获取请求token
     *
     * @param request
     * @return token
     */
    private String getToken(HttpServletRequest request) {
        String token = request.getHeader(tokenProperties.getHeader());
        if (Validator.isNotEmpty(token) && token.startsWith(Constants.TOKEN_PREFIX)) {
            token = token.replace(Constants.TOKEN_PREFIX, "");
        }
        return token;
    }

    private String getTokenKey(String uuid) {
        return Constants.LOGIN_TOKEN_KEY + uuid;
    }
}