Spring中的Bean配置方式

点击蓝字“程序员考拉”欢迎关注！

1.IOC和DI概述

IOC(Inversion of Control)：其思想是反转资源获取的方向. 传统的资源查找方式要求组件向容器发起请求查找资源. 作为回应, 容器适时的返回资源. 而应用了 IOC 之后, 则是容器主动地将资源推送给它所管理的组件, 组件所要做的仅是选择一种合适的方式来接受资源. 这种行为也被称为查找的被动形式。

DI(Dependency Injection) — IOC 的另一种表述方式：即组件以一些预先定义好的方式(例如: setter 方法)接受来自如容器的资源注入. 相对于 IOC 而言，这种表述更直接。

2.Bean的配置方式

Bean 的配置方式：通过全类名（反射）、通过工厂方法（静态工厂方法 & 实例工厂方法）、FactoryBean。

2.1 Spring通过全类名（反射）配置Bean特点：

 1. 基于xml文件的方式，
 2. 通过全类名反射，
 3. 依靠IOC容器，
 4. 依赖注入的方式：属性注入，构造器注入

基于xml文件的方式：

bean id="helloworld" class="com.java.spring.HelloWorld"
  property name="name" value="koala"/property
/bean

id:Bean的名称，在IOC容器中必须是惟一的。

2.2通过工厂方法配置Bean

2.2.1 通过调用静态工厂配置Bean

调用静态工厂方法创建 Bean是将对象创建的过程封装到静态方法中. 当客户端需要对象时, 只需要简单地调用静态方法, 而不用关心创建对象的细节.

要声明通过静态方法创建的 Bean, 需要在 Bean 的 class 属性里指定拥有该工厂的方法的类, 同时在 factory-method 属性里指定工厂方法的名称. 最后, 使用 constrctor-arg 元素为该方法传递方法参数.

示例代码：

Car.java

package com.java.spring.factory;

public class Car {
  private String brand;
  private double price;
  public String getBrand() {
    return brand;
  }
  public void setBrand(String brand) {
    this.brand = brand;
  }
  public double getPrice() {
    return price;
  }
  public void setPrice(double price) {
    this.price = price;
  }
  public Car(String brand, double price) {
    super();
    this.brand = brand;
    this.price = price;
  }
  @Override
  public String toString() {
    return "Car [brand=" + brand + ", price=" + price + "]";
  }
}

StaticCarFactory.java

package com.java.spring.factory;
import java.util.HashMap;
import java.util.Map;
public class StaticCarFactory {
    private static MapString,Car cars=new HashMapString,Car();
    static{
        cars.put("audi",new Car("audi",300000.00));
        cars.put("ford",new Car("ford",400000.00));
    }
   //静态工厂方法
    public static Car getCar(String name){
        return cars.get(name);
    }    
}

在beans-factory.xml中进行配置：

bean id="car1" class="com.java.spring.factory.StaticCarFactory" factory-method="getCar"
  constructor-arg value="audi"/constructor-arg
/bean

主方法中进行实例化Bean：

package com.java.spring.factory;
import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;
public class Main {
  public static void main(String[] args){
    ApplicationContext ctx=new ClassPathXmlApplicationContext("beans-factory.xml");
    Car car1=(Car) ctx.getBean("car1");
    System.out.println(car1);
  }
}

运行后输出：

Car [brand=audi, price=300000.0]

静态工厂方法就是直接调用一个类的静态方法就能返回Bean的实例，上面代码中根据静态工厂方法public static Car getCar(String name)来配置Bean实例。

2.2.2 通过调用实例工厂方法创建 Bean

实例工厂方法: 将对象的创建过程封装到另外一个对象实例的方法里. 当客户端需要请求对象时, 只需要简单的调用该实例方法而不需要关心对象的创建细节.

要声明通过实例工厂方法创建的 Bean：

在 bean 的 factory-bean 属性里指定拥有该工厂方法的 Bean；

在 factory-method 属性里指定该工厂方法的名称；

使用 construtor-arg 元素为工厂方法传递方法参数；

InstanceCarFactory.java

package com.java.spring.factory;
import java.util.HashMap;
import java.util.Map;
public class InstanceCarFactory {
  private static MapString,Car cars=null;
  public InstanceCarFactory() {
    cars=new HashMapString,Car();
    cars.put("Audi",new Car("Audi",300000.00));
    cars.put("Ford",new Car("Ford",400000.00));
  }
  public Car getCar(String brand){
    return cars.get(brand);
  }
}

在beans-factory.xml中进行配置：

