前言
在应用spring的过程中,咱们有没有发现它的扩大能力很强呢? 因为这个劣势的存在,使得spring具备很强的包容性,所以很多第三方利用或者框架能够很容易的投入到spring的怀抱中。明天咱们次要来学习Spring中很罕用的11个扩大点,你用过几个呢?
- 类型转换器
如果接口中接管参数的实体对象中,有一个字段类型为Date,但理论传递的参数是字符串类型:2022-12-15 10:20:15,该如何解决?
Spring提供了一个扩大点,类型转换器Type Converter,具体分为3类:
Converter<S,T>: 将类型 S 的对象转换为类型 T 的对象
ConverterFactory<S, R>: 将 S 类型对象转换为 R 类型或其子类对象
GenericConverter:它反对多种源和指标类型的转换,还提供了源和指标类型的上下文。 此上下文容许您依据正文或属性信息执行类型转换。
还是不明确的话,咱们举个例子吧。
定义一个用户对象
@Data
public class User {
private Long id;private String name;private Date registerDate;
}
复制代码
实现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;}
}
复制代码
将新定义的类型转换器注入到Spring容器中
@Configuration
public class WebConfig extends WebMvcConfigurerAdapter {
@Overridepublic void addFormatters(FormatterRegistry registry) { registry.addConverter(new DateConverter());}
}
复制代码
调用接口测试
@RequestMapping("/user")
@RestControllerpublic class UserController { @RequestMapping("/save") public String save(@RequestBody User user) { return "success"; }}
复制代码
申请接口时,前端传入的日期字符串,会主动转换成Date类型。
获取容器Bean
在咱们日常开发中,常常须要从Spring容器中获取bean,然而你晓得如何获取Spring容器对象吗?
2.1 BeanFactoryAware
@Service
public class PersonService implements BeanFactoryAware {
private BeanFactory beanFactory;@Override
public 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;@Override
public 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;
@Override
public void onApplicationEvent(ContextRefreshedEvent event) {applicationContext = event.getApplicationContext();
}
public void add() {
Person person = (Person) applicationContext.getBean("person");
}
}
复制代码全局异样解决
以往咱们在开发界面的时候,如果出现异常,要给用户更敌对的提醒,例如:
@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,在业务接口中就能够安心应用,不再须要捕捉异样(对立有人解决)。- 自定义拦截器
Spring MVC拦截器,它能够取得HttpServletRequest和HttpServletResponse等web对象实例。
Spring MVC拦截器的顶层接口是HandlerInterceptor,它蕴含三个办法:
preHandle 在指标办法执行之前执行
执行指标办法后执行的postHandle
afterCompletion 在申请实现时执行
为了不便,咱们个别继承HandlerInterceptorAdapter,它实现了HandlerInterceptor。
如果有受权鉴权、日志、统计等场景,能够应用该拦截器,咱们来演示下吧。
写一个类继承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;}
}
复制代码
将拦截器注册到spring容器中
@Configuration
public class WebAuthConfig extends WebMvcConfigurerAdapter {
@Beanpublic AuthInterceptor getAuthInterceptor() { return new AuthInterceptor();}@Overridepublic void addInterceptors(InterceptorRegistry registry) { registry.addInterceptor(new AuthInterceptor());}
}
复制代码
Spring MVC在申请接口时能够主动拦挡接口,并通过拦截器验证权限。
- 导入配置
有时咱们须要在某个配置类中引入其余的类,引入的类也退出到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种。
- 当工程启动时
有时候咱们须要在我的项目启动的时候自定义一些额定的性能,比方加载一些零碎参数,实现初始化,预热本地缓存等。 咱们应该做什么?
好消息是 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注解来指定。
批改BeanDefinition
在实例化Bean对象之前,Spring IOC须要读取Bean的相干属性,保留在BeanDefinition对象中,而后通过BeanDefinition对象实例化Bean对象。
如果要批改BeanDefinition对象中的属性怎么办?
答案:咱们能够实现 BeanFactoryPostProcessor 接口。
@Component
public class MyBeanFactoryPostProcessor implements BeanFactoryPostProcessor {@Override
public 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的相干对象,批改对象的属性。- 初始化 Bean 前和后
有时,您想在 bean 初始化前后实现一些您本人的逻辑。
这时候就能够实现:BeanPostProcessor接口。
该接口目前有两个办法:
postProcessBeforeInitialization:应该在初始化办法之前调用。
postProcessAfterInitialization:此办法在初始化办法之后调用。
@Component
public class MyBeanPostProcessor implements BeanPostProcessor { @Override public Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException { if (bean instanceof User) { ((User) bean).setUserName("Tom"); } return bean; }}
复制代码
咱们常常应用的@Autowired、@Value、@Resource、@PostConstruct等注解都是通过AutowiredAnnotationBeanPostProcessor和CommonAnnotationBeanPostProcessor来实现的。
- 初始化办法
目前在Spring中初始化bean的形式有很多种:
应用@PostConstruct注解
实现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办法,在该办法中能够实现初始化性能。
敞开Spring容器前
有时候,咱们须要在敞开spring容器之前做一些额定的工作,比方敞开资源文件。
此时你能够实现 DisposableBean 接口并重写它的 destroy 办法。
@Service
public class DService implements InitializingBean, DisposableBean {@Override
public void destroy() throws Exception {System.out.println("DisposableBean destroy");
}
@Override
public void afterPropertiesSet() throws Exception {System.out.println("InitializingBean afterPropertiesSet");
}
}
复制代码
这样,在spring容器销毁之前,会调用destroy办法做一些额定的工作。
通常咱们会同时实现InitializingBean和DisposableBean接口,重写初始化办法和销毁办法。- 自定义Bean的scope
咱们都晓得spring core默认只反对两种Scope:
Singleton单例,从spring容器中获取的每一个bean都是同一个对象。
prototype多实例,每次从spring容器中获取的bean都是不同的对象。
Spring Web 再次扩大了 Scope,增加
RequestScope:同一个申请中从spring容器中获取的bean都是同一个对象。
SessionScope:同一个session从spring容器中获取的bean都是同一个对象。
尽管如此,有些场景还是不合乎咱们的要求。
比方咱们在同一个线程中要从spring容器中获取的bean都是同一个对象,怎么办?
答案:这须要一个自定义范畴。
实现 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;}
}
复制代码
将新定义的Scope注入到Spring容器中
@Component
public class ThreadLocalBeanFactoryPostProcessor implements BeanFactoryPostProcessor {
@Overridepublic void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException { beanFactory.registerScope("threadLocalScope", new ThreadLocalScope());}
}
复制代码
应用新定义的Scope
@Scope("threadLocalScope")
@Service
public class CService {
public void add() {}
}
复制代码
总结
本文总结了Spring中很罕用的11个扩大点,能够在Bean创立、初始化到销毁各个阶段注入本人想要的逻辑,也有Spring MVC相干的拦截器等扩大点,心愿对大家有帮忙。