你知道这11个Spring中最常用的扩展点吗？

前言

在使用spring的过程中，我们有没有发现它的扩展本领很强呢？ 由于这个优势的存在，使得spring具有很强的包容性，所以很多第三方应用大概框架可以很轻易的投入到spring的怀抱中。今天我们主要来学习Spring中很常用的11个扩展点，你用过几个呢？
1. 类型转换器

假如接口中接收参数的实体对象中，有一个字段类型为Date，但实际通报的参数是字符串类型：2022-12-15 10:20:15，该如那边理惩罚？
Spring提供了一个扩展点，类型转换器Type Converter，具体分为3类：

• Converter<S,T>: 将类型 S 的对象转换为类型 T 的对象
  
• ConverterFactory<S, R>: 将 S 类型对象转换为 R 类型或其子类对象
  
• GenericConverter：它支持多种源和目的类型的转换，还提供了源和目的类型的上下文。 此上下文答应您根据注释或属性信息实行类型转换。
  

还是不明白的话，我们举个例子吧。

• 界说一个用户对象
  

1. @Data
2. public class User {
3.     private Long id;
4.     private String name;
5.     private Date registerDate;
6. }

复制代码

• 实现Converter接口
  

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

复制代码

• 将新界说的类型转换器注入到Spring容器中
  

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

复制代码

• 调用接口测试
  

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

复制代码

哀求接口时，前端传入的日期字符串，会自动转换成Date类型。
2. 获取容器Bean

在我们一样平常开辟中，常常必要从Spring容器中获取bean，但是你知道怎样获取Spring容器对象吗？
2.1 BeanFactoryAware

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

复制代码

实现BeanFactoryAware接口，然后重写setBeanFactory方法，可以从方法中获取spring容器对象。
2.2 ApplicationContextAware

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

复制代码

实现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.     }
9.     public void add() {
10.         Person person = (Person) applicationContext.getBean("person");
11.     }
12. }

复制代码

3. 全局异常处理惩罚

以往我们在开辟界面的时间，假如出现异常，要给用户更友好的提示，比方：

1. @RequestMapping("/test")
2. @RestController
3. public class TestController {
5.     @GetMapping("/add")
6.     public String add() {
7.         int a = 10 / 0;
8.         return "su";
9.     }
10. }

复制代码

假如不对哀求添加接口结果做任那边理惩罚，会直接报错：
用户可以直接看到错误信息吗？
这种交互给用户带来的体验非常差。 为相识决这个问题，我们通常在接口中捕获异常：

1. @GetMapping("/add")
2. public String add() {
3.     String result = "success";
4.     try {
5.         int a = 10 / 0;
6.     } catch (Exception e) {
7.         result = "error";
8.     }
9.     return result;
10. }

复制代码

界面修改后，出现异常时会提示：“数据异常”，更加人性化。
看起来不错，但是有一个问题。
假如只是一个接口还好，但是假如项目中有成百上千个接口，还得加异常捕获代码吗？
答案是否定的，这就是全局异常处理惩罚派上用场的地方：RestControllerAdvice。

1. @RestControllerAdvice
2. public class GlobalExceptionHandler {
4.     @ExceptionHandler(Exception.class)
5.     public String handleException(Exception e) {
6.         if (e instanceof ArithmeticException) {
7.             return "data error";
8.         }
9.         if (e instanceof Exception) {
10.             return "service error";
11.         }
12.         retur null;
13.     }
14. }

复制代码

方法中处理惩罚异常只必要handleException，在业务接口中就可以安心使用，不再必要捕获异常（统一有人处理惩罚）。
4. 自界说拦截器

Spring MVC拦截器，它可以得到HttpServletRequest和HttpServletResponse等web对象实例。
Spring MVC拦截器的顶层接口是HandlerInterceptor，它包罗三个方法：

• preHandle 在目的方法实行之前实行
  
• 实行目的方法后实行的postHandle
  
• afterCompletion 在哀求完成时实行
  

为了方便，我们一样平常继续HandlerInterceptorAdapter，它实现了HandlerInterceptor。
假如有授权鉴权、日志、统计等场景，可以使用该拦截器，我们来演示下吧。

• 写一个类继续HandlerInterceptorAdapter：
  

1. public class AuthInterceptor extends HandlerInterceptorAdapter {
2.     @Override
3.     public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
4.     throws Exception {
5.         String requestUrl = request.getRequestURI();
6.         if (checkAuth(requestUrl)) {
7.             return true;
8.         }
9.         return false;
10.     }
11.     private boolean checkAuth(String requestUrl) {
12.         return true;
13.     }
14. }

复制代码

• 将拦截器注册到spring容器中
  

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

复制代码

• Spring MVC在哀求接口时可以自动拦截接口，并通过拦截器验证权限。
  

5. 导入配置

偶然我们必要在某个配置类中引入其他的类，引入的类也加入到Spring容器中。 这时间可以使用注解@Import来完成这个功能。
假如你检察它的源代码，你会发现导入的类支持三种不同的类型。
但是我觉得最好把平常类的配置类和@Configuration注解分开表明，所以列出了四种不同的类型：
5.1 通用类

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

1. public class A {
2. }
4. @Import(A.class)
5. @Configuration
6. public class TestConfiguration {
7.    
8. }

复制代码

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

1. @Autowired
2. private A a;

复制代码

5.2 配置类

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

• @Import
  
• @ImportResource
  
• @PropertySource
  

1. public class A {
2. }
4. public class B {
5. }
7. @Import(B.class)
8. @Configuration
9. public class AConfiguration {
11.     @Bean
12.     public A a() {
13.         return new A();
14.     }
15. }
17. @Import(AConfiguration.class)
18. @Configuration
19. public class TestConfiguration {
20. }

