深入解析Spring中的@Bean注解
@Bean 基礎(chǔ)概念
隨著SpringBoot的流行,我們現(xiàn)在更多采用基于注解式的配置從而替換掉了基于XML的配置,所以本篇文章我們主要探討基于注解的@Bean以及和其他注解的使用;
- @Bean:Spring的@Bean注解用于告訴方法,產(chǎn)生一個Bean對象,然后這個Bean對象交給Spring管理。產(chǎn)生這個Bean對象的方法Spring只會調(diào)用一次,隨后這個Spring將會將這個Bean對象放在自己的IOC容器中;
- SpringIOC 容器管理一個或者多個bean,這些bean都需要在@Configuration注解下進(jìn)行創(chuàng)建,在一個方法上使用@Bean注解就表明這個方法需要交給Spring進(jìn)行管理;
- @Bean是一個方法級別上的注解,主要用在@Configuration注解的類里,也可以用在@Component注解的類里。添加的bean的id為方法名;
- 使用Bean時,即是把已經(jīng)在xml文件中配置好的Bean拿來用,完成屬性、方法的組裝;比如@Autowired , @Resource,可以通過byTYPE(@Autowired)、byNAME(@Resource)的方式獲取Bean;
- 注冊Bean時,@Component , @Repository , @ Controller , @Service , @Configration這些注解都是把你要實例化的對象轉(zhuǎn)化成一個Bean,放在IoC容器中,等你要用的時候,它會和上面的@Autowired , @Resource配合到一起,把對象、屬性、方法完美組裝;
- @Configuration與@Bean結(jié)合使用:@Configuration可理解為用spring的時候xml里面的標(biāo)簽,@Bean可理解為用spring的時候xml里面的標(biāo)簽;
快速搭建一個maven項目并配置好所需要的Spring 依賴
<dependency> <groupId>org.springframework</groupId> <artifactId>spring-context</artifactId> <version>4.3.13.RELEASE</version> </dependency> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-beans</artifactId> <version>4.3.13.RELEASE</version> </dependency> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-core</artifactId> <version>4.3.13.RELEASE</version> </dependency> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-web</artifactId> <version>4.3.13.RELEASE</version> </dependency>
在src根目錄下創(chuàng)建一個AppConfig的配置類,這個配置類也就是管理一個或多個bean 的配置類,并在其內(nèi)部聲明一個myBean的bean,并創(chuàng)建其對應(yīng)的實體類
@Configuration public class AppConfig { // 使用@Bean 注解表明myBean需要交給Spring進(jìn)行管理 // 未指定bean 的名稱,默認(rèn)采用的是 "方法名" + "首字母小寫"的配置方式 @Bean public MyBean myBean(){ return new MyBean(); } } public class MyBean { public MyBean(){ System.out.println("MyBean Initializing"); } }
然后再創(chuàng)建一個測試類SpringBeanApplicationTests,測試上述代碼的正確性
public class SpringBeanApplicationTests { public static void main(String[] args) { ApplicationContext context = new AnnotationConfigApplicationContext(AppConfig.class); context.getBean("myBean"); } }
輸出 : MyBean Initializing
深入了解@Bean注解的源代碼
@Target({ElementType.METHOD, ElementType.ANNOTATION_TYPE}) @Retention(RetentionPolicy.RUNTIME) @Documented public @interface Bean { @AliasFor("name") String[] value() default {}; @AliasFor("value") String[] name() default {}; Autowire autowire() default Autowire.NO; String initMethod() default ""; String destroyMethod() default AbstractBeanDefinition.INFER_METHOD; }
@Bean的屬性:
- value:bean別名和name是相互依賴關(guān)聯(lián)的,value,name如果都使用的話值必須要一致;
- name:bean名稱,如果不寫會默認(rèn)為注解的方法名稱;
- autowire:自定裝配默認(rèn)是不開啟的,建議盡量不要開啟,因為自動裝配不能裝配基本數(shù)據(jù)類型、字符串、數(shù)組等,這是自動裝配設(shè)計的局限性,并且自動裝配不如依賴注入精確;
- initMethod:bean的初始化之前的執(zhí)行方法,該參數(shù)一般不怎么用,因為完全可以在代碼中實現(xiàn);
- destroyMethod:默認(rèn)使用javaConfig配置的bean,如果存在close或者shutdown方法,則在bean銷毀時會自動執(zhí)行該方法,如果你不想執(zhí)行該方法,則添加@Bean(destroyMethod="")來防止出發(fā)銷毀方法;
如果發(fā)現(xiàn)銷毀方法沒有執(zhí)行,原因是bean銷魂之前程序已經(jīng)結(jié)束了,可以手動close下如下:
AnnotationConfigApplicationContext applicationContext2 = new AnnotationConfigApplicationContext(MainConfig.class); User bean2 = applicationContext2.getBean(User.class); System.out.println(bean2); //手動執(zhí)行close方法 applicationContext2.close();
運行結(jié)果如下:
初始化用戶bean之前執(zhí)行
User [userName=張三, age=26]
bean銷毀之后執(zhí)行
我們發(fā)現(xiàn)@baen注解的@Target是ElementType.METHOD,ElementType.ANNOTATION_TYPE也就說@Bean注解可以在使用在方法上,以及一個注釋類型聲明
@Bean 注解與其他注解一起使用
@Bean注解不止這幾個屬性,它還能和其他的注解一起配合使用,請繼續(xù)往下看:
@Profile 注解
@Profile的作用是把一些meta-data進(jìn)行分類,分成Active和InActive這兩種狀態(tài),然后你可以選擇在active 和在Inactive這兩種狀態(tài)下配置bean,在Inactive狀態(tài)通常的注解有一個!操作符,通常寫為:@Profile("!p"),這里的p是Profile的名字。
三種設(shè)置方式:
- 可以通過
ConfigurableEnvironment.setActiveProfiles()
以編程的方式激活。 - 可以通過
AbstractEnvironment.ACTIVE_PROFILES_PROPERTY_NAME (spring.profiles.active )
屬性設(shè)置為JVM屬性。 - 作為環(huán)境變量,或作為web.xml 應(yīng)用程序的Servlet 上下文參數(shù)。也可以通過
@ActiveProfiles
注解在集成測試中以聲明方式激活配置文件。
作用域:
- 作為類級別的注解在任意類或者直接與@Component 進(jìn)行關(guān)聯(lián),包括@Configuration 類
- 作為原注解,可以自定義注解
- 作為方法的注解作用在任何方法
注意:
- 如果一個配置類使用了Profile 標(biāo)簽或者@Profile 作用在任何類中都必須進(jìn)行啟用才會生效,如果
@Profile({“p1”,"!p2"})
標(biāo)識兩個屬性,那么p1 是啟用狀態(tài) 而p2 是非啟用狀態(tài)的。
例如:
@Profile("dev") public @Bean("activityMongoFactory") MongoDbFactory activityMongoFactoryDev(MongoClient activityMongo) { return new SimpleMongoDbFactory(activityMongo, stringValueResolver.resolveStringValue("${mongodb.dev.database}")); }
@Scope 注解
在Spring中對于bean的默認(rèn)處理都是單例的,我們通過上下文容器.getBean方法拿到bean容器,并對其進(jìn)行實例化,這個實例化的過程其實只進(jìn)行一次,即多次getBean 獲取的對象都是同一個對象,也就相當(dāng)于這個bean的實例在IOC容器中是public的,對于所有的bean請求來講都可以共享此bean。
如果我們不想把這個bean被所有的請求共享或者說每次調(diào)用我都想讓它生成一個新的bean實例,該怎么實現(xiàn)呢?
bean的多個實例
bean的非單例原型范圍會使每次發(fā)出對該特定bean的請求時都創(chuàng)建新的bean實例,也就是說,bean被注入另一個bean,或者通過對容器的getBean()方法調(diào)用來請求它。
下面,我們通過一個示例來說明bean的多個實例
新建一個ConfigScope配置類,用來定義多例的bean
@Configuration public class ConfigScope { /** * 為myBean起兩個名字,b1 和 b2 * @Scope 默認(rèn)為 singleton,但是可以指定其作用域 * prototype 是多例的,即每一次調(diào)用都會生成一個新的實例。 */ @Bean({"b1","b2"}) @Scope("prototype") public MyBean myBean(){ return new MyBean(); } }
注意:prototype代表bean對象的定義為任意數(shù)量的對象實例,所以指定為prototype屬性可以定義為多例,也會每一次調(diào)用都會生成一個新的實例。
singleton和prototype 一般都用在普通的Java項目中,而request、session、application、websocket都用于web應(yīng)用中。
@Lazy 注解
表明一個bean 是否延遲加載,可以作用在方法上,表示這個方法被延遲加載;可以作用在@Component (或者由@Component 作為原注解) 注釋的類上,表明這個類中所有的bean 都被延遲加載。
如果沒有@Lazy注釋,或者@Lazy 被設(shè)置為false,那么該bean 就會急切渴望被加載;除了上面兩種作用域,@Lazy 還可以作用在@Autowired和@Inject注釋的屬性上,在這種情況下,它將為該字段創(chuàng)建一個惰性代理,作為使用ObjectFactory或Provider的默認(rèn)方法。
下面來演示一下:
@Lazy @Configuration @ComponentScan(basePackages = "com.spring.configuration.pojo") public class AppConfigWithLazy { @Bean public MyBean myBean(){ System.out.println("myBean Initialized"); return new MyBean(); } @Bean public MyBean IfLazyInit(){ System.out.println("initialized"); return new MyBean(); } }
@Primary 注解
指示當(dāng)多個候選者有資格自動裝配依賴項時,應(yīng)優(yōu)先考慮bean。此注解在語義上就等同于在Spring XML中定義的bean 元素的primary屬性。
注意:除非使用component-scanning進(jìn)行組件掃描,否則在類級別上使用@Primary不會有作用。如果@Primary 注解定義在XML中,那么@Primary 的注解元注解就會忽略,相反的話就可以優(yōu)先使用。另外,關(guān)注Java知音公眾號,回復(fù)“后端面試”,送你一份面試題寶典!
@Primary 的兩種使用方式:
- 與@Bean 一起使用,定義在方法上,方法級別的注解
- 與@Component 一起使用,定義在類上,類級別的注解
新建一個AppConfigWithPrimary類,在方法級別上定義@Primary注解
@Configuration public class AppConfigWithPrimary { @Bean public MyBean myBeanOne(){ return new MyBean(); } @Bean @Primary public MyBean myBeanTwo(){ return new MyBean(); } }
上面代碼定義了兩個bean ,其中myBeanTwo 由@Primary 進(jìn)行標(biāo)注,表示它首先會進(jìn)行注冊,使用測試類進(jìn)行測試。
到此這篇關(guān)于深入解析Spring中的@Bean注解的文章就介紹到這了,更多相關(guān)Spring的@Bean注解內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
- Springboot @Configuration @bean注解作用解析
- Spring @Bean注解配置及使用方法解析
- SpringBoot配置@Configuration注解和@bean注解
- Spring注解驅(qū)動之關(guān)于@Bean注解指定初始化和銷毀的方法
- SpringBoot?@Configuration與@Bean注解使用介紹
- Spring?@Bean注解深入分析源碼執(zhí)行過程
- 關(guān)于spring的@Bean注解放入引用Bean中初始化失敗分析
- Spring @Bean注解的使用場景與案例實現(xiàn)
- spring中@Configuration和@Bean注解的用法
- 一文讀懂Spring中@Bean注解的核心作用
相關(guān)文章
Spring中@Autowired和@Resource注解的使用區(qū)別詳解
這篇文章主要介紹了Spring中@Autowired和@Resource注解的使用區(qū)別詳解,@Autowired默認(rèn)根據(jù)type進(jìn)行注入,找到與指定類型兼容的?Bean?并進(jìn)行注入,如果無法通過type匹配到對應(yīng)的?Bean?的話,會根據(jù)name進(jìn)行匹配,如果都匹配不到則拋出異常,需要的朋友可以參考下2023-11-11SpringBoot?pdf打印及預(yù)覽(openhtmltopdf+freemarker)
這篇文章主要介紹了SpringBoot?pdf打印及預(yù)覽(openhtmltopdf+freemarker)2023-05-05