Spring之什麼是ObjectFactory?什麼是ObjectProvider?

2023-11-01 10:01:01

在Spring的學習過程中，總是學的越多，不懂的越多。本來只是想將ApplicationContext的相關內容全部梳理一遍，結果發現涉及的東西越來越多，比如上篇文章中的ResolvableType，到這篇文章介紹的ObjectFactory跟ObjectProvider。不過想想也沒辦法，一步一步往前走唄，在這個過程中也確實學到了很多東西。廢話不多說，直接進入正文。

ObjectFactory

介面定義

// 一個物件工廠
public interface ObjectFactory<T> {

    // 返回一個物件
    T getObject() throws BeansException;

}

這個介面的定義非常簡單，就是一個物件工廠，定義了一個返回物件的工廠方法。回顧我們直接介紹過的一個內容FactroyBean，其介面定義如下：

public interface FactoryBean<T> {

	@Nullable
	T getObject() throws Exception;

	@Nullable
	Class<?> getObjectType();

	default boolean isSingleton() {
		return true;
	}

}

可以看到兩者都有一個getObject方法，那麼它們有什麼區別或者聯絡呢？

跟FactoryBean的區別及聯絡

聯絡

二者在功能設計上是沒有什麼聯絡的，他們最大的共同點就是都採用了工廠模式，通過工廠模式來返回一個物件

區別

FactoryBean在BeanFacotry的實現中有著特殊的處理，如果一個物件實現了FactoryBean 那麼通過它get出來的物件實際是factoryBean.getObject()得到的物件，如果想得到FactoryBean必須通過在 '&' + beanName的方式獲取

FactoryBean的設計主要是為了進行擴充套件容器中Bean的建立方式，所以FactoryBean著重於自定義建立物件過程，同時FactoryBean都會放到容器中，FactoryBean所建立的Bean也會放入容器中

ObjectFactory則只是一個普通的物件工廠介面。在Spring中主要兩處用了它

Scope介面中的get方法，需要傳入一個ObjectFactory，如下：

Object get(String name, ObjectFactory<?> objectFactory);

這個方法的目的就是從對於的域中獲取到指定名稱的物件。為什麼要傳入一個objectFactory呢？主要是為了方便我們擴充套件自定義的域，而不是僅僅使用request，session等域。

ConfigurableListableBeanFactory類中的registerResolvableDependency方法，其定義如下，

void registerResolvableDependency(Class<?> dependencyType, @Nullable Object autowiredValue);

粗看起來，好像這個方法跟ObjectFactory沒有什麼關聯，但是我們留意這個方法上面的JavaDoc，其中有一段關於引數autowiredValue的介紹，如下

@param autowiredValue the corresponding autowired value. This may also be an* implementation of the {@link org.springframework.beans.factory.ObjectFactory}* interface, which allows for lazy resolution of the actual target value.

從這段內容中我們能知道，autowiredValue這個引數可能就是一個ObjectFactory，主要是為了讓注入點能夠被延遲注入。

Spring通過這種方式注入了request,response等物件

beanFactory.registerResolvableDependency(ServletRequest.class, new RequestObjectFactory());
beanFactory.registerResolvableDependency(ServletResponse.class, new ResponseObjectFactory());
beanFactory.registerResolvableDependency(HttpSession.class, new SessionObjectFactory());
beanFactory.registerResolvableDependency(WebRequest.class, new WebRequestObjectFactory());

我們看看RequestObjectFactory的定義：

private static class RequestObjectFactory implements ObjectFactory<ServletRequest>, Serializable {

    @Override
    // 是從當前執行緒中獲取的
    public ServletRequest getObject() {
        return currentRequestAttributes().getRequest();
    }

    @Override
    public String toString() {
        return "Current HttpServletRequest";
    }
}

當我們在某一個類中如果注入了ServletRequest物件，並不會直接建立一個ServletRequest然後注入進去，而是注入一個代理類，代理類中的方法是通過ObjectFactoryDelegatingInvocationHandler實現的，而這個物件中會持有一個RequestObjectFactory物件。

基於此，我們可以通過下面這種方式直接注入request物件，並且保證執行緒安全

@RestController
public class AutowiredRequestController {
 
    @Autowired
    private HttpServletRequest request;
}

ObjectProvider

介面定義

// 1.可以看到ObjectProvider本身繼承了ObjectFactory介面，所以它本身就是一個ObjectFactory
// 2.從5.1之後，這個介面還多繼承了一個Iterable介面，意味著能對它進行迭代以及流式操作
public interface ObjectProvider<T> extends ObjectFactory<T>, Iterable<T> {

	// 返回用指定引數建立的bean, 如果容器中不存在, 丟擲異常
	T getObject(Object... args) throws BeansException;

	// 如果指定型別的bean註冊到容器中, 返回 bean 範例, 否則返回 null
	@Nullable
	T getIfAvailable() throws BeansException;

	// 如果返回物件不存在，則用傳入的Supplier獲取一個Bean並返回，否則直接返回存在的物件
	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");
	}
}

介面分析

在Spring4.3之前，如果你建構函式中要依賴另外一個bean，你必須顯示依賴@Autowired（這裡不考慮使用了自動注入的方式，關於自動注入跟精確注入請參我之前的文章，《Spring官網閱讀》系列第二，三篇） ,像這樣子

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

而在4.3版本之後，已經不需要這麼做了，只要我們只提供了一個建構函式，並且建構函式所需要的引數都在Spring容器中（實際上官網中也指出，如果依賴關係是強制的，那麼最好使用建構函式進行注入），那麼不需要進行精確的指定使用@Autowired。

相比於4.3版本這無疑簡化了我們的開發，但是這種隱式的注入仍然存在一些不足。

