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的使用和源码解析完成。


目录
相关文章
|
6天前
|
运维 Java 程序员
Spring5深入浅出篇:基于注解实现的AOP
# Spring5 AOP 深入理解:注解实现 本文介绍了基于注解的AOP编程步骤,包括原始对象、额外功能、切点和组装切面。步骤1-3旨在构建切面,与传统AOP相似。示例代码展示了如何使用`@Around`定义切面和执行逻辑。配置中,通过`@Aspect`和`@Around`注解定义切点,并在Spring配置中启用AOP自动代理。 进一步讨论了切点复用,避免重复代码以提高代码维护性。通过`@Pointcut`定义通用切点表达式,然后在多个通知中引用。此外,解释了AOP底层实现的两种动态代理方式:JDK动态代理和Cglib字节码增强,默认使用JDK,可通过配置切换到Cglib
|
1天前
|
Java 应用服务中间件 测试技术
深入探索Spring Boot Web应用源码及实战应用
【5月更文挑战第11天】本文将详细解析Spring Boot Web应用的源码架构,并通过一个实际案例,展示如何构建一个基于Spring Boot的Web应用。本文旨在帮助读者更好地理解Spring Boot的内部工作机制,以及如何利用这些机制优化自己的Web应用开发。
8 2
|
2天前
|
JSON 前端开发 Java
【JAVA进阶篇教学】第七篇:Spring中常用注解
【JAVA进阶篇教学】第七篇:Spring中常用注解
|
4天前
|
存储 前端开发 Java
Spring Boot自动装配的源码学习
【4月更文挑战第8天】Spring Boot自动装配是其核心机制之一,其设计目标是在应用程序启动时,自动配置所需的各种组件,使得应用程序的开发和部署变得更加简单和高效。下面是关于Spring Boot自动装配的源码学习知识点及实战。
13 1
|
5天前
|
JavaScript Java 开发者
Spring Boot中的@Lazy注解:概念及实战应用
【4月更文挑战第7天】在Spring Framework中,@Lazy注解是一个非常有用的特性,它允许开发者控制Spring容器的bean初始化时机。本文将详细介绍@Lazy注解的概念,并通过一个实际的例子展示如何在Spring Boot应用中使用它。
17 2
|
5天前
|
传感器 人工智能 前端开发
JAVA语言VUE2+Spring boot+MySQL开发的智慧校园系统源码(电子班牌可人脸识别)Saas 模式
智慧校园电子班牌,坐落于班级的门口,适合于各类型学校的场景应用,班级学校日常内容更新可由班级自行管理,也可由学校统一管理。让我们一起看看,电子班牌有哪些功能呢?
47 4
JAVA语言VUE2+Spring boot+MySQL开发的智慧校园系统源码(电子班牌可人脸识别)Saas 模式
|
6天前
|
前端开发 Java
SpringBoot之自定义注解参数校验
SpringBoot之自定义注解参数校验
16 2
|
12天前
|
Java Spring
springboot自带的@Scheduled注解开启定时任务
springboot自带的@Scheduled注解开启定时任务
|
13天前
|
设计模式 安全 Java
【初学者慎入】Spring源码中的16种设计模式实现
以上是威哥给大家整理了16种常见的设计模式在 Spring 源码中的运用,学习 Spring 源码成为了 Java 程序员的标配,你还知道Spring 中哪些源码中运用了设计模式,欢迎留言与威哥交流。
|
15天前
|
XML JSON Java
【SpringBoot】springboot常用注解
【SpringBoot】springboot常用注解