Spring Boot 註解之ObjectProvider源碼追蹤

最近依舊在學習閱讀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源碼追蹤》

<center>程序新視界：精彩和成長都不容錯過</center>