spring常用的11个扩展点

news/2024/12/18 23:38:11/文章来源:https://www.cnblogs.com/euler-blog/p/18616065

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
public class User {private Long id;private String name;private Date registerDate;
}
  1. 实现Converter接口
public class DateConverter implements Converter<String, Date> {private SimpleDateFormat simpleDateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");@Overridepublic Date convert(String source) {if (source != null && !"".equals(source)) {try {simpleDateFormat.parse(source);} catch (ParseException e) {e.printStackTrace();}}return null;}
}
  1. 将新定义的类型转换器注入到Spring容器中
@Configuration
public class WebConfig extends WebMvcConfigurerAdapter {@Overridepublic void addFormatters(FormatterRegistry registry) {registry.addConverter(new DateConverter());}
}
  1. 调用接口测试
@RequestMapping("/user")@RestControllerpublic class UserController {@RequestMapping("/save")public String save(@RequestBody User user) {return "success";}}

请求接口时,前端传入的日期字符串,会自动转换成Date类型。

2. 获取容器Bean

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

2.1 BeanFactoryAware

@Service
public class PersonService implements BeanFactoryAware {private BeanFactory beanFactory;@Overridepublic void setBeanFactory(BeanFactory beanFactory) throws BeansException {this.beanFactory = beanFactory;}public void add() {Person person = (Person) beanFactory.getBean("person");}
}

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

2.2 ApplicationContextAware

@Service
public class PersonService2 implements ApplicationContextAware {private ApplicationContext applicationContext;@Overridepublic void setApplicationContext(ApplicationContext applicationContext) throws BeansException {this.applicationContext = applicationContext;}public void add() {Person person = (Person) applicationContext.getBean("person");}
}

实现ApplicationContextAware接口,然后重写setApplicationContext方法,也可以通过该方法获取spring容器对象。

2.3 ApplicationListener

@Service
public class PersonService3 implements ApplicationListener<ContextRefreshedEvent> {private ApplicationContext applicationContext;@Overridepublic void onApplicationEvent(ContextRefreshedEvent event) {applicationContext = event.getApplicationContext();}public void add() {Person person = (Person) applicationContext.getBean("person");}
}

3. 全局异常处理

以往我们在开发界面的时候,如果出现异常,要给用户更友好的提示,例如:

@RequestMapping("/test")
@RestController
public class TestController {@GetMapping("/add")public String add() {int a = 10 / 0;return "su";}
}

如果不对请求添加接口结果做任何处理,会直接报错:

用户可以直接看到错误信息吗?

这种交互给用户带来的体验非常差。 为了解决这个问题,我们通常在接口中捕获异常:

@GetMapping("/add")
public String add() {String result = "success";try {int a = 10 / 0;} catch (Exception e) {result = "error";}return result;
}

界面修改后,出现异常时会提示:“数据异常”,更加人性化。

看起来不错,但是有一个问题。

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

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

@RestControllerAdvice
public class GlobalExceptionHandler {@ExceptionHandler(Exception.class)public String handleException(Exception e) {if (e instanceof ArithmeticException) {return "data error";}if (e instanceof Exception) {return "service error";}retur null;}
}

方法中处理异常只需要handleException,在业务接口中就可以安心使用,不再需要捕获异常(统一有人处理)。

4. 自定义拦截器

Spring MVC拦截器,它可以获得HttpServletRequestHttpServletResponse等web对象实例。

Spring MVC拦截器的顶层接口是HandlerInterceptor,它包含三个方法:

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

为了方便,我们一般继承HandlerInterceptorAdapter,它实现了HandlerInterceptor

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

  1. 写一个类继承HandlerInterceptorAdapter
public class AuthInterceptor extends HandlerInterceptorAdapter {@Overridepublic boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)throws Exception {String requestUrl = request.getRequestURI();if (checkAuth(requestUrl)) {return true;}return false;}private boolean checkAuth(String requestUrl) {return true;}
}
  1. 将拦截器注册到spring容器中
@Configuration
public class WebAuthConfig extends WebMvcConfigurerAdapter {@Beanpublic AuthInterceptor getAuthInterceptor() {return new AuthInterceptor();}@Overridepublic void addInterceptors(InterceptorRegistry registry) {registry.addInterceptor(new AuthInterceptor());}
}
  1. Spring MVC在请求接口时可以自动拦截接口,并通过拦截器验证权限。

5. 导入配置

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

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

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

5.1 通用类

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

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

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

@Autowired
private A a;

5.2 配置类

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

  • @Import
  • @ImportResource
  • @PropertySource
public class A {
}public class B {
}@Import(B.class)
@Configuration
public class AConfiguration {@Beanpublic A a() {return new A();}
}@Import(AConfiguration.class)
@Configuration
public class TestConfiguration {
}

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

5.3 ImportSelector

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

