SpringBoot整合JWT

奇妙屋
215 阅读9分钟

一、JWT简介

1、概念

json web token (JWT), 是为了在网络应用环境间传递声明而执行的一种基于JSON的开放标准（(RFC 7519).定义了一种简洁的，自包含的方法用于通信双方之间以JSON对象的形式安全的传递信息。因为数字签名的存在，这些信息是可信的，JWT可以使用HMAC算法或者是RSA的公私秘钥对进行签名。

2、JWT请求流程

  1. 用户使用账号和密码发出post请求；
  2. 服务器使用私钥创建一个jwt；
  3. 服务器返回这个jwt给浏览器；
  4. 浏览器将该jwt串在请求头中像服务器发送请求；
  5. 服务器验证该jwt；
  6. 返回响应的资源给浏览器。

3、JWT的主要应用场景

身份认证在这种场景下，一旦用户完成了登陆，在接下来的每个请求中包含JWT，可以用来验证用户身份以及对路由，服务和资源的访问权限进行验证。由于它的开销非常小，可以轻松的在不同域名的系统中传递，所有目前在单点登录（SSO）中比较广泛的使用了该技术。 信息交换在通信的双方之间使用JWT对数据进行编码是一种非常安全的方式，由于它的信息是经过签名的，可以确保发送者发送的信息是没有经过伪造的。

4、JWT的优点

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

5、JWT的结构

（1）、Header 头部

标题包含了令牌的元数据，并且包含签名和/或加密算法的类型。
JWT的头部承载两部分信息：token类型和采用的加密算法。

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

