Spring(SpringBoot)--解决拦截器中注入Bean失败的问题

原文网址：Spring(SpringBoot)--解决拦截器中注入Bean失败的问题_IT利刃出鞘的博客-CSDN博客
简介

说明
        本文用示例介绍如何解决拦截器中注入Bean失败的问题。
场景
        Token拦截器中需要用@Autowired注入JavaJwtUtil类，结果发现注入的JavaJwtUtil为Null。
原因
        拦截器的配置类是以new JwtInterceptor的方式使用的，那么这个JwtInterceptor不受Spring管理。因此，里边@Autowired注入JavaJwtUtil是不会注入进去的。
问题重现

代码

application.yml

1. server:
2.   port: 8080
3. spring:
4.   application:
5.     name: springboot-jwt
6. config:
7.   jwt:
8.     # 密钥
9.     secret: abcd1234
10.     # token过期时间（5分钟）。单位：毫秒.
11.     expire: 300000

复制代码

拦截器配置

1. @Configuration
2. public class InterceptorConfig implements WebMvcConfigurer {
4.     @Override
5.     public void addInterceptors(InterceptorRegistry registry) {
6.         registry.addInterceptor(new JwtInterceptor());
7.     }
8. }

复制代码

拦截器

1. package com.example.demo.interceptor;
3. import com.example.demo.util.JavaJwtUtil;
4. import lombok.extern.slf4j.Slf4j;
5. import org.springframework.beans.BeansException;
6. import org.springframework.beans.factory.annotation.Autowired;
7. import org.springframework.context.ApplicationContext;
8. import org.springframework.context.ApplicationContextAware;
9. import org.springframework.stereotype.Component;
10. import org.springframework.util.StringUtils;
11. import org.springframework.web.method.HandlerMethod;
12. import org.springframework.web.servlet.HandlerInterceptor;
14. import javax.annotation.PostConstruct;
15. import javax.servlet.http.HttpServletRequest;
16. import javax.servlet.http.HttpServletResponse;
17. import java.util.Arrays;
18. import java.util.List;
20. @Slf4j
21. @Component
22. public class JwtInterceptor implements HandlerInterceptor {
23.     @Autowired
24.     JavaJwtUtil javaJwtUtil;
26.     List<String> whiteList = Arrays.asList(
27.             "/auth/login",
28.             "/error"
29.     );
31.     @Override
32.     public boolean preHandle(HttpServletRequest request, HttpServletResponse response,
33.                              Object handler) throws Exception {
34.         // 如果不是映射到方法直接通过
35.         if (!(handler instanceof HandlerMethod)) {
36.             return true;
37.         }
40.         //放过不需要验证的页面。
41.         String uri = request.getRequestURI();
42.         if (whiteList.contains(uri)) {
43.             return true;
44.         }
46.         // 头部和参数都查看一下是否有token
47.         String token = request.getHeader("token");
48.         if (StringUtils.isEmpty(token)) {
49.             token = request.getParameter("token");
50.             if (StringUtils.isEmpty(token)) {
51.                 throw new RuntimeException("token是空的");
52.             }
53.         }
55.         if (!javaJwtUtil.verifyToken(token)) {
56.             log.error("token无效");
57.             return false;
58.         }
60.         String userId = javaJwtUtil.getUserIdByToken(token);
61.         log.info("userId:" + userId);
62.         String userName = javaJwtUtil.getUserNameByToken(token);
63.         log.info("userName:" + userName);
64.         return true;
65.     }
66. }

复制代码

Jwt工具类

1. package com.example.demo.util;
3. import com.auth0.jwt.JWT;
4. import com.auth0.jwt.JWTVerifier;
5. import com.auth0.jwt.algorithms.Algorithm;
6. import com.auth0.jwt.exceptions.JWTDecodeException;
7. import com.auth0.jwt.exceptions.JWTVerificationException;
8. import com.auth0.jwt.interfaces.DecodedJWT;
9. import org.springframework.beans.factory.annotation.Value;
10. import org.springframework.stereotype.Component;
12. import java.util.Date;
14. @Component
15. public class JavaJwtUtil {
16.     //过期时间
17.     @Value("${config.jwt.expire}")
18.     private Long EXPIRE_TIME;
20.     //密钥
21.     @Value("${config.jwt.secret}")
22.     private String SECRET;
24.     // 生成Token，五分钟后过期
25.     public String createToken(String userId) {
26.         try {
27.             Date date = new Date(System.currentTimeMillis() + EXPIRE_TIME);
28.             Algorithm algorithm = Algorithm.HMAC256(SECRET);
29.             return JWT.create()
30.                     // 将 user id 保存到 token 里面
31.                     .withAudience(userId)
32.                     // date之后，token过期
33.                     .withExpiresAt(date)
34.                     // token 的密钥
35.                     .sign(algorithm);
36.         } catch (Exception e) {
37.             return null;
38.         }
39.     }
41.     // 根据token获取userId
42.     public String getUserIdByToken(String token) {
43.         try {
44.             String userId = JWT.decode(token).getAudience().get(0);
45.             return userId;
46.         } catch (JWTDecodeException e) {
47.             return null;
48.         }
49.     }
51.     // 根据token获取userName
52.     public String getUserNameByToken(String token) {
53.         try {
54.             String userName = JWT.decode(token).getSubject();
55.             return userName;
56.         } catch (JWTDecodeException e) {
57.             return null;
58.         }
59.     }
61.     //校验token
62.     public boolean verifyToken(String token) {
63.         try {
64.             Algorithm algorithm = Algorithm.HMAC256(SECRET);
65.             JWTVerifier verifier = JWT.require(algorithm)
66.                     // .withIssuer("auth0")
67.                     // .withClaim("username", username)
68.                     .build();
69.             DecodedJWT jwt = verifier.verify(token);
70.             return true;
71.         } catch (JWTVerificationException exception) {
72. //            throw new RuntimeException("token 无效，请重新获取");
73.             return false;
74.         }
75.     }
76. }

