转载自: 微信公众号 [Java后端技术]


前言

我们一说到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. @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. System.out.println("===权限校验===");
  13. return true;
  14. }
  15. }

第二步,将该拦截器注册到spring容器:

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

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

2.获取Spring容器对象

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

2.1 BeanFactoryAware接口

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

2.2 ApplicationContextAware接口

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

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

3.全局异常处理

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

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

如果不做任何处理请求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. }

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

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

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

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

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

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

4.类型转换器

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

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

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

第一步,定义一个实体User:

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

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

5.导入配置

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

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

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

5.1 普通类

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

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

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

  1. @Autowired
  2. private A a;

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

5.2 配置类

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

  • @Import
  • @ImportResource
  • @PropertySource等。

  1. public class A {
  2. }
  3. public class B {
  4. }
  5. @Import(B.class)
  6. @Configuration
  7. public class AConfiguration {
  8. @Bean
  9. public A a() {
  10. return new A();
  11. }
  12. }
  13. @Import(AConfiguration.class)
  14. @Configuration
  15. public class TestConfiguration {
  16. }

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

5.3 ImportSelector

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

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

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

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

6.项目启动时

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

好消息是springboot提供了:

  • CommandLineRunner
  • ApplicationRunner

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

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

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

实现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. @Override
  4. public void postProcessBeanFactory(ConfigurableListableBeanFactory configurableListableBeanFactory) throws BeansException {
  5. DefaultListableBeanFactory defaultListableBeanFactory = (DefaultListableBeanFactory) configurableListableBeanFactory;
  6. BeanDefinitionBuilder beanDefinitionBuilder = BeanDefinitionBuilder.genericBeanDefinition(User.class);
  7. beanDefinitionBuilder.addPropertyValue("id", 123);
  8. beanDefinitionBuilder.addPropertyValue("name", "苏三说技术");
  9. defaultListableBeanFactory.registerBeanDefinition("user", beanDefinitionBuilder.getBeanDefinition());
  10. }
  11. }

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

8.初始化Bean前后

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

这时可以实现:BeanPostProcessor接口。

该接口目前有两个方法:

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

例如:


  1. @Component
  2. 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("苏三说技术");
  7. }
  8. return bean;
  9. }
  10. }

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

其实,我们经常使用的注解,比如:@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("===初始化===");
  6. }
  7. }

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

9.2 实现InitializingBean接口

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

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

10.关闭容器前

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

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

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

这样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. @Override
  4. public Object get(String name, ObjectFactory<?> objectFactory) {
  5. Object value = THREAD_LOCAL_SCOPE.get();
  6. if (value != null) {
  7. return value;
  8. }
  9. Object object = objectFactory.getObject();
  10. THREAD_LOCAL_SCOPE.set(object);
  11. return object;
  12. }
  13. @Override
  14. public Object remove(String name) {
  15. THREAD_LOCAL_SCOPE.remove();
  16. return null;
  17. }
  18. @Override
  19. public void registerDestructionCallback(String name, Runnable callback) {
  20. }
  21. @Override
  22. public Object resolveContextualObject(String key) {
  23. return null;
  24. }
  25. @Override
  26. public String getConversationId() {
  27. return null;
  28. }
  29. }