例如，就上面的例子而言，如果容器中存在了一個以上的FooRepository甚至一個都沒有的情況下，丟擲異常

Parameter 0 of constructor in com.example.demo.FooServicerequired a bean of type ‘com.example.demo.FooRepository’ that could not be found.

或者是

No qualifying bean of type ‘com.example.demo.FooRepository’’ available: expected single matching bean but found 2:

那麼我們有什麼辦法解決它呢？

基於這個原因，ObjectProvider就出場了。如果注入範例為空時，使用ObjectProvider則避免了強依賴導致的依賴物件不存在異常；如果有多個範例，ObjectProvider的方法可以根據Bean實現的Ordered介面或@Order註解指定的先後順序獲取一個Bean。從而了提供了一個更加寬鬆的依賴注入方式。

Spring主要在org.springframework.beans.factory.support.DefaultListableBeanFactory#resolveDependency方法中使用了它，具體程式碼如下：

@Override
public Object resolveDependency(DependencyDescriptor descriptor, String requestingBeanName, Set<String> autowiredBeanNames, @Nullable TypeConverter typeConverter) throws BeansException {
	// descriptor代表當前需要注入的那個欄位，或者方法的引數，也就是注入點
    // ParameterNameDiscovery用於解析方法引數名稱
    descriptor.initParameterNameDiscovery(getParameterNameDiscoverer());
    // 1. Optional<T>
    if (Optional.class == descriptor.getDependencyType()) {
        return createOptionalDependency(descriptor, requestingBeanName);
    // 2. ObjectFactory<T>、ObjectProvider<T>
    } else if (ObjectFactory.class == descriptor.getDependencyType() ||
             ObjectProvider.class == descriptor.getDependencyType()) {
        return new DependencyObjectProvider(descriptor, requestingBeanName);
    // 3. javax.inject.Provider<T>
    } else if (javaxInjectProviderClass == descriptor.getDependencyType()) {
        return new Jsr330Factory().createDependencyProvider(descriptor, requestingBeanName);
    } else {
        // 4. @Lazy
        Object result = getAutowireCandidateResolver().getLazyResolutionProxyIfNecessary(
            descriptor, requestingBeanName);
        // 5. 正常情況
        if (result == null) {
            result = doResolveDependency(descriptor, requestingBeanName, autowiredBeanNames, typeConverter);
        }
        return result;
    }
}

其實不管是上面的哪個情況，最終都會呼叫到正常情況下的doResolveDependency方法中。

我們著重關注上面的第二種情況，可以看到當注入點為ObjectFactory或者ObjectProvider時，會new一個DependencyObjectProvider返回出去，那麼返回的這個DependencyObjectProvider是什麼呢？

其繼承關係如下：

這個DependencyObjectProvider物件，其實就是一個ObjectProvider，我們看看它是如何實現ObjectProvider中的方法的（方法的實現邏輯都差不多，這裡就看一個方法）：

public Object getIfAvailable() throws BeansException {
    // 用於解決巢狀的情況，像這種：ObjectProvider<Optional<T>>
    if (this.optional) {
        return createOptionalDependency(this.descriptor, this.beanName);
    }
    else {
        DependencyDescriptor descriptorToUse = new DependencyDescriptor(this.descriptor) {
            @Override
            public boolean isRequired() {
                return false;
            }
        };
        // 最終還是會呼叫這個方法解決依賴
        return doResolveDependency(descriptorToUse, this.beanName, null, null);
    }
}

從上面的過程中我們可以看出，但Spring中某個Bean的依賴型別為ObjectProvider時，我們不需要提供一個ObjectProvider型別的Bean到容器中，只需要提供一個T型別的Bean到容器中，容器會自動將其包裝成一個ObjectProvider，然後注入到依賴中。

而基於ObjectProvider的一系列方法，我們就能解決之前提到的問題。

ObjectProvider解決的問題

問題一

容器中沒有Bean時，丟擲

Parameter 0 of constructor in com.example.demo.FooServicerequired a bean of type 'com.example.demo.FooRepository' that could not be found.

解決方式：

@Component
public class IndexService {

	B b;

    public IndexService(ObjectProvider<B> b) {
		this.b = b.getIfAvailable();
	}
}

但是上面這種解決方式的弊病也很明顯，就是b可能為空，則可能將異常從啟動階段轉移到業務執行階段。

問題二

容器中存在多個Bean時，丟擲

No qualifying bean of type 'com.example.demo.FooRepository'' available: expected single matching bean but found 2

@Component
public class IndexService {

	B b;

	public IndexService(ObjectProvider<B> b) {
		this.b = b.orderedStream().findFirst().orElse(null);
	}
}

當容器存在多個Bean，我們可以呼叫它的流式方法獲取一個自己想要的依賴。

總結

本文介紹了ObjectFactory跟ObjectProvider，對於ObjectFactory主要介紹了它的應用並且將其與我們之前學習過的FactoryBean做了比較。

關於ObjectProvider也對其中定義的方法，以及它解決的問題做了分析。可能有些讀者覺得這些東西也不是很重要，並不影響核心程式碼的閱讀。不過筆者在閱讀原始碼過程中，看到了不去弄明白實在是難受，本人也是秉著愚公移山的精神慢慢啃，一個知識點一個知識點慢慢摸索，雖然這樣慢了點，但是能學到東西也是有很大滿足感的。

以上為個人經驗，希望能給大家一個參考，也希望大家多多支援it145.com。

Spring之什麼是ObjectFactory?什麼是ObjectProvider?

目錄

ObjectFactory

介面定義

跟FactoryBean的區別及聯絡

ObjectProvider

介面定義

介面分析

ObjectProvider解決的問題

總結

熱門文章