2.3 Bean的装配方式
Bean的装配可以理解为依赖关系注入,Bean的装配方式即Bean依赖注入的方式。Spring容器支持多种形式的Bean装配方式,如基于XML的装配、基于Annotation(注解)的装配和自动装配等。本节主要讲解这3种装配方式的使用。
2.3.1 基于XML的装配
Spring提供了两种基于XML的装配方式:设值注入(Setter Injection)和构造注入(Constructor Injection)。下面讲解如何在XML配置文件中使用这两种注入方式来实现基于XML的装配。
在Spring实例化Bean的过程中,Spring首先会调用Bean的默认构造方法来实例化Bean对象,然后通过反射的方式调用setter()方法来注入属性值。因此,设值注入要求一个Bean必须满足以下两点要求:
- Bean类必须提供一个默认的无参构造方法。
- Bean类必须为需要注入的属性提供对应的setter()方法。
使用设值注入时,在Spring配置文件中需要使用<bean>元素的子元素<property>来为每个属性注入值;而使用构造注入时,在配置文件中需要使用<bean>元素的子元素<constructor-arg>来定义构造方法的参数,可以使用其value属性(或子元素)来设置该参数的值。
【示例2-2】下面通过一个案例来演示基于XML方式的Bean的装配。
(1)在项目chapter02的src目录下创建一个com.ssm.assemble包,在该包中创建User类,并在类中定义userName、password和list集合3个属性及对应的setter()方法,如文件2.4所示。
文件2.4 User.java
在文件2.4的第11~16行、第26~28行,由于要使用构造注入,因此需要编写有参和无参的构造方法。
(2)在Spring的配置文件application.xml(文件2.2)中,增加通过构造注入和设值注入的方法装配User实例的两个Bean,代码如下所示。
在上述代码中,<constructor-arg>元素用于定义构造方法的参数,其属性index表示其索引(从0开始),value属性用于设置注入的值,其子元素<list>为User类中对应的list集合属性注入值。然后又使用设值注入方法装配User类的实例,其中<property>元素用于调用Bean实例中的setter()方法完成属性赋值,从而完成依赖注入,而其子元素<list>同样为User类中对应的list集合属性注入值。
(3)在com.ssm.assemble包中创建测试类XmlAssembleTest,在类中分别获取并输出配置文件中的user1和user2实例,如文件2.5所示。
文件2.5 XmlAssembleTest.java
执行程序后,控制台输出结果如图2.3所示。可以看出,已经成功地使用基于XML装配的构造注入和设值注入两种方式装配了User实例。
图2.3 运行结果
2.3.2 基于Annotation的装配
在Spring中,尽管使用XML配置文件可以实现Bean的装配工作,但如果应用中有很多Bean,就会导致XML配置文件过于臃肿,给以后的维护和升级工作带来一定的困难。为此,Spring提供了对Annotation(注解)技术的全面支持。
Spring中定义了一系列的注解,常用的注解如表2.3所示。
表2.3 Spring的常用注解
注意
在表2.3的几个注解中,虽然@Repository、@Service和@Controller的功能与@Component注解的功能相同,但为了使标注类本身用途更加清晰,建议在实际开发中使用@Repository、@Service和@Controller分别对实现类进行标注。
【示例2-3】接下来,通过一个案例来演示如何通过这些注解来装配Bean。
(1)在chapter02项目的src目录下创建一个com.ssm.annotation包,在该包中创建接口UserDao,并在接口中定义一个save()方法,如文件2.6所示。
文件2.6 UserDao.java
(2)在com.ssm.annotation包中创建UserDao接口的实现类UserDaoImpl,该类需要实现接口中的save()方法,如文件2.7所示。
文件2.7 UserDaoImpl.java
在文件2.7中,首先使用@Repository注解将UserDaoImpl类标识为Spring中的Bean,其写法相当于配置文件中<bean id="user Dao" class=" com.ssm.annotation.UserDaoImpl />的编写。然后在save()方法中打印一句话,用于验证是否成功调用了该方法。
(3)在com.ssm.annotation包中创建接口UserService,在接口中同样定义一个save()方法,如文件2.8所示。
文件2.8 UserService.java
(4)在com.ssm.annotation包中创建UserService接口的实现类UserServiceImpl,该类需要实现接口中的save()方法,如文件2.9所示。
文件2.9 UserServiceImpl.java
在文件2.9中,首先使用@Service注解将UserServiceImpl类标识为Spring中的Bean,这相当于配置文件中<bean id= "userService" class="com.ssm.annotation.UserServiceImpl"/>的编写;然后使用@Resource注解标注在属性userDao上,这相当于配置文件中<property name="userDao" ref="userDao”/>的写法;最后在该类的save()方法中调用userData中的save()方法,并输出一句话。
(5)在com.ssm.annotation包中创建控制器类UserController,如文件2.10所示。
文件2.10 UserController.java
首先使用@Controller注解标注了UserController类,这相当于在配置文件中编写<bean id="userController" class=" com.ssm.annotation.UserController"/>;然后使用@Resource注解标注在userService属性上,这相当于在配置文件中编写<property name="userService" ref=" userService"/>;最后在其save()方法中调用了userService中的save()方法,并输出一句话。
(6)在com.ssm.annotation包中创建配置文件beans1.xml,在配置文件中编写基于Annotation装配的代码,如文件2.11所示。
文件2.11 beans1.xml
从上述代码可以看出,文件2.11与之前的配置文件有很大不同。首先,在<beans>元素中增加了04、07和08行中包含context的约束信息;然后通过配置<context: annotation-config/>来开启注解处理器;最后分别定义了3个Bean对应的3个实例。与XML配置方式有所不同的是,这里不再需要配置子元素<property>。
上述Spring配置文件中的注解方式虽然较大程度地简化了XML文件中Bean的配置,但仍需在Spring配置文件中一一配置相应的Bean,为此Spring注解提供了另一种高效的注解配置方式(对包路径下的所有Bean文件进行扫描),其配置方式如下:
所以可以将上述文件2.11中的09~14行代码进行如下替换:
注意
Spring 4.0以上版本使用上面的代码对指定包中的注解进行扫描前,需要先向项目中导入SpringAOP的JAR包spring-aop-4.3.6.RELEASE.jar,否则程序在运行时会报出“java.lang.NoClassDefFoundError:org/springframework/aop/TargetSource”错误。
(7)在com.ssm.annotation包中创建测试类AnnotationAssembleTest,在类中编写测试方法并定义配置文件的路径,然后通过Spring容器加载配置文件并获取UserController实例,最后调用实例中的save()方法,如文件2.12所示。
文件2.12 AnnotationAssembleTest.java
执行程序后,控制台的输出结果如图2.4所示。从中可以看到,Spring容器已成功获取了UserController的实例,并通过调用实例中的方法执行了各层中的输出语句,这说明已成功实现了基于Annotation来装配Bean实例。
图2.4 运行结果
注意
上述案例中使用@Autowired注解替换@Resource注解也可以达到同样的效果。
2.3.3 自动装配
虽然使用注解的方式装配Bean在一定程度上减少了配置文件中的代码量,但是也有企业项目中是没有使用注解方式开发的,那么有没有什么办法既可以减少代码量,又能够实现Bean的装配呢?答案是肯定的。Spring的<bean>元素中包含一个autowire属性,我们可以通过设置autowire的属性值来自动装配Bean。所谓自动装配,就是将一个Bean自动注入其他Bean的Property中。
autowire属性有5个值,其值及说明如表2.4所示。
表2.4 <bean>元素的autowire属性值及说明
【示例2-4】下面通过修改2.3.2节中的案例来演示如何使用自动装配。
(1)修改2.3.2小节中的文件2.9(UserServiceImpl.java)和文件2.10(UserController.java),分别在这两个文件中增加类属性的setter()方法。
(2)修改2.3.2小节中的配置文件2.11(beans1.xml),将其修改成自动装配形式,如文件2.13所示。
文件2.13 beans2.xml
在上述配置文件中,用于配置userService和userController的<bean>元素中除了id和class属性外,还增加了autowire属性,并将其属性值设置为byName。在默认情况下,配置文件中需要通过ref来装配Bean,但设置了autowire="byName"后,Spring会自动寻找userServiceBean中的属性,并将其属性名称与配置文件中定义的Bean做匹配。由于UserServiceImpl中定义了userDao属性及其setter()方法,这与配置文件中id为userDao的Bean相匹配,因此Spring会自动地将id为userDao的Bean装配到id为userService的Bean中。
执行程序后,控制台的输出结果与图2.4相同。