Spring进阶（十二）之@Configuration和@Bean详解

目录

@Configration注解

用法

总结

@Bean注解

用法

案例：

去掉@Configration注解会怎样？

@Configuration加不加到底区别在哪？

加@Configration的案例

不加@Configration的案例

总结

---

之前我们都是通过xml的方式定义bean，里面会写很多bean元素，然后spring启动的时候，就会读取 bean xml配置文件，然后解析这些配置，然后会将这些bean注册到spring容器中，供使用者使用。

jdk1.5里面有了注解的功能，spring也没闲着，觉得注解挺好用的，就将注解加了进来，让我们通过注解的方式来定义bean，用起来能达到xml中定义bean一样的效果，并且更简洁一些，这里面需要用到的注解就有 @Configuration 注解和 @Bean 注解。

@Configration注解

用法

@Configuration这个注解可以加在类上，让这个类的功能等同于一个bean xml配置文件，如下：

@Configuration
public class ConfigBean {
}

上面代码类似于下面的xml：

通过 AnnotationConfigApplicationContext 来加载 @Configuration 修饰的类，如下：

AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(ConfigBean.class);

此时ConfigBean类中没有任何内容，相当于一个空的xml配置文件，此时我们要在ConfigBean类中注册 bean，那么我们就要用到@Bean注解了。

总结

@Configuration 使用步骤：

• 在类上使用 @Configuration 注解
• 通过 AnnotationConfigApplicationContext 容器来加载@Configuration注解修饰的类

@Bean注解

用法

这个注解类似于bean xml配置文件中的bean元素，用来在spring容器中注册一个bean。 @Bean注解用在方法上，表示通过方法来定义一个bean，默认将方法名称作为bean名称，将方法返回值作为bean对象，注册到spring容器中。 如： 

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

@Bean注解还有很多属性，我们来看一下其源码：