//配置工厂的实例
bean id="carFactory" class="com.java.spring.factory.InstanceCarFactory"/bean
//通过实例工厂方法来配置bean
bean id="car2" factory-bean="carFactory" factory-method="getCar"
  constructor-arg value="Ford"/constructor-arg
/bean

2.3 实现 FactoryBean 接口在 Spring IOC 容器中配置 Bean

Spring 中有两种类型的 Bean, 一种是普通Bean, 另一种是工厂Bean, 即FactoryBean. 工厂 Bean 跟普通Bean不同, 其返回的对象不是指定类的一个实例, 其返回的是该工厂 Bean 的 getObject 方法所返回的对象。

package com.java.spring.FactoryBean;
import org.springframework.beans.factory.FactoryBean;
public class CarFactoryBean implements FactoryBean{
  private String brand;
  public void setBrand(String brand){
    this.brand=brand;
  }
  @Override
        //FactoryBean返回的实例
  public Car getObject() throws Exception {
    return new Car(brand,500000.00);
  }
  @Override
        //FactoryBean返回的实例是否为单例
  public boolean isSingleton() {
    return false;
  }
  @Override
        //FactoryBean返回的类型
  public Class getObjectType() {
    return Car.class;
  }
}

在beans-factory.xml中进行配置：

bean id="car3" class="com.java.spring.FactoryBean.CarFactoryBean"
  property name="brand" value="BWM"/property
/bean

在主方法中实例化：

Object car3= ctx.getBean("car3");

3.获取Bean

Spring提供的最常用的IOC容器实现是ApplicationContext，ApplicationContext的主要实现类ClassPathXmlApplicationContext从类路径下加载配置文件。

创建Spring的IOC对象：

ApplicationContext ctx=new ClassPathXmlApplicationContext("applicationContext.xml");

从IOC容器中获取Bean：调用ApplicationContext的getBean()方法。

HelloWorld helloWorld=(HelloWorld) ctx.getBean("helloworld");

4.Spring依赖注入的方式

4.1 属性注入

属性注入即通过 setter 方法注入Bean 的属性值或依赖的对象。使用 property 元素, 使用 name 属性指定 Bean 的属性名称，value 属性或 value 子节点指定属性值，是最常用的注入方式。

例如：

bean id="helloworld" class="com.java.spring.HelloWorld"
  property name="name" value="koala"/property
/bean

4.2 构造方法注入

通过构造方法注入Bean 的属性值或依赖的对象，它保证了 Bean 实例在实例化后就可以使用。构造器注入在 constructor-arg 元素里声明属性, constructor-arg 中没有 name 属性。

Car.java

package com.java.spring;

public class Car {
  private String brand;
  private String corp;
  private double price;
  private int maxSpeed;
  public Car(String brand, String corp, double price) {
    super();
    this.brand = brand;
    this.corp = corp;
    this.price = price;
  }
  public Car(String brand, String corp, int maxSpeed) {
    super();
    this.brand = brand;
    this.corp = corp;
    this.maxSpeed = maxSpeed;
  }
  @Override
  public String toString() {
    return "Car [brand=" + brand + ", corp=" + corp + ", price=" + price + ", maxSpeed=" + maxSpeed + "]";
  }
}

4.2.1 按索引匹配入参

在XML中设置：

bean id="car" class="com.java.spring.Car"
  constructor-arg value="Audi" index="0"/constructor-arg
  constructor-arg value="上海" index="1"/constructor-arg
  constructor-arg value="500000.0000" index="2"/constructor-arg
/bean

主方法中获取Bean实例：

package com.java.spring;

import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;

public class Main {

  public static void main(String[] args){
    //1.创建spring的IOC对象
    ApplicationContext ctx=new ClassPathXmlApplicationContext("applicationContext.xml");
    //2.从IOC容器中获取bean实例
    Car car=(Car) ctx.getBean("car");
    System.out.println(car);
  }
}

运行后输出：

Car [brand=Audi, corp=上海, price=500000.0, maxSpeed=0]

4.2.2 按类型匹配入参

在XML中设置：

bean id="car2" class="com.java.spring.Car"
  constructor-arg value="Audi" type="String"/constructor-arg
  constructor-arg value="长春一汽" type="String"/constructor-arg
  constructor-arg value="240" type="int"/constructor-arg
/bean

也可以使用value/value子节点进行赋值:

bean id="car2" class="com.java.spring.Car"
  constructor-arg value="Audi" type="String"/constructor-arg
  constructor-arg value="长春一汽" type="String"/constructor-arg
  constructor-arg type="int"
    value240/value
  /constructor-arg