public class AImportSelector implements ImportSelector {private static final String CLASS_NAME = "com.sue.cache.service.test13.A";public String[] selectImports(AnnotationMetadata importingClassMetadata) {return new String[]{CLASS_NAME};}
}@Import(AImportSelector.class)
@Configuration
public class TestConfiguration {
}

这种方法的好处是selectImports方法返回的是一个数组,也就是说可以同时引入多个类,非常方便。

5.4 ImportBeanDefinitionRegistrar

该导入方法需要实现ImportBeanDefinitionRegistrar接口:

public class AImportBeanDefinitionRegistrar implements ImportBeanDefinitionRegistrar {@Overridepublic void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {RootBeanDefinition rootBeanDefinition = new RootBeanDefinition(A.class);registry.registerBeanDefinition("a", rootBeanDefinition);}
}@Import(AImportBeanDefinitionRegistrar.class)
@Configuration
public class TestConfiguration {
}

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

6. 当工程启动时

有时候我们需要在项目启动的时候自定义一些额外的功能,比如加载一些系统参数,完成初始化,预热本地缓存等。 我们应该做什么?

好消息是 SpringBoot 提供了:

  • CommandLineRunner
  • ApplicationRunner

这两个接口帮助我们实现了上面的需求。

它们的用法很简单,以ApplicationRunner接口为例:

@Component
public class TestRunner implements ApplicationRunner {@Autowiredprivate LoadDataService loadDataService;public void 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 接口。

@Component
public class MyBeanFactoryPostProcessor implements BeanFactoryPostProcessor {@Overridepublic void postProcessBeanFactory(ConfigurableListableBeanFactory configurableListableBeanFactory) throws BeansException {DefaultListableBeanFactory defaultListableBeanFactory = (DefaultListableBeanFactory) configurableListableBeanFactory;BeanDefinitionBuilder beanDefinitionBuilder = BeanDefinitionBuilder.genericBeanDefinition(User.class);beanDefinitionBuilder.addPropertyValue("id", 123);beanDefinitionBuilder.addPropertyValue("name", "Tom");defaultListableBeanFactory.registerBeanDefinition("user", beanDefinitionBuilder.getBeanDefinition());}
}

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

8. 初始化 Bean 前和后

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

这时候就可以实现:BeanPostProcessor接口。

该接口目前有两个方法:

