• 聊聊Spring中最常用的11个扩展点

    前言

    我们一说到spring，可能第一个想到的是 IOC（控制反转） 和 AOP（面向切面编程）。

    没错，它们是spring的基石，得益于它们的优秀设计，使得spring能够从众多优秀框架中脱颖而出。

    除此之外，我们在使用spring的过程中，有没有发现它的扩展能力非常强。由于这个优势的存在，让spring拥有强大的包容能力，让很多第三方应用能够轻松投入spring的怀抱。比如：rocketmq、mybatis、redis等。

    今天跟大家一起聊聊，在Spring中最常用的11个扩展点。

    1.自定义拦截器

    spring mvc拦截器根spring拦截器相比，它里面能够获取HttpServletRequest和HttpServletResponse等web对象实例。

    spring mvc拦截器的顶层接口是：HandlerInterceptor，包含三个方法：

    • preHandle 目标方法执行前执行
    • postHandle 目标方法执行后执行
    • afterCompletion 请求完成时执行

    为了方便我们一般情况会用HandlerInterceptor接口的实现类HandlerInterceptorAdapter类。

    假如有权限认证、日志、统计的场景，可以使用该拦截器。

    第一步，继承HandlerInterceptorAdapter类定义拦截器：

    1. public class AuthInterceptor extends HandlerInterceptorAdapter {
    2.  
    3.     @Override
    4.     public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
    5.             throws Exception {
    6.         String requestUrl = request.getRequestURI();
    7.         if (checkAuth(requestUrl)) {
    8.             return true;
    9.         }
    10.  
    11.         return false;
    12.     }
    13.  
    14.     private boolean checkAuth(String requestUrl) {
    15.         System.out.println("===权限校验===");
    16.         return true;
    17.     }
    18. }
    19. 复制代码

    第二步，将该拦截器注册到spring容器：

    1. @Configuration
    2. public class WebAuthConfig extends WebMvcConfigurerAdapter {
    3.  
    4.     @Bean
    5.     public AuthInterceptor getAuthInterceptor() {
    6.         return new AuthInterceptor();
    7.     }
    8.  
    9.     @Override
    10.     public void addInterceptors(InterceptorRegistry registry) {
    11.         registry.addInterceptor(new AuthInterceptor());
    12.     }
    13. }
    14. 复制代码

    第三步，在请求接口时spring mvc通过该拦截器，能够自动拦截该接口，并且校验权限。

    2.获取Spring容器对象

    在我们日常开发中，经常需要从Spring容器中获取Bean，但你知道如何获取Spring容器对象吗？

    2.1 BeanFactoryAware接口

    1. @Service
    2. public class PersonService implements BeanFactoryAware {
    3.     private BeanFactory beanFactory;
    4.  
    5.     @Override
    6.     public void setBeanFactory(BeanFactory beanFactory) throws BeansException {
    7.         this.beanFactory = beanFactory;
    8.     }
    9.  
    10.     public void add() {
    11.         Person person = (Person) beanFactory.getBean("person");
    12.     }
    13. }
    14. 复制代码

    实现BeanFactoryAware接口，然后重写setBeanFactory方法，就能从该方法中获取到spring容器对象。

    2.2 ApplicationContextAware接口

    1. @Service
    2. public class PersonService2 implements ApplicationContextAware {
    3.     private ApplicationContext applicationContext;
    4.  
    5.     @Override
    6.     public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
    7.         this.applicationContext = applicationContext;
    8.     }
    9.  
    10.     public void add() {
    11.         Person person = (Person) applicationContext.getBean("person");
    12.     }
    13. }
    14. 复制代码

    实现ApplicationContextAware接口，然后重写setApplicationContext方法，也能从该方法中获取到spring容器对象。

    2.3 ApplicationListener接口

    1. @Service
    2. public class PersonService3 implements ApplicationListener<ContextRefreshedEvent> {
    3.     private ApplicationContext applicationContext;
    4.     @Override
    5.     public void onApplicationEvent(ContextRefreshedEvent event) {
    6.         applicationContext = event.getApplicationContext();
    7.     }
    8.  
    9.     public void add() {
    10.         Person person = (Person) applicationContext.getBean("person");
    11.     }
    12. }
    13. 复制代码

    3.全局异常处理

    以前我们在开发接口时，如果出现异常，为了给用户一个更友好的提示，例如：

    1. @RequestMapping("/test")
    2. @RestController
    3. public class TestController {
    4.  
    5.     @GetMapping("/add")
    6.     public String add() {
    7.         int a = 10 / 0;
    8.         return "成功";
    9.     }
    10. }
    11. 复制代码

    如果不做任何处理请求add接口结果直接报错：

    what？用户能直接看到错误信息？

    这种交互方式给用户的体验非常差，为了解决这个问题，我们通常会在接口中捕获异常：

    1. @GetMapping("/add")
    2. public String add() {
    3.     String result = "成功";
    4.     try {
    5.         int a = 10 / 0;
    6.     } catch (Exception e) {
    7.         result = "数据异常";
    8.     }
    9.     return result;
    10. }
    11. 复制代码

    接口改造后，出现异常时会提示：“数据异常”，对用户来说更友好。

    看起来挺不错的，但是有问题。。。

    如果只是一个接口还好，但是如果项目中有成百上千个接口，都要加上异常捕获代码吗？

    答案是否定的，这时全局异常处理就派上用场了：RestControllerAdvice。

    1. @RestControllerAdvice
    2. public class GlobalExceptionHandler {
    3.  
    4.     @ExceptionHandler(Exception.class)
    5.     public String handleException(Exception e) {
    6.         if (e instanceof ArithmeticException) {
    7.             return "数据异常";
    8.         }
    9.         if (e instanceof Exception) {
    10.             return "服务器内部异常";
    11.         }
    12.         retur nnull;
    13.     }
    14. }
    15. 复制代码

    只需在handleException方法中处理异常情况，业务接口中可以放心使用，不再需要捕获异常（有人统一处理了）。真是爽歪歪。

    4.类型转换器

    spring目前支持3中类型转换器：

    • Converter：将 S 类型对象转为 T 类型对象
    • ConverterFactory：将 S 类型对象转为 R 类型及子类对象
    • GenericConverter：它支持多个source和目标类型的转化，同时还提供了source和目标类型的上下文，这个上下文能让你实现基于属性上的注解或信息来进行类型转换。

    这3种类型转换器使用的场景不一样，我们以Converter为例。假如：接口中接收参数的实体对象中，有个字段的类型是Date，但是实际传参的是字符串类型：2021-01-03 10:20:15，要如何处理呢？

    第一步，定义一个实体User：

    1. @Data
    2. public class User {
    3.  
    4.     private Long id;
    5.     private String name;
    6.     private Date registerDate;
    7. }
    8. 复制代码

    第二步，实现Converter接口：

    1. public class DateConverter implements Converter<String, Date> {
    2.  
    3.     private SimpleDateFormat simpleDateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
    4.  
    5.     @Override
    6.     public Date convert(String source) {
    7.         if (source != null && !"".equals(source)) {
    8.             try {
    9.                 simpleDateFormat.parse(source);
    10.             } catch (ParseException e) {
    11.                 e.printStackTrace();
    12.             }
    13.         }
    14.         return null;
    15.     }
    16. }
    17. 复制代码

    第三步，将新定义的类型转换器注入到spring容器中：

    1. @Configuration
    2. public class WebConfig extends WebMvcConfigurerAdapter {
    3.  
    4.     @Override
    5.     public void addFormatters(FormatterRegistry registry) {
    6.         registry.addConverter(new DateConverter());
    7.     }
    8. }
    9. 复制代码

    第四步，调用接口

    1. @RequestMapping("/user")
    2. @RestController
    3. public class UserController {
    4.  
    5.     @RequestMapping("/save")
    6.     public String save(@RequestBody User user) {
    7.         return "success";
    8.     }
    9. }
    10. 复制代码

    请求接口时User对象中registerDate字段会被自动转换成Date类型。

    5.导入配置

    有时我们需要在某个配置类中引入另外一些类，被引入的类也加到spring容器中。这时可以使用@Import注解完成这个功能。

    如果你看过它的源码会发现，引入的类支持三种不同类型。

    但是我认为最好将普通类和@Configuration注解的配置类分开讲解，所以列了四种不同类型：

    5.1 普通类

    这种引入方式是最简单的，被引入的类会被实例化bean对象。

    1. public class A {
    2. }
    3.  
    4. @Import(A.class)
    5. @Configuration
    6. public class TestConfiguration {
    7. }
    8. 复制代码

    通过@Import注解引入A类，spring就能自动实例化A对象，然后在需要使用的地方通过@Autowired注解注入即可：

    1. @Autowired
    2. private A a;
    3. 复制代码

    是不是挺让人意外的？不用加@Bean注解也能实例化bean。

    5.2 配置类

    这种引入方式是最复杂的，因为@Configuration注解还支持多种组合注解，比如：

    • @Import
    • @ImportResource
    • @PropertySource等。
    1. public class A {
    2. }
    3.  
    4. public class B {
    5. }
    6.  
    7. @Import(B.class)
    8. @Configuration
    9. public class AConfiguration {
    10.  
    11.     @Bean
    12.     public A a() {
    13.         return new A();
    14.     }
    15. }
    16.  
    17. @Import(AConfiguration.class)
    18. @Configuration
    19. public class TestConfiguration {
    20. }
    21. 复制代码

    通过@Import注解引入@Configuration注解的配置类，会把该配置类相关@Import、@ImportResource、@PropertySource等注解引入的类进行递归，一次性全部引入。

    5.3 ImportSelector

    这种引入方式需要实现ImportSelector接口：

    1. public class AImportSelector implements ImportSelector {
    2.  
    3. private static final String CLASS_NAME = "com.sue.cache.service.test13.A";
    4.     
    5.  public String[] selectImports(AnnotationMetadata importingClassMetadata) {
    6.         return new String[]{CLASS_NAME};
    7.     }
    8. }
    9.  
    10. @Import(AImportSelector.class)
    11. @Configuration
    12. public class TestConfiguration {
    13. }
    14. 复制代码

    这种方式的好处是selectImports方法返回的是数组，意味着可以同时引入多个类，还是非常方便的。

    5.4 ImportBeanDefinitionRegistrar

    这种引入方式需要实现
    ImportBeanDefinitionRegistrar接口：

    1. public class AImportBeanDefinitionRegistrar implements ImportBeanDefinitionRegistrar {
    2.     @Override
    3.     public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {
    4.         RootBeanDefinition rootBeanDefinition = new RootBeanDefinition(A.class);
    5.         registry.registerBeanDefinition("a", rootBeanDefinition);
    6.     }
    7. }
    8.  
    9. @Import(AImportBeanDefinitionRegistrar.class)
    10. @Configuration
    11. public class TestConfiguration {
    12. }
    13. 复制代码

    这种方式是最灵活的，能在registerBeanDefinitions方法中获取到BeanDefinitionRegistry容器注册对象，可以手动控制BeanDefinition的创建和注册。

    6.项目启动时

    有时候我们需要在项目启动时定制化一些附加功能，比如：加载一些系统参数、完成初始化、预热本地缓存等，该怎么办呢？

    好消息是springboot提供了：

    • CommandLineRunner
    • ApplicationRunner

    这两个接口帮助我们实现以上需求。

    它们的用法还是挺简单的，以ApplicationRunner接口为例：

    1. @Component
    2. public class TestRunner implements ApplicationRunner {
    3.  
    4.     @Autowired
    5.     private LoadDataService loadDataService;
    6.  
    7.     public void run(ApplicationArguments args) throws Exception {
    8.         loadDataService.load();
    9.     }
    10. }
    11. 复制代码

    实现ApplicationRunner接口，重写run方法，在该方法中实现自己定制化需求。

    如果项目中有多个类实现了ApplicationRunner接口，他们的执行顺序要怎么指定呢？

    答案是使用@Order(n)注解，n的值越小越先执行。当然也可以通过@Priority注解指定顺序。

    7.修改BeanDefinition

    Spring IOC在实例化Bean对象之前，需要先读取Bean的相关属性，保存到BeanDefinition对象中，然后通过BeanDefinition对象，实例化Bean对象。

    如果想修改BeanDefinition对象中的属性，该怎么办呢？

    答：我们可以实现BeanFactoryPostProcessor接口。

    1. @Component
    2. public class MyBeanFactoryPostProcessor implements BeanFactoryPostProcessor {
    3.     
    4.     @Override
    5.     public void postProcessBeanFactory(ConfigurableListableBeanFactory configurableListableBeanFactory) throws BeansException {
    6.         DefaultListableBeanFactory defaultListableBeanFactory = (DefaultListableBeanFactory) configurableListableBeanFactory;
    7.         BeanDefinitionBuilder beanDefinitionBuilder = BeanDefinitionBuilder.genericBeanDefinition(User.class);
    8.         beanDefinitionBuilder.addPropertyValue("id", 123);
    9.         beanDefinitionBuilder.addPropertyValue("name", "苏三说技术");
    10.         defaultListableBeanFactory.registerBeanDefinition("user", beanDefinitionBuilder.getBeanDefinition());
    11.     }
    12. }
    13. 复制代码

    在postProcessBeanFactory方法中，可以获取BeanDefinition的相关对象，并且修改该对象的属性。

    8.初始化Bean前后

    有时，你想在初始化Bean前后，实现一些自己的逻辑。

    这时可以实现：BeanPostProcessor接口。

    该接口目前有两个方法：

    • postProcessBeforeInitialization 该在初始化方法之前调用。
    • postProcessAfterInitialization 该方法再初始化方法之后调用。

    例如：

    1. @Component
    2. public class MyBeanPostProcessor implements BeanPostProcessor {
    3.  
    4.     @Override
    5.     public Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException {
    6.         if (bean instanceof User) {
    7.             ((User) bean).setUserName("苏三说技术");
    8.         }
    9.         return bean;
    10.     }
    11. }
    12. 复制代码

    如果spring中存在User对象，则将它的userName设置成：苏三说技术。

    其实，我们经常使用的注解，比如：@Autowired、@Value、@Resource、@PostConstruct等，是通过
    AutowiredAnnotationBeanPostProcessor和CommonAnnotationBeanPostProcessor实现的。

    9.初始化方法

    目前spring中使用比较多的初始化bean的方法有：

    1. 使用@PostConstruct注解
    2. 实现InitializingBean接口

    9.1 使用@PostConstruct注解

    1. @Service
    2. public class AService {
    3.     @PostConstruct
    4.     public void init() {
    5.         System.out.println("===初始化===");
    6.     }
    7. }
    8. 复制代码

    在需要初始化的方法上增加@PostConstruct注解，这样就有初始化的能力。

    9.2 实现InitializingBean接口

    1. @Service
    2. public class BService implements InitializingBean {
    3.  
    4.     @Override
    5.     public void afterPropertiesSet() throws Exception {
    6.         System.out.println("===初始化===");
    7.     }
    8. }
    9. 复制代码

    实现InitializingBean接口，重写afterPropertiesSet方法，该方法中可以完成初始化功能。

    10.关闭容器前

    有时候，我们需要在关闭spring容器前，做一些额外的工作，比如：关闭资源文件等。

    这时可以实现DisposableBean接口，并且重写它的destroy方法：

    1. @Service
    2. public class DService implements InitializingBean, DisposableBean {
    3.  
    4.     @Override
    5.     public void destroy() throws Exception {
    6.         System.out.println("DisposableBean destroy");
    7.     }
    8.  
    9.     @Override
    10.     public void afterPropertiesSet() throws Exception {
    11.         System.out.println("InitializingBean afterPropertiesSet");
    12.     }
    13. }
    14. 复制代码

    这样spring容器销毁前，会调用该destroy方法，做一些额外的工作。

    通常情况下，我们会同时实现InitializingBean和DisposableBean接口，重写初始化方法和销毁方法。

    11.自定义作用域

    我们都知道spring默认支持的Scope只有两种：

    • singleton 单例，每次从spring容器中获取到的bean都是同一个对象。
    • prototype 多例，每次从spring容器中获取到的bean都是不同的对象。

    spring web又对Scope进行了扩展，增加了：

    • RequestScope 同一次请求从spring容器中获取到的bean都是同一个对象。
    • SessionScope 同一个会话从spring容器中获取到的bean都是同一个对象。

    即便如此，有些场景还是无法满足我们的要求。

    比如，我们想在同一个线程中从spring容器获取到的bean都是同一个对象，该怎么办？

    这就需要自定义Scope了。

    第一步实现Scope接口：

    1. public class ThreadLocalScope implements Scope {
    2.     private static final ThreadLocal THREAD_LOCAL_SCOPE = new ThreadLocal();
    3.  
    4.     @Override
    5.     public Object get(String name, ObjectFactory objectFactory) {
    6.         Object value = THREAD_LOCAL_SCOPE.get();
    7.         if (value != null) {
    8.             return value;
    9.         }
    10.  
    11.         Object object = objectFactory.getObject();
    12.         THREAD_LOCAL_SCOPE.set(object);
    13.         return object;
    14.     }
    15.  
    16.     @Override
    17.     public Object remove(String name) {
    18.         THREAD_LOCAL_SCOPE.remove();
    19.         return null;
    20.     }
    21.  
    22.     @Override
    23.     public void registerDestructionCallback(String name, Runnable callback) {
    24.     }
    25.  
    26.     @Override
    27.     public Object resolveContextualObject(String key) {
    28.         return null;
    29.     }
    30.  
    31.     @Override
    32.     public String getConversationId() {
    33.         return null;
    34.     }
    35. }
    36. 复制代码

    第二步将新定义的Scope注入到spring容器中：

    1. @Component
    2. public class ThreadLocalBeanFactoryPostProcessor implements BeanFactoryPostProcessor {
    3.     @Override
    4.     public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException {
    5.         beanFactory.registerScope("threadLocalScope", new ThreadLocalScope());
    6.     }
    7. }
    8. 复制代码

    第三步使用新定义的Scope：

    1. @Scope("threadLocalScope")
    2. @Service
    3. public class CService {
    4.     public void add() {
    5.     }
    6. }
  • 相关阅读:
    [数据结构]链表OJ--环形链表判断是否有环(快慢指针法)
    [原创] Go/Rust/Kotlin 的协程和队列性能评测
    多版本node的安装与切换详细操作
    MySQL查询为啥慢了？
    新版Ai企业级系统去授权版本完美运行
    1055 The World‘s Richest
    剑指 Offer 06. 从尾到头打印链表
    zabbix中文乱码解决方法
    【第四阶段】kotlin语言中的数组类型
    Vue.js条件渲染与列表渲染指南
  • 原文地址：https://blog.csdn.net/lt_xiaodou/article/details/127047699