最近依舊在學習閱讀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又可以註解在不同的地方來達到注入的效果，比如註解在建構函式上：

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

註解在屬性上：

@Service
public class FooService {
    @Autowired
    private final FooRepository repository;
}

註解在setter方法上：

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

spring4.3新特性

上面是最常見的注入方式，如果忘記寫@Autowired註解，那麼在啟動的時候就會丟擲異常。

但在spring 4.3之後，引入了一個新特性：當構造方法的引數為單個構造引數時，可以不使用@Autowired進行註解。

因此，上面的程式碼可變為如下形式：

@Service
public 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之後，上面的程式碼便變為如下方式：

@Service
public 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的使用和原始碼解析完成。

原文連結：《SPRING BOOT 註解之OBJECTPROVIDER原始碼追蹤》

程式新視界：精彩和成長都不容錯過

相關推薦