复制代码

@Configuration注解的配置类通过@Import注解导入，配置类@Import、@ImportResource相关注解引入的类会一次性全部递归引入@PropertySource所在的属性。
5.3 ImportSelector

该导入方法必要实现ImportSelector接口

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

复制代码

这种方法的好处是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. }
9. @Import(AImportBeanDefinitionRegistrar.class)
10. @Configuration
11. public class TestConfiguration {
12. }

复制代码

这种方法是最机动的。 容器注册对象可以在registerBeanDefinitions方法中获取，可以手动创建BeanDefinition注册到BeanDefinitionRegistry种。
6. 当工程启动时

偶然候我们必要在项目启动的时间自界说一些额外的功能，比如加载一些体系参数，完成初始化，预热当地缓存等。 我们应该做什么？
好消息是 SpringBoot 提供了：

• CommandLineRunner
  
• ApplicationRunner
  

这两个接口资助我们实现了上面的需求。
它们的用法很简单，以ApplicationRunner接口为例：

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

复制代码

oid run(ApplicationArguments args) throws Exception { loadDataService.load(); } } 复制代码
实现ApplicationRunner接口，重写run方法，在该方法中实现您的自界说需求。
假如项目中有多个类实现了ApplicationRunner接口，怎样指定它们的实行顺序？
答案是使用@Order(n)注解，n的值越小越早实行。 固然，顺序也可以通过@Priority注解来指定。
7. 修改BeanDefinition

在实例化Bean对象之前，Spring IOC必要读取Bean的相关属性，保存在BeanDefinition对象中，然后通过BeanDefinition对象实例化Bean对象。
假如要修改BeanDefinition对象中的属性怎么办？
答案：我们可以实现 BeanFactoryPostProcessor 接口。

1. @Component
2. public class MyBeanFactoryPostProcessor implements BeanFactoryPostProcessor {
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", "Tom");
10.         defaultListableBeanFactory.registerBeanDefinition("user", beanDefinitionBuilder.getBeanDefinition());
11.     }
12. }

复制代码

在postProcessBeanFactory方法中，可以获取BeanDefinition的相关对象，修改对象的属性。
8. 初始化 Bean 前和后

偶然，您想在 bean 初始化前后实现一些您自己的逻辑。
这时间就可以实现：BeanPostProcessor接口。
该接口现在有两个方法：

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

1. @Component
2.     public class MyBeanPostProcessor implements BeanPostProcessor {
4.         @Override
5.         public Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException {
6.             if (bean instanceof User) {
7.                 ((User) bean).setUserName("Tom");
8.             }
9.             return bean;
10.         }
11.     }

复制代码

我们常常使用的@Autowired、@Value、@Resource、@PostConstruct等注解都是通过AutowiredAnnotationBeanPostProcessor和CommonAnnotationBeanPostProcessor来实现的。
9. 初始化方法

现在在Spring中初始化bean的方式有很多种：

• 使用@PostConstruct注解
  
• 实现InitializingBean接口
  

9.1 使用 @PostConstruct

1. @Service
2. public class AService {
3.     @PostConstruct
4.     public void init() {
5.         System.out.println("===init===");
6.     }
7. }

复制代码

为必要初始化的方法添加注解@PostConstruct，使其在Bean初始化时实行。
9.2 实现初始化接口InitializingBean

1. @Service
2. public class BService implements InitializingBean {
4.     @Override
5.     public void afterPropertiesSet() throws Exception {
6.         System.out.println("===init===");
7.     }
8. }

复制代码

实现InitializingBean接口，重写afterPropertiesSet方法，在该方法中可以完成初始化功能。
10. 关闭Spring容器前

偶然候，我们必要在关闭spring容器之前做一些额外的工作，比如关闭资源文件。
此时你可以实现 DisposableBean 接口并重写它的 destroy 方法。

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

复制代码

如许，在spring容器烧毁之前，会调用destroy方法做一些额外的工作。
通常我们会同时实现InitializingBean和DisposableBean接口，重写初始化方法和烧毁方法。
11. 自界说Bean的scope

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

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

Spring Web 再次扩展了 Scope，添加

• RequestScope：同一个哀求中从spring容器中获取的bean都是同一个对象。
  
• SessionScope：同一个session从spring容器中获取的bean都是同一个对象。
  

只管如此，有些场景还是不符合我们的要求。
比如我们在同一个线程中要从spring容器中获取的bean都是同一个对象，怎么办？
答案：这必要一个自界说范围。

• 实现 Scope 接口
  

1. public class ThreadLocalScope implements Scope {
2.     private static final ThreadLocal THREAD_LOCAL_SCOPE = new ThreadLocal();
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.         }
11.         Object object = objectFactory.getObject();
12.         THREAD_LOCAL_SCOPE.set(object);
13.         return object;
14.     }
16.     @Override
17.     public Object remove(String name) {
18.         THREAD_LOCAL_SCOPE.remove();
19.         return null;
20.     }
22.     @Override
23.     public void registerDestructionCallback(String name, Runnable callback) {
24.     }
26.     @Override
27.     public Object resolveContextualObject(String key) {
28.         return null;
29.     }
31.     @Override
32.     public String getConversationId() {
33.         return null;
34.     }
35. }

复制代码

• 将新界说的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. }

复制代码

• 使用新界说的Scope
  

1. @Scope("threadLocalScope")
2. @Service
3. public class CService {
4.     public void add() {
5.     }
6. }

复制代码

总结

本文总结了Spring中很常用的11个扩展点，可以在Bean创建、初始化到烧毁各个阶段注入自己想要的逻辑，也有Spring MVC相关的拦截器等扩展点，希望对各人有资助。

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。