Spring之什么是ObjectFactory?什么是ObjectProvider?
在Spring的學(xué)習(xí)過程中,總是學(xué)的越多,不懂的越多。本來只是想將ApplicationContext的相關(guān)內(nèi)容全部梳理一遍,結(jié)果發(fā)現(xiàn)涉及的東西越來越多,比如上篇文章中的ResolvableType,到這篇文章介紹的ObjectFactory跟ObjectProvider。不過想想也沒辦法,一步一步往前走唄,在這個過程中也確實學(xué)到了很多東西。廢話不多說,直接進入正文。
ObjectFactory
接口定義
// 一個對象工廠
public interface ObjectFactory<T> {
// 返回一個對象
T getObject() throws BeansException;
}
這個接口的定義非常簡單,就是一個對象工廠,定義了一個返回對象的工廠方法?;仡櫸覀冎苯咏榻B過的一個內(nèi)容FactroyBean,其接口定義如下:
public interface FactoryBean<T> {
@Nullable
T getObject() throws Exception;
@Nullable
Class<?> getObjectType();
default boolean isSingleton() {
return true;
}
}
可以看到兩者都有一個getObject方法,那么它們有什么區(qū)別或者聯(lián)系呢?
跟FactoryBean的區(qū)別及聯(lián)系
聯(lián)系
二者在功能設(shè)計上是沒有什么聯(lián)系的,他們最大的共同點就是都采用了工廠模式,通過工廠模式來返回一個對象
區(qū)別
FactoryBean在BeanFacotry的實現(xiàn)中有著特殊的處理,如果一個對象實現(xiàn)了FactoryBean 那么通過它get出來的對象實際是factoryBean.getObject()得到的對象,如果想得到FactoryBean必須通過在 '&' + beanName的方式獲取
FactoryBean的設(shè)計主要是為了進行擴展容器中Bean的創(chuàng)建方式,所以FactoryBean著重于自定義創(chuàng)建對象過程,同時FactoryBean都會放到容器中,FactoryBean所創(chuàng)建的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沒有什么關(guān)聯(lián),但是我們留意這個方法上面的JavaDoc,其中有一段關(guān)于參數(shù)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.
從這段內(nèi)容中我們能知道,autowiredValue這個參數(shù)可能就是一個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
// 是從當(dāng)前線程中獲取的
public ServletRequest getObject() {
return currentRequestAttributes().getRequest();
}
@Override
public String toString() {
return "Current HttpServletRequest";
}
}
當(dāng)我們在某一個類中如果注入了ServletRequest對象,并不會直接創(chuàng)建一個ServletRequest然后注入進去,而是注入一個代理類,代理類中的方法是通過ObjectFactoryDelegatingInvocationHandler實現(xiàn)的,而這個對象中會持有一個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> {
// 返回用指定參數(shù)創(chuàng)建的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回調(diào)消耗目標對象。
// 如果不存在則直接返回
default void ifAvailable(Consumer<T> dependencyConsumer) throws BeansException {
T dependency = getIfAvailable();
if (dependency != null) {
dependencyConsumer.accept(dependency);
}
}
// 如果不可用或不唯一(沒有指定primary)則返回null。否則,返回對象。
@Nullable
T getIfUnique() throws BeansException;
// 如果不存在唯一對象,則調(diào)用Supplier的回調(diào)函數(shù)
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();
}
// 返回符合條件對象的連續(xù)的Stream,沒有特殊順序保證(一般為注冊順序)
default Stream<T> stream() {
throw new UnsupportedOperationException("Multi element access not supported");
}
// 返回符合條件對象的連續(xù)的Stream。在標注Spring應(yīng)用上下文中采用@Order注解或?qū)崿F(xiàn)Order接口的順序
default Stream<T> orderedStream() {
throw new UnsupportedOperationException("Ordered element access not supported");
}
}
接口分析
在Spring4.3之前,如果你構(gòu)造函數(shù)中要依賴另外一個bean,你必須顯示依賴@Autowired(這里不考慮使用了自動注入的方式,關(guān)于自動注入跟精確注入請參我之前的文章,《Spring官網(wǎng)閱讀》系列第二,三篇) ,像這樣子
@Service
public class FooService {
private final FooRepository repository;
@Autowired
public FooService(FooRepository repository) {
this.repository = repository
}
}
而在4.3版本之后,已經(jīng)不需要這么做了,只要我們只提供了一個構(gòu)造函數(shù),并且構(gòu)造函數(shù)所需要的參數(shù)都在Spring容器中(實際上官網(wǎng)中也指出,如果依賴關(guān)系是強制的,那么最好使用構(gòu)造函數(shù)進行注入),那么不需要進行精確的指定使用@Autowired。
相比于4.3版本這無疑簡化了我們的開發(fā),但是這種隱式的注入仍然存在一些不足。
例如,就上面的例子而言,如果容器中存在了一個以上的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則避免了強依賴導(dǎo)致的依賴對象不存在異常;如果有多個實例,ObjectProvider的方法可以根據(jù)Bean實現(xiàn)的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代表當(dāng)前需要注入的那個字段,或者方法的參數(shù),也就是注入點
// ParameterNameDiscovery用于解析方法參數(shù)名稱
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;
}
}
其實不管是上面的哪個情況,最終都會調(diào)用到正常情況下的doResolveDependency方法中。
我們著重關(guān)注上面的第二種情況,可以看到當(dāng)注入點為ObjectFactory或者ObjectProvider時,會new一個DependencyObjectProvider返回出去,那么返回的這個DependencyObjectProvider是什么呢?
其繼承關(guān)系如下:

