【转】Spring学习---Bean配置的三种方式（XML、注解、Java类）介绍与对比

【原文】https://www.toutiao.com/i6594205115605844493/

Spring学习Bean配置的三种方式（XML、注解、Java类）介绍与对比

本文将详细介绍Spring Bean配置的三种不同方式的特点与使用条件。

主要包括：

• 基于XML的配置方式
• 基于注解的配置方式
• 基于Java类的配置方式

一.基于XML的配置

请看Spring学习（十二）Spring 的配置文件概述

二.基于注解的配置

Spring2.0开始引入基于注解的配置方式,即Bean的定义信息可以通过在Bean的实现类上标注注解实现。

具体关于注解的知识请看Java注解（Annotation）介绍

@Component是Spring容器中的基本注解，表示容器中的一个组件（bean），可以作用在任何层次，下面的示例介绍该注解的使用方法。

注解配置示例：

2. @Component("userDao")
3. public class userDao{......}

他等效于XML配置

<bean id="userDao" class="cn.lovepi.***.userDao"/>

此外，还有一些其他的可以被用来注解bean的注解，这些可以让注解类本身的用途更加清晰，此外，特定的注解也具备特定的功能。

Spring在2.5后提供了一个context的命名空间，它提供了通过扫描类包来加载利用注解定义的Bean的方式。

在context中可以使用resource-pattern来过滤出特定的类。

<context:component-scan base-package="cn.lovepi.spring" resource-pattern="anno/*.class"/>

默认情况下加载的是package下的*.class即扫描全部类，在使用了resource-pattern之后，则只扫描package下的anno子包下的所有类。

不过使用resource-pattern并不能提供给我们完善的功能，所有我们得使用过滤子元素的方法。

2. <context:component-scan base-package="cn.lovepi.spring">
3. <context:include-filter type="regex" expression="cn.lovepi.spring.*"/>
4. <context:exclude-filter type="aspectj" expression="cn.lovepi..*Controller+"/>
5. </context:component-scan>

其中：

include-filter表示要包含的目标类，

exclude-filter表示要排除在外的目标类

一个component-scan标签下可以有多个include-filter和exclude-filter，

过滤表达式所支持的类型如下表所示：

在这些类型当中，除了Custom外，aspectj的过滤功能最强大，他能轻易的实现其他类别的过滤规则。

Spring3.0提供了一系列的针对依赖注入的注解，这使得Spring IoC在XML文件之外多了一种可行的选择，主要包含如下注解类型：

• Bean的定义注解
• Bean的生命周期注解
• Bean的依赖检查注解
• Bean的自动装配注解

1.Bean的定义注解

Spring自2.0开始，陆续引入了一些注解用于简化Spring的开发。

@Repository注解便属于最先引入的一批，用于将数据访问层（DAO层）的类标识为Spring Bean。具体使用如下：

①首先使用@Repository将DAO类声明为Bean

2. @Repository
3. public class UserDaoImpl implements UserDao{......}

②在XML配置文件中启动Spring的自动扫描功能

2. <beans ...>
3. <context:component-scan base-package="cn.lovepi.dao"/>
4. ......
5. <beans/>

如此的话，我们便不在需要在XML当中显式使用bean来进行bean的配置。Spring容器在初始化的时候便会自动扫描base-package所指定的包以及子包下面的所有class文件。所有标注为Repository的类将被自动注册为bean。

为什么Repository只能标注在DAO类上面呢？

因为该注解的作用不只是将类识别为bean，同时他还能将所标注的类中所抛出的数据访问异常封装为Spring的数据访问异常类型。Spring本身提供了一个丰富的，并且是与具体的访问技术无关的数据访问异常结构，用于封装不同的持久层框架所抛出的异常，使得异常独立与底层的框架。

Spring2.5在@Repository的基础上增加了功能类似的额外三个注解，总共有如下四种注解：

• @Component：一个泛化的概念，表示一个组件（Bean），可作用在任何层次
• @Controller：用于对Controller实现类进行标注，目前该功能与Component相同
• @Repository：用于对DAO实现类进行标注
• @Service：用于对Service实现类进行标注，目前该功能与Component相同

这三个注解除了作用于不同软件层次的类，其使用方式与Repository是完全相同的。

2.Bean的生命周期注解