  • postProcessBeforeInitialization:应该在初始化方法之前调用。
  • postProcessAfterInitialization:此方法在初始化方法之后调用。
@Componentpublic class MyBeanPostProcessor implements BeanPostProcessor {@Overridepublic Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException {if (bean instanceof User) {((User) bean).setUserName("Tom");}return bean;}}

我们经常使用的@Autowired@Value@Resource@PostConstruct等注解都是通过AutowiredAnnotationBeanPostProcessorCommonAnnotationBeanPostProcessor来实现的。

9. 初始化方法

目前在Spring中初始化bean的方式有很多种:

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

9.1 使用 @PostConstruct

@Service
public class AService {@PostConstructpublic void init() {System.out.println("===init===");}
}

为需要初始化的方法添加注解@PostConstruct,使其在Bean初始化时执行。

9.2 实现初始化接口InitializingBean

@Service
public class BService implements InitializingBean {@Overridepublic void afterPropertiesSet() throws Exception {System.out.println("===init===");}
}

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

10. 关闭Spring容器前

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

此时你可以实现 DisposableBean 接口并重写它的 destroy 方法。

@Service
public class DService implements InitializingBean, DisposableBean {@Overridepublic void destroy() throws Exception {System.out.println("DisposableBean destroy");}@Overridepublic void afterPropertiesSet() throws Exception {System.out.println("InitializingBean afterPropertiesSet");}
}

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

通常我们会同时实现InitializingBeanDisposableBean接口,重写初始化方法和销毁方法。

11. 自定义Beanscope

我们都知道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 {private static final ThreadLocal THREAD_LOCAL_SCOPE = new ThreadLocal();@Overridepublic Object get(String name, ObjectFactory<?> objectFactory) {Object value = THREAD_LOCAL_SCOPE.get();if (value != null) {return value;}Object object = objectFactory.getObject();THREAD_LOCAL_SCOPE.set(object);return object;}@Overridepublic Object remove(String name) {THREAD_LOCAL_SCOPE.remove();return null;}@Overridepublic void registerDestructionCallback(String name, Runnable callback) {}@Overridepublic Object resolveContextualObject(String key) {return null;}@Overridepublic String getConversationId() {return null;}
}
  1. 将新定义的Scope注入到Spring容器中
@Component
public class ThreadLocalBeanFactoryPostProcessor implements BeanFactoryPostProcessor {@Overridepublic void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException {beanFactory.registerScope("threadLocalScope", new ThreadLocalScope());}
}
  1. 使用新定义的Scope

@Scope("threadLocalScope")
@Service
public class CService {public void add() {}
}

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.hqwc.cn/news/855095.html

如若内容造成侵权/违法违规/事实不符,请联系编程知识网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

【开源系列】CentOS7下Docker环境搭建开源堡垒机Apache Guacamole

Apache Guacamole 是一个无客户端远程桌面网关。它支持 VNC、RDP 和 SSH 等标准协议。不需要插件或客户端软件。借助 HTML5,一旦在服务器上安装了 Guacamole,只需使用 Web 浏览器即可访问桌面。 1.Guacamole的架构介绍 Guacamole不是一个独立的网络应用程序,而是由多个部分组…

ThreeJs-07操控物体实现家具编辑器

本章节实现效果,通过gui快速添加场景,家具,并且可以快速设置家具实现一个编辑器效果一.基础设置与物体添加列表 用之前做过的一个案例来改首先不要这个模型,然后换个背景颜色,并且添加一个网格辅助器1.1 添加场景 先往事件对象里面添加一个函数,到时候点击就会调用这个函…

数据集划分;参数超参数;交叉验证

在机器学习和深度学习中,将数据分为训练集(Training Set)、验证集(Validation Set)和测试集(Test Set)是常见的做法,每部分数据承担不同的任务: 一.基本概念 1.训练集(Training Set):训练集用于训练模型,即通过算法调整模型的参数以最小化损失函数(Loss Function…

爱米导航网(imi),您的互联网书签搭子

爱米导航(Imi)网是一个综合性的互联网资源聚合平台,它以其丰富的内容和便捷的服务受到了广大用户的喜爱。该网站收录了数千个不同类型的互联网工具网站,覆盖了AI工具、自媒体运营工具、产品经理工具以及UI设计师工具等多个领域,为用户提供了一个一站式的解决方案。 爱米导…

记录一次springboot启动流程不完整版

1.Sort ApplicationInitializer:2.sort Listener:3.getRunListener:4.eventPublishingRunListener.starting 发布启动中事件; 构建 ApplicationArguments 参数, 4.1prepareEnvement: [StubPropertySource {name=servletConfigInitParams}, StubPropertySource {name=servletC…

键盘连击软件解决方案

解决的问题 jjjjjjjjjjjjjjjj键盘连击了,windows系统中的“筛选键”功能就能短暂解决这个问题,可是筛选的时间太长无法在面板设置更短的时间,但可以使用软件解决。 方法一 系统 筛选键 win+i 打开设置 -> 搜索“筛选键” -> 打开筛选键开关 使用限制:重复键最低只能设…

【建议收藏】最新版IDEA2024.3及 AI Assistant 一键激活到2099

成功永久激活 一、支持的IDE和版本支持JB家族所有IDE激活 支持版本为2021.3~2024.1二、如何破解激活 第一步:激活工具下载 为了防止破解工具被删除,通过公众号回复“「永久激活」”获取下载最新工具(如过期,请记得提醒我哦) 关注公众号后台回复“「永久激活」”,获取最新…

《平衡树》读后感

第一框,世界属于fhq-treap 是什么? 你说的对,但是《fhq-treap》是由范浩强自主研发的一款全新树形数据结构。数据结构发生在一个被称作「二叉搜索树」的幻想世界,在这里,被人创造的节点将被授予「随机优先级」,导引期望 \(O(\log n)\) 之力。treap 将扮演一位名为「根据优…

虚拟机unraid系统安装

首先下载unraid文件https://unraid.net/getting-started windows系统使用vmware虚拟机 创建虚拟机过程中注意usb的不同协议 2.0 3.0 由于unraid系统只能识别fat32协议的文件系统,因此需要将u盘格式化 可以使用easeus 或者 傲梅 https://www.easeus.com/partition-manager/ htt…

基于.NET WinForm开发的一款硬件及协议通讯工具

前言 今天大姚给大家分享一款基于.NET WinForm开发的一款硬件及协议通讯工具:PLC-CommunTools。 项目介绍 PLC-CommunTools是一款基于.NET WinForm开发的一款硬件及协议通讯工具,包含各类厂商的PLC协议及基础的TCP、串口通讯、IO口通讯等协议通讯功能的实现整合,注意还有一部…

游戏过程

根据是否结束游戏的逻辑选择对掷骰子的过程用bool申明变量掷骰子 static bool RollDice (w,h,ref Player p1,ref Player p2,Map map) {InfoClear(h);Console.ForegroundColor=p1.type==E_PlayerType.Player?ConsoleColor.Cyan:ConsoleColor.Meganta;if(p1.isPause){p1.isPause…

6.Group组件

关于Group组件的简单介绍首先,Group组件本身并不是一个“布局”类的组件,它只是一个容器,没有提供调整内部组件展示位置的方法,也就是说,当我们将多个组件(比如button)放在group中时,他们(根据流式规则?)会全部挤在窗口的左上角,当然,如果我们没有设置组件的大小的话…