java中@Configuration使用場景

更新時間：2023年03月10日 10:33:03 作者：Super_Leng

本文主要介紹了java中@Configuration使用場景，文中通過示例代碼介紹的非常詳細(xì)，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧

一、簡單介紹

@Configuration注解可以標(biāo)注到類上，當(dāng)標(biāo)注到類上時，啟動Spring就會自動掃描@Configuration注解標(biāo)注的類，將其注冊到IOC容器中，并被實例化成Bean對象。
如果被@Configuration注解標(biāo)注的類中存在使用@Bean注解標(biāo)注的創(chuàng)建某個類對象的方法，那么，Spring也會自動執(zhí)行使用@Bean注解標(biāo)注的方法，將對應(yīng)的Bean定義信息注冊到IOC容器，并進(jìn)行實例化。

二、注解說明

@Configuration注解是從Spring 3.0版本開始加入的一個使Spring能夠支持注解驅(qū)動開發(fā)的標(biāo)注型注解，主要用于標(biāo)注在類上。當(dāng)某個類標(biāo)注了@Configuration注解時，表示這個類是Spring的一個配置類。@Configuration注解能夠替代Spring的applicationContext.xml文件，并且被@Configuration注解標(biāo)注的類，能夠自動注冊到IOC容器并進(jìn)行實例化。

1. @Configuration源碼

源碼詳見：org.springframework.context.annotation.Configuration。

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Component
public @interface Configuration {
 @AliasFor(annotation = Component.class)
 String value() default "";
 // Since: 5.2
 boolean proxyBeanMethods() default true;
 // Since: 6.0
 boolean enforceUniqueMethods() default true;
}

@Configuration注解中每個屬性的含義如下所示：

value：存入到Spring IOC容器中的Bean的id。
proxyBeanMethods：從Spring 5.2版本開始加入到@Configuration注解，表示被@Configuration注解標(biāo)注的配置類是否會被代理，并且在配置類中使用@Bean注解生成的Bean對象在IOC容器中是否是單例對象，取值為true或者false。當(dāng)取值為true時，表示full（全局）模式，此模式下被@Configuration注解標(biāo)注的配置類會被代理，在配置類中使用@Bean注解注入到IOC容器中的Bean對象是單例模式，無論調(diào)用多少次被@Bean注解標(biāo)注的方法，返回的都是同一個Bean對象。當(dāng)取值為false時，表示lite（輕量級）模式，此模式下被@Configuration注解標(biāo)注的配置類不會被代理，在配置類中使用@Bean注解注入到IOC容器中的Bean對象不是單例模式，每次調(diào)用被@Bean注解標(biāo)注的方法時，都會返回一個新的Bean對象。默認(rèn)的取值為true。
enforceUniqueMethods：從Spring 6.0開始加入到@Configuration注解，指定使用@Bean注解標(biāo)注的方法是否需要具有唯一的方法名稱，取值為true或者false。當(dāng)取值為true時，表示使用@Bean注解標(biāo)注的方法具有唯一的方法名稱，并且這些方法名稱不會重疊。當(dāng)取值為false時，表示使用@Bean注解標(biāo)注的方法名稱不唯一，存在被重疊的風(fēng)險。默認(rèn)取值為true。

從@Configuration注解的源碼也可以看出，@Configuration注解本質(zhì)上是一個@Component注解，所以，被@Configuration注解標(biāo)注的配置類本身也會被注冊到IOC容器中。同時，@Configuration注解也會被@ComponentScan注解掃描到。

2. @Configuration使用場景

基于Spring的注解開發(fā)應(yīng)用程序時，可以將@Configuration注解標(biāo)注到某個類上。當(dāng)某個類被@Configuration注解標(biāo)注時，說明這個類是配置類，可以在這個類中使用@Bean注解向IOC容器中注入Bean對象，也可以使用@Autowired、@Inject和@Resource等注解來注入所需的Bean對象。

注意：基于Spring的注解模式開發(fā)應(yīng)用程序時，在使用AnnotationConfigApplicationContext類創(chuàng)建IOC容器時，需要注意如下事項：

（1）如果調(diào)用的是AnnotationConfigApplicationContext類中傳入Class類型可變參數(shù)的構(gòu)造方法來創(chuàng)建IOC容器，表示傳入使用@Configuration注解標(biāo)注的配置類的Class對象來創(chuàng)建IOC容器，則標(biāo)注到配置類上的@Configuration注解可以省略。
如果傳入的配置類上省略了@Configuration注解，則每次調(diào)用配置類中被@Bean注解標(biāo)注的方法時，都會返回不同的Bean實例對象。