這個DependencyObjectProvider對象,其實就是一個ObjectProvider,我們看看它是如何實現(xiàn)ObjectProvider中的方法的(方法的實現(xiàn)邏輯都差不多,這里就看一個方法):
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;
}
};
// 最終還是會調(diào)用這個方法解決依賴
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可能為空,則可能將異常從啟動階段轉(zhuǎn)移到業(yè)務(wù)運行階段。
問題二
容器中存在多個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);
}
}
當(dāng)容器存在多個Bean,我們可以調(diào)用它的流式方法獲取一個自己想要的依賴。
總結(jié)
本文介紹了ObjectFactory跟ObjectProvider,對于ObjectFactory主要介紹了它的應(yīng)用并且將其與我們之前學(xué)習(xí)過的FactoryBean做了比較。
關(guān)于ObjectProvider也對其中定義的方法,以及它解決的問題做了分析??赡苡行┳x者覺得這些東西也不是很重要,并不影響核心代碼的閱讀。不過筆者在閱讀源碼過程中,看到了不去弄明白實在是難受,本人也是秉著愚公移山的精神慢慢啃,一個知識點一個知識點慢慢摸索,雖然這樣慢了點,但是能學(xué)到東西也是有很大滿足感的。
以上為個人經(jīng)驗,希望能給大家一個參考,也希望大家多多支持腳本之家。
相關(guān)文章
詳解springboot+mybatis-plue實現(xiàn)內(nèi)置的CRUD使用詳情
這篇文章主要介紹了詳解springboot+mybatis-plue實現(xiàn)內(nèi)置的CRUD使用詳情,文中通過示例代碼介紹的非常詳細,對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2020-07-07
淺談java中異步多線程超時導(dǎo)致的服務(wù)異常
下面小編就為大家?guī)硪黄獪\談java中異步多線程超時導(dǎo)致的服務(wù)異常。小編覺得挺不錯的,現(xiàn)在就分享給大家,也給大家做個參考。一起跟隨小編過來看看吧2016-06-06
springBoot基于webSocket實現(xiàn)掃碼登錄
最近做了個新項目,涉及到掃碼登錄。之前項目使用的是 ajax輪詢的方式。感覺太low了。所以這次用webSocket的方式進行實現(xiàn),感興趣的可以了解一下2021-06-06
java數(shù)據(jù)庫開發(fā)之JDBC的完整封裝兼容多種數(shù)據(jù)庫
這篇文章主要介紹了java數(shù)據(jù)庫開發(fā)之JDBC的完整封裝兼容多種數(shù)據(jù)庫,需要的朋友可以參考下2020-02-02
java 中InputStream,String,File之間的相互轉(zhuǎn)化對比
這篇文章主要介紹了java 中InputStream,String,File之間的相互轉(zhuǎn)化對比的相關(guān)資料,需要的朋友可以參考下2017-04-04
java微信公眾號開發(fā)第一步 公眾號接入和access_token管理
這篇文章主要為大家介紹了java微信公眾號開發(fā),主要內(nèi)容包括公眾號接入和access_token管理,感興趣的小伙伴們可以參考一下2016-01-01

