SpringBoot 学习笔记【整合JWT】

小鱼儿 2023-01-01 02:52 175阅读 0赞

### SpringBoot 学习笔记 【整合JWT】 ###

*  添加依赖
 *  创建工具类
 *   *  扩展信息操作
 *  登录获取jwt
 *  使用jwt
 *  Demo源码
 *  参考资料

# 添加依赖 #

`pom.xml`

...
            <dependency>
                <groupId>com.auth0</groupId>
                <artifactId>java-jwt</artifactId>
                <version>3.12.0</version>
            </dependency>
            <dependency>
                <groupId>io.jsonwebtoken</groupId>
                <artifactId>jjwt</artifactId>
                <version>0.7.0</version>
            </dependency>
    	...

# 创建工具类 #

`com.jerry.jwt.demo.utils.JwtUtil`

package com.jerry.jwt.demo.utils;
    
    import io.jsonwebtoken.Claims;
    import io.jsonwebtoken.JwtBuilder;
    import io.jsonwebtoken.Jwts;
    import io.jsonwebtoken.SignatureAlgorithm;
    import lombok.Data;
    import lombok.extern.slf4j.Slf4j;
    import org.springframework.boot.context.properties.ConfigurationProperties;
    import org.springframework.stereotype.Component;
    import org.springframework.util.ObjectUtils;
    
    import java.util.Date;
    import java.util.Map;
    import java.util.UUID;
    
    /** * JWT 的 token，区分大小写 * @author jerryjin */
    @ConfigurationProperties(prefix = "auth.jwt")
    @Component
    @Data
    @Slf4j
    public class JwtUtil { 
    
        private String issuer;
        private String secret;
        private long expire;
    
    
        /** * 生成 token * @param subject 主题（比如：用户id 或 用户名） * @return String */
        public String createToken (String subject){ 
            return createToken(subject, "com.jerry.smartApp", null);
        }
    
        /** * 生成 token * @param subject 主题（比如：用户id 或 用户名） * @param audience JWT的接收者（比如：APP的包名） * @param claims 自定义数据 * @return String */
        public String createToken (String subject, String audience, Map<String, Object> claims){ 
            Date nowDate = new Date();
            Date expireDate = new Date(nowDate.getTime() + expire * 1000);
    
            JwtBuilder builder = Jwts.builder()
                    .setHeaderParam("typ", "JWT")
                    .setIssuer(issuer)
                    .setSubject(subject)
                    .setAudience(audience)
                    .setExpiration(expireDate)
                    .setNotBefore(nowDate)
                    .setIssuedAt(nowDate)
                    .setId(UUID.randomUUID().toString())
                    .signWith(SignatureAlgorithm.HS256, secret);
    
            if(!ObjectUtils.isEmpty(claims)){ 
                builder.setClaims(claims);
            }
    
            return builder.compact();
        }
    
        /** * 获取 token 中注册信息 * @param token 令牌 * @return Claims */
        public Claims getClaim(String token) { 
            try { 
                return Jwts.parser().setSigningKey(secret).parseClaimsJws(token).getBody();
            }catch (Exception e){ 
                log.error(e.getMessage());
            }
            return null;
        }
    
        /** * 验证 token 是否过期 * @param expirationTime 过期时间 * @return boolean */
        public boolean isExpired(Date expirationTime) { 
            return expirationTime.before(new Date());
        }
    
        /** * 从 token 中获取 Subject * @param token 令牌 * @return String */
        public String getSubject(String token) { 
            return getClaim(token).getSubject();
        }
    
    }

## 扩展信息操作 ##

*  如果有额外的数据可以直接打包存在`claims`里（它是个 Map）。

public static void main(String[] args) { 
    
            JwtUtil jwtUtil = new JwtUtil();
    
            Hero hero = new Hero("霸下", 1800);
    
            HashMap<String, Object> map = new HashMap<>();
            map.put("tag", "666");
            map.put("hero", hero);
    
            String token = jwtUtil.createToken("123456", "com.jerry.app", map);
            System.out.println("token: " + token);
    
            Claims claim = jwtUtil.getClaim(token);
            System.out.println("tag: " + claim.get("tag"));
            System.out.println("hero: " + claim.get("hero"));
    
        }

token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJoZXJvIjp7Im5hbWUiOiLpnLjkuIsiLCJhZ2UiOjE4MDAsImZyaWVuZCI6bnVsbCwid2VhcG9uIjpudWxsfSwidGFnIjoiNjY2In0.4iKeFT5X70tAuavrKied-A988GNd3TL2ggrn-8nHUXU
    tag: 666
    hero: { name=霸下, age=1800, friend=null, weapon=null}

# 登录获取jwt #

[http://127.0.0.1/login][http_127.0.0.1_login]

{ 
        "code": 200,
        "msg": "操作成功",
        "data": { 
            "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczovL2plcnJ5amluLmJsb2cuY3Nkbi5uZXQiLCJzdWIiOiI0Y2E1NjlhMS1lYjcxLTRlMjEtOWE4NS00NjFjMzEzOWIyYjkiLCJhdWQiOiJjb20uamVycnkuc21hcnRBcHAiLCJleHAiOjE2MTIyNzU0NzcsIm5iZiI6MTYxMjE4OTA3NywiaWF0IjoxNjEyMTg5MDc3LCJqdGkiOiI5MWZlNWU0NS05M2E4LTQ1YjMtYWE4YS02YTgyOTVkMmQzMzcifQ.bSJ1BiLeOUgBwHU3Ey2reoRjk90N6rQoWtVjznYT7H8"
        },
        "time": "2021-02-01 22:17:57"
    }

# 使用jwt #

[http://127.0.0.1/info][http_127.0.0.1_login]

{ 
        "code": 200,
        "msg": "操作成功",
        "data": { 
            "userId": "4ca569a1-eb71-4e21-9a85-461c3139b2b9"
        },
        "time": "2020-12-30 22:26:30"
    }

# Demo源码 #

[https://gitee.com/jerryjin0630/jwt-damo][https_gitee.com_jerryjin0630_jwt-damo]

├─java
    │  └─com
    │      └─jerry
    │          └─jwt
    │              └─demo
    │                  │  JwtDemoApplication.java 	// 启动类
    │                  │  
    │                  ├─config
    │                  │      WebConfig.java 		// 注册拦截器
    │                  │      WebPathConfig.java 	// 拦截器：放行列表、拦截列表(从配置文件注入)
    │                  │      
    │                  ├─constant
    │                  │      StatusEnum.java		// 状态枚举类
    │                  │      SysConstant.java		// 系统常量
    │                  │      
    │                  ├─controller
    │                  │      UserAuthController.java	// 控制器
    │                  │      
    │                  ├─exception
    │                  │      TokenException.java		// 自定义异常
    │                  │      
    │                  ├─interceptor
    │                  │      GlobalExceptionInterceptor.java	// 全局异常处理
    │                  │      TokenInterceptor.java				// token拦截器
    │                  │      
    │                  ├─utils
    │                  │      JwtUtil.java			// JWT工具类
    │                  │      
    │                  └─web
    │                          Result.java			// 接口返回封装类
    │                          
    └─resources
            application.yml							// 配置文件

# 参考资料 #

[官网 https://jwt.io][https_jwt.io]  
[JWT 学习笔记][JWT]

[http_127.0.0.1_login]: http://127.0.0.1/login
[https_gitee.com_jerryjin0630_jwt-damo]: https://gitee.com/jerryjin0630/jwt-damo
[https_jwt.io]: https://jwt.io/
[JWT]: https://jerryjin.blog.csdn.net/article/details/108188207