AnnotationConfigApplicationContext類中傳入Class類型可變參數(shù)的構(gòu)造方法源碼如下所示：

public AnnotationConfigApplicationContext(Class<?>... componentClasses) {
    this();
    register(componentClasses);
    refresh();
}

（2）如果調(diào)用的是AnnotationConfigApplicationContext類中傳入String類型可變參數(shù)的構(gòu)造方法來創(chuàng)建IOC容器，表示傳入應(yīng)用程序的包名來創(chuàng)建IOC容器，則標(biāo)注到配置類上的@Configuration注解不能省略。

AnnotationConfigApplicationContext類中傳入String類型可變參數(shù)的構(gòu)造方法源碼如下所示：

public AnnotationConfigApplicationContext(String... basePackages) {
    this();
    scan(basePackages);
    refresh();
}

三、使用案例

1. 驗證proxyBeanMethods屬性的作用

proxyBeanMethods屬性可取值為true或者false。取值為true時，無論調(diào)用多少次在被@Configuration注解標(biāo)注的類中被@Bean注解標(biāo)注的方法，返回的都是同一個Bean對象。取值為false時，每次調(diào)用在被@Configuration注解標(biāo)注的類中被@Bean注解標(biāo)注的方法，都回返回不同的Bean對象。

1.1 驗證proxyBeanMethods取值為true的情況

（1）創(chuàng)建Person類

Person類主要是用來注冊到IOC容器中，并實例化對象。

public class Person {
    private String name;
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
}

（2）創(chuàng)建ConfigurationAnnotationConfig類

ConfigurationAnnotationConfig類的作用就是充當(dāng)程序啟動的配置類，會在ConfigurationAnnotationConfig類上標(biāo)注@Configuration注解，說明ConfigurationAnnotationConfig類是Spring啟動時的配置類。

@Configuration
public class ConfigurationAnnotationConfig {
    @Bean
    public Person person(){
        return new Person();
    }
}

可以看到，在ConfigurationAnnotationConfig類上標(biāo)注了@Configuration注解，由于@Configuration注解中的proxyBeanMethods屬性默認(rèn)為true，所以在ConfigurationAnnotationConfig類上的@Configuration注解省略了proxyBeanMethods屬性。

（3）創(chuàng)建ConfigurationAnnotationTest類

ConfigurationAnnotationTest類的作用就是整個案例程序的啟動類，對整個案例程序進(jìn)行測試。

public class ConfigurationAnnotationTest {

? ? private static final Logger LOGGER = LoggerFactory.getLogger(ConfigurationAnnotationTest.class);

? ? public static void main(String[] args) {
? ? ? ? AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(ConfigurationAnnotationConfig.class);
? ? ? ? ConfigurationAnnotationConfig config = context.getBean(ConfigurationAnnotationConfig.class);
? ? ? ? Person person1 = config.person();
? ? ? ? Person person2 = config.person();
? ? ? ? LOGGER.info("person1 == person2 ===>> {}", (person1 == person2));
? ? }
}

可以看到，在ConfigurationAnnotationTest類的main()方法中，首先基于AnnotationConfigApplicationContext常見了IOC容器context，從context中獲取了ConfigurationAnnotationConfig類的Bean實例對象config，接下來，調(diào)用兩次config的person()方法分別賦值給Person類型的局部變量person1和person2，最后打印person1是否等于person2的日志。

（4）測試案例

運行ConfigurationAnnotationTest類的main()方法，輸出的結(jié)果信息如下所示。

person1 是否等于 person2 ===>> true

通過輸出的結(jié)果信息可以看出，person1是否等于person2輸出的結(jié)果為true。說明當(dāng)@Configuration注解中的proxyBeanMethods屬性為true時，每次調(diào)用使用@Configuration注解標(biāo)注的類中被@Bean注解標(biāo)注的方法時，都會返回同一個Bean實例對象。

1.2 驗證proxyBeanMethods取值為false的情況

驗證@Configuration注解中的proxyBeanMethods屬性為false的情況，與驗證proxyBeanMethods屬性為true的情況的案例程序基本一致，只是將ConfigurationAnnotationConfig類上標(biāo)注的@Configuration注解的proxyBeanMethods屬性設(shè)置為false，案例實現(xiàn)的具體步驟如下所示。

