Spring装配Bean教程之XML安装配置bean详解
前言
众所周知在spring刚出现的时候,xml是描述配置的主要方式,在spring的名义下,我们创建了无数行xml代码。在一定程度上,spring成为了xml的同义词。
现在随着强大的自动化配置和java代码的配置出现,xml不再是唯一选择,也不应该是首选,学习xml配置,更多用于维护已有的xml的配置。下面话不多说了,来一起看看详细的介绍吧。
创建xml配置规范
在使用xml配置前,需要创建一个新的配置规范,就像javaconfig需要我们创建带有 @configuration注解的类,而在xml配置中,需要创建一个新的xml配置文件,并且要以<beans>元素为根。
<?xml version="1.0" encoding="utf-8"?> <beans xmlns="http://www.springframework.org/schema/beans"; xmlns:xsi="http://www.w3.org/2001/xmlschema-instance"; xmlns:context="http://www.springframework.org/schema/context"; xsi:schemalocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/context"> </beans>
可以看出基本的xml配置就已经比javaconfig复杂很多。用来装配bean的最基本的xml元素包含在spring-beans模式中,在上面这个xml文件中,它被定义为根命名空间。<beans>是该模式中过的一个元素,它是所有spring配置文件的根元素。
声明一个简单的<bean>
使用spring-beans模式中的另外一个元素:<bean>,该元素类似于javaconfig中的 @bean注解。
<bean class="soundsystem.sgtpeppers"/>
因为没有明确的给定id,所以这个bean会根据全限定类名来进行命名。在本例中bean的id将会是“soundsystem.sgtpeppers#0
”。其中,“#0”是一个计数的形式,用来区别相同类型的其它bean。如果再有一个就是“#1”。
尽管自动话的bean命名方式方便,但是稍引用就会认为自动产生的名字就没有多大的用处了。因此最好的办法还是用id属性,为每个bean设置一个自己的选择的名字:
<bean id="compactdisc" class="soundsystem.sgtpeppers"/>
可以看出xml中不再需要直接负责创建sgtpeppers的实例,在基于javaconfig的配置中,我们需要自己实例化。当spring发现这个<bean>元素时,默认调用sgtpeppers默认的构造器来创建bean。
借助构造器注入初始化bean
在spring xml配置中,只有一种声明bean的方式:使用元素并指定class属性。在xml中声明id是,会有多种配置方案,具体到构造器的注入,分为两个基本的配置方案:
- <constructor-arg>元素
- 使用spring 3.0所引入的c-命名空间
构造器注入bean引用,现在我们已经声明了compactdisc bean,并且sgtpeppers类实现了compactdisc接口,所以实际上我们已经有了一个可以注入到cdplayer bean中的bean。我们所需要做的就是在xml中声明cdplayer并通过id引用compactdisc:
<bean id="cdplayer" class="cdplayer"> <constructor-arg ref="compactdisc"/> </bean>
作为替代的方案,也可以使用spring的c-命名空间。c-命名空间是在spring 3.0中引入的,它是在xml中更为简洁的描述构造器参数的方式。要使用它的话,需要在xml的顶部声明其模式:
<?xml version="1.0" encoding="utf-8"?> <beans xmlns="http://www.springframework.org/schema/beans”; xmlns:c=“http://www.springframework.org/shcema/c" xmlns:xsi="http://www.w3.org/2001/xmlschema-instance";"; xsi:schemalocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd"> </beans>
在这之后我们就可以它来声明构造器的参数了,如下:
<bean id="cdplayer" class="cdplayer"> <c:cd-ref="compactdisc"/> </bean>
很显然c-命名空间的方式简练很多。具体看下写法,“c:“表示c-命名空间的前缀,“cd”表示构造器参数名(忘记的可以看下:spring装配bean之组件扫描和自动装配),“-ref“表示注入bean引用。
这里的cd直接引用了构造器参数的名称,可以利用参数在整个参数列表中的位置信息作为替代方案实现。
<bean id="cdplayer" class="cdplayer"> <c:_0-ref="compactdisc"/> </bean>
这个c-命名空间表示方法看起来比上面的更加怪异,我们将参数名用“0”表示,也就是参数的索引。因为xml中不允许数字作为第一个字符,所以用下划线作为前缀。使用索引来标识构造器参数感觉比使用名字更好一些,只要保存相同的顺序,就可以随意重命名参数名,如果有多个构造参数,这个方式更有用处。因为现在就一个参数,甚至可以不用标识。
<bean id="cdplayer" class="cdplayer"> <c:_-ref="compactdisc"/> </bean>
这将是最怪异的表示方法。
将字面量注入到构造器中
前面我们所做的di通常指的是类型的装配,也就是将对象的引用装配到依赖于它的其它对象中,而有时需要引入的只是一个字面量的配置对象。现在需要创建一个新的compactdisc实现:
package soundsystem; public class blankdisc implements compactdisc { private string title; private string artist; public blankdisc(string title, string artist) { this.title = title; this.artist = artist; } public void play() { system.out.println("playing " + title + " by " + artist); } }
在sgtpeppers中,参数都是硬编码的,但是这个compactdisc实现不同,所以xml配置也会不同:
<bean id="compactdisc" class="soundsystem.blankdisc"> <constructor-arg value="sgt. pepper's lonely hearts club band"/> <constructor-arg value="the beatles"/> </bean>
我们再次用<constructor-arg>元素进行构造器参数的注入。但是这次我们没有使用“ref”属性,而是使用了value属性,通过该属性表明给定的要以字面量的形式注入到构造器中。
下面用c-命名空间的方式实现:
<bean id="compactdisc" class="soundsystem.blankdisc"> <c:_title="sgt. pepper's lonely hearts club band"/> <c:_artist="the beatles"/> </bean>
可以看出,装配字面量与装配引用的区别在于属性名中去掉了“-ref“的后缀。与之类似,用参数索引实现方式:
<bean id="compactdisc" class="soundsystem.blankdisc"> <c:_0="sgt. pepper's lonely hearts club band"/> <c:_1="the beatles"/> </bean>
在装配bean引用和字面量值方面,两种实现方式的功能是相同的。但是有一种情况是<constructor-arg>能够实现,c-命名空间却无法做到。
装配集合
假设blankdisc构造函数中新增一个list类型的参数,如下:
package soundsystem; import java.util.list; import soundsystem.compactdisc; public class blankdisc implements compactdisc { private string title; private string artist; private list<string> tracks; public blankdisc(string title, string artist, list<string> tracks) { this.title = title; this.artist = artist; this.tracks = tracks; } public void play() { system.out.println("playing " + title + " by " + artist); for (string track : tracks) { system.out.println("-track: " + track); } } }
在声明bean的时候,我们必须要提前准备一个列表,最简单的方式就是直接设置为null。
<bean id="compactdisc" class="soundsystem.blankdisc"> <constructor-arg value="sgt. pepper's lonely hearts club band"/> <constructor-arg value="the beatles”/> <constructor-arg><null/><constructor-arg> </bean>
<null/>元素所做的事情,就是将null作为参数传递到构造器,但这并不是解决问题的办法,虽然在注入器能够正常执行,但是调用play()
方法的时候,就会出现异常。
合理的处理方案,我们可以利用元素将其声明为一个列表:
<bean id="compactdisc" class="soundsystem.blankdisc"> <constructor-arg value="sgt. pepper's lonely hearts club band" /> <constructor-arg value="the beatles" /> <constructor-arg> <list> <value>sgt. pepper's lonely hearts club band</value> <value>with a little help from my friends</value> <value>lucy in the sky with diamonds</value> <value>getting better</value> <value>fixing a hole</value> </list> </constructor-arg> </bean>
其中,<list>元素是<constructor-arg>的子元素,这表明一个包含值的列表将会传递到构造器中。其中,<value>表示每个元素。与之类似,我们可以用代替<value>,实现bean引用列表的装配。
在装配集合方面,<constructor-arg>比c-命名空间的属性更具优势,目前使用c-命名空间的方式不能实现装配集合的功能。
设置属性
前面所有类完全是通过构造器注入的,没有使用属性的setter方法,下面我们看下使用spring xml实现属性注入。假设属性注入cdplayer如下:
package soundsystem; import org.springframework.beans.factory.annotation.autowired; import soundsystem.compactdisc; import soundsystem.mediaplayer; public class cdplayer implements mediaplayer { private compactdisc compactdisc; @autowired public void setcompactdisc(compactdisc compactdisc) { this.compactdisc = compactdisc; } public void play() { compactdisc.play(); } }
这里有个需要考虑的问题,到底是构造器注入还是属性注入呢?作为一个通用的规则,对强依赖使用构造依赖,而可选的依赖使用属性注入。之前的blankdisc属于强依赖,因此构造器注入是正确的方案。不过对于cdplayer来说,对compactdisc的依赖不能是强依赖的,因为即便没有把compactdisc装入进去,cdplayer依然具有某些功能。
因此这样是可行的:
<bean id="cdplayer" class="soundsysten.cdplayer" />
在创建bean的时候不会出现任何的问题,但是cdplayer开始工作的时候就会出现异常。此时,我们可以注入cdplayer的compactdisc属性。
<bean id="cdplayer" class="soundsystem.cdplayer"> <property name="compactdisc" ref="compactdisc" /> </bean>
<property>元素为属性的setter方法所提供的功能,和<constructor-arg>元素为构造器所提供的功能是一样的。在本例中,它引入了id为compactdisc的bean(通过ref属性),并将其注入到compactdisc属性中。
同样的spring为<property>提供了简介的p-命名空间的替代方案。引入p-命名空间:
<beans xmlns="http://www.springframework.org/schema/beans"; xmlns:xsi="http://www.w3.org/2001/xmlschema-instance"; xmlns:p="http://www.springframework.org/schema/p"; xsi:schemalocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd”> </beans>
使用p-命名空间,装配compactdisc属性:
<bean id="cdplayer" class="soundsystem.cdplayer" p:compactdisc-ref="compactdisc" />
命名空间中属性所遵循的命名约定与c-命名空间中的属性类似。
将字面量注入到属性中
属性也可以注入字面量,这与构造器参数非常类似。我们将blankdisc bean,通过属性注入的方式进行配置,而不是构造器的方式:
package soundsystem; import java.util.list; import soundsystem.compactdisc; public class blankdisc implements compactdisc { private string title; private string artist; private list<string> tracks; public void settitle(string title) { this.title = title; } public void setartist(string artist) { this.artist = artist; } public void settracks(list<string> tracks) { this.tracks = tracks; } public void play() { system.out.println("playing " + title + " by " + artist); for (string track : tracks) { system.out.println("-track: " + track); } } }
现在它不在是强制要求我们装配任何属性。
<bean id="reallyblankdisc" class="soundsystem.blankdisc"/>
当然在装配的时候不设置这些属性,cd播放的时候不能正常播放,所以还是通过<property>元素的value属性实现属性注入。
<bean id="compactdisc" class="soundsystem.blankdisc"> <property name="title" value="sgt. pepper's lonely hearts club band" /> <property name="artist" value="the beatles" /> <property name="tracks"> <list> <value>sgt. pepper's lonely hearts club band</value> <value>with a little help from my friends</value> <value>lucy in the sky with diamonds</value> <value>getting better</value> <value>fixing a hole</value> </list> </property> </bean>
可以看出与之前<constructor-arg>元素装配tracks是完全一样的。另一种可选方案是p-命名空间的属性来实现:
<bean id="compactdisc" class="soundsystem.blankdisc" p:title="sgt. pepper's lonely hearts club band" p:artist="the beatles"> <property name="tracks"> <list> <value>sgt. pepper's lonely hearts club band</value> <value>with a little help from my friends</value> <value>lucy in the sky with diamonds</value> <value>getting better</value> <value>fixing a hole</value> <value>she's leaving home</value> <value>being for the benefit of mr. kite!</value> <value>within you without you</value> <value>when i'm sixty-four</value> <value>lovely rita</value> <value>good morning good morning</value> <value>sgt. pepper's lonely hearts club band (reprise)</value> <value>a day in the life</value> </list> </property> </bean>
与c-命名空间一样,装配bean引用与装配字面量的唯一区别在于是否带有“-ref”后缀,同样的p-命名空间也没有实现装配集合的功能。
总结
以上就是这篇文章的全部内容了,希望本文的内容对大家的学习或者工作具有一定的参考学习价值,如果有疑问大家可以留言交流,谢谢大家对的支持。