声明类型:这里是jwt声明加密的算法:通常直接使用 HMAC、SHA256。
加密算法是单向函数散列算法，常见的有MD5、SHA、HAMC。
MD5(message-digest algorithm 5) （信息-摘要算法）缩写，广泛用于加密和解密技术，常用于文件校验。校验:不管文件多大，经过MD5后都能生成唯一的MD5值
SHA (Secure Hash Algorithm，安全散列算法），数字签名等密码学应用中重要的工具，安全性高于MD5。
HMAC (Hash Message Authentication Code)，散列消息鉴别码，基于密钥的Hash算法的认证协议。用公开函数和密钥产生一个固定长度的值作为认证标识，用这个标识鉴别消息的完整性。常用于接口签名验证。

（2）、Payload 负载

类似于飞机上承载的物品
载荷就是存放有效信息的地方。
有效信息包含三个部分
1、标准中注册的声明(建议但不强制使用)
iss: jwt签发者。
sub: 面向的用户(jwt所面向的用户)。
aud: 接收jwt的一方。
exp: 过期时间戳(jwt的过期时间，这个过期时间必须要大于签发时间)。
nbf: 定义在什么时间之前，该jwt都是不可用的。
iat: jwt的签发时间。
jti: jwt的唯一身份标识，主要用来作为一次性token,从而回避重放攻击。
2、公共的声明
公共的声明可以添加任何的信息，一般添加用户的相关信息或其他业务需要的必要信息.但不建议添加敏感信息，因为该部分在客户端可解密。
3、私有的声明
私有声明是提供者和消费者所共同定义的声明，一般不建议存放敏感信息，因为base64是对称解密的，意味着该部分信息可以归类为明文信息。

（3）、Signature 签名/签证

jwt的第三部分是一个签证信息。
这个部分需要base64加密后的header和base64加密后的payload使用.连接组成的字符串，然后通过header中声明的加密方式进行加盐secret组合加密，然后就构成了jwt的第三部分。密钥secret是保存在服务端的，服务端会根据这个密钥进行生成token和进行验证，所以需要保护好。

二、实现步骤

1、实现拦截器去获取token并验证token

实现HandlerInterceptor接口

（1）、boolean preHandle ()：

预处理回调方法,实现处理器的预处理，第三个参数为响应的处理器,自定义Controller,返回值为true表示继续流程（如调用下一个拦截器或处理器）或者接着执行postHandle()和afterCompletion()；false表示流程中断，不会继续调用其他的拦截器或处理器，中断执行。

（2）、void postHandle()

后处理回调方法，实现处理器的后处理（DispatcherServlet进行视图返回渲染之前进行调用），此时我们可以通过modelAndView（模型和视图对象）对模型数据进行处理或对视图进行处理，modelAndView也可能为null。

（3）、void afterCompletion():

整个请求处理完毕回调方法,该方法也是需要当前对应的Interceptor的preHandle()的返回值为true时才会执行，也就是在DispatcherServlet渲染了对应的视图之后执行。用于进行资源清理。整个请求处理完毕回调方法。如性能监控中我们可以在此记录结束时间并输出消耗时间，还可以进行一些资源清理，类似于try-catch-finally中的finally，但仅调用处理器执行链中。

2、主要流程

1、从 http 请求头中取出 token。
2、判断是否映射到方法。
3、检查是否有passtoken注释，有则跳过认证。
4、检查有没有需要用户登录的注解，有则需要取出并验证。
5、认证通过则可以访问，不通过会报相关错误信息。

3、配置拦截器

1、实现WebMvcConfigurer

InterceptorRegistry内的addInterceptor需要一个实现HandlerInterceptor接口的拦截器实例，addPathPatterns方法用于设置拦截器的过滤路径规则。

三、代码实现

1、添加注解

作用：用于判定哪些接口不需要验证Token，可以直接跳过验证

@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface PassToken {
    boolean required() default true;
}

2、实现HandlerInterceptor

作用：执行JWT验证逻辑

public class AuthenticationInterceptor implements HandlerInterceptor {


    /**
     * 在业务处理器处理请求之前被调用。预处理，可以进行编码、安全控制、权限校验等处理；
     * @param request
     * @param response
     * @param handler
     * @return
     * @throws Exception
     */
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {


        //从http头部取出token
        String token = request.getHeader("token");


        if (!(handler instanceof HandlerMethod)){
            return true;
        }


        //获取拦截的方法
        HandlerMethod handlerMethod = (HandlerMethod) handler;
        Method method = handlerMethod.getMethod();


        //检查该方法是否有passToken注解，有则跳过验证
        if (method.isAnnotationPresent(PassToken.class)){
            PassToken passToken = method.getAnnotation(PassToken.class);
            if (passToken.required()){
                return true;
            }
        }


        //校验Token
        //执行认证
        if (StringUtils.isBlank(token)){
            throw new Exception("token为空");
        }
        // 获取token中的 userId
        String userId;
        try {
            userId = JWT.decode(token).getAudience().get(0);
        } catch (JWTDecodeException e) {
            throw new Exception(e.getMessage());
        }
        //查询用户信息(具体业务查询用户信息)
//                UserJwt userJwt= userJwtService.findUserById(userId);
        UserJwt userJwt=new UserJwt();
        if (Objects.isNull(userJwt)){
            throw new RRException("用户不存在，请重新登录！！！");
        }
        //验证token
        JWTVerifier jwtVerifier = JWT.require(Algorithm.HMAC256(userJwt.getPassWord())).build();
        try {
            jwtVerifier.verify(token);
        } catch (JWTVerificationException e) {
            throw new RRException( e.getMessage());
        }
        return true;
    }


    /**
     * 在业务处理器处理请求执行完成后，生成视图之前执行。后处理（调用了Service并返回ModelAndView，但未进行页面渲染），有机会修改ModelAndView
     * @param request
     * @param response
     * @param handler
     * @param modelAndView
     * @throws Exception
     */
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {


    }


    /**
     * 在DispatcherServlet完全处理完请求后被调用，可用于清理资源等。返回处理（已经渲染了页面）
     * @param request
     * @param response
     * @param handler
     * @param ex
     * @throws Exception
     */
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {


    }
}

3、配置拦截器

实现WebMvcConfigurer 作用：配置拦截哪些请求路径

@Configuration
public class InterceptorConfig implements WebMvcConfigurer {


    /**
     * 配置拦截的请求路径
     * @param registry
     */
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(authenticationInterceptor()).addPathPatterns("/**");
    }


    /**
     * 注入自定义的拦截器规则
     * @return
     */
    @Bean
    public AuthenticationInterceptor authenticationInterceptor() {
        return new AuthenticationInterceptor();
    }
}

