springboot整合token

写在前面

• 在前后端交互过程中, 为了保证信息安全，我们往往需要加点用户验证。本文介绍了用 springboot 简单整合 token。
• springboot 版本 2.2.0。另外主要用到了 jjwt,redis。阅读本文, 你大概需要花费 7 -10 分钟时间

整合 token

1. 导入相关依赖

pom.xml 文件中

<!--        jwt 加密解密工具类 -->
        <dependency>
            <groupId>io.jsonwebtoken</groupId>
            <artifactId>jjwt</artifactId>
            <version>0.9.0</version>
        </dependency>

2.TokenUtil.java 实现生成 / 解析 token

package com.dbc.usermanager.util;

import com.dbc.usermanager.service.RedisService;
import io.jsonwebtoken.Claims;
import io.jsonwebtoken.JwtBuilder;
import io.jsonwebtoken.Jwts;
import io.jsonwebtoken.SignatureAlgorithm;
import org.springframework.beans.factory.annotation.Autowired;

import javax.crypto.spec.SecretKeySpec;
import javax.xml.bind.DatatypeConverter;
import java.security.Key;
import java.util.Date;

public class TokenUtil {
    /**
     * 签名秘钥, 可以换成 秘钥 注入
     */
    public static final String SECRET = "DaTiBao";// 注意: 本参数需要长一点，不然后面剪切的时候很可能长度为 0，就会报错
    /**
     * 签发地
     */
    public static final String issuer  = "dtb.com";
    /**
     * 过期时间
     */
    public static final long ttlMillis = 3600*1000*60;

    /**
     * 生成 token
     *
     * @param id 一般传入 userName
     * @return
     */
    public static String createJwtToken(String id,String subject) {return createJwtToken(id, issuer, subject, ttlMillis);
    }
    public static String createJwtToken(String id) {return createJwtToken(id, issuer, "", ttlMillis);
    }

    /**
     * 生成 Token
     *
     * @param id        编号
     * @param issuer    该 JWT 的签发者，是否使用是可选的
     * @param subject   该 JWT 所面向的用户，是否使用是可选的；* @param ttlMillis 签发时间（有效时间，过期会报错）* @return token String
     */
    public static String createJwtToken(String id, String issuer, String subject, long ttlMillis) {

        // 签名算法，将对 token 进行签名
        SignatureAlgorithm signatureAlgorithm = SignatureAlgorithm.HS256;

        // 生成签发时间
        long nowMillis = System.currentTimeMillis();
        Date now = new Date(nowMillis);

        // 通过秘钥签名 JWT
        byte[] apiKeySecretBytes = DatatypeConverter.parseBase64Binary(SECRET);
        String str=signatureAlgorithm.getJcaName();
        Key signingKey = new SecretKeySpec(apiKeySecretBytes, str);

        // 让我们设置 JWT 声明
        JwtBuilder builder = Jwts.builder().setId(id)
                .setIssuedAt(now)
                .setSubject(subject)
                .setIssuer(issuer)
                .signWith(signatureAlgorithm, signingKey);

        // if it has been specified, let's add the expiration
        if (ttlMillis >= 0) {
            // 过期时间
            long expMillis = nowMillis + ttlMillis;
            Date exp = new Date(expMillis);
            builder.setExpiration(exp);
        }

        // 构建 JWT 并将其序列化为一个紧凑的 url 安全字符串
        return builder.compact();}

    /**
     * Token 解析方法
     * @param jwt Token
     * @return
     */
    public static Claims parseJWT(String jwt) {// 如果这行代码不是签名的 JWS( 如预期)，那么它将抛出异常
        Claims claims = Jwts.parser()
                .setSigningKey(DatatypeConverter.parseBase64Binary(SECRET))
                .parseClaimsJws(jwt).getBody();
        return claims;
    }


    public static void main(String[] args) {String token = TokenUtil.createJwtToken("2","ltz");

        System.out.println(TokenUtil.createJwtToken("2","ltz"));

        Claims claims = TokenUtil.parseJWT(token);

        System.out.println(claims);

    }
}

3. 新增登录验证的注解 @LoginRequired

package com.dbc.usermanager.util;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

// 加入此注解, 就需要 token
@Target({ElementType.METHOD, ElementType.TYPE})// 表明此注解可用在方法名上
@Retention(RetentionPolicy.RUNTIME)// 运行时有效
public @interface LoginRequired {boolean required() default true;
}

4. 测试

    @PostMapping(value = "test")
    @ApiOperation(value="生成 token")
    public ResultJson test(@RequestBody JSONObject requestJson){String token= TokenUtil.createJwtToken("1","dtb");
        redisService.set(token,"1");
        return new ResultJson(0,"测试成功",null);
    }
    @GetMapping(value = "getToken")
    @LoginRequired
    @ApiOperation("")
    public ResultJson getToken(String token){if(redisService.exists(token)){System.out.println(redisService.get(token));
        }
        return new ResultJson(0,"测试成功",null);
    }

最后

• 实体类 User.java 等相关文件就不贴出来了，大家可以用自己写好的实体类去编写。
• 很多步骤与思想都在代码中体现, 代码中也加了很多注释，你可以根据自己的需求进行增删查改。