乐趣区

关于spring:SpringBoot系列之拦截器注入Bean的几种姿势

jiezi

之前介绍过一篇拦截器的根本应用姿态:【WEB 系列】SpringBoot 之拦截器 Interceptor 应用姿态介绍

在 SpringBoot 中，通过实现 WebMvcConfigurer 的addInterceptors办法来注册拦截器，那么当咱们的拦截器中心愿应用 Bean 时，能够怎么整？

<!– more –>

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，有趣味的小伙伴能够尝试一下

III. 不能错过的源码和相干知识点

0. 我的项目

相干博文：

  • SpringBoot 之拦截器 Interceptor 应用姿态介绍

我的项目源码：

  • 工程：https://github.com/liuyueyi/spring-boot-demo
  • 源码：https://github.com/liuyueyi/spring-boot-demo/tree/master/spring-boot/213-web-interceptor

1. 微信公众号: 一灰灰 Blog

尽信书则不如，以上内容，纯属一家之言，因集体能力无限，不免有疏漏和谬误之处，如发现 bug 或者有更好的倡议，欢送批评指正，不吝感谢

上面一灰灰的集体博客，记录所有学习和工作中的博文，欢送大家前去逛逛

  • 一灰灰 Blog 集体博客 https://blog.hhui.top
  • 一灰灰 Blog-Spring 专题博客 http://spring.hhui.top

退出移动版