Java中@Configuration的使用場景是什麼？

一、簡單介紹

@Configuration註解可以標註到類別上，當標註到類別上時，啟動Spring就會自動掃描@Configuration註解標註的類別，將其註冊到IOC容器中，並被實例化成Bean物件。
如果被@Configuration註解標註的類別中存在使用@Bean註解標註的建立某個類別物件的方法，那麼，Spring也會自動執行使用@Bean註解標註的方法，將對應的Bean定義資訊註冊到IOC容器，並進行實例化。

二、註解說明

@Configuration註解是從Spring 3.0版本開始加入的一個使Spring能夠支援註解驅動開發的標註型註解，主要用於標註在類別上。當某個類別標註了@Configuration註解時，表示這個類別是Spring的一個配置類別。 @Configuration註解能夠取代Spring的applicationContext.xml文件，並且被@Configuration註解標註的類，能夠自動註冊到IOC容器並進行實例化。

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註解標註的組態類別是否會被代理，並且在組態類別中使用@Bean註解產生的Bean對像在IOC容器中是否為單例對象，取值為true或false。當取值為true時，表示full（全域）模式，此模式下被@Configuration註解標註的組態類別會被代理，在組態類別中使用@Bean註解注入到IOC容器中的Bean物件是單例模式，無論呼叫多少次被@Bean註解標註的方法，傳回的都是同一個Bean物件。當取值為false時，表示lite（輕量級）模式，此模式下被@Configuration註解標註的配置類別不會被代理，在配置類別中使用@Bean註解注入到IOC容器中的Bean物件不是單範例模式，每次呼叫被@Bean註解標註的方法時，都會傳回一個新的Bean物件。預設的取值為true。

• enforceUniqueMethods：從Spring 6.0開始加入到@Configuration註解，指定使用@Bean註解標註的方法是否需要具有唯一的方法名稱，取值為true或false。當取值為true時，表示使用@Bean註解標註的方法具有唯一的方法名稱，且這些方法名稱不會重疊。當取值為false時，表示使用@Bean註解標註的方法名稱不唯一，有被重疊的風險。預設取值為true。

從@Configuration註解的原始碼也可以看出，@Configuration註解本質上是一個@Component註解，所以，被@Configuration註解標註的設定類別本身也會被註冊到IOC容器中。同時，@Configuration註解也會被@ComponentScan註解掃描到。

2. @Configuration使用場景

基於Spring的註解開發應用程式時，可以將@Configuration註解標註到某個類別上。當某個類別被@Configuration註解標註時，說明這個類別是配置類，可以在這個類別中使用@Bean註解向IOC容器中註入Bean對象，也可以使用@Autowired、@Inject和@Resource等註解來注入所需的Bean對象。

注意：基於Spring的註解模式開發應用程式時，在使用AnnotationConfigApplicationContext類別建立IOC容器時，需要注意以下事項：

（1）如果呼叫的是AnnotationConfigApplicationContext類別中傳入Class型別可變參數的建構方法來建立IOC容器，表示傳入使用@Configuration註解標註的組態類別的Class物件來建立IOC容器，則標註到組態類別上的@Configuration註解可以省略。
如果傳入的組態類別上省略了@Configuration註解，則每次呼叫組態類別中被@Bean註解標註的方法時，都會傳回不同的Bean實例物件。

AnnotationConfigApplicationContext類別中傳入Class類型可變參數的建構方法原始碼如下所示：

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

（2）如果呼叫的是AnnotationConfigApplicationContext類別中傳入String類型可變參數的建構方法來建立IOC容器，表示傳入應用程式的套件名稱來建立IOC容器，則標註到設定類別上的@Configuration註解不能省略。

AnnotationConfigApplicationContext類別中傳入String類型可變參數的建構方法原始碼如下所示：

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

三、 使用案例

1.驗證proxyBeanMethods屬性的作用

proxyBeanMethods屬性可取值為true或false。取值為true時，無論呼叫多少次在被@Configuration註解標註的類別中被@Bean註解標註的方法，傳回的都是同一個Bean物件。取值為false時，每次呼叫在被@Configuration註解標註的類別中被@Bean註解標註的方法，都會回傳回不同的Bean物件。

