4. Spring 如何通过 XML 文件配置Bean,以及如何获取Bean

时间:2022-08-20 16:06:42

在 Spring 容器内拼凑 bean 叫做装配。装配 bean 的时候,你是在告诉容器,需要哪些 bean ,以及容器如何使用依赖注入将它们配合在一起。

理论上,bean 装配的信息可以从任何资源获得,包括属性文件,关系数据库等,但 XML 文件是最常见的 Spring 应用系统配置源, Spring 中的几种容器都支持使用 XML 装配 bean,包括:

  --XMLBeanFactory

  --ClassPathXMLApplicationContext

  --FileSystemXMLApplicationContext

  --XMLWebApplicationContext

其中我们常用的有 ClassPathXMLApplicationContext,FileSystemXMLApplicationContext 两种。

在 XML 文件中配置 bean 包括以下几个方面:

  1. 添加 bean

  2. 配置 bean 属性

    2.1 手动配置

      2.1.1 通过 setter 方法

      2.1.2 通过 constructor

    2.2 自动配置

下面,我们来添加 bean,并通过 setter 方法来对 bean 的属性来进行配置:

  首先,先写两个 bean ,分别是 Person 和 Address , 其中 Person 是依赖于 Address 的。下面附上代码:

package com.spring.xmlBean;

public class Person {
private String name;
private int age;
private Address address; public String getName() {
return name;
} public void setName(String name) {
this.name = name;
} public int getAge() {
return age;
} public void setAge(int age) {
this.age = age;
} public Address getAddress() {
return address;
} public void setAddress(Address address) {
this.address = address;
} public Person(String name, int age, Address address) {
super();
this.name = name;
this.age = age;
this.address = address;
} public Person() {
super();
} @Override
public String toString() {
return "Person [name=" + name + ", age=" + age + ", address=" + address + "]";
} }

Person 类

package com.spring.xmlBean;

public class Person {
private String name;
private int age;
private Address address; public String getName() {
return name;
} public void setName(String name) {
this.name = name;
} public int getAge() {
return age;
} public void setAge(int age) {
this.age = age;
} public Address getAddress() {
return address;
} public void setAddress(Address address) {
this.address = address;
} public Person(String name, int age, Address address) {
super();
this.name = name;
this.age = age;
this.address = address;
} public Person() {
super();
} @Override
public String toString() {
return "Person [name=" + name + ", age=" + age + ", address=" + address + "]";
} }

Address 类

  类写完之后,我们在 classpath 下创建一个 Spring Bean Configuration File

4. Spring 如何通过 XML 文件配置Bean,以及如何获取Bean

创建完 XML 文件之后,我们开始在这个文件里配置 Bean。

首先,第一步:添加 bean

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
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"> <!-- 添加 Address 和 Person -->
<bean id="address" class="com.spring.xmlBean.Address"></bean> <bean id="person" class="com.spring.xmlBean.Person"></bean>
</beans>

Spring Bean Configuration File

在这里,我们通过 <bean></bean> 节点来添加 bean ,其中 class 属性代表 bean 的全类名, id 属性用来对 bean 进行标示,在调用 bean 的时候会使用这个 id 名,这个名字是唯一的,在配置文件中不能有重复,否则 Spring 会报错

添加完 bean 之后,我们先来测试一下,看能不能获取到这个 bean。我们先试着获取一下 Person

package com.spring.test;

import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext; import com.spring.helloworld.HelloWorld;
import com.spring.xmlBean.Person; public class TestMain {
public static void main(String[] args) { // 创建 Spring 的 IOC 容器
ApplicationContext ctx = new ClassPathXmlApplicationContext("beanConfiguration-xml.xml");
// 使用 getBean() 方法, 通过传入刚才的 id 名,来获取 bean, 但是这里返回的是一个 Object 对象, 所以要转型
Person person = (Person) ctx.getBean("person");
// 打印 person
System.out.println(person);
}
}

TestMain

运行 main 方法,控制台输出了以下信息

4. Spring 如何通过 XML 文件配置Bean,以及如何获取Bean

我们看到,我们成功的获取到了 person,但是,person 中的属性是空的,因为我们还没有配置他们,只是单纯的把它们添加到容器里面

那么现在,我们就来手动配置一下这两个 bean

前面讲过,手动配置 bean 有两种方式,一种是通过 setter 方法,一种是通过 构造器(constructor)来配置。下面,我们都试一下:

1. 通过 setter 方法

  首先,需要注意的是,若要通过 setter 方法来配置 bean ,那么这个 bean 里面一定要有 setter 方法,否则 Spring 会报错

  下面,我附上 XML 文件的代码

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
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"> <!-- 添加 Address 和 Person -->
<bean id="address" class="com.spring.xmlBean.Address">
<property name="city" value="日照"></property>
<property name="province" value="山东"></property>
</bean> <bean id="person" class="com.spring.xmlBean.Person">
<property name="name" value="Little-Koala"></property>
<property name="age" value="18"></property>
<!-- 通过 ref 引用了 address 这个 bean -->
<property name="address" ref="address"></property>
</bean>
</beans>

Spring Bean Configuration File

运行刚才测试用的那个 main 方法,发现配置成功了

4. Spring 如何通过 XML 文件配置Bean,以及如何获取Bean

在配置的时候,我们使用了 <property name="属性名"  value="值" ></property> 这个节点来对 bean 进行配置

其中,我们的 person 中有一个 Address 属性,它通过 ref 这个属性节点引用了 id 值为 address 的 bean

总结:通过 setter 方法来配置 bean ,我们使用 property 节点来进行配置,但前提是这个 bean 要有 setter 方法。其中,name 属性表示 bean 的属性名,bean 的属性值可以通过 value 属性来直接设置,也可以通过 ref 属性来引用其他的 bean

2. 通过构造器来进行配置

  首先要注意的问题,在配置之前要有自己的构造器。我们通过 <constructor-arg></constructor-arg> 这个节点来进行配置,下面附上代码:

<bean id="address" class="com.spring.xmlBean.Address">
<constructor-arg name="city" value="日照"></constructor-arg>
<constructor-arg name="province" value="山东"></constructor-arg>
<!--
<property name="city" value="日照"></property>
<property name="province" value="山东"></property>
-->
</bean>

Spring Bean Configuration File

上面的 Address 这个 bean 换成了用构造器来配置,运行的效果和上面是一样的

其中,name 代码构造器中属性的名字,value 代表值

刚才上面说了怎样配置 bean ,还没有具体的讲怎么样从容器中获取 bean

获取bean分两步:

  1. 创建 IOC 容器

  2. 从容器中获取 bean

下面附上代码:

package com.spring.test;

import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext; import com.spring.helloworld.HelloWorld;
import com.spring.xmlBean.Person; public class TestMain {
public static void main(String[] args) { // 创建 Spring 的 IOC 容器
ApplicationContext ctx = new ClassPathXmlApplicationContext("beanConfiguration-xml.xml");
// 使用 getBean() 方法, 通过传入刚才的 id 名,来获取 bean, 但是这里返回的是一个 Object 对象, 所以要转型
Person person = (Person) ctx.getBean("person");
// 打印 person
System.out.println(person);
}
}

怎样获取 Bean

这是刚才的那个测试类

其中 getBean( ) 方法可以通过传入 id 值来获取 IOC 容器中的 bean ,也可以通过传入 Bean.class 来获取对应类型的对象

以上内容都是基础的内容,还有一部分没有提到,剩下的那些内容在以后的学习中会慢慢接触,多读源码,多看文档,慢慢的就会了