JWT整合Springboot

Posted 2021-12-21 LL.LEBRON

文章目录

• JWT整合Springboot
• • 1.基于JWT认证
  • • 1.1 认证流程
    • 1.2 JWT优势
    • 1.3 JWT的结构是什么
  • 2.使用JWT
  • 3.整合Springboot

JWT整合Springboot

1.基于JWT认证

1.1 认证流程

1. 首先，前端通过Web表单将自己的用户名和密码发送到后端的接口。这一过程一般是一个HTTP POST请求。建议的方式是通过SSL加密的传输（https协议），从而避免敏感信息被嗅探。
2. 后端核对用户名和密码成功后，将用户的id等其他信息作为JWT Payload（负载），将其与头部分别进行Base64编码拼接后签名，形成一个JWT(Token)。形成的JWT就是一个形同lll.zzz.xxx的字符串。 token head.payload.singurater
3. 后端将JWT字符串作为登录成功的返回结果返回给前端。前端可以将返回的结果保存在localStorage或sessionStorage上，退出登录时前端删除保存的JWT即可。
4. 前端在每次请求时将JWT放入HTTP Header中的Authorization位。(解决XSS和XSRF问题) HEADER
5. 后端检查是否存在，如存在验证JWT的有效性。例如，检查签名是否正确；检查Token是否过期；检查Token的接收方是否是自己（可选）。
6. 验证通过后，后端使用JWT中包含的用户信息进行其他逻辑操作，返回相应结果。

1.2 JWT优势

1. 简洁(Compact): 可以通过URL，POST参数或者在HTTP header发送，因为数据量小，传输速度也很快
2. 自包含(Self-contained)：负载中包含了所有用户所需要的信息，避免了多次查询数据库
3. 因为Token是以JSON加密的形式保存在客户端的，所以JWT是跨语言的，原则上任何web形式都支持
4. 不需要在服务端保存会话信息，特别适用于分布式微服务

1.3 JWT的结构是什么

token string ====> header.payload.singnature token

令牌组成

• 标头(Header)
• 有效载荷(Payload)
• 签名(Signature)

因此，JWT通常如下所示:xxxxx.yyyyy.zzzzz Header.Payload.Signature

Header

• 标头通常由两部分组成：令牌的类型（即JWT）和所使用的签名算法，例如HMAC SHA256或RSA。它会使用 Base64 编码组成 JWT 结构的第一部分。

• 注意:Base64是一种编码，也就是说，它是可以被翻译回原来的样子来的。它并不是一种加密过程。

  "alg": "HS256",
  "typ": "JWT"

Payload

• 令牌的第二部分是有效负载，其中包含声明。声明是有关实体
• （通常是用户）和其他数据的声明。同样的，它会使用 Base64 编码组成 JWT 结构的第二部分

  "sub": "1234567890",
  "name": "John Doe",
  "admin": true

Signature

• 前面两部分都是使用 Base64 进行编码的，即前端可以解开知道里面的信息。Signature 需要使用编码后的 header 和 payload以及我们提供的一个密钥，然后使用 header 中指定的签名算法（HS256）进行签名。签名的作用是保证 JWT 没有被篡改过
• 如：HMACSHA256(base64UrlEncode(header) + “.” + base64UrlEncode(payload),secret);

签名目的

最后一步签名的过程，实际上是对头部以及负载内容进行签名，防止内容被窜改。如果有人对头部以及负载的内容解码之后进行修改，再进行编码，最后加上之前的签名组合形成新的JWT的话，那么服务器端会判断出新的头部和负载形成的签名和JWT附带上的签名是不一样的。如果要对新的头部和负载进行签名，在不知道服务器加密时用的密钥的话，得出来的签名也是不一样的。

信息安全问题

在这里大家一定会问一个问题：Base64是一种编码，是可逆的，那么我的信息不就被暴露了吗？

是的。所以，在JWT中，不应该在负载里面加入任何敏感的数据。在上面的例子中，我们传输的是用户的User ID。这个值实际上不是什么敏感内容，一般情况下被知道也是安全的。但是像密码这样的内容就不能被放在JWT中了。如果将用户的密码放在了JWT中，那么怀有恶意的第三方通过Base64解码就能很快地知道你的密码了。因此JWT适合用于向Web应用传递一些非敏感信息。JWT还经常用于设计用户认证和授权系统，甚至
实现Web应用的单点登录。