/bean

主方法中获取Bean实例：

package com.java.spring;

import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;

public class Main {

  public static void main(String[] args){
    //1.创建spring的IOC对象
    ApplicationContext ctx=new ClassPathXmlApplicationContext("applicationContext.xml");
    //2.从IOC容器中获取bean实例
    Car car=(Car) ctx.getBean("car2");
    System.out.println(car);
  }
}

运行后输出：

Car [brand=Audi, corp=长春一汽, price=0.0, maxSpeed=240]

5.引用其他Bean

5.1 ref引用

组成应用程序的 Bean 经常需要相互协作以完成应用程序的功能.。要使 Bean 能够相互访问, 就必须在 Bean 配置文件中指定对 Bean 的引用。在 Bean 的配置文件中, 可以通过 ref 元素或 ref  属性为 Bean 的属性或构造器参数指定对 Bean 的引用。

新建一个Person类Person.java

package com.java.spring;

public class Person {
  private String name;
  private int age;
  private Car car;
  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 Car getCar() {
    return car;
  }
  public void setCar(Car car) {
    this.car = car;
  }
  @Override
  public String toString() {
    return "Person [name=" + name + ", age=" + age + ", car=" + car + "]";
  }
}

在xml中进行配置：（value的值只能为字面值，即基本数据类型及其封装类，String等类型，Car非字面值，需通过ref引用其他bean）

bean id="person" class="com.java.spring.Person"
  property name="name" value="Tom"/property
  property name="age" value="23"/property
  property name="car" ref="car"/property
/bean

主方法中获取Bean实例：

Person person=(Person) ctx.getBean("person");

运行后输出：

Person [name=Tom, age=23, car=Car [brand=Audi, corp=上海, price=500000.0, maxSpeed=0]]

5.2 内部Bean

当 Bean 实例仅仅给一个特定的属性使用时, 可以将其声明为内部 Bean。 内部 Bean 声明直接包含在 property 或 constructor-arg 元素里，不需要设置任何 id 或 name 属性。内部 Bean 不能使用在任何其他地方。

同实现上面的功能，在XML中进行配置：

bean id="person1" class="com.java.spring.Person"
  property name="name" value="Tom"/property
  property name="age" value="23"/property
  property name="car"
    bean class="com.java.spring.Car"
      constructor-arg value="Audi" index="0"/constructor-arg
      constructor-arg value="长春一汽" index="1"/constructor-arg
      constructor-arg value="500000.0000" index="2"/constructor-arg
    /bean
  /property
/bean

6.级联属性赋值

和 Struts、Hiberante 等框架一样，Spring 支持级联属性的配置。

bean id="car" class="com.java.spring.Car"
  constructor-arg value="Audi" index="0"/constructor-arg
  constructor-arg value="上海" index="1"/constructor-arg
  constructor-arg value="500000.0000" index="2"/constructor-arg
/bean
bean id="person" class="com.java.spring.Person"
  property name="name" value="Tom"/property
  property name="age" value="23"/property
  property name="car" ref="car"/property
  property name="car.price" value="300000.0000"/property
/bean

使用级联属性赋值的前提是car中的price必须有setPrice()方法。

运行后输出：

[name=Tom, age=23, car=Car [brand=Audi, corp=上海, price=300000.0, maxSpeed=0]]

7.集合属性的配置

在 Spring中可以通过一组内置的 xml 标签(例如: list, set 或 map) 来配置集合属性。

7.1 配置 java.util.List 类型的属性， 需要指定 list  标签, 在标签里包含一些元素。这些标签可以通过 value 指定简单的常量值，通过 ref 指定对其他 Bean 的引用。 通过bean 指定内置 Bean 定义。通过 null/ 指定空元素。 甚至可以内嵌其他集合。数组的定义和 List 一样, 都使用 list。

示例代码：

Person.java

package com.java.spring;

import java.util.List;

public class Person {
  private String name;
  private int age;
  private ListCar cars;
  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 ListCar getCars() {
    return cars;
  }
  public void setCars(ListCar cars) {
    this.cars = cars;
  }
  @Override
  public String toString() {
    return "Person [name=" + name + ", age=" + age + ", cars=" + cars + "]";
  }
}

在xml中进行配置：

bean id="person" class="com.java.spring.Person"
  property name="name" value="Tom"/property
  property name="age" value="23"/property
  property name="cars"
    list
      ref bean="car"/
      ref bean="car2"/
    /list
  /property
/bean

在主方法中获取Bean实例：