在某些情况下，可能需要我们手工做一些额外的初始化或者销毁操作，例如资源的获取和是否操作，Spring1.x为此提供了两种方式供用户指定执行生命周期回调的方法：

1. 实现Spring提供的两个接口：initializingBean 和 DisposableBean，这种方法是要求bean类实现Spring的接口，但增加了bean和Spring容器的耦合度，因此不推荐使用。
2. 在XML文件中使用<bean>的init-method 和 destory-method 属性，指定初始化之后和回调之前的回调方法。这两个属性的取值是bean中相应的初始化和销毁方法的名称。方法名称任意，但是方法不能有参数。

示例如下：

2. <bean id="userService" class="cn.lovepi.***.UserService"
3. init-method="init" destory-method="destory">
4. </bean>

在这里，我们指定了userService 这个bean的初始化方法为：init 销毁方法为：destory

Spring2.5在保留以上两种方式的基础上，提供了对JSR-250的支持。

JSR-250规范定义了两个用于指定声明周期方法的注解：

• @PostConstruct：初始化之后的执行的回调方法
• @PreDestroy：销毁之前的回调方法

注解示例说明：

2. public class PersonService{
3. @PostConstruct
4. public void init(){......}
5. @PreDestory
6. public void destory(){......}
7. }

在这里init方法是初始化之后执行的方法，而destory方法为销毁之前执行的方法

由于使用了注解，所以得激活Bean的后处理器，所以得在XML配置文件当中增加

<context:annotation-config/>

3.Bean的依赖检查注解

Spring2.0之前使用dependency-check在配置文件中设置属性用于依赖检查（只会检查Setter方法是否被调用），缺点是粒度较粗，该属性的取值包括以下几种：

• none： 默认不执行依赖检查
• simple ：对原始基本类型和集合类型进行检查
• objects ：对复杂类型进行检查
• all ：对所有类型进行检查

使用Spring2.0提供的@Required注解，提供了更细粒度的控制，@Required注解只能标注在Setter方法之上，（标注在其他方法之上会被忽略 ）用于检查其是否被调用，当Setter方法未被调用的话会抛出异常。

由于使用了注解，所以得激活Bean的后处理器，所以得在XML配置文件当中增加

<context:annotation-config/>

4.Bean的自动装配注解

@Autowired可以对成员变量、方法和构造函数进行标注，来完成自动装配的工作，他根据类型进行自动装配，如果需要按名称进行装配，则需要配合@Qualifier使用。

当标注了@Autowired的方法所需的类型在Spring容器中不存在的话会抛出异常

2. @Service
3. public class LoginService{
4. @Autowired
5. private LogDao logDao;
6. }

如上面的例子所示，假如Spring容器中没有LogDao这个bean的话便会抛出异常。

解决的办法便是使用required=false属性来标注

2. public class LoginService{
3. @Autowired(required=false)
4. private LogDao LogDao;
5. }

但是假如Spring当中存在多个所需类型的bean，那么便要使用@Qualifier注解来指定名称。

2. public class LoginService{
3. @Autowired
4. @Qualifier("userDao")
5. private UserDao userDao;
6. }

@Autowired 可以对类中集合类的变量或方法入参进行标注,此时会将容器中类型匹配的所有Bean都注入进来，如下所示：

2. public class loginService{
3. @Autowired(required=false)
4. public List<Plugin> pligins;
5. public List<Plugin> getPlugins(){
6. return plugins;
7. }
8. }

Spring会将容器中所有类型为Plugin的bean都注入到集合中去。

三.基于Java类的配置

基于Java类定义Bean配置元数据，其实就是通过Java类定义Spring配置元数据，且直接消除XML配置文件。

首先让我们看一下基于Java类如何定义Bean配置元数据，具体步骤如下：

1. 使用@Configuration注解需要作为配置的类，表示该类将定义Bean的元数据
2. 使用@Bean注解相应的方法，该方法名默认就是Bean的名称，该方法返回值就是Bean的对象。
3. AnnotationConfigApplicationContext或子类进行加载基于java类的配置

接下来通过示例来演示下如何基于Java类来配置Spring

首先创建一个配置类

2. @Configuration
3. public class ApplicationContextConfig {
4. @Bean
5. public String message() {
6. return "hello";
7. }
8. }<strong>
9. </strong>

