当前位置：首页 > news >正文

你知道JWT是什么吗？它和Session的区别又在哪里？

news 来源：原创 2024/5/17 15:27:48

听说微信搜索《Java鱼仔》会变更强哦！

本文收录于JavaStarter ，里面有我完整的Java系列文章，学习或面试都可以看看哦

（一）前言

在前面一篇讲分布式session的时候，有读者问了一句用JWT不香吗，连Redis服务器都省了，又可以实现分布式环境下的人员信息认证。正好我也还没写过关于JWT的文章，刚好在项目中又用过这项技术，今天就来分享一下。还是一样，先理论后实践，有问题评论一起头脑风暴。

（二）什么是JWT

JWT全程JSON Web Token，用户会话信息存储在客户端浏览器中，各方之间通过JSON对象安全传输信息，这些信息可以通过加密算法进行加密。

这样描述可能比较难懂，简单来讲，JWT就是在你登陆的时候生成一串加密字符串token，在每次请求的时候都带上这串token，服务器如果可以解密这段字符串，说明就是登陆状态的。

我们一般会将非敏感数据加密生成token，如果服务器端需要用到人员信息，就解密取人员信息。

你会发现，使用JWT直接就解决了分布式集群环境下的人员认证问题，因为生成的这串token在哪台服务器上都可以解析出来。如下图所示：

JWT流程图

了解了原理之后，来讲讲实际的，JWT的数据包含三个部分：

1、Header 2、Payload 3、Signature

三者通过"."组合在一起，经过加密后生成一段token：

Header.Payload.Signature

下面是我生成的一段token

eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJqYXZheXoiLCJjcmVhdGVkYXRlIjoxNjExNzU1MDIxNjk1LCJpZCI6MSwiZXhwIjoxNjEyMzU5ODIxLCJ1c2VyTGV2ZWxJZCI6bnVsbH0.ahFWQ_BJ1WNWp9GnlTrSNThVa3i3dydzcaNxLmPb7HI

Header用来描述JWT元数据，包含两个数据，其中alg表示签名的算法，默认HS256，typ属性表示令牌类型，这里就是JWT。上面生成的token中第一个“.”之前的数据base64解码后就是下面的json

{
    alg : "HS256",
    typ : "JWT"
}

Payload用来以JSON格式记录用户信息，这里的用户信息可以自定义，上面第一个“.”和第二个“.”之间的数据base64解码后就是下面的json

{
    "sub":"javayz",
    "createdate":1611755021695,
    "id":1,
    "exp":1612359821,
    "userLevelId":null
}

Signature存放加密串，通过指定算法对Header和Payload加盐加密，各部分通过“.”分割。组成了token。

（三）JWT身份认证流程

看完上面的内容，我相信你对JWT的认证已经有认识了，其身份认证的流程如下所示：

1、用户输入用户名和密码登陆

2、服务器端校验用户名和密码是否正确，如果正确就返回token给客户端

3、客户端将token存放在cookie或者local storage中

4、客户端后续的每次请求，都要带上这个token

5、服务器通过token判断是哪个用户

（四）代码实践

接下通过代码模拟JWT的认证实现，我写这段代码时的环境为springBoot2.4.2，引入JWT依赖：

<!--JWT依赖-->
<dependency>
    <groupId>io.jsonwebtoken</groupId>
    <artifactId>jjwt</artifactId>
    <version>0.9.0</version>
</dependency>

在配置文件中配置一些接下来会用到的属性：

jwt:
  tokenHeader: Authorization
  secret: javayz
  expiration: 604800
  tokenHead: Bearer

写个类来读取这些参数：

@Data
@ConfigurationProperties(prefix = "jwt")
@Component
public class JwtProperties {
    private String tokenHeader;
    private String secret;
    private Long expiration;
    private String tokenHead;
}

编写JWT工具类，实现生成token和解码token的功能：

public class JwtKit {

    @Autowired
    private JwtProperties jwtProperties;

    /**
     * 创建token
     * @param user
     * @return
     */
    public String generateJwtToken(User user){
        //所有的用户数据放在claims中
        Map<String,Object> claims=new HashMap<>();
        claims.put("sub",user.getUsername());
        claims.put("createdate",new Date());
        claims.put("id",user.getId());
        claims.put("userLevelId",user.getLevelId());

        return Jwts.builder()
                .setClaims(claims)
                .setHeaderParam("typ", "JWT")
                .setExpiration(new Date(System.currentTimeMillis()+jwtProperties.getExpiration()*1000))
                .signWith(SignatureAlgorithm.HS256, jwtProperties.getSecret())
                .compact();
    }