4、JWT整合Swagger实现全局验证

image.png

（1）、拦截器取消对swagger资源的拦截

@Configuration
public class InterceptorConfig implements WebMvcConfigurer {


    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(authenticationInterceptor()).addPathPatterns("/**")
        .excludePathPatterns("/swagger-resources/**", "/webjars/**", "/v2/**", "/swagger-ui.html/**");
    }


    @Bean
    public AuthenticationInterceptor authenticationInterceptor() {
        return new AuthenticationInterceptor();
    }
}

（2）、swagger配置验证参数

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket creatRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .pathMapping("/")
                .select()
//                .apis(RequestHandlerSelectors.basePackage("com.demo.user.controller"))
                .apis(RequestHandlerSelectors.withClassAnnotation(RestController.class))
                .paths(PathSelectors.any())
                .build().apiInfo(new ApiInfoBuilder()
                        .title("用户服务")
                        .description("用户基础数据相关.................")
                        .version("1.0")
                        .contact(new Contact("邮件", "http://www.baidu.com", "aaa@gmail.com"))
                        .license("The Apache License")
                        .licenseUrl("http://www.baidu.com")
                        .build())
                .securitySchemes(unifiedAuth())
                .securityContexts(securityContexts());
    }


    private static List<ApiKey> unifiedAuth() {
        List<ApiKey> keys = new ArrayList<>();
        keys.add(new ApiKey("token", "token", "headers"));
        return keys;
    }


    private List<SecurityContext> securityContexts() {
        List<SecurityContext> securityContexts=new ArrayList<>();
        securityContexts.add(
                SecurityContext.builder()
                        .securityReferences(defaultAuth())
                        .forPaths(PathSelectors.regex("^(?!auth).*$"))
                        .build());
        return securityContexts;
    }


    private List<SecurityReference> defaultAuth() {
        AuthorizationScope authorizationScope = new AuthorizationScope("global", "accessEverything");
        AuthorizationScope[] authorizationScopes = new AuthorizationScope[1];
        authorizationScopes[0] = authorizationScope;
        List<SecurityReference> securityReferences=new ArrayList<>();
        securityReferences.add(new SecurityReference("token", authorizationScopes));
        return securityReferences;
    }
}

四、PS

Token工具类

public class TokenUtils {


    /**
     * 生成Token
     * @param user
     * @return
     * Algorithm.HMAC256():使用HS256生成token,密钥则是用户的密码，唯一密钥的话可以保存在服务端。
     * withAudience()存入需要保存在token的信息，这里我把用户ID存入token中
     */
    public static String getToken(UserJwt user){
        String token="";
        token = JWT.create()
                .withAudience(user.getUserId()).
                sign(Algorithm.HMAC256(user.getUserId()));
        return token;
    }


    public static void main(String[] args) {
        String token = getToken(UserJwt.builder().userId("1296657852869406722").build());
        System.out.println(token);
    }
}

注解Annotation简介

@Target:注解的作用目标

  • @Target(ElementType.TYPE)——接口、类、枚举、注解
  • @Target(ElementType.FIELD)——字段、枚举的常量
  • @Target(ElementType.METHOD)——方法
  • @Target(ElementType.PARAMETER)——方法参数
  • @Target(ElementType.CONSTRUCTOR) ——构造函数
  • @Target(ElementType.LOCAL_VARIABLE)——局部变量
  • @Target(ElementType.ANNOTATION_TYPE)——注解
  • @Target(ElementType.PACKAGE)——包

@Retention：注解的保留位置

RetentionPolicy.SOURCE:这种类型的Annotations只在源代码级别保留,编译时就会被忽略,在class字节码文件中不包含
RetentionPolicy.CLASS:这种类型的Annotations编译时被保留,默认的保留策略,在class文件中存在,但JVM将会忽略,运行时无法获得。
RetentionPolicy.RUNTIME:这种类型的Annotations将被JVM保留,所以他们能在运行时被JVM或其他使用反射机制的代码所读取和使用。
@Document：说明该注解将被包含在javadoc中
@Inherited：说明子类可以继承父类中的该注解

avatar
文章
阅读
粉丝