@Target({ElementType.METHOD, ElementType.ANNOTATION_TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Bean {
@AliasFor("name")
String[] value() default {};
@AliasFor("value")
String[] name() default {};
@Deprecated
Autowire autowire() default Autowire.NO;
boolean autowireCandidate() default true;
String initMethod() default "";
String destroyMethod() default AbstractBeanDefinition.INFER_METHOD;
}

1. 第一行的@Target表示@Bean注解只能用在方法或者注解上
2. 根据该注解value和name参数能得知，使用的时候这两个参数不能同时使用，且给一个设置值的时候，另一个也拥有了相同的值
3. value或者name都是数组类型的，该数组第一个元素表示该Bean对象的名字，之后的数组元素则表示该Bean的别名
4. autowire参数上面标注了@Deprecated注解，表示该参数已经过时，不建议使用
5. initMethod表示bean的初始化方法，之后详讲
6. destroyMethod表示bean的销毁方法，之后详讲

案例：

public class User {
}

@Configuration
public class ConfigBean {

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

    @Bean("myUser2")
    public User user2(){
        return new User();
    }

    @Bean({"userSan","userThree","user3"})
    public User user3(){
        return new User();
    }
}

public class Test {

    @org.junit.Test
    public void test(){
        AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(ConfigBean.class);
        for (String beanName : context.getBeanDefinitionNames()) {
            //别名
            String[] aliases = context.getAliases(beanName);
            System.out.println(String.format("bean名称:%s,别名:%s,bean对象:%s",
                    beanName,
                    Arrays.asList(aliases),
                    context.getBean(beanName)));
        }

    }
}

运行输出：

bean名称:org.springframework.context.annotation.internalConfigurationAnnotationProcessor,别名:[],bean对象:org.springframework.context.annotation.ConfigurationClassPostProcessor@35d019a3
bean名称:org.springframework.context.annotation.internalAutowiredAnnotationProcessor,别名:[],bean对象:org.springframework.beans.factory.annotation.AutowiredAnnotationBeanPostProcessor@689604d9
bean名称:org.springframework.context.annotation.internalCommonAnnotationProcessor,别名:[],bean对象:org.springframework.context.annotation.CommonAnnotationBeanPostProcessor@18078bef
bean名称:org.springframework.context.event.internalEventListenerProcessor,别名:[],bean对象:org.springframework.context.event.EventListenerMethodProcessor@799f10e1
bean名称:org.springframework.context.event.internalEventListenerFactory,别名:[],bean对象:org.springframework.context.event.DefaultEventListenerFactory@4c371370
bean名称:configBean,别名:[],bean对象:com.example.ConfigurationTest.ConfigBean$$EnhancerBySpringCGLIB$$552a1060@145f66e3
bean名称:user1,别名:[],bean对象:com.example.ConfigurationTest.User@3023df74
bean名称:myUser2,别名:[],bean对象:com.example.ConfigurationTest.User@313ac989
bean名称:userSan,别名:[user3, userThree],bean对象:com.example.ConfigurationTest.User@4562e04d

其它的先不用管，我们就看最后四行。其中有我们自己创建的user1,myUser2和userSan这三个bean对象，但是我们还发现有一个configBean对象，我们并没有创建过啊，这是咋来的 。猜测是因为我们给CondigBean类加了@Configration注解，然后会给我们这个配置类也自动生成一个对象。

去掉@Configration注解会怎样？

我们把上面案例中的代码去掉@Configration注解，再运行输出：

bean名称:org.springframework.context.annotation.internalConfigurationAnnotationProcessor,别名:[],bean对象:org.springframework.context.annotation.ConfigurationClassPostProcessor@51e5fc98
bean名称:org.springframework.context.annotation.internalAutowiredAnnotationProcessor,别名:[],bean对象:org.springframework.beans.factory.annotation.AutowiredAnnotationBeanPostProcessor@7c469c48
bean名称:org.springframework.context.annotation.internalCommonAnnotationProcessor,别名:[],bean对象:org.springframework.context.annotation.CommonAnnotationBeanPostProcessor@12e61fe6
bean名称:org.springframework.context.event.internalEventListenerProcessor,别名:[],bean对象:org.springframework.context.event.EventListenerMethodProcessor@7ee955a8
bean名称:org.springframework.context.event.internalEventListenerFactory,别名:[],bean对象:org.springframework.context.event.DefaultEventListenerFactory@1677d1
bean名称:configBean,别名:[],bean对象:com.example.ConfigurationTest.ConfigBean@48fa0f47
bean名称:user1,别名:[],bean对象:com.example.ConfigurationTest.User@6ac13091
bean名称:myUser2,别名:[],bean对象:com.example.ConfigurationTest.User@5e316c74
bean名称:userSan,别名:[user3, userThree],bean对象:com.example.ConfigurationTest.User@6d2a209c

我们将加@Configration注解和不加该注解运行后输出的结果进行对比得出：

• 有没有@Configuration注解，不影响@Bean，@Bean都会起效，都会将@Bean修饰的方法作为bean注册到容器中（推翻了上面红色字体中我们的猜测）
• 被@Configuration修饰的bean最后输出的时候带有 EnhancerBySpringCGLIB 的字样，而没有@Configuration注解的bean没有Cglib的字样；有 EnhancerBySpringCGLIB 字样的说明这个bean被cglib处理过的，变成了一个代理对象。

但我们目前为止还是看不出来加不加@Configration的本质区别是啥，接着往下看

@Configuration加不加到底区别在哪？

通常情况下，bean之间是有依赖关系的，我们来创建个有依赖关系的bean试试

加@Configration的案例

public class ServiceA {
}

public class ServiceB {

    private ServiceA serviceA;

    public ServiceB(ServiceA serviceA){
        this.serviceA=serviceA;
    }

    @Override
    public String toString() {
        return "ServiceB{" +
                "serviceA=" + serviceA +
                '}';
    }
}

@Configuration
public class ConfigBean {

    @Bean
    public ServiceA serviceA(){
        System.out.println("serviceA被调用");
        return new ServiceA();
    }

    @Bean
    public ServiceB serviceB1(){
        System.out.println("serviceB1被调用");
        return new ServiceB(this.serviceA());
    }

    @Bean
    public ServiceB serviceB2(){
        System.out.println("serviceB2被调用");
        return new ServiceB(this.serviceA());
    }
}

public class Test {

    @org.junit.Test
    public void test(){
        AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(ConfigBean.class);
        for (String beanName : context.getBeanDefinitionNames()) {
            //别名
            String[] aliases = context.getAliases(beanName);
            System.out.println(String.format("bean名称:%s,别名:%s,bean对象:%s",
                    beanName,
                    Arrays.asList(aliases),
                    context.getBean(beanName)));
        }
    }
}

运行后输出：

serviceA被调用
serviceB1被调用
serviceB2被调用
bean名称:org.springframework.context.annotation.internalConfigurationAnnotationProcessor,别名:[],bean对象:org.springframework.context.annotation.ConfigurationClassPostProcessor@35d019a3
bean名称:org.springframework.context.annotation.internalAutowiredAnnotationProcessor,别名:[],bean对象:org.springframework.beans.factory.annotation.AutowiredAnnotationBeanPostProcessor@689604d9
bean名称:org.springframework.context.annotation.internalCommonAnnotationProcessor,别名:[],bean对象:org.springframework.context.annotation.CommonAnnotationBeanPostProcessor@18078bef
bean名称:org.springframework.context.event.internalEventListenerProcessor,别名:[],bean对象:org.springframework.context.event.EventListenerMethodProcessor@799f10e1
bean名称:org.springframework.context.event.internalEventListenerFactory,别名:[],bean对象:org.springframework.context.event.DefaultEventListenerFactory@4c371370
bean名称:configBean,别名:[],bean对象:com.example.ConfigurationTest.doem1.ConfigBean$$EnhancerBySpringCGLIB$$7112055c@145f66e3
bean名称:serviceA,别名:[],bean对象:com.example.ConfigurationTest.doem1.ServiceA@3023df74
bean名称:serviceB1,别名:[],bean对象:ServiceB{serviceA=com.example.ConfigurationTest.doem1.ServiceA@3023df74}
bean名称:serviceB2,别名:[],bean对象:ServiceB{serviceA=com.example.ConfigurationTest.doem1.ServiceA@3023df74}

从输出中可以看出

• 前三行可以看出，被@Bean修饰的方法都只被调用了一次，这个很关键
• 最后三行中可以看出都是同一个ServiceA对象，都是 ServiceA@3023df74 这个实例

不加@Configration的案例

代码就不重复写了，就将上面代码的@Configration注解去掉就行了，运行后输出：

serviceA被调用
serviceB1被调用
serviceA被调用
serviceB2被调用
serviceA被调用
bean名称:org.springframework.context.annotation.internalConfigurationAnnotationProcessor,别名:[],bean对象:org.springframework.context.annotation.ConfigurationClassPostProcessor@1ffe63b9
bean名称:org.springframework.context.annotation.internalAutowiredAnnotationProcessor,别名:[],bean对象:org.springframework.beans.factory.annotation.AutowiredAnnotationBeanPostProcessor@51e5fc98
bean名称:org.springframework.context.annotation.internalCommonAnnotationProcessor,别名:[],bean对象:org.springframework.context.annotation.CommonAnnotationBeanPostProcessor@7c469c48
bean名称:org.springframework.context.event.internalEventListenerProcessor,别名:[],bean对象:org.springframework.context.event.EventListenerMethodProcessor@12e61fe6
bean名称:org.springframework.context.event.internalEventListenerFactory,别名:[],bean对象:org.springframework.context.event.DefaultEventListenerFactory@7ee955a8
bean名称:configBean,别名:[],bean对象:com.example.ConfigurationTest.doem1.ConfigBean@1677d1
bean名称:serviceA,别名:[],bean对象:com.example.ConfigurationTest.doem1.ServiceA@48fa0f47
bean名称:serviceB1,别名:[],bean对象:ServiceB{serviceA=com.example.ConfigurationTest.doem1.ServiceA@6ac13091}
bean名称:serviceB2,别名:[],bean对象:ServiceB{serviceA=com.example.ConfigurationTest.doem1.ServiceA@5e316c74}

从输出中可以看出

• serviceA()方法被调用了3次
• configBean这个bean没有代理效果了
• 最后3行可以看出，几个ServiceA对象都是不一样的

总结

• @Configuration注解修饰的类，会被spring通过cglib做增强处理，通过cglib会生成一个代理对 象，代理会拦截所有被@Bean注解修饰的方法，可以确保这些bean是单例的
• 不管@Bean所在的类上是否有@Configuration注解，都可以将@Bean修饰的方法作为一个bean 注册到spring容器中