本文将详细介绍Spring Bean配置的三种不同方式的特点与使用条件。
主要包括:
基于XML的配置方式
基于注解的配置方式
基于Java类的配置方式
一.基于XML的配置
我们应该怎么理解和认识Spring的配置文件呢?
其实,Spring的配置文件是Spring容器对Bean进行生产以及关系注入的图纸,他是Spring的基础。如果我们没有配置文件的话,则Spring的容器将无从谈起。
Spring 的配置文件是用于指导 Spring 工厂进行 Bean 的生产、依赖关系注入及 Bean 实例分发的“图纸”, J2EE 程序员必须学会并灵活应用这份“图纸”,准确地表达自己的“生产意图”。它是一个或多个标准的XML文档,其ApplicationContext.xml是Spring的默认配置文件,当容器启动时找不到其他的配置文件时,则会尝试加载这个默认的配置文件。
Spring容器成功启动需要以下三方面的条件同时具备:
Spring的类包必须已经放在Spring的类容器下面
应用程序应当为Spring提供完备的Bean的配置信息
Bean的类都已经放在Spring的类容器下面
Spring启动时读取应用程序提供的Bean的配置信息,并在Spring容器中生成一份相应的Bean的配置注册表,然后根据这张注册表来实例化Bean,装配好Bean之间的依赖关系,为上层应用提供准备就绪的运行环境。
而bean的配置信息就是Bean的元数据信息,他由以下五个方面来组成:
Bean的实现类
Bean的属性信息 比如:数据源的连接数,用户名和密码等等。
Bean的依赖关系 Spring根据依赖关系配置完成Bean之间的装配
Bean的行为配置 比如:生命周期范围以及生命周期各个过程的回调函数等
Bean的创建方式定义 主要说明是通过构造器还是工厂方法来构造Bean
接下来是他们之间的相互关系:
有时,一个项目中可能存在多个配置文件,那么Spring项目加载多个配置文件的方法:
在配置文件中使用import来导入所需的配置文件。
将多个配置文件构造为一个数组,然后传递给ApplicationContext实现加载多个配置文件。
这两种方式都是通过调用BeanDefinitionReader来读取定义文件的,在内部实现上没有任何的区别。
在大型的Spring项目当中,所有的bean配置在一个配置文件当中很不容易管理且也不利于团队的开发。通常在开发过程当中,我们会按照功能模块和开发人员来将配置文件分成多个。这样会有利与模块的划分。接下来我们需要使用import属性来引入多个配置文件到项目当中。
假如我们的项目需要用到多个配置文件,且配置文件位于不同的文件夹下,比如:
Spring-Common.xml位于common文件夹下
Spring-Connection.xml位于connection文件夹下
Spring-Module.xml位于module文件夹下
传统加载方式:
但是这种方法不宜组织,且不宜维护。
则我们使用整合配置文件:Spring-All-Module.xml
在文件当中使用import直接将其他的配置文件导入到这个文件当中就好了。
整合后加载方式:
ApplicationContext context = new ClassPathXmlApplicationContext(“Spring-All-Module.xml”);
可以看到配置文件是整个Spring项目的灵魂,我们先来看一下Spring配置文件的一般结构:
可以看到一个简单的Spring配置文件就是这样。
其中:
Import标签可以放在Beans标签下的任何位置,没有顺序关系。
bean3和bean2是同一个Bean,bean3是bean2的别名。
Spring 的配置文件是基于XML格式的,Spring1.0的配置文件采用DTD格式,Spring2.0以后使用Schema的格式,后者让不同类型的配置拥有了自己的命名空间,使配置文件更具有扩展性。
采取基于Schema的配置格式,文件头的声明会复杂一些,请看一个简单示例:
我们在上面的代码中定义了三个命名空间,
首先我们定义了一个默认命名空间,他没有空间名,用于Spring Bean的定义。
接下来我们命名了一个xsi命名空间,这个命名空间用于为每个文档中命名空间指定相对应的schema的样式文件。是标准组织定义的标准命名空间。
我们还命名了一个aop的命名空间,这个命名空间是Spring配置aop的命名空间,是用户自定义的命名空间。
命名空间的定义分为了两个步骤:
指定命名空间的名称,需要指定命名空间的缩类名和全名
指定命名空间的schema文档样式文件的位置,用空格或回车行来进行分割。
指定命名空间schema地址有两个用途:
xml解析器可以获取schema文件,并对文档进行格式合法性验证
在开发环境下,IDE可以用schema文件来对文档编辑器进行诱导功能。
Spring3.0 的配置Schema文件分布在各模块类包中,如果模块拥有对应的Schema文件,则可以在模块类包中找到一个config目录,Schema文件就位于该目录中,如下是对这些Schema文件的用途进行了简单说明:
示例说明:Spring-beans-3.0.xsd
命名空间:http://www.springframework.org/schema/beans
Schema 文件:http://www.springframework.org/schema/beans/spring-beans-3.0.xsd
可以看出在Spring3.0当中,所有的Schema文件的命名空间以及对应的位置都和Beans这个Schema文件是类似的。
那么接下来来了解以下Spring当中其他Schema文件的用途:
spring-beans-3.0.xsd:Spring3.0最主要的配置文件,主要是用于配置Bean
spring-aop-3.0.xsd:aop配置定义的schema
spring-tx-3.0.xsd:声明式事物配置定义的Schema
spring-mvc-3.0.xsd:Spring3.0当中新增的
spring-util-3.0.xsd:是为简化某些复杂的标准配置而提供的Schema
spring-jee-3.0.xsd:是为简化J2EE中EJB等功能的配置而提供的Schema
spring-jdbc-3.0.xsd:为Spring内接数据库而提供的Schema,3.0新增
spring-jms-3.0.xsd:jms配置的Schema
spring-lang-3.0.xsd:增加了对动态语言的支持,为集成动态语言而定义
spring-oxm-3.0.xsd:配置对象xml映射到schema,3.0新增
spring-task-3.0.xsd:任务调度的Schema
spring-tool-3.0.xsd:为集成Schema一些有用工具而提供的Schema
二.基于注解的配置
Spring2.0开始引入基于注解的配置方式,即Bean的定义信息可以通过在Bean的实现类上标注注解实现。
具体关于注解的知识请看Java注解(Annotation)介绍
@Component是Spring容器中的基本注解,表示容器中的一个组件(bean),可以作用在任何层次,下面的示例介绍该注解的使用方法。
注解配置示例:
此外,还有一些其他的可以被用来注解bean的注解,这些可以让注解类本身的用途更加清晰,此外,特定的注解也具备特定的功能。
Spring在2.5后提供了一个context的命名空间,它提供了通过扫描类包来加载利用注解定义的Bean的方式。
在context中可以使用resource-pattern来过滤出特定的类。
默认情况下加载的是package下的*.class即扫描全部类,在使用了resource-pattern之后,则只扫描package下的anno子包下的所有类。
不过使用resource-pattern并不能提供给我们完善的功能,所有我们得使用过滤子元素的方法。
其中:
include-filter表示要包含的目标类,
exclude-filter表示要排除在外的目标类
Spring3.0提供了一系列的针对依赖注入的注解,这使得Spring IoC在XML文件之外多了一种可行的选择,主要包含如下注解类型:
Bean的定义注解
Bean的生命周期注解
Bean的依赖检查注解
Bean的自动装配注解
1.Bean的定义注解
Spring自2.0开始,陆续引入了一些注解用于简化Spring的开发。
@Repository注解便属于最先引入的一批,用于将数据访问层(DAO层)的类标识为Spring Bean。具体使用如下:
①首先使用@Repository将DAO类声明为Bean
如此的话,我们便不在需要在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为此提供了两种方式供用户指定执行生命周期回调的方法:实现Spring提供的两个接口:initializingBean 和 DisposableBean,这种方法是要求bean类实现Spring的接口,但增加了bean和Spring容器的耦合度,因此不推荐使用。在XML文件中使用的init-method 和 destory-method 属性,指定初始化之后和回调之前的回调方法。这两个属性的取值是bean中相应的初始化和销毁方法的名称。方法名称任意,但是方法不能有参数。
示例如下:
在这里,我们指定了userService 这个bean的初始化方法为:init 销毁方法为:destory
Spring2.5在保留以上两种方式的基础上,提供了对JSR-250的支持。
JSR-250规范定义了两个用于指定声明周期方法的注解:
@PostConstruct:初始化之后的执行的回调方法
@PreDestroy:销毁之前的回调方法
注解示例说明:
3.Bean的依赖检查注解
Spring2.0之前使用dependency-check在配置文件中设置属性用于依赖检查(只会检查Setter方法是否被调用),缺点是粒度较粗,该属性的取值包括以下几种:
none: 默认不执行依赖检查
simple :对原始基本类型和集合类型进行检查
objects :对复杂类型进行检查
all :对所有类型进行检查
使用Spring2.0提供的@Required注解,提供了更细粒度的控制,@Required注解只能标注在Setter方法之上,(标注在其他方法之上会被忽略 )用于检查其是否被调用,当Setter方法未被调用的话会抛出异常。
由于使用了注解,所以得激活Bean的后处理器,所以得在XML配置文件当中增加
三.基于Java类的配置
基于Java类定义Bean配置元数据,其实就是通过Java类定义Spring配置元数据,且直接消除XML配置文件。
首先让我们看一下基于Java类如何定义Bean配置元数据,具体步骤如下:
使用@Configuration注解需要作为配置的类,表示该类将定义Bean的元数据
使用@Bean注解相应的方法,该方法名默认就是Bean的名称,该方法返回值就是Bean的对象。
AnnotationConfigApplicationContext或子类进行加载基于java类的配置
接下来通过示例来演示下如何基于Java类来配置Spring
首先创建一个配置类
然后还需要一个测试类,来查看配置是否成功
基于Java方式的配置方式不是为了完全替代基于XML方式的配置,两者可以结合使用,因此可以有两种结合使用方式:
在基于Java方式的配置类中引入基于XML方式的配置文件
在基于XML方式的配置文件中中引入基于Java方式的配置
总结:不同配置方式比较
我们来看一下不同配置方式在不同方面的使用
其实Spring支持这么多的配置方式,那么这些配置方式必然有其自己独特的舞台
基于XML的配置主要使用场景:
第三方类库,如DataSource、JdbcTemplate等;
命名空间,如aop、context等;
基于注解的配置主要使用场景:
Bean的实现类是当前项目开发的,可直接在Java类中使用注解配置
基于Java类的配置主要使用场景:
对于实例化Bean的逻辑比较复杂,则比较适合用基于Java类配置的方式
在日常的开发中我们主要是使用XML配置和注解配置方式向结合的开发方式,一般不推荐使用基于Java类的配置方式。