Person person=(Person) ctx.getBean("person");

运行后输出：

Person [name=Tom, age=23, cars=[Car [brand=Audi, corp=上海, price=500000.0, maxSpeed=0], 
Car [brand=Audi, corp=长春一汽, price=0.0, maxSpeed=240]]]

7.2 配置 java.util.Set 需要使用 set 标签，定义元素的方法与 List 一样。

7.3 Java.util.Map 通过 map 标签定义，map 标签里可以使用多个 entry 作为子标签。每个条目包含一个键和一个值，必须在 key 标签里定义键。因为键和值的类型没有限制, 所以可以自由地为它们指定 value, ref, bean 或 null 元素。可以将 Map 的键和值作为 entry 的属性定义: 简单常量使用 key 和 value 来定义; Bean 引用通过 key-ref 和 value-ref 属性定义。

Person.java

package com.java.spring;

import java.util.Map;

public class Person {
  private String name;
  private int age;
  private MapString,Car cars;
  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 MapString,Car getCars() {
    return cars;
  }
  public void setCars(MapString,Car cars) {
    this.cars = cars;
  }
  @Override
  public String toString() {
    return "Person [name=" + name + ", age=" + age + ", cars=" + cars + "]";
  }
}

在xml中进行配置：

bean id="person" class="com.java.spring.Person"
  property name="name" value="Tom"/property
  property name="age" value="23"/property
  property name="cars"
    map
      entry key="A" value-ref="car"/entry
      entry key="B" value-ref="car2"/entry
    /map
  /property
/bean

在主方法中获取Bean实例：

Person person=(Person) ctx.getBean("person");

运行后输出：

Person [name=Tom, age=23, cars={A=Car [brand=Audi, corp=上海, price=500000.0, maxSpeed=0],
B=Car [brand=Audi, corp=长春一汽, price=0.0, maxSpeed=240]}]

7.4 使用 props 定义 java.util.Properties， 该标签使用多个 prop 作为子标签。每个 prop 标签必须定义 key 属性。

DataSource.java

package com.java.spring;

import java.util.Properties;

public class DataSource {
  private Properties properties;
  public Properties getProperties() {
    return properties;
  }
  public void setProperties(Properties properties) {
    this.properties = properties;
  }
  @Override
  public String toString() {
    return "DataSource [properties=" + properties + "]";
  }
}

在xml中进行配置：

bean id="datasource" class="com.java.spring.DataSource"
  property name="properties"
    props
      prop key="user"root/prop
      prop key="password"1234/prop
      prop key="jdbcUrl"jdbc:mysql:///test/prop
      prop key="driverClass"com.mysql.jdbc.Driver/prop
    /props
  /property
/bean

在主方法中获取Bean实例：

package com.java.spring;
import java.util.Properties;
import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;

public class Main {
  public static void main(String[] args){
    //1.创建spring的IOC对象
    ApplicationContext ctx=new ClassPathXmlApplicationContext("applicationContext.xml");
    //2.从IOC容器中获取bean实例
    DataSource datasource= (DataSource) ctx.getBean(DataSource.class);
    System.out.println(datasource);
  }
}

运行后输出：

DataSource [properties={driverClass=com.mysql.jdbc.Driver, user=root, password=1234, jdbcUrl=jdbc:mysql:///test}]

8.使用 utility scheme 定义集合

使用基本的集合标签定义集合时, 不能将集合作为独立的 Bean 定义, 导致其他 Bean 无法引用该集合, 所以无法在不同 Bean 之间共享集合。解决这个问题的方法是使用 util schema 里的集合标签定义独立的集合 Bean. 需要注意的是, 必须在 beans 根元素里添加 util schema 定义。使用前需要先导入util命名空间，导入方式如下：

示例代码：

在xml中进行配置：

util:list id="cars"
  ref bean="car"/
  ref bean="car2"/
/util:list

就可以在另一个Bean里进行引用：

bean id="person" class="com.java.spring.Person"
  property name="name" value="Tom"/property
  property name="age" value="23"/property
  property name="cars" ref="cars"/property
/bean

9.使用p命名空间

为了简化 XML 文件的配置，越来越多的 XML 文件采用属性而非子元素配置信息。Spring 从 2.5 版本开始引入了一个新的 p 命名空间，可以通过 bean 元素属性的方式配置 Bean 的属性。使用之前像导入util命名空间一样先导入p命名空间。这种配置方式相对于传统的配置方式更加简洁。

bean id="person" class="com.java.spring.Person" p:age="24" p:name="Tom" p:cars-ref="cars"/bean