复制代码

 Controller

1. package com.example.demo.controller;
3. import com.example.demo.util.JavaJwtUtil;
4. import org.springframework.beans.factory.annotation.Autowired;
5. import org.springframework.web.bind.annotation.RequestMapping;
6. import org.springframework.web.bind.annotation.RestController;
8. @RestController
9. @RequestMapping("/auth")
10. public class AuthController {
11.     @Autowired
12.     JavaJwtUtil javaJwtUtil;
14.     @RequestMapping("/login")
15.     public String login() {
16.         // 验证userName，password和数据库中是否一致，如不一致，直接返回失败
17.         // 通过userName，password从数据库中获取userId
19.         String userId = 5 + "";
20.         String token = javaJwtUtil.createToken(userId);
21.         System.out.println("token:" + token);
22.         return token;
23.     }
25.     //需要token验证
26.     @RequestMapping("/info")
27.     public String info() {
28.         return  "验证通过";
29.     }
30. }

复制代码

测试

访问：http://localhost:8080/auth/login 
前端结果：一串token字符串
访问：http://localhost:8080/auth/info(以token作为header或者参数）
后端结果

1. java.lang.NullPointerException: null
2.         at com.example.demo.interceptor.JwtInterceptor.preHandle(JwtInterceptor.java:55) ~[main/:na]

复制代码

解决方案

方案简述
配置类中将new JwtInterceptor()改为Bean的方式
配置类

1. package com.example.demo.interceptor;
3. import org.springframework.context.annotation.Bean;
4. import org.springframework.context.annotation.Configuration;
5. import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
6. import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
8. @Configuration
9. public class InterceptorConfig implements WebMvcConfigurer {
11.     @Override
12.     public void addInterceptors(InterceptorRegistry registry) {
13.         registry.addInterceptor(getJwtInterceptor());
14.     }
16.     @Bean
17.     JwtInterceptor getJwtInterceptor() {
18.         return new JwtInterceptor();
19.     }
20. }

复制代码

拦截器（此时无需@Component）

1. package com.example.demo.interceptor;
3. import com.example.demo.util.JavaJwtUtil;
4. import lombok.extern.slf4j.Slf4j;
5. import org.springframework.beans.factory.annotation.Autowired;
6. import org.springframework.util.StringUtils;
7. import org.springframework.web.method.HandlerMethod;
8. import org.springframework.web.servlet.HandlerInterceptor;
10. import javax.servlet.http.HttpServletRequest;
11. import javax.servlet.http.HttpServletResponse;
12. import java.util.Arrays;
13. import java.util.List;
15. @Slf4j
16. public class JwtInterceptor implements HandlerInterceptor {
17.     @Autowired
18.     JavaJwtUtil javaJwtUtil;
20.     List<String> whiteList = Arrays.asList(
21.             "/auth/login",
22.             "/error"
23.     );
25.     @Override
26.     public boolean preHandle(HttpServletRequest request, HttpServletResponse response,
27.                              Object handler) throws Exception {
28.         // 如果不是映射到方法直接通过
29.         if (!(handler instanceof HandlerMethod)) {
30.             return true;
31.         }
34.         //放过不需要验证的页面。
35.         String uri = request.getRequestURI();
36.         if (whiteList.contains(uri)) {
37.             return true;
38.         }
40.         // 头部和参数都查看一下是否有token
41.         String token = request.getHeader("token");
42.         if (StringUtils.isEmpty(token)) {
43.             token = request.getParameter("token");
44.             if (StringUtils.isEmpty(token)) {
45.                 throw new RuntimeException("token是空的");
46.             }
47.         }
49.         if (!javaJwtUtil.verifyToken(token)) {
50.             log.error("token无效");
51.             return false;
52.         }
54.         String userId = javaJwtUtil.getUserIdByToken(token);
55.         log.info("userId:" + userId);
56.         String userName = javaJwtUtil.getUserNameByToken(token);
57.         log.info("userName:" + userName);
58.         return true;
59.     }
60. }

复制代码

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！