Spring Boot 注解之ObjectProvider源码追踪

简介: Spring Boot 注解之ObjectProvider源码追踪

image.png最近依旧在学习阅读Spring Boot的源代码,在此过程中涉及到很多在日常项目中比较少见的功能特性,对此深入研究一下,也挺有意思,这也是阅读源码的魅力之一。这里写成文章,分享给大家。

自动配置中的ObjectProvider

在阅读Spring Boot自动配置源码中关于Tomcat的配置时,看到这样如下的自动配置配置源代码。













@Configuration(proxyBeanMethods = false)@ConditionalOnClass({Servlet.class,Tomcat.class, UpgradeProtocol.class })@ConditionalOnMissingBean(value = ServletWebServerFactory.class, search = SearchStrategy.CURRENT)public static class EmbeddedTomcat {  @Bean  public TomcatServletWebServerFactory tomcatServletWebServerFactory(      ObjectProvider<TomcatConnectorCustomizer> connectorCustomizers,      ObjectProvider<TomcatContextCustomizer> contextCustomizers,      ObjectProvider<TomcatProtocolHandlerCustomizer<?>> protocolHandlerCustomizers) {    // ...  }}

这就是一个常规的基于Java的配置类,那么你是否发现它在用法与其他的有所不同?是的,那就是三个ObjectProvider的参数。这也是本文要讲的内容。

Spring中的传统注入

在介绍ObjectProvider的使用之前,我们先来回顾一下注入相关的知识。

在Spring的使用过程中,我们可以通过多种形式将一个类注入到另外一个类当中,比如通过@Autowired和@Resources注解。

而@Autowired又可以注解在不同的地方来达到注入的效果,比如注解在构造函数上:









@Servicepublic class FooService {    private final FooRepository repository;    @Autowired    public FooService(FooRepository repository) {        this.repository = repository    }}

注解在属性上:






@Servicepublic class FooService {    @Autowired    private final FooRepository repository;}

注解在setter方法上:









@Servicepublic class FooService {    private final FooRepository repository;    @Autowired    public void setFooRepository(FooRepository repository) {        this.repository = repository    }}

spring4.3新特性

上面是最常见的注入方式,如果忘记写@Autowired注解,那么在启动的时候就会抛出异常。

但在spring 4.3之后,引入了一个新特性:当构造方法为单个构造器时,可以不使用@Autowired进行注解。

因此,上面的代码可变为如下形式:








@Servicepublic class FooService {    private final FooRepository repository;    public FooService(FooRepository repository) {        this.repository = repository    }}

使用此种形式便会显得优雅一些。该特性,在Spring Boot的自动配置类中大量被使用。

依赖关系的改进

同样是在Spring 4.3版本中,不仅隐式的注入了单构造参数的属性。还引入了ObjectProvider接口。

ObjectProvider接口是ObjectFactory接口的扩展,专门为注入点设计的,可以让注入变得更加宽松和更具有可选项。

那么什么时候使用ObjectProvider接口?

如果待注入参数的Bean为空或有多个时,便是ObjectProvider发挥作用的时候了。

如果注入实例为空时,使用ObjectProvider则避免了强依赖导致的依赖对象不存在异常;如果有多个实例,ObjectProvider的方法会根据Bean实现的Ordered接口或@Order注解指定的先后顺序获取一个Bean。从而了提供了一个更加宽松的依赖注入方式。

Spring 5.1之后提供了基于Stream的orderedStream方法来获取有序的Stream的方法。

使用ObjectProvider之后,上面的代码便变为如下方式:








@Servicepublic class FooService {    private final FooRepository repository;    public FooService(ObjectProvider<FooRepository> repositoryProvider) {        this.repository = repositoryProvider.getIfUnique();    }}

这样的好处很显然,当容器中不存在FooRepository或存在多个时,可以从容处理。但坏处也很明显,如果FooRepository不能为null,则可能将异常从启动阶段转移到业务运行阶段。

ObjectProvider源码

ObjectProvider的源码及解析如下:



























































public interface ObjectProvider<T> extends ObjectFactory<T>, Iterable<T> {
  // 返回指定类型的bean, 如果容器中不存在, 抛出NoSuchBeanDefinitionException异常    // 如果容器中有多个此类型的bean, 抛出NoUniqueBeanDefinitionException异常  T getObject(Object... args) throws BeansException;
  // 如果指定类型的bean注册到容器中, 返回 bean 实例, 否则返回 null  @Nullable  T getIfAvailable() throws BeansException;
  // 如果返回对象不存在,则进行回调,回调对象由Supplier传入  default T getIfAvailable(Supplier<T> defaultSupplier) throws BeansException {    T dependency = getIfAvailable();    return (dependency != null ? dependency : defaultSupplier.get());  }
   // 消费对象的一个实例(可能是共享的或独立的),如果存在通过Consumer回调消耗目标对象。  default void ifAvailable(Consumer<T> dependencyConsumer) throws BeansException {    T dependency = getIfAvailable();    if (dependency != null) {      dependencyConsumer.accept(dependency);    }  }
  // 如果不可用或不唯一(没有指定primary)则返回null。否则,返回对象。  @Nullable  T getIfUnique() throws BeansException;
  // 如果存在唯一对象,则调用Supplier的回调函数  default T getIfUnique(Supplier<T> defaultSupplier) throws BeansException {    T dependency = getIfUnique();    return (dependency != null ? dependency : defaultSupplier.get());  }
  // 如果存在唯一对象,则消耗掉该对象  default void ifUnique(Consumer<T> dependencyConsumer) throws BeansException {    T dependency = getIfUnique();    if (dependency != null) {      dependencyConsumer.accept(dependency);    }  }
  // 返回符合条件的对象的Iterator,没有特殊顺序保证(一般为注册顺序)  @Override  default Iterator<T> iterator() {    return stream().iterator();  }
  // 返回符合条件对象的连续的Stream,没有特殊顺序保证(一般为注册顺序)  default Stream<T> stream() {    throw new UnsupportedOperationException("Multi element access not supported");  }
  // 返回符合条件对象的连续的Stream。在标注Spring应用上下文中采用@Order注解或实现Order接口的顺序  default Stream<T> orderedStream() {    throw new UnsupportedOperationException("Ordered element access not supported");  }}

其中,在BeanFactory中也使用了该接口来定义方法的返回值:







public interface BeanFactory {
    <T> ObjectProvider<T> getBeanProvider(Class<T> requiredType);    <T> ObjectProvider<T> getBeanProvider(ResolvableType requiredType);    ...}

至此,关于ObjectProvider的使用和源码解析完成。


目录
相关文章
|
11天前
|
XML Java 数据格式
SpringBoot入门(8) - 开发中还有哪些常用注解
SpringBoot入门(8) - 开发中还有哪些常用注解
29 0
|
6天前
|
监控 Java 应用服务中间件
高级java面试---spring.factories文件的解析源码API机制
【11月更文挑战第20天】Spring Boot是一个用于快速构建基于Spring框架的应用程序的开源框架。它通过自动配置、起步依赖和内嵌服务器等特性,极大地简化了Spring应用的开发和部署过程。本文将深入探讨Spring Boot的背景历史、业务场景、功能点以及底层原理,并通过Java代码手写模拟Spring Boot的启动过程,特别是spring.factories文件的解析源码API机制。
22 2
|
23天前
|
数据采集 监控 前端开发
二级公立医院绩效考核系统源码,B/S架构,前后端分别基于Spring Boot和Avue框架
医院绩效管理系统通过与HIS系统的无缝对接,实现数据网络化采集、评价结果透明化管理及奖金分配自动化生成。系统涵盖科室和个人绩效考核、医疗质量考核、数据采集、绩效工资核算、收支核算、工作量统计、单项奖惩等功能,提升绩效评估的全面性、准确性和公正性。技术栈采用B/S架构,前后端分别基于Spring Boot和Avue框架。
|
29天前
|
Java Spring
在使用Spring的`@Value`注解注入属性值时,有一些特殊字符需要注意
【10月更文挑战第9天】在使用Spring的`@Value`注解注入属性值时,需注意一些特殊字符的正确处理方法,包括空格、引号、反斜杠、新行、制表符、逗号、大括号、$、百分号及其他特殊字符。通过适当包裹或转义,确保这些字符能被正确解析和注入。
|
18天前
|
XML JSON Java
SpringBoot必须掌握的常用注解!
SpringBoot必须掌握的常用注解!
41 4
SpringBoot必须掌握的常用注解!
|
12天前
|
前端开发 Java 开发者
Spring生态学习路径与源码深度探讨
【11月更文挑战第13天】Spring框架作为Java企业级开发中的核心框架,其丰富的生态系统和强大的功能吸引了无数开发者的关注。学习Spring生态不仅仅是掌握Spring Framework本身,更需要深入理解其周边组件和工具,以及源码的底层实现逻辑。本文将从Spring生态的学习路径入手,详细探讨如何系统地学习Spring,并深入解析各个重点的底层实现逻辑。
39 9
|
8天前
|
存储 运维 安全
Spring运维之boot项目多环境(yaml 多文件 proerties)及分组管理与开发控制
通过以上措施,可以保证Spring Boot项目的配置管理在专业水准上,并且易于维护和管理,符合搜索引擎收录标准。
19 2
|
19天前
|
存储 缓存 Java
Spring缓存注解【@Cacheable、@CachePut、@CacheEvict、@Caching、@CacheConfig】使用及注意事项
Spring缓存注解【@Cacheable、@CachePut、@CacheEvict、@Caching、@CacheConfig】使用及注意事项
61 2
|
19天前
|
JSON Java 数据库
SpringBoot项目使用AOP及自定义注解保存操作日志
SpringBoot项目使用AOP及自定义注解保存操作日志
34 1
|
14天前
|
存储 安全 Java
springboot当中ConfigurationProperties注解作用跟数据库存入有啥区别
`@ConfigurationProperties`注解和数据库存储配置信息各有优劣,适用于不同的应用场景。`@ConfigurationProperties`提供了类型安全和模块化的配置管理方式,适合静态和简单配置。而数据库存储配置信息提供了动态更新和集中管理的能力,适合需要频繁变化和集中管理的配置需求。在实际项目中,可以根据具体需求选择合适的配置管理方式,或者结合使用这两种方式,实现灵活高效的配置管理。
10 0