第二步将新定义的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个扩展点的更多相关文章

  1. Spring中Bean的生命周期及其扩展点

    原创作品,可以转载,但是请标注出处地址http://www.cnblogs.com/V1haoge/p/6106456.html Spring中Bean的管理是其最基本的功能,根据下面的图来了解Spr ...

  2. Spring中的常用注解

    Spring中的常用注解 1.@Controller 标识一个该类是Spring MVC controller处理器,用来创建处理http请求的对象.

  3. Spring系列14:IoC容器的扩展点

    Spring系列14:IoC容器的扩展点 回顾 知识需要成体系地学习,本系列文章前后有关联,建议按照顺序阅读.上一篇我们详细介绍了Spring Bean的生命周期和丰富的扩展点,没有阅读的强烈建议先阅 ...

  4. spring中spEL常用应用场景

    spEL表达式表示:#{} 一.基本类型值运算操作 {}可以放置数字,字符串,布尔型,表达式(运算,正则,逻辑).这个应用场景和EL表达式一样的,实际中用的也不多. 注意:在XML中表示==,> ...

  5. Spring中11个最常用的扩展点,你知道几个?

    前言 在使用spring的过程中,我们有没有发现它的扩展能力很强呢? 由于这个优势的存在,使得spring具有很强的包容性,所以很多第三方应用或者框架可以很容易的投入到spring的怀抱中.今天我们主 ...

  6. Spring中常用的注解,你知道几个呢?

    今天给大家分享下Spring中一般常用的注解都有哪些.可能很多人做了很长是了但有些还是不知道一些注解,不过没有关系,你接着往下看. Spring部分 1.声明bean的注解 @Component 组件 ...

  7. spring中的BeanFactory与ApplicationContext的作用和区别?

    BeanFactory类关系继承图 1. BeanFactory类结构体系: BeanFactory接口及其子类定义了Spring IoC容器体系结构,由于BeanFactory体系非常的庞大和复杂, ...

  8. 【Java基础】Java开发过程中的常用工具类库

    目录 Java开发过程中的常用工具类库 1. Apache Commons类库 2. Guava类库 3. Spring中的常用工具类 4. 其他工具 参考 Java开发过程中的常用工具类库 1. A ...

  9. Spring源码系列 — BeanDefinition扩展点

    前言 前文介绍了Spring Bean的生命周期,也算是XML IOC系列的完结.但是Spring的博大精深,还有很多盲点需要摸索.整合前面的系列文章,从Resource到BeanDefinition ...

  10. Spring Boot 使用Java代码创建Bean并注册到Spring中

    版权声明:本文为博主原创文章,未经博主允许不得转载. https://blog.csdn.net/catoop/article/details/50558333 声明同一个类下的多个实例: packa ...

随机推荐

  1. 前端基础知识-html(一)个人学习记录

    待补充 块级元素与行内元素,常见举例 html5新特性?

  2. 线上排查:内存异常使用导致full gc频繁

    线上排查:内存异常使用导致full gc频繁 问题系统 日常巡检发现,应用线上出现频繁full gc 现象 应用线上出现频繁full gc 排查过程 分析dump 拉dump文件:小插曲:dump时如 ...

  3. vue学习笔记(一) ----- vue指令(菜单列表案例)

    一.渲染品牌列表 <div id="app"> <div class="panel panel-primary"> <div cl ...

  4. drf-jwt、simplejwt的使用

    1.接口文档 # 前后端分离 -我们做后端,写接口 -前端做前端,根据接口写app,pc,小程序 -作为后端来讲,我们很清楚,比如登录接口 /api/v1/login/---->post---- ...

  5. ARM启动顺序

    iROM(也叫BL0)的作用:   初始化系统时钟,设置看门狗,初始化栈和堆   加载BL1 BL1的作用:   初始化RAM , 关闭Cache , 设置栈   加载BL2 BL2的作用:   初始 ...

  6. 【CTO变形记】高维视角,跳出“农场主与火鸡”

    前言:看待人事物的角度决定了我们的思考方向和处理事情的方式.在这些认识人事物的过程中,导致了一些"事故"发生:就好比"以手指月",原本要看"月亮&qu ...

  7. .NET Core Redis的简单使用

    1.Redis简介 Redis 是完全开源的,遵守 BSD 协议,是一个高性能的 key-value 数据库. 2.Redis主要特点 Redis支持数据的持久化 Redis支持多种数据结构 Redi ...

  8. element-UI el-table动态显示隐藏列造成固定一侧的列(fixed=“left/right“)错误显示

    问题原因:多个tabs共用一个实体,动态显示隐藏列 出现了固定在右侧的列(fixed="right")错位 [解决方案] 表格的重新布局,只要table数据发生变化的时候就重新渲染 ...

  9. K8s 网络新手教程(Kubernetes Networking Guide for Beginners)

    K8s 网络新手教程(Kubernetes Networking Guide for Beginners) 原文链接: Kubernetes Networking Guide for Beginner ...

  10. HGAME2023_WP_WEEK2

    Git Leakage Githack一波带走,下载得到flag v2board 搜索得知V2Board存在越权漏洞,随便注册个账号拿到authorization 访问/api/v1/admin/us ...