如今大部分的Spring項目都採用了基於註解的配置,採用了@Configuration 替換標籤的作法。一行簡單的註解就能夠解決不少事情。可是,其實每個註解背後都有不少值得學習和思考的內容。這些思考的點也是不少大廠面試官喜歡問的內容。java
在一次關於Spring註解的面試中,可能會經歷面試官的一段奪命連環問:web
@Configuration有什麼用? @Configuration和XML有什麼區別?哪一種好? Spring是如何基於來獲取Bean的定義的? @Autowired 、 @Inject、@Resource 之間有什麼區別? @Value、@PropertySource 和 @Configuration? Spring如何處理帶@Configuration @Import的類? @Profile有什麼用? @Configuration 如何嵌套? Spring如何對Bean進行延遲初始化? Spring項目怎麼進行單元測試? @Configuration 使用上有哪些約束?面試
本文就來嘗試回答下以上問題。簡單介紹下@Configuration 註解,而且你看一下他的基本用法以及和其餘註解產生化學反應。文章內容較長,建議收藏。spring
定義:指示一個類聲明一個或者多個@Bean 聲明的方法而且由Spring容器統一管理,以便在運行時爲這些bean生成bean的定義和服務請求的類。例如:apache
@Configuration public class AppConfig { @Bean public MyBean myBean(){ return new MyBean(); } }
上述AppConfig 加入@Configuration 註解,代表這就是一個配置類。有一個myBean()的方法,返回一個MyBean()的實例,並用@Bean 進行註釋,代表這個方法是須要被Spring進行管理的bean。@Bean 若是不指定名稱的話,默認使用myBean名稱,也就是小寫的名稱。編程
經過啓動一個AnnotationConfigApplicationContext 來引導這個@Configuration 註解的類,好比:app
AnnotationConfigApplicationContext ctx = new AnnotationConfigApplicationContext(); ctx.register(AppConfig.class); ctx.refresh();
在web項目中,也可使用AnnotationContextWebApplicationContext或者其餘變體來啓動。maven
新建一個SpringBoot項目(別問我爲何,由於這樣建立項目比較快)。ide
pom.xml 文件以下:函數
<?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> <parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> <version>2.1.5.RELEASE</version> <relativePath/> <!-- lookup parent from repository --> </parent> <groupId>com.spring.configuration</groupId> <artifactId>spring-configuration</artifactId> <version>0.0.1-SNAPSHOT</version> <name>spring-configuration</name> <description>Demo project for Spring Boot</description> <properties> <java.version>1.8</java.version> </properties> <dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-test</artifactId> <scope>test</scope> </dependency> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-context</artifactId> <version>5.0.6.RELEASE</version> </dependency> </dependencies> <build> <plugins> <plugin> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-maven-plugin</artifactId> </plugin> </plugins> </build> </project>
在config 包下新建一個MyConfiguration環境配置,和上面的示例代碼類似,完整的代碼以下:
@Configuration public class MyConfiguration { @Bean public MyBean myBean(){ System.out.println("myBean Initialized"); return new MyBean(); } }
說明MyConfiguration 是一個配置類,可以在此類下面聲明管理多個Bean,咱們聲明瞭一個MyBean的bean,但願它被容器加載和管理。
在pojo包下新建一個MyBean的類,具體代碼以下
public class MyBean { public MyBean(){ System.out.println("generate MyBean Instance"); } public void init(){ System.out.println("MyBean Resources Initialized"); } }
新建一個SpringConfigurationApplication類,用來測試MyConfiguration類,具體代碼以下:
public class SpringConfigurationApplication { public static void main(String[] args) { // AnnotationConfigApplicationContext context = = new AnnotationConfigApplicationContext(MyConfiguration.class) // 由於咱們加載的@Configuration 是基於註解形式的,因此須要建立AnnotationConfigApplicationContext AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(); // 註冊MyConfiguration 類並刷新bean 容器。 context.register(MyConfiguration.class); context.refresh(); } }
輸出:
myBean Initialized generate MyBean Instance
從輸出的結果能夠看到,默認名稱爲myBean 的bean隨着容器的加載而加載,由於myBean方法返回一個myBean的構造方法,因此myBean被初始化了。
經過XML 的方式來啓動
能夠經過使用XML方式定義的開啓基於註解的啓動,而後再定義一個MyConfiguration的bean,在/resources 目錄下新建 application-context.xml 代碼以下:
<?xml version="1.0" encoding="UTF-8"?> <beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:context="http://www.springframework.org/schema/context" xmlns:util="http://www.springframework.org/schema/util" xsi:schemaLocation=" http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-4.2.xsd http://www.springframework.org/schema/util http://www.springframework.org/schema/util/spring-util-4.2.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.2.xsd" > <!-- 至關於基於註解的啓動類 AnnotationConfigApplicationContext--> <context:annotation-config /> <bean class="com.spring.configuration.config.MyConfiguration"/> </beans>
須要引入applicationContext.xml ,在SpringConfigurationApplication 須要進行引入,修改後的SpringConfigurationApplication以下:
public class SpringConfigurationApplication { public static void main(String[] args) { ApplicationContext context = new ClassPathXmlApplicationContext("applicationContext.xml"); } }
輸出:
myBean Initialized generate MyBean Instance
@Configuration 使用@Component 進行原註解,所以@Configuration 類也能夠被組件掃描到(特別是使用XML元素)。
在這裏認識幾個註解: @Controller, @Service, @Repository, @Component
@Controller: 代表一個註解的類是一個"Controller",也就是控制器,能夠把它理解爲MVC 模式的Controller 這個角色。這個註解是一個特殊的@Component,容許實現類經過類路徑的掃描掃描到。它一般與@RequestMapping 註解一塊兒使用。
@Service: 代表這個帶註解的類是一個"Service",也就是服務層,能夠把它理解爲MVC 模式中的Service層這個角色,這個註解也是一個特殊的@Component,容許實現類經過類路徑的掃描掃描到
@Repository: 代表這個註解的類是一個"Repository",團隊實現了JavaEE 模式中像是做爲"Data Access Object" 可能做爲DAO來使用,當與 PersistenceExceptionTranslationPostProcessor 結合使用時,這樣註釋的類有資格得到Spring轉換的目的。這個註解也是@Component 的一個特殊實現,容許實現類可以被自動掃描到
@Component: 代表這個註釋的類是一個組件,當使用基於註釋的配置和類路徑掃描時,這些類被視爲自動檢測的候選者。
也就是說,上面四個註解標記的類都可以經過@ComponentScan 掃描到,上面四個註解最大的區別就是使用的場景和語義不同,好比你定義一個Service類想要被Spring進行管理,你應該把它定義爲@Service 而不是@Controller由於咱們從語義上講,@Service更像是一個服務的類,而不是一個控制器的類,@Component一般被稱做組件,它能夠標註任何你沒有嚴格予以說明的類,好比說是一個配置類,它不屬於MVC模式的任何一層,這個時候你更習慣於把它定義爲 @Component。@Controller,@Service,@Repository 的註解上都有@Component,因此這三個註解均可以用@Component進行替換。
來看一下代碼進行理解:
定義五個類,類上分別用@Controller, @Service, @Repository, @Component, @Configuration 進行標註,分別以下
@Component public class UserBean {} @Configuration public class UserConfiguration {} @Controller public class UserController {} @Repository public class UserDao {} @Service public class UserService {}
在MyConfiguration上加上@ComponentScan 註解,掃描上面5個類所在的包位置。代碼以下:
@Configuration @ComponentScan(basePackages = "com.spring.configuration.pojo") public class MyConfiguration { @Bean public MyBean myBean(){ System.out.println("myBean Initialized"); return new MyBean(); } }
修改 SpringConfigurationApplication 中的代碼,以下:
public class SpringConfigurationApplication { public static void main(String[] args) { // AnnotationConfigApplicationContext context = = new AnnotationConfigApplicationContext(MyConfiguration.class) // ApplicationContext context = new ClassPathXmlApplicationContext("applicationContext.xml"); AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(); context.register(MyConfiguration.class); context.refresh(); // 獲取啓動過程當中的bean 定義的名稱 for(String str : context.getBeanDefinitionNames()){ System.out.println("str = " + str); } context.close(); } }
輸出:
myBean Initialized generate MyBean Instance str = org.springframework.context.annotation.internalConfigurationAnnotationProcessor str = org.springframework.context.annotation.internalAutowiredAnnotationProcessor str = org.springframework.context.annotation.internalRequiredAnnotationProcessor str = org.springframework.context.annotation.internalCommonAnnotationProcessor str = org.springframework.context.event.internalEventListenerProcessor str = org.springframework.context.event.internalEventListenerFactory str = myConfiguration str = userBean str = userConfiguration str = userController str = userDao str = userService str = myBean
由輸出能夠清楚的看到,上述定義的五個類成功被@ComponentScan 掃描到,並在程序啓動的時候進行加載。
@Configuration 一般和Environment 一塊兒使用,經過@Environment 解析的屬性駐留在一個或多個"屬性源"對象中,@Configuration類可使用@PropertySource,像Environment 對象提供屬性源
爲了便於測試,咱們引入junit4和spring-test 的依賴,完整的配置文件以下
<?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> <parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> <version>2.1.5.RELEASE</version> <relativePath/> <!-- lookup parent from repository --> </parent> <groupId>com.spring.configuration</groupId> <artifactId>spring-configuration</artifactId> <version>0.0.1-SNAPSHOT</version> <name>spring-configuration</name> <description>Demo project for Spring Boot</description> <properties> <java.version>1.8</java.version> <spring.version>5.0.6.RELEASE</spring.version> <spring.test.version>4.3.13.RELEASE</spring.test.version> <junit.version>4.12</junit.version> </properties> <dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-test</artifactId> <scope>test</scope> </dependency> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-context</artifactId> <version>${spring.version}</version> </dependency> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-test</artifactId> <version>${spring.test.version}</version> </dependency> <dependency> <groupId>junit</groupId> <artifactId>junit</artifactId> <version>${junit.version}</version> </dependency> </dependencies> <build> <plugins> <plugin> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-maven-plugin</artifactId> </plugin> </plugins> </build> </project>
在config 包下定義一個 EnvironmentConfig 類,注入Environment 屬性,完整代碼以下:
@RunWith(SpringJUnit4ClassRunner.class) @ContextConfiguration(classes = EnvironmentConfig.class) @Configuration @PropertySource("classpath:beanName.properties") public class EnvironmentConfig { @Autowired Environment env; @Test public void testReadProperty(){ // 獲取bean.name.controller 的屬性 System.out.println(env.getProperty("bean.name.controller")); // 判斷是否包含bean.name.component System.out.println(env.containsProperty("bean.name.component")); // 返回與給定鍵關聯的屬性值 System.out.println(env.getRequiredProperty("bean.name.service")); } }
在/resources 目錄下新建beanName.properties 文件,以下:
bean.name.configuration=beanNameConfiguration bean.name.controller=beanNameController bean.name.service=beanNameService bean.name.component=beanNameComponent bean.name.repository=beanNameRepository
啓動並進行Junit測試,輸出以下:
…..…… beanNameController true beanNameService …..……
@Inject: 這是jsr330 的規範,經過AutowiredAnnotationBeanPostProcessor 類實現的依賴注入。位於javax.inject包內,是Java自帶的註解。
@Inject @Named("environment") Environment env;
不加@Named註解,須要配置與變量名一致便可。
@Autowired: @Autowired 是Spring提供的註解,經過AutowiredAnnotationBeanPostProessor 類實現注入。位於org.springframework.beans.factory.annotation 包內,是Spring 中的註解
@Autowired Environment env;
默認是經過byType 實現注入
@Resource: @Resource 是jsr250規範的實現,@Resource經過CommonAnnotationBeanPostProcessor 類實現注入。@Resource 通常會指定一個name屬性,以下:
@Resource(name = "environment") Environment env;
@Autowired和@Inject基本是同樣的,由於二者都是使用AutowiredAnnotationBeanPostProcessor來處理依賴注入。可是@Resource是個例外,它使用的是CommonAnnotationBeanPostProcessor來處理依賴注入。固然,二者都是BeanPostProcessor。
在介紹完上述三者的區別以後,能夠對Environment的屬性以上述注入方式進行改造
@Configuration 能夠和@Value 和@PropertySource 一塊兒使用讀取外部配置文件,具體用法以下:
在config 包下新建一個ReadValueFromPropertySource類,代碼以下
@PropertySource("classpath:beanName.properties") @Configuration public class ReadValueFromPropertySource { @Value("bean.name.component") String beanName; @Bean("myTestBean") public MyBean myBean(){ return new MyBean(beanName); } }
經過@PropertySource引入的配置文件,使@Value 可以獲取到屬性值,在給myBean()方法指定了一個名稱叫作myTestBean。
修改MyBean類,增長一個name屬性和一個構造器,再生成其toString() 方法
public class MyBean { String name; public MyBean(String name) { this.name = name; } public MyBean(){ System.out.println("generate MyBean Instance"); } public void init(){ System.out.println("MyBean Resources Initialized"); } @Override public String toString() { return "MyBean{" + "name='" + name + '\'' + '}'; } }
在SpringConfigurationApplication中進行測試,以下
public class SpringConfigurationApplication { public static void main(String[] args) { // 爲了展現配置文件的完整性,以前的代碼沒有刪除。 // AnnotationConfigApplicationContext context = = new AnnotationConfigApplicationContext(MyConfiguration.class) // ApplicationContext context = new ClassPathXmlApplicationContext("applicationContext.xml"); // AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(); // context.register(MyConfiguration.class); // context.refresh(); // // // 獲取啓動過程當中的bean 定義的名稱 // for(String str : context.getBeanDefinitionNames()){ // System.out.println("str = " + str); // } // context.close(); ApplicationContext context = new AnnotationConfigApplicationContext(ReadValueFromPropertySource.class); MyBean myBean = (MyBean) context.getBean("myTestBean"); System.out.println("myBean = " + myBean); } }
使用Applicatio@InConntext 就可以獲取myTestBean 這個bean,再生成myBean的實例。
輸出:myBean = MyBean{name='bean.name.component'}
@Import的定義(來自於JavaDoc):代表一個或者多個配置類須要導入,提供與Spring XML中相等的功能,容許導入@Configuration 、@ImportSelector、@ImportBeanDefinitionRegistar的實現,以及常規組件相似於AnnotationConfigApplicationContext。可能用於類級別或者是原註解。若是XML或者其餘非@Configuration標記的Bean資源須要被導入的話,使用@ImportResource。下面是一個示例代碼:
在pojo 包下新建兩個配置類,分別是CustomerBo, SchedualBo
@Configuration public class CustomerBo { public void printMsg(String msg){ System.out.println("CustomerBo : " + msg); } @Bean public CustomerBo testCustomerBo(){ return new CustomerBo(); } } @Configuration public class SchedulerBo { public void printMsg(String msg){ System.out.println("SchedulerBo : " + msg); } @Bean public SchedulerBo testSchedulerBo(){ return new SchedulerBo(); } }
在config 包下新建一個AppConfig,導入CustomerBo 和 SchedulerBo 。
@Configuration @Import(value = {CustomerBo.class,SchedulerBo.class}) public class AppConfig {}
在config 包下新建一個ImportWithConfiguration ,用於測試@Import 和 @Configuration 的使用
public class ImportWithConfiguration { public static void main(String[] args) { ApplicationContext context = new AnnotationConfigApplicationContext(AppConfig.class); CustomerBo customerBo = (CustomerBo) context.getBean("testCustomerBo"); customerBo.printMsg("System out println('get from customerBo')"); SchedulerBo schedulerBo = (SchedulerBo) context.getBean("testSchedulerBo"); schedulerBo.printMsg("System out println('get from schedulerBo')"); } }
輸出:
CustomerBo : System out println('get from customerBo') SchedulerBo : System out println('get from schedulerBo')
@Profile: 表示當一個或多個@Value 指定的配置文件處於可用狀態時,組件符合註冊條件,能夠進行註冊。
三種設置方式:
能夠經過ConfigurableEnvironment.setActiveProfiles()以編程的方式激活
能夠經過AbstractEnvironment.ACTIVE_PROFILES_PROPERTY_NAME (spring.profiles.active )屬性設置爲 JVM屬性
做爲環境變量,或做爲web.xml 應用程序的Servlet 上下文參數。也能夠經過@ActiveProfiles 註解在集成測試中以聲明方式激活配置文件。
做用域
做爲類級別的註釋在任意類或者直接與@Component 進行關聯,包括@Configuration 類
做爲原註解,能夠自定義註解
做爲方法的註解做用在任何方法
注意:
若是一個配置類使用了Profile 標籤或者@Profile 做用在任何類中都必須進行啓用纔會生效,若是@Profile({"p1","!p2"}) 標識兩個屬性,那麼p1 是啓用狀態 而p2 是非啓用狀態的。
@ImportResource: 這個註解提供了與@Import 功能類似做用,一般與@Configuration 一塊兒使用,經過AnnotationConfigApplicationContext 進行啓動,下面以一個示例來看一下具體用法:
在config下新建TestService 類,聲明一個構造函數,類初始化時調用
public class TestService { public TestService(){ System.out.println("test @importResource success"); } }
在/resources 目錄下新建 importResources.xml ,爲了導入TestService
<?xml version="1.0" encoding="UTF-8"?> <beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:context="http://www.springframework.org/schema/context" xmlns:util="http://www.springframework.org/schema/util" xsi:schemaLocation=" http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-4.2.xsd http://www.springframework.org/schema/util http://www.springframework.org/schema/util/spring-util-4.2.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.2.xsd" > <bean id = "testService" class="com.spring.configuration.config.TestService" /> </beans>
而後在config 下新建一個ImportResourceWithConfiguration, 用於讀取配置文件
@Configuration @ImportResource("classpath:importResources.xml") public class ImportResourceWithConfiguration { @Autowired private TestService service; public void getImportResource(){ new TestService(); } public static void main(String[] args) { AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(ImportResourceWithConfiguration.class); context.getBean("testService"); } }
輸出:test @importResource success
@Configuration註解做用在類上,就和普通類同樣可以進行相互嵌套,定義內部類。
// 來自JavaDoc @Configuration public class AppConfig{ @Inject DataSource dataSource; @Bean public MyBean myBean(){ return new MyBean(dataSource); } @Configuration static class DataConfig(){ @Bean DataSource dataSource(){ return new EmbeddedDatabaseBuilder().build() } } }
在上述代碼中,只須要在應用程序的上下文中註冊 AppConfig 。因爲是嵌套的@Configuration 類,DatabaseConfig 將自動註冊。當AppConfig 、DatabaseConfig 之間的關係已經隱含清楚時,這就避免了使用@Import 註解的須要。
@Lazy : 代表一個bean 是否延遲加載,能夠做用在方法上,表示這個方法被延遲加載;能夠做用在@Component (或者由@Component 做爲原註解) 註釋的類上,代表這個類中全部的bean 都被延遲加載。若是沒有@Lazy註釋,或者@Lazy 被設置爲false,那麼該bean 就會急切渴望被加載;除了上面兩種做用域,@Lazy 還能夠做用在@Autowired和@Inject註釋的屬性上,在這種狀況下,它將爲該字段建立一個惰性代理,做爲使用ObjectFactory或Provider的默認方法。下面來演示一下:
修改MyConfiguration類,在該類上添加@Lazy 註解,新增一個IfLazyInit()方法,檢驗是否被初始化。
@Lazy @Configuration @ComponentScan(basePackages = "com.spring.configuration.pojo") public class MyConfiguration { @Bean public MyBean myBean(){ System.out.println("myBean Initialized"); return new MyBean(); } @Bean public MyBean IfLazyInit(){ System.out.println("initialized"); return new MyBean(); } }
修改SpringConfigurationApplication 啓動類,放開以前MyConfiguration 的啓動類
public class SpringConfigurationApplication { public static void main(String[] args) { AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(MyConfiguration.class); // ApplicationContext context = new ClassPathXmlApplicationContext("applicationContext.xml"); // AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(); // context.register(MyConfiguration.class); // context.refresh(); // // // 獲取啓動過程當中的bean 定義的名稱 for(String str : context.getBeanDefinitionNames()){ System.out.println("str = " + str); } // context.close(); // ApplicationContext context = // new AnnotationConfigApplicationContext(ReadValueFromPropertySource.class); // MyBean myBean = (MyBean) context.getBean("myTestBean"); // System.out.println("myBean = " + myBean); } }
輸出你會發現沒有關於bean的定義信息,可是當吧@Lazy 註釋拿掉,你會發現輸出了關於bean的初始化信息:
myBean Initialized generate MyBean Instance initialized generate MyBean Instance
Junit4 測試類,用於註解在類上表示經過Junit4 進行測試,能夠省略編寫啓動類代碼,是ApplicationContext 等啓動類的替換。通常用@RunWith 和 @Configuration 進行單元測試,這是軟件開發過程當中很是必要並且具備專業性的一部分,上面EnvironmentConfig 類證明了這一點:
@RunWith(SpringJUnit4ClassRunner.class) @ContextConfiguration(classes = EnvironmentConfig.class) @Configuration @PropertySource("classpath:beanName.properties") public class EnvironmentConfig { // @Autowired // Environment env; @Inject Environment env; @Test public void testReadProperty(){ // 獲取bean.name.controller 的屬性 System.out.println(env.getProperty("bean.name.controller")); // 判斷是否包含bean.name.component System.out.println(env.containsProperty("bean.name.component")); // 返回與給定鍵關聯的屬性值 System.out.println(env.getRequiredProperty("bean.name.service")); } }
詳情查閱@EnableAsync,@EnableScheduling,@EnableTransactionManagement,@EnableAspectJAutoProxy,@EnableWebMvc官方文檔
必須以類的方式提供(即不是從工廠方法返回的實例) @Configuration 註解的類必須是非final的 配置類必須是非本地的(便可能不在方法中聲明),native 標註的方法 任何嵌套的@Configuration 都必須是static 的。 @Bean 方法可能不會反過來建立更多配置類