1.1 驗證proxyBeanMethods取值為true的情況

（1）建立Person類別

Person類別主要是用來註冊到IOC容器中，並且實例化物件。

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

（2）建立ConfigurationAnnotationConfig類別

ConfigurationAnnotationConfig类的作用就是充当程序启动的配置类，会在ConfigurationAnnotationConfig类上标注@Configuration注解，说明ConfigurationAnnotationConfig类是Spring启动时的配置类。

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

可以看到，在ConfigurationAnnotationConfig类上标注了@Configuration注解，由于@Configuration注解中的proxyBeanMethods属性默认为true，所以在ConfigurationAnnotationConfig类上的@Configuration注解省略了proxyBeanMethods属性。

（3）创建ConfigurationAnnotationTest类

ConfigurationAnnotationTest类的作用就是整个案例程序的启动类，对整个案例程序进行测试。

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，接下来，调用两次config的person()方法分别赋值给Person类型的局部变量person1和person2，最后打印person1是否等于person2的日志。

（4）测试案例

运行ConfigurationAnnotationTest类的main()方法，输出的结果信息如下所示。

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

通过输出的结果信息可以看出，person1是否等于person2输出的结果为true。说明当@Configuration注解中的proxyBeanMethods属性为true时，每次调用使用@Configuration注解标注的类中被@Bean注解标注的方法时，都会返回同一个Bean实例对象。

1.2 验证proxyBeanMethods取值为false的情况

验证@Configuration注解中的proxyBeanMethods属性为false的情况，与验证proxyBeanMethods属性为true的情况的案例程序基本一致，只是将ConfigurationAnnotationConfig类上标注的@Configuration注解的proxyBeanMethods属性设置为false，案例实现的具体步骤如下所示。

（1）修改proxyBeanMethods属性的值

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

（2）测试案例
运行ConfigurationAnnotationTest类的main()方法，输出的结果信息如下所示。

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

从输出的结果信息可以看出，person1是否等于person2输出的结果为false。说明当@Configuration注解中的proxyBeanMethods属性为false时，每次调用使用@Configuration注解标注的类中被@Bean注解标注的方法时，都会返回不同的Bean实例对象。

2. 传入配置类创建IOC容器

调用AnnotationConfigApplicationContext类的构造方法传入配置类的Class对象创建IOC容器时，可以省略配置类上的@Configuration注解，案例的具体实现步骤如下所示。

（1）删除@Configuration注解

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

（2）测试案例
运行ConfigurationAnnotationTest类的main()方法，输出的结果信息如下所示。

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

从输出的结果信息可以看到，输出了person1是否等于person2的结果为false。说明调用AnnotationConfigApplicationContext类的构造方法传入配置类的Class对象创建IOC容器时，可以省略配置类上的@Configuration注解，此时每次调用配置类中被@Bean注解标注的方法时，都会返回不同的Bean实例对象。

3. 传入包名创建IOC容器

调用AnnotationConfigApplicationContext类的构造方法传入包名创建IOC容器时，不能省略配置类上的@Configuration注解，案例的具体实现步骤如下所示。

（1）修改测试类

修改ConfigurationAnnotationTest类的main()方法中，创建AnnotationConfigApplicationContext对象的代码，将调用传入Class对象的构造方法修改为调用传入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

从输出的结果信息可以看出，调用AnnotationConfigApplicationContext类的构造方法传入包名创建IOC容器时，不能省略配置类上的@Configuration注解，否则会抛出NoSuchBeanDefinitionException。

（4）添加@Configuration注解

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

（5）再次测试案例

再次运行ConfigurationAnnotationTest类的main()方法，输出的结果信息如下所示。

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

從輸出的結果資訊可以看到，輸出了person1是否等於person2的結果為true，再次說明呼叫AnnotationConfigApplicationContext類別的建構方法傳入套件名稱建立IOC容器時，不能省略配置類別上的@ Configuration註解。

以上是Java中@Configuration的使用場景是什麼？的詳細內容。更多資訊請關注PHP中文網其他相關文章！