2.使用JWT

引入依赖

<!--引入jwt-->
<dependency>
  <groupId>com.auth0</groupId>
  <artifactId>java-jwt</artifactId>
  <version>3.4.0</version>
</dependency>

生成token

@Test
void contextLoads() 
    HashMap<String, Object> map = new HashMap<>();
    Calendar instance=Calendar.getInstance();
    instance.add(Calendar.SECOND,200);
    //获取token
    String token = JWT.create().withHeader(map)  //header，默认，可以不写
        .withClaim("userId", 23)
        .withClaim("username", "xpp") //palyload
        .withExpiresAt(instance.getTime())  //指定令牌的过期时间
        .sign(Algorithm.HMAC256("xpp@ll"));//签名，指定秘钥
    System.out.println(token);

生成结果

eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE2Mzc5MDM2OTksInVzZXJJZCI6MjMsInVzZXJuYW1lIjoieHBwIn0.dnWldEBILZpt7Upz762VcMm-uTU9HI5jK-AHk3XyX0s

根据令牌和签名解析数据

@Test
public void test()
    //创建验证对象
    JWTVerifier jwtVerifier = JWT.require(Algorithm.HMAC256("xpp@ll")).build();
    //验证token
    DecodedJWT verify = jwtVerifier.verify("eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE2Mzc5MDM2OTksInVzZXJJZCI6MjMsInVzZXJuYW1lIjoieHBwIn0.dnWldEBILZpt7Upz762VcMm-uTU9HI5jK-AHk3XyX0s");
    //获取存入palyload的信息
    Date expiresAt = verify.getExpiresAt();
    System.out.println(expiresAt);
    System.out.println(verify.getClaim("userId").asInt());

常见异常信息

• SignatureVerificationException: 签名不一致异常
• TokenExpiredException: 令牌过期异常
• AlgorithmMismatchException: 算法不匹配异常
• InvalidClaimException: 失效的payload异常

3.整合Springboot

引入依赖

<!--引入jwt-->
<dependency>
  <groupId>com.auth0</groupId>
  <artifactId>java-jwt</artifactId>
  <version>3.4.0</version>
</dependency>

<!--引入mybatis-->
<dependency>
  <groupId>org.mybatis.spring.boot</groupId>
  <artifactId>mybatis-spring-boot-starter</artifactId>
  <version>2.1.3</version>
</dependency>

<!--引入lombok-->
<dependency>
  <groupId>org.projectlombok</groupId>
  <artifactId>lombok</artifactId>
  <version>1.18.12</version>
</dependency>

<!--引入druid-->
<dependency>
  <groupId>com.alibaba</groupId>
  <artifactId>druid</artifactId>
  <version>1.1.19</version>
</dependency>

<!--引入mysql-->
<dependency>
  <groupId>mysql</groupId>
  <artifactId>mysql-connector-java</artifactId>
  <version>5.1.38</version>
</dependency>

配置

server.port=8989
spring.application.name=jwt

spring.datasource.type=com.alibaba.druid.pool.DruidDataSource
spring.datasource.driver-class-name=com.mysql.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3306/jwt?characterEncoding=UTF-8
spring.datasource.username=root
spring.datasource.password=root

mybatis.type-aliases-package=com.baizhi.entity
mybatis.mapper-locations=classpath:com/baizhi/mapper/*.xml

logging.level.com.baizhi.dao=debug

数据库表

DROP TABLE IF EXISTS `user`;
CREATE TABLE `user` (
  `id` int(11) NOT NULL AUTO_INCREMENT COMMENT '主键',
  `name` varchar(80) DEFAULT NULL COMMENT '用户名',
  `password` varchar(40) DEFAULT NULL COMMENT '用户密码',
  PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=2 DEFAULT CHARSET=utf8;

实体类

@Data
@Accessors(chain=true)
public class User 
    private String id;
    private String name;
    private String password;

开发DAO接口和mapper.xml

@Mapper
public interface UserDAO 
    User login(User user);

<mapper namespace="com.baizhi.dao.UserDAO">
    <!--这里就写的简单点了毕竟不是重点-->
    <select id="login" parameterType="User" resultType="User">
        select * from user where name=#name and password = #password
    </select>
</mapper>

开发Service 接口以及实现类

public interface UserService 
    User login(User user);//登录接口

@Service
@Transactional
public class UserServiceImpl implements UserService 
    @Autowired
    private UserDAO userDAO;
    @Override
    @Transactional(propagation = Propagation.SUPPORTS)
    public User login(User user) 
        User userDB = userDAO.login(user);
        if(userDB!=null)
            return userDB;
        
        throw  new RuntimeException("登录失败~~");
    

编写JWT工具类

/**
 * @Auther: xppll
 * @Date: 2021/11/26 13:25
 */
