一、前言
之前的IoC講解部分大多是理論內(nèi)容,感覺缺少一些操作示例,接下來我就會用Spring的注解開發(fā),將一些主要的Spring黑科技展示出來,而所要展示的內(nèi)容很多,可能一次寫不完整,所以分為多篇博客進(jìn)行講解。下面我們一起學(xué)習(xí)一下Spring的注解驅(qū)動開發(fā),我是參照尚硅谷的Spring注解驅(qū)動開發(fā)視頻學(xué)習(xí)的此部分內(nèi)容,自己實現(xiàn)了所有的代碼,而這個視頻大家可以在B站看到,也可以去尚硅谷官網(wǎng)下載,個人感覺這個教程和《Spring揭秘》這本書很配套,也非常推薦。
二、通過@Bean注解將Bean注入Spring容器
我們都應(yīng)該知道使用xml文件來配置bean,在xml中配置的bean會注入到Spring容器中,我們就可以通過ApplicationContext.getBean()
方法獲取相關(guān)的對象,那么我們使用注解怎么實現(xiàn)這個功能呢?下面先給出代碼,然后根據(jù)代碼進(jìn)行講解:
Person類
package com.jiayifan.bean;
import org.springframework.beans.factory.annotation.Value;
/**
* Created by Yifan Jia on 2018/6/12.
*/
public class Person {
private String name;
private Integer age;
public Person() {
}
public Person(String name, Integer age) {
this.name = name;
this.age = age;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public Integer getAge() {
return age;
}
public void setAge(Integer age) {
this.age = age;
}
@Override
public String toString() {
return "Person{" +
"name='" + name + '\'' +
", age=" + age +
'}';
}
}
配置類
@Configuration//告訴spring這是一個配置類
public class MainConfig {
@Bean//給容器中至少一個bean,bean的類型就是返回值得類型,id默認(rèn)為方法名
public Person person() {
return new Person("賈一帆", 20);
}
}
首先,我們也需要一個像xml一樣的配置文件來配置我們想注入容器的bean,這里我們創(chuàng)建了一個配置類,我們就可以把這個配置類當(dāng)做以前的xml配置文件,在xml中可以配置的東西在配置類中都可以使用相應(yīng)的注解實現(xiàn),上面例子中,我們希望將Person類注入到容器中,創(chuàng)建一個配置類后,我們需要使用@Configuration
注解來告訴Spring這是一個配置類,然后我們可以通過寫一個返回我們需要對象的方法加上@Bean
注解,就是:
@Bean//給容器中至少一個bean,bean的類型就是返回值得類型,id默認(rèn)為方法名
public Person person() {
return new Person("賈一帆", 20);
}
來實現(xiàn)bean的注入,然后我們就可以測試一下了:
@Test
public void test01() {
//獲取容器
AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext(MainConfig.class);
//查看容器中類型是Person類的BeanName
String[] beanNamesForType = applicationContext.getBeanNamesForType(Person.class);
for(String name : beanNamesForType) {
System.out.println(name);
}
}
這里我們創(chuàng)建的容器不再是ClassPathXmlApplicationContext
而是AnnotationConfigApplicationContext
,然后傳入的參數(shù)也不是xml配置文件,而是配置類,下面看一下測試的結(jié)果:
這里我們也可以看到容器中的
Person
類的BeanName
(Bean的id)是方法名。我們?nèi)绻胍付?code>BeanName,我們可以在@Bean
注解中添加屬性,比如:@Bean("myPerson")
,這樣一改上面的測試結(jié)果就變成了:三、通過包掃描的方法為容器中注入Bean
我們都知道在xml配置文件中可以通過包掃描的方法批量的將bean注入到容器中,而在配置類中,我們也有這樣的功能,下面我們先看一下代碼:
這里我創(chuàng)建了其他一些POJO來作為Bean注入到容器中,和上面的Person類相似,下面就顯示一個POJO,其他的就不展示了:
@Component//使用包掃描功能時需要添加這個注解
public class Yellow {
}
配置類
@ComponentScan(value = "com.jiayifan.bean"})
@Configuration//告訴spring這是一個配置類
public class MainConfig {
}
上面的代碼我們看出來我們并沒有使用@Bean
注解的方法添加bean到容器中,而是使用了@ComponentScan(value = "com.jiayifan.bean"})
注解,掃描com.jiayifan。bean
包下有@@Component
注解標(biāo)注的類,自動加入到容器中。下面我們來測試一下這個類:
private void printBeans() {
AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext(MainConfig.class);
//獲取容器中所有的bean的名字
String[] beanDefinitionNames = applicationContext.getBeanDefinitionNames();
for(String name : beanDefinitionNames) {
System.out.println(name);
}
}
上面這個方法可以打印容器中所有的bean的名字,我們以后會經(jīng)常使用這個方法,大家請記住這個方法,后面的講解中會調(diào)用了這個方法。
@Test
public void importTest() {
printBeans();
}
測試的結(jié)果是:
我們可以看到除了Spring容器啟動時自動加載的一些bean,還加載了mainConfig
、yellow
、myPerson
,這里的mainConfig
就是我們的配置類,其他的兩個就是com.jiayifan.bean
中使用@Component
標(biāo)注了的類,當(dāng)然我們也可以使用@Controller
、@Repository
、@Service
來標(biāo)注需要包掃描添加的bean,不過因為不涉及到web,所以使用了@Component
。
四、通過@Import
將Bean注入到容器
我們也可以通過@Import
注解來快速的為容器中注入我們所需要的bean,下面還是先看代碼:
導(dǎo)入的POJO類省略
配置類
@Configuration//告訴spring這是一個配置類
@Import(value = {Color.class})//快速導(dǎo)入bean,id默認(rèn)為全類名
public class MainConfig2 {
}
這時候我們測試一下容器中有哪些bean:
這里我換了另外一個配置類當(dāng)做配置文件,我們可以看到容器中只有
com.jiayifan.bean.Color
和mainConfig2
,這里需要注意,使用@Import
注解導(dǎo)入的bean的名稱為全類名。除了使用
@Import(value = {Color.class})
直接導(dǎo)入bean之外,我們可以通過查看@Import
注解的源碼,看一下@Import
還可以通過其他的方法導(dǎo)入bean:
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Import {
/**
* {@link Configuration}, {@link ImportSelector}, {@link ImportBeanDefinitionRegistrar}
* or regular component classes to import.
*/
Class<?>[] value();
}
我們可以看到value
屬性除了可以直接添加類之外,還可以添加ImportSelector
,其實這個ImportSelector
是一個接口,我們可以自定義實現(xiàn)一個ImportSelector
:
public class MyImportSelect implements ImportSelector {
//返回值就是要導(dǎo)入到容器中的bean全類名
//AnnotationMetadata:當(dāng)前標(biāo)注@Import注解的類的所有注解信息
public String[] selectImports(AnnotationMetadata importingClassMetadata) {
//可以返回一個空數(shù)組,但是不要返回null,會報錯
return new String[]{"com.jiayifan.bean.Blue", "com.jiayifan.bean.Yellow", "com.jiayifan.bean.Red"};
}
}
通過實現(xiàn)的MyImportSelect
我們可以看到,其實這個ImportSelector
,就是一個將需要注入容器的bean的信息包裝起來的類,我們主要將bean的全類名包裝在這個類中,然后在@Import
的屬性中添加該類,就可以實現(xiàn)將多個bean一起注入到容器,不過這個類的主要作用應(yīng)該是可以使用importingClassMetadata
參數(shù)對所需要注入的bean進(jìn)行篩選。我們看一下使用這種方法怎么將bean注入容器:
@Configuration//告訴spring這是一個配置類
@Import(value = {MyImportSelect.class})
public class MainConfig2 {
}
測試結(jié)果:
在上面的
@Import
注解的源碼中,我們還發(fā)現(xiàn)除了類、ImportSelector
之外,還可以添加ImportBeanDefinitionRegister
,我們上面兩種方法添加到容器中的bean的名稱都是全類名,但是如果使用ImportBeanDefinitionRegister
,我們就可以自定義bean的名稱了。這里實現(xiàn)一個自己的
ImportBeanDefinitionRegister
:
public class MyImportBeanDefinitionRegistrar implements ImportBeanDefinitionRegistrar {
/**
*
* @param importingClassMetadata 當(dāng)前類的注解信息
* @param registry bean定義的注冊類
* 把所有需要注冊到容器中的bean:通過BeanDefinitionRegistry注冊到容器中
*/
public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {
//指定bean和BeanDefinition
//BeanDefinition自己創(chuàng)建
RootBeanDefinition rootBeanDefinition = new RootBeanDefinition(Yellow.class);
registry.registerBeanDefinition("yellow", rootBeanDefinition);
}
}
我們可以發(fā)現(xiàn)在這個方法中,我們通過自定義BeanDefinition
,手動的將BeanDefinition
注冊到容器中實現(xiàn)將bean注入容器的功能,這個方法中我們的自由度更大,感覺只是注冊一個類有點大材小用的感覺。我們接著測試一下:
@Configuration//告訴spring這是一個配置類
@Import(value = {MyImportBeanDefinitionRegistrar.class})
public class MainConfig2 {
}
測試結(jié)果:
上我們可以發(fā)現(xiàn)bean的名稱就是我們在
registry.registerBeanDefinition("yellow", rootBeanDefinition);
中添加的名稱。
五、總結(jié)
上面介紹了一下使用注解驅(qū)動開發(fā)過程中我們怎么將bean注冊到容器中,介紹了三種方法,我們比較常用的應(yīng)該就是包掃描和@Bean
注解的方法,其實除了這三個方法還有一種方法也可以實現(xiàn),并且我們肯定會想在包掃描的時候是不是可以像xml配置那樣有一些過濾的功能,其實這些在注解開發(fā)中都可以實現(xiàn),但是限于篇幅,這一篇中就沒有講解相關(guān)的內(nèi)容,這些內(nèi)容我們將在下一篇博客中進(jìn)行講解。