    /**
     * 解码token
     * @param jwtToken
     * @return
     */
    public Claims parseJwtToken(String jwtToken){
        Claims claims=null;
        try {
            claims=Jwts.parser()
                    .setSigningKey(jwtProperties.getSecret())
                    .parseClaimsJws(jwtToken)
                    .getBody();
        }catch (ExpiredJwtException e){
            throw new MyException("JWTtoken过期");
        }catch (UnsupportedJwtException e){
            throw new MyException("JWTtoken格式不支持");
        }catch (MalformedJwtException e){
            throw new MyException("无效的token");
        }catch (SignatureException e){
            throw new MyException("无效的token");
        }catch (IllegalArgumentException e){
            throw new MyException("无效的token");
        }
        return claims;
    }
}

再将这个工具类注入到Bean容器中：

@Configuration
public class JwtConfiguration {

    @Bean
    public JwtKit jwtKit(){
        return new JwtKit();
    }
}

然后就可以愉快地使用了

@RestController
@RequestMapping("/sso")
public class UserController extends BaseController {

    @Autowired
    private UserService userService;

    @Autowired
    private JwtKit jwtKit;

    @Autowired
    private JwtProperties jwtProperties;

    @PostMapping("jwtlogin")
    public CommonResult jwtLogin(@RequestParam String username,@RequestParam String password){
        User user = userService.login(username, password);
        if (user!=null){
            Map<String,Object> map=new HashMap<>();
            String token=jwtKit.generateJwtToken(user);
            map.put("tokenHead",jwtProperties.getTokenHead());
            map.put("token",token);
            return new CommonResult(ResponseCode.SUCCESS.getCode(),ResponseCode.SUCCESS.getMsg(),map);
        }
        return new CommonResult(ResponseCode.USER_NOT_EXISTS.getCode(),ResponseCode.USER_NOT_EXISTS.getMsg(),"");
    }
}

登陆成功的话将token的开头和实际token值返回给后端。

接着编写拦截器，拦截除/sso/*外的其他请求，这些请求是需要登陆才可以访问的。

@Configuration
public class IntercepterConfiguration implements WebMvcConfigurer {

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        List list=new ArrayList();
        list.add("/sso/**");
        registry.addInterceptor(authInterceptorHandler())
                .addPathPatterns("/**")
                .excludePathPatterns(list);
    }

    @Bean
    public AuthInterceptorHandler authInterceptorHandler(){
        return new AuthInterceptorHandler();
    }
}

接着是对拦截的处理，首先判断header中是否有key为Authorization的数据，如果没有，说明未登陆，将未登录的结果返回出去。如果header中存在key为Authorization的数据，则先判断是否以Bearer开头（这个可以自定义），如果是的话说明登陆了，就直接返回true不拦截。

@Slf4j
public class AuthInterceptorHandler implements HandlerInterceptor {

    @Autowired
    private JwtKit jwtKit;

    @Autowired
    private JwtProperties jwtProperties;

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        log.info("进入拦截器");
        String aa = request.getHeader("aa");
        String authorization =request.getHeader(jwtProperties.getTokenHeader());
        log.info("Authorization"+authorization);
        //如果不为空，说明head里存了数据，
        if(StringUtils.isNotEmpty(authorization) && authorization.startsWith(jwtProperties.getTokenHead())){
            String authToken = authorization.substring(jwtProperties.getTokenHead().length());
            Claims claims=null;
            try {
                claims=jwtKit.parseJwtToken(authToken);
                if (claims!=null){
                    return true;
                }
            }catch (MyException e){
                log.info(e.getMessage()+":"+authToken);
            }
        }

        response.setHeader("Content-Type","application/json");
        response.setCharacterEncoding("UTF-8");
        String result = new ObjectMapper().writeValueAsString(new CommonResult(ResponseCode.NEED_LOGIN.getCode(), ResponseCode.NEED_LOGIN.getMsg(), ""));
        response.getWriter().println(result);
        return false;
    }
}

最后写一个测试类：

@RestController
public class IndexController extends BaseController{

    @Autowired
    private JwtProperties jwtProperties;
    @Autowired
    private JwtKit jwtKit;

    @RequestMapping(value = "/index",method = RequestMethod.GET)
    public CommonResult index(){

        String authorization = getRequest().getHeader(jwtProperties.getTokenHeader());
        String authToken = authorization.substring(jwtProperties.getTokenHead().length());
        Claims claims=jwtKit.parseJwtToken(authToken);
        return new CommonResult(ResponseCode.SUCCESS.getCode(),ResponseCode.SUCCESS.getMsg(),claims.get("sub"));
    }
}