public class JWTUtils 
    //秘钥
    private static final String TOKEN = "xpp@ll";

    /**
     * 生成token(head.playload.sing)
     *
     * @param map 用户传过了的信息，例如id等
     * @return
     */
    public static String getToken(Map<String, String> map) 
        Calendar instance = Calendar.getInstance();
        //设置默认7天过期
        instance.add(Calendar.DATE, 7);

        //创建jwt builder
        JWTCreator.Builder builder = JWT.create();
        //payload
        map.forEach((k, v) -> 
            builder.withClaim(k, v);
        );
        //指定令牌过期时间
        String token = builder.withExpiresAt(instance.getTime())
                //sign，传入加密盐
                .sign(Algorithm.HMAC256(TOKEN));
        return token;
    

    /**
     * 验证token合法性
     *
     * @param token
     */
    public static void verify(String token) 
        JWT.require(Algorithm.HMAC256(TOKEN)).build().verify(token);
    

    /**
     * 获取token信息方法
     *
     * @param token
     * @return
     */
    public static DecodedJWT getTokenInfo(String token) 
        DecodedJWT verify = JWT.require(Algorithm.HMAC256(TOKEN)).build().verify(token);
        return verify;
    

开发controller

/**
 * @Auther: xppll
 * @Date: 2021/11/26 14:07
 */
@RestController
@Slf4j
public class UserController 

    @Autowired
    private UserService userService;

    @GetMapping("/user/login")
    public Map<String, Object> login(User user) 
        Map<String, Object> map = new HashMap<>();
        try 
            User userDB = userService.login(user);
            //用来存放payload
            Map<String, String> payload = new HashMap<>();
            payload.put("id", userDB.getId());
            payload.put("name", userDB.getName());
            //生成JWT的令牌
            String token = JWTUtils.getToken(payload);
            map.put("state", true);
            map.put("msg", "成功");
            //成功返回token信息
            map.put("token", token);
         catch (Exception e) 
            map.put("state", false);
            map.put("msg", e.getMessage());
        
        return map;
    

数据库添加测试数据启动项目

通过postman模拟登录失败

通过postman模拟登录成功

编写测试接口

@PostMapping("user/test")
public Map<String, Object> test(String token) 
    //通过拦截器验证了，token验证成功
    Map<String, Object> map = new HashMap<>();
    map.put("state", true);
    map.put("msg", "请求成功！");
    return map;

使用拦截器验证token

/**
 * @Auther: xppll
 * @Date: 2021/11/26 15:20
 */
@Component
public class JWTInterceptor implements HandlerInterceptor 
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception 
        //获取请求头中存放的令牌token
        String token = request.getHeader("token");
        Map<String, Object> map = new HashMap<>();
        try 
            //验证令牌
            JWTUtils.verify(token);
            return true;
         catch (SignatureVerificationException e) 
            e.printStackTrace();
            map.put("msg", "无效签名");
         catch (AlgorithmMismatchException e) 
            e.printStackTrace();
            map.put("msg", "token算法不一致");
         catch (TokenExpiredException e) 
            e.printStackTrace();
            map.put("msg", "token过期");
         catch (Exception e) 
            e.printStackTrace();
            map.put("msg", "token无效");
        

        map.put("state", false);
        //将map转为json，返回给前端
        String json = new ObjectMapper().writeValueAsString(map);
        response.setContentType("application/json;charset=utf-8");
        response.getWriter().print(json);
        return false;
    

使拦截器生效

/**
 * @Auther: xppll
 * @Date: 2021/11/26 15:28
 */
@Configuration
public class InterceptorConfig implements WebMvcConfigurer 
    @Autowired
    private JWTInterceptor jwtInterceptor;

    @Override
    public void addInterceptors(InterceptorRegistry registry) 
        registry.addInterceptor(jwtInterceptor)
                //其他接口需要token验证，拦截器拦截
                .addPathPatterns("/user/test")
                .excludePathPatterns("/user/login");
    

最后喜欢的小伙伴，记得三连哦！😏🍭😘