（1）修改proxyBeanMethods屬性的值

@Configuration(proxyBeanMethods = false)
public class ConfigurationAnnotationConfig {
    @Bean
    public Person person(){
        return new Person();
    }
}

（2）測試案例
運行ConfigurationAnnotationTest類的main()方法，輸出的結(jié)果信息如下所示。

person1 是否等于 person2 ===>> false

從輸出的結(jié)果信息可以看出，person1是否等于person2輸出的結(jié)果為false。說明當(dāng)@Configuration注解中的proxyBeanMethods屬性為false時，每次調(diào)用使用@Configuration注解標(biāo)注的類中被@Bean注解標(biāo)注的方法時，都會返回不同的Bean實例對象。

2. 傳入配置類創(chuàng)建IOC容器

調(diào)用AnnotationConfigApplicationContext類的構(gòu)造方法傳入配置類的Class對象創(chuàng)建IOC容器時，可以省略配置類上的@Configuration注解，案例的具體實現(xiàn)步驟如下所示。

（1）刪除@Configuration注解

public class ConfigurationAnnotationConfig {
    @Bean
    public Person person(){
        return new Person();
    }
}

（2）測試案例
運行ConfigurationAnnotationTest類的main()方法，輸出的結(jié)果信息如下所示。

person1 是否等于 person2 ===>> false

從輸出的結(jié)果信息可以看到，輸出了person1是否等于person2的結(jié)果為false。說明調(diào)用AnnotationConfigApplicationContext類的構(gòu)造方法傳入配置類的Class對象創(chuàng)建IOC容器時，可以省略配置類上的@Configuration注解，此時每次調(diào)用配置類中被@Bean注解標(biāo)注的方法時，都會返回不同的Bean實例對象。

3. 傳入包名創(chuàng)建IOC容器

調(diào)用AnnotationConfigApplicationContext類的構(gòu)造方法傳入包名創(chuàng)建IOC容器時，不能省略配置類上的@Configuration注解，案例的具體實現(xiàn)步驟如下所示。

（1）修改測試類

修改ConfigurationAnnotationTest類的main()方法中，創(chuàng)建AnnotationConfigApplicationContext對象的代碼，將調(diào)用傳入Class對象的構(gòu)造方法修改為調(diào)用傳入String對象的方法，修改后的代碼如下所示。

public class ConfigurationAnnotationTest {

? ? private static final Logger LOGGER = LoggerFactory.getLogger(ConfigurationAnnotationTest.class);

? ? public static void main(String[] args) {
? ? ? ? AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext("com.lwk.demo.spring.annocation.configuration.config");
? ? ? ? ConfigurationAnnotationConfig config = context.getBean(ConfigurationAnnotationConfig.class);
? ? ? ? Person person1 = config.person();
? ? ? ? Person person2 = config.person();
? ? ? ? LOGGER.info("person1 是否等于 person2 ===>> {}", (person1 == person2));
? ? }
}

（2）刪除@Configuration注解

public class ConfigurationAnnotationConfig {
    @Bean
    public Person person(){
        return new Person();
    }
}

（3）測試案例

運行ConfigurationAnnotationTest類的main()方法，可以看到程序拋出了異常信息，如下所示。

Exception in thread "main" org.springframework.beans.factory.NoSuchBeanDefinitionException: No qualifying bean of type 'io.binghe.spring.annotation.chapter01.configuration.config.ConfigurationAnnotationConfig' available

從輸出的結(jié)果信息可以看出，調(diào)用AnnotationConfigApplicationContext類的構(gòu)造方法傳入包名創(chuàng)建IOC容器時，不能省略配置類上的@Configuration注解，否則會拋出NoSuchBeanDefinitionException。

（4）添加@Configuration注解

@Configuration
public class ConfigurationAnnotationConfig {
    @Bean
    public Person person(){
        return new Person();
    }
}

（5）再次測試案例

再次運行ConfigurationAnnotationTest類的main()方法，輸出的結(jié)果信息如下所示。

person1 是否等于 person2 ===>> true

從輸出的結(jié)果信息可以看到，輸出了person1是否等于person2的結(jié)果為true，再次說明調(diào)用AnnotationConfigApplicationContext類的構(gòu)造方法傳入包名創(chuàng)建IOC容器時，不能省略配置類上的@Configuration注解。

到此這篇關(guān)于java中@Configuration使用場景的文章就介紹到這了,更多相關(guān)java @Configuration內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！