SpringBoot系列之拦截器注入Bean的几种姿势

简介: 在SpringBoot中,通过实现WebMvcConfigurer的addInterceptors方法来注册拦截器,那么当我们的拦截器中希望使用Bean时,可以怎么整?


image.png


之前介绍过一篇拦截器的基本使用姿势: 【WEB系列】SpringBoot之拦截器Interceptor使用姿势介绍


在SpringBoot中,通过实现WebMvcConfigureraddInterceptors方法来注册拦截器,那么当我们的拦截器中希望使用Bean时,可以怎么整?


I. 项目搭建



本项目借助SpringBoot 2.2.1.RELEASE +  maven 3.5.3 + IDEA进行开发

开一个web服务用于测试


<dependencies>
    <!-- 邮件发送的核心依赖 -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
</dependencies>
复制代码


II.拦截器



实现拦截器比较简单,实现HandlerInterceptor接口就可以了,比如我们实现一个基础的权限校验的拦截器,通过从请求头中获取参数,当满足条件时表示通过


0.安全校验拦截器


@Slf4j
public class SecurityInterceptor implements HandlerInterceptor {
    /**
     * 在执行具体的Controller方法之前调用
     *
     * @param request
     * @param response
     * @param handler
     * @return
     * @throws Exception
     */
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        // 一个简单的安全校验,要求请求头中必须包含 req-name : yihuihui
        String header = request.getHeader("req-name");
        if ("yihuihui".equals(header)) {
            return true;
        }
        log.info("请求头错误: {}", header);
        return false;
    }
    /**
     * controller执行完毕之后被调用,在 DispatcherServlet 进行视图返回渲染之前被调用,
     * 所以我们可以在这个方法中对 Controller 处理之后的 ModelAndView 对象进行操作。
     * <p>
     * preHandler 返回false,这个也不会执行
     *
     * @param request
     * @param response
     * @param handler
     * @param modelAndView
     * @throws Exception
     */
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        log.info("执行完毕!");
        response.setHeader("res", "postHandler");
    }
    /**
     * 方法需要在当前对应的 Interceptor 类的 preHandle 方法返回值为 true 时才会执行。
     * 顾名思义,该方法将在整个请求结束之后,也就是在 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 {
        log.info("回收");
    }
}
复制代码


接下来是这个拦截器的注册

@RestController
@SpringBootApplication
public class Application implements WebMvcConfigurer {
    public static void main(String[] args) {
        SpringApplication.run(Application.class);
    }
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new SecurityInterceptor()).addPathPatterns("/**");
    }
    @GetMapping(path = "show")
    public String show() {
        return UUID.randomUUID().toString();
    }
}
复制代码


接下来问题来了,我们希望这个用于校验的值放在配置文件中,不是在代码中写死,可以怎么整?


1. 指定配置


在项目资源文件中,添加一个配置用于表示校验的请求头

application.yml


security:
  check: yihuihui
复制代码


配置的读取,可以使用 Envrioment.getProperty(),也可以使用 @Value注解

但是注意上面的拦截器注册,直接构造的一个方法,添加到InterceptorRegistry,在拦截器中,即使添加@Value@Autowired注解也不会生效(归根结底就是这个拦截器并没有受Spring上下文管理)


2. 拦截器注入Bean


那么在拦截器中如果想使用Spring容器中的bean对象,可以怎么整?


2.1 新增静态的ApplicationContext容器类


一个可行的方法就是在项目中维护一个工具类,其内部持有ApplicationContext的引用,通过这个工具类来访问bean对象


@Component
public class SpringUtil implements ApplicationContextAware, EnvironmentAware {
    private static ApplicationContext applicationContext;
    private static Environment environment;
    @Override
    public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
        SpringUtil.applicationContext = applicationContext;
    }
    @Override
    public void setEnvironment(Environment environment) {
        SpringUtil.environment = environment;
    }
    public static <T> T getBean(Class<T> clz) {
        return applicationContext.getBean(clz);
    }
    public static String getProperty(String key) {
        return environment.getProperty(key);
    }
}
复制代码


基于此,在拦截器中,如果想要获取配置,直接改成下面这样既可


@Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        // 一个简单的安全校验,要求请求头中必须包含 req-name : yihuihui
        String header = request.getHeader("req-name");
        if (Objects.equals(SpringUtil.getProperty("security.check"), header)) {
            return true;
        }
        log.info("请求头错误: {}", header);
        return false;
    }
复制代码


这种方式来访问bean,优点就是通用性更强,适用范围广


2.2 拦截器注册为bean


上面的方法虽然可行,但是看起来总归不那么优雅,那么有办法直接将拦截器声明为bean对象,然后直接使用@Autowired注解来注入依赖的bean么


当然是可行的,注意bean注册的几种姿势,我们这里采用下面这种方式来注册拦截器

@Bean
public SecurityInterceptor securityInterceptor() {
    return new SecurityInterceptor();
}
@Override
public void addInterceptors(InterceptorRegistry registry) {
    registry.addInterceptor(securityInterceptor()).addPathPatterns("/**");
}
复制代码


上面通过配置类的方式来声明bean,然后在注册拦截器的地方,不直接使用构造方法来创建实例;上面的用法表示是使用spring的bean容器来注册,基于这种方式来实现拦截器的bean声明


因此在拦截器中就可以注入其他依赖了


测试就比较简单了,如下

yihui@M-162D9NNES031U:SpringBlog git:(master) $ curl 'http://127.0.0.1:8080/show' -H 'req-name:yihuihui' -i
HTTP/1.1 200
Content-Type: text/plain;charset=UTF-8
Content-Length: 36
Date: Mon, 15 Nov 2021 10:56:30 GMT
6610e593-7c60-4dab-97b7-cc671c27762d%
复制代码


3. 小结


本文虽说介绍的是如何在拦截器中注入bean,实际上的知识点依然是创建bean对象的几种姿势;上面提供了两种常见的方式,一个SpringUtil持有SpringContext,然后借助这个工具类来访问bean对象,巧用它可以省很多事;


另外一个就是将拦截器声明为bean,这种方式主要需要注意的点是拦截器的注册时,不能直接new 拦截器;当然bean的创建,除了上面这个方式之外,还有其他的case,有兴趣的小伙伴可以尝试一下



相关文章
|
2月前
|
Java 容器
如何在SpringBoot项目中使用过滤器和拦截器
过滤器和拦截器是日常开发中常用技术,用于对特定请求进行增强处理,如插入自定义代码以实现特定功能。过滤器在请求到达 `servlet` 前执行,而拦截器在请求到达 `servlet` 后执行。`SpringBoot` 中的拦截器依赖于 `SpringBoot` 容器,过滤器则由 `servlet` 提供。通过实现 `Filter` 接口并重写 `doFilter()` 方法可实现过滤器;通过实现 `HandlerInterceptor` 接口并重写相应方法可实现拦截器。两者的主要区别在于执行时机的不同,需根据具体场景选择使用。
158 4
如何在SpringBoot项目中使用过滤器和拦截器
|
14天前
|
架构师 Java 开发者
得物面试:Springboot自动装配机制是什么?如何控制一个bean 是否加载,使用什么注解?
在40岁老架构师尼恩的读者交流群中,近期多位读者成功获得了知名互联网企业的面试机会,如得物、阿里、滴滴等。然而,面对“Spring Boot自动装配机制”等核心面试题,部分读者因准备不足而未能顺利通过。为此,尼恩团队将系统化梳理和总结这一主题,帮助大家全面提升技术水平,让面试官“爱到不能自已”。
得物面试:Springboot自动装配机制是什么?如何控制一个bean 是否加载,使用什么注解?
|
26天前
|
Java Spring 容器
Springboot3.2.1搞定了类Service和bean注解同名同类型问题修复
这篇文章讨论了在Spring Boot 3.2.1版本中,同名同类型的bean和@Service注解类之间冲突的问题得到了解决,之前版本中同名bean会相互覆盖,但不会在启动时报错,而在配置文件中设置`spring.main.allow-bean-definition-overriding=true`可以解决这个问题。
60 0
Springboot3.2.1搞定了类Service和bean注解同名同类型问题修复
|
2月前
|
Java Spring
springboot 集成 swagger 2.x 和 3.0 以及 Failed to start bean ‘documentationPluginsBootstrapper‘问题的解决
本文介绍了如何在Spring Boot项目中集成Swagger 2.x和3.0版本,并提供了解决Swagger在Spring Boot中启动失败问题“Failed to start bean ‘documentationPluginsBootstrapper’; nested exception is java.lang.NullPointerEx”的方法,包括配置yml文件和Spring Boot版本的降级。
springboot 集成 swagger 2.x 和 3.0 以及 Failed to start bean ‘documentationPluginsBootstrapper‘问题的解决
|
21天前
|
Java Shell C++
Springboot加载注入bean的方式
本文详细介绍了Spring Boot中Bean的装配方法。首先讲解了使用@Component、@Service、@Controller、@Repository等注解声明Bean的方式,并解释了这些注解之间的关系及各自适用的层次。接着介绍了通过@Configuration和@Bean注解定义Bean的方法,展示了其灵活性和定制能力。最后讨论了@Component与@Bean的区别,并提供了在Spring Boot应用中装配依赖包中Bean的三种方法:使用@ComponentScan注解扫描指定包、使用@Import注解导入特定Bean以及在spring.factories文件中配置Bean。
|
4月前
|
Java Spring 容器
Spring Boot 启动源码解析结合Spring Bean生命周期分析
Spring Boot 启动源码解析结合Spring Bean生命周期分析
96 11
|
3月前
|
缓存 Java 数据库连接
Spring Boot 资源文件属性配置,紧跟技术热点,为你的应用注入灵动活力!
【8月更文挑战第29天】在Spring Boot开发中,资源文件属性配置至关重要,它让开发者能灵活定制应用行为而不改动代码,极大提升了可维护性和扩展性。Spring Boot支持多种配置文件类型,如`application.properties`和`application.yml`,分别位于项目的resources目录下。`.properties`文件采用键值对形式,而`yml`文件则具有更清晰的层次结构,适合复杂配置。此外,Spring Boot还支持占位符引用和其他外部来源的属性值,便于不同环境下覆盖默认配置。通过合理配置,应用能快速适应各种环境与需求变化。
41 0
|
3月前
|
安全 Java 开发者
开发者必看!@Resource与private final的较量,Spring Boot注入技巧大揭秘,你不可不知的细节!
【8月更文挑战第29天】Spring Boot作为热门Java框架,其依赖注入机制备受关注。本文通过对比@Resource(JSR-250规范)和@Autowired(Spring特有),并结合private final声明的字段注入,详细探讨了两者的区别与应用场景。通过示例代码展示了@Resource按名称注入及@Autowired按类型注入的特点,并分析了它们在注入时机、依赖性、线程安全性和单一职责原则方面的差异,帮助开发者根据具体需求选择最合适的注入策略。
81 0
|
4月前
|
消息中间件 Java Kafka
Spring boot 自定义kafkaTemplate的bean实例进行生产消息和发送消息
Spring boot 自定义kafkaTemplate的bean实例进行生产消息和发送消息
165 5
|
3月前
|
Java Spring 容器
Java SpringBoot 中,动态执行 bean 对象中的方法
Java SpringBoot 中,动态执行 bean 对象中的方法
37 0