SpringBoot注册组件之@Configuration@Bean注解作用及注意点

SpringBoot版本

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.3.12.RELEASE</version>
        <relativePath/>
    </parent>

@Configuration作用

1. 标识使用该注解的类是配置类，可以在该类的方法中使用@Bean注解注册组件，一般用于注册第三方组件到容器，本地组件在类上使用对应的@Component@Servcice@Controller等注解即可
2. 使用@Bean注解的方法，方法名默认是组件名，方法返回值是容器中注册的对象

源码

package org.springframework.context.annotation;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import org.springframework.core.annotation.AliasFor;
import org.springframework.stereotype.Component;

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Component
public @interface Configuration {
    @AliasFor(
        annotation = Component.class
    )
    String value() default "";

    boolean proxyBeanMethods() default true;
}

package org.springframework.context.annotation;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import org.springframework.beans.factory.annotation.Autowire;
import org.springframework.core.annotation.AliasFor;

@Target({ElementType.METHOD, ElementType.ANNOTATION_TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Bean {
    @AliasFor("name")
    String[] value() default {};

    @AliasFor("value")
    String[] name() default {};

    /** @deprecated */
    @Deprecated
    Autowire autowire() default Autowire.NO;

    boolean autowireCandidate() default true;

    String initMethod() default "";

    String destroyMethod() default "(inferred)";
}

示例

• 创建待注入的组件类

package com.ultra.config;

public class User {
}

• 创建注册组件的配置文件

package com.ultra.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class UserConfig {

    @Bean
    public User user() {
        return new User();
    }
}

测试

• 在SpringBoot启动了中获取容器，从容器中获取对应的组件

package com.ultra;

import com.ultra.config.UserConfig;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.ConfigurableApplicationContext;

/**
 * @author admin
 */
@SpringBootApplication
public class SpringbootWebApplication {

    public static void main(String[] args) {
        ConfigurableApplicationContext applicationContext = SpringApplication.run(SpringbootWebApplication.class, args);
        UserConfig userConfig = applicationContext.getBean(UserConfig.class);
        System.out.println(userConfig);
        User userFromMethod = userConfig.user();
        User userFromContext = applicationContext.getBean(User.class);
        System.out.println("userFromMethod:" + userFromMethod);
        System.out.println("userFromContext:" + userFromContext);
        System.out.println(userFromMethod == userFromContext);

    }
}

• 日志输出

com.ultra.config.UserConfig$$EnhancerBySpringCGLIB$$5eb8b049@4c58ca3c
userFromMethod:com.ultra.config.User@70ba780d
userFromContext:com.ultra.config.User@70ba780d
true

• 无论是从容器还是通过正常的方法调用获取的对象都是同一个
• 可以看到UserConfig是使用SpringCGLIB代理的对象，目的就是可以改变原方法的默认行为：调用该方法时，检查容器中是否已存在，已存在的直接返回容器中的对象，不存在的在执行方法，真正创建组件对象并注入到容器中。

注意点

1. 通过源码可以看出@Configuration注解是组合注解，包含@Component注解功能，所以使用@Configuration的配置类也会注入到容器中
2. 在方法上使用@Bean注解注册的对象默认是单例的，如果需要多例则需要在方法上额外添加@Scope(“prototype”)注解，其中可以的取值如下。
   
3. @Configuration注解中有一个proxyBeanMethods属性，该属性的作用就是是否需要代理注册的Bean的方法，也就是代理配置类。
   默认true：可以确保开发者无论是通过自动注入还是通过调用配置类的方法获取的对象都是同一个，很少有开发者通过后者获取容器组件；
   false：该配置类就是一个普通类，调用该类的方法时，每次都会创建一个新的对象，通过容器获取的还是同一个。
4. 综上所述，建议大家将该值设置为false；但是要确保获取该组件时不能通过调用方法的方式。避免方式：
   在不同类中需要某个方法注入的组件，则通过容器获取；
   在同类中需要某个方法注入的组件，则声明一个属性，将该方法中创建的对象赋值给该属性，其他方法使用属性获取。

package com.ultra.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class UserConfig {

    private User user;

    @Bean
    public User user() {
        user = new User();
        return user;
    }

    @Bean
    public User useUser() {
        //使用user
        return user;
    }
}