Spring中11个最常用的扩展点，你知道几个？

曾经终败给现在 2023-09-30 19:14 133阅读 0赞

1. 类型转换器

如果接口中接收参数的实体对象中，有一个字段类型为Date，但实际传递的参数是字符串类型：2022-12-15 10:20:15，该如何处理？

Spring提供了一个扩展点，类型转换器Type Converter，具体分为3类：

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

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

  1. 定义一个用户对象

    @Data
    public class User {

    1. private Long id;
    2. private String name;
    3. private Date registerDate;

    }

  2. 实现Converter接口

    public class DateConverter implements Converter {

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

    }

  3. 将新定义的类型转换器注入到Spring容器中

    @Configuration
    public class WebConfig extends WebMvcConfigurerAdapter {

    1. @Override
    2. public void addFormatters(FormatterRegistry registry) {
    3.     registry.addConverter(new DateConverter());
    4. }

    }

  4. 调用接口测试

    @RequestMapping(“/user”)

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

请求接口时，前端传入的日期字符串，会自动转换成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。

如果有授权鉴权、日志、统计等场景，可以使用该拦截器，我们来演示下吧。

  1. 写一个类继承HandlerInterceptorAdapter：

    public class AuthInterceptor extends HandlerInterceptorAdapter {

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

    }

  2. 将拦截器注册到spring容器中

    @Configuration
    public class WebAuthConfig extends WebMvcConfigurerAdapter {

    1. @Bean
    2. public AuthInterceptor getAuthInterceptor() {
    3.     return new AuthInterceptor();
    4. }
    5. @Override
    6. public void addInterceptors(InterceptorRegistry registry) {
    7.     registry.addInterceptor(new AuthInterceptor());
    8. }

    }

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

5. 导入配置

有时我们需要在某个配置类中引入其他的类，引入的类也加入到Spring容器中。 这时候可以使用注解@Import来完成这个功能。

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

但是我觉得最好把普通类的配置类和@Configuration注解分开解释，所以列出了四种不同的类型：

5.1 通用类

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

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

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

  1. @Autowired
  2. private A a;

5.2 配置类

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

  • @Import
  • @ImportResource

  • @PropertySource

    public class A {
    }

    public class B {
    }

    @Import(B.class)
    @Configuration
    public class AConfiguration {

    1. @Bean
    2. public A a() {
    3.     return new A();
    4. }

    }

    @Import(AConfiguration.class)
    @Configuration
    public class TestConfiguration {
    }

@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. }

实现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：此方法在初始化方法之后调用。

    @Component

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

我们经常使用的@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("===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都是同一个对象，怎么办？

答案：这需要一个自定义范围。

  1. 实现 Scope 接口

    public class ThreadLocalScope implements Scope {

    1. private static final ThreadLocal THREAD_LOCAL_SCOPE = new ThreadLocal();
    3. @Override
    4. public Object get(String name, ObjectFactory<?> objectFactory) {
    5.     Object value = THREAD_LOCAL_SCOPE.get();
    6.     if (value != null) {
    7.         return value;
    8.     }
    10.     Object object = objectFactory.getObject();
    11.     THREAD_LOCAL_SCOPE.set(object);
    12.     return object;
    13. }
    15. @Override
    16. public Object remove(String name) {
    17.     THREAD_LOCAL_SCOPE.remove();
    18.     return null;
    19. }
    21. @Override
    22. public void registerDestructionCallback(String name, Runnable callback) {
    23. }
    25. @Override
    26. public Object resolveContextualObject(String key) {
    27.     return null;
    28. }
    30. @Override
    31. public String getConversationId() {
    32.     return null;
    33. }

    }

  2. 将新定义的Scope注入到Spring容器中

    @Component
    public class ThreadLocalBeanFactoryPostProcessor implements BeanFactoryPostProcessor {

    1. @Override
    2. public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException {
    3.     beanFactory.registerScope("threadLocalScope", new ThreadLocalScope());
    4. }

    }

  3. 使用新定义的Scope

    @Scope(“threadLocalScope”)
    @Service
    public class CService {

    1. public void add() {
    2. }

    }

发表评论

表情：
评论列表 （有 0 条评论，133人围观）

还没有评论，来说两句吧...

相关阅读