然后还需要一个测试类，来查看配置是否成功

2. public class ConfigurationTest {
3. public static void main(String[] args) {
4. AnnotationConfigApplicationContext ctx =
5. new AnnotationConfigApplicationContext(ApplicationContextConfig.class);
6. System.out.println(ctx.getBean("message"));
7. }
8. }

通过@Configuration注解的类将被作为配置类使用，表示在该类中将定义Bean配置元数据，且使用@Configuration注解的类本身也是一个Bean，使用方式如下所示：

2. @Configuration("ctxConfig")
3. public class ApplicationContextConfig {
4. ……
5. }

其中Configuration中的参数值即为该bean的名称。

通过@Bean注解配置类中的相应方法，则该方法名默认就是Bean名，该方法返回值就是Bean对象，并定义了Spring IoC容器如何实例化、自动装配、初始化Bean逻辑，具体使用方法如下：

2. @Bean(name={},
3. autowire=Autowire.NO,
4. initMethod="",
5. destroyMethod="")

其中name为bean的名称，可以有多个，autowire为是否自动装配，默认值为NO，initMethod为bean的初始化方法，destoryMethod为bean的销毁方法。

bean的注解具体使用如下：

2. @Bean
3. public String message() {
4. return new String("hello");
5. }

如上的代码等价与XML配置：

2. <bean id="message" class="java.lang.String">
3. <constructor-arg index="0" value="hello"/>
4. </bean>

注意：使用bean注解的方法不能是private、final、static的。

基于Java方式的配置方式不是为了完全替代基于XML方式的配置，两者可以结合使用，因此可以有两种结合使用方式：

• 在基于Java方式的配置类中引入基于XML方式的配置文件
• 在基于XML方式的配置文件中中引入基于Java方式的配置

引入基于XML配置文件：

2. <bean id="message" class="java.lang.String">
3. <constructor-arg index="0" value="test"></constructor-arg>
4. </bean>
7. @Configuration("ctxConfig")
8. @ImportResource("classpath:com/jike/***/appCtx.xml")
9. public class ApplicationContextConfig {
10. ……
11. }

可以看到在java程序中使用@ImportResource导入了XML的配置文件

引入基于Java的配置文件：

2. <context:annotation-config/>
3. <bean id="ctxConfig" class=“com.jike.***..ApplicationContextConfig"/>
5. //测试类
6. public void testXmlConfig() {
7. String configLocations[] = {" classpath:com/jike/***/appCtx.xml"};
8. ApplicationContext ctx = new ClassPathXmlApplicationContext(configLocations);
9. ……
10. }

可以看到在XML的配置文件当中将java的配置类当中Bean来声明，第一行的是开启注解驱动支持。

值得注意的是必须得配置<context:annotation-config/>在XML配置文件中。

Spring提供了一个AnnotationConfigApplicanContext类，能够直接通过标注@Configuration的Java类启动Spring容器：

通过构造函数加载配置类:

ApplicationContext ctx = new AnnotationConfigApplicationContext(AppConf.class);

通过编码方式注册配置类：

2. AnnotationConfigApplicationContext ctx = new AnnotationConfigApplicationContext();
3. ctx.register(DaoConfig.class);
4. ctx.register(ServiceConfig.class);
5. ctx.refresh();

可以看到ctx注册了多个configuration类，然后通过refresh类来刷新容器以应用这些配置文件。

可以通过代码一个个的引入配置类，当然也可以使用@Import注解来引入配置类

引入多个配置类：

2. @Configuration
3. @Import(DaoConfig.class)
4. public class ServiceConfig {……}

总结：不同配置方式比较

我们来看一下不同配置方式在不同方面的使用

其实Spring支持这么多的配置方式，那么这些配置方式必然有其自己独特的舞台

基于XML的配置主要使用场景：

• 第三方类库，如DataSource、JdbcTemplate等；
• 命名空间，如aop、context等；

基于注解的配置主要使用场景：

• Bean的实现类是当前项目开发的，可直接在Java类中使用注解配置

基于Java类的配置主要使用场景：

• 对于实例化Bean的逻辑比较复杂，则比较适合用基于Java类配置的方式

在日常的开发中我们主要是使用XML配置和注解配置方式向结合的开发方式，一般不推荐使用基于Java类的配置方式。