12--Spring BeanFactory和FactoryBean的區別

阿新 • • 發佈：2019-01-29

上一篇介紹了Spring中bean的作用域和生命週期，今天繼續來溫習Spring中的另一個重要介面FactoryBean，在初學Spring時，大家可能混淆Spring中的兩個介面，FactoryBean和BeanFactory，我們先來看一下這兩者的各自含義，再通過簡單的例子說明一下FactoryBean的使用。

BeanFactory：在前面的部落格中已經做了大量的介紹，該介面是IoC容器的頂級介面，是IoC容器的最基礎實現，也是訪問Spring容器的根介面，負責對bean的建立，訪問等工作
FactoryBean：是一種工廠bean，可以返回bean的例項，我們可以通過實現該介面對bean進行額外的操作，例如根據不同的配置型別返回不同型別的bean，簡化xml配置等；其在使用上也有些特殊，大家還記得BeanFactory中有一個字元常量String FACTORY_BEAN_PREFIX = "&";

當我們去獲取BeanFactory型別的bean時，如果beanName不加&則獲取到對應bean的例項；如果beanName加上&，則獲取到BeanFactory本身的例項；FactoryBean介面對應Spring框架來說佔有重要的地位，Spring本身就提供了70多個FactoryBean的實現。他們隱藏了例項化一些複雜的細節，給上層應用帶來了便利。從Spring3.0開始，FactoryBean開始支援泛型。

上面的文字可能生澀難懂，我們通過兩個例子才簡單說明下FactoryBean的使用：

1.簡化xml配置，隱藏細節

如果一個類有很多的屬性，我們想通過Spring來對類中的屬性進行值的注入，勢必要在配置檔案中書寫大量屬性配置，造成配置檔案臃腫，那麼這時可以考慮使用FactoryBean來簡化配置

新建bean

package com.lyc.cn.day03;

/**
 * @author: LiYanChao
 * @create: 2018-09-05 11:50
 */
public class Student {
	/** 姓名 */
	private String name;
	/** 年齡 */
	private int age;
	/** 班級名稱 */
	private String className;

	public Student() {
	}

	public Student(String name, int age, String className) {
		this.name = 
 name;
		this.age = age;
		this.className = className;
	}

	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 String getClassName() {
		return className;
	}

	public void setClassName(String className) {
		this.className = className;
	}

	@Override
	public String toString() {
		return "Student{" + "name='" + name + '\'' + ", age=" + age + ", className='" + className + '\'' + '}';
	}
}

實現FactoryBean介面

package com.lyc.cn.day03;

import org.springframework.beans.factory.FactoryBean;

/**
 * @author: LiYanChao
 * @create: 2018-09-05 11:49
 */
public class StudentFactoryBean implements FactoryBean<Student> {

	private String studentInfo;

	@Override
	public Student getObject() throws Exception {
		if (this.studentInfo == null) {
			throw new IllegalArgumentException("'studentInfo' is required");
		}

		String[] splitStudentInfo = studentInfo.split(",");
		if (null == splitStudentInfo || splitStudentInfo.length != 3) {
			throw new IllegalArgumentException("'studentInfo' config error");
		}

		Student student = new Student();
		student.setName(splitStudentInfo[0]);
		student.setAge(Integer.valueOf(splitStudentInfo[1]));
		student.setClassName(splitStudentInfo[2]);
		return student;
	}

	@Override
	public Class<?> getObjectType() {
		return Student.class;
	}

	public void setStudentInfo(String studentInfo) {
		this.studentInfo = studentInfo;
	}
}

新建day03.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"
	   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">

	<!--注意:class是StudentFactoryBean而不是Student-->
	<bean id="student" class="com.lyc.cn.day03.StudentFactoryBean" p:studentInfo="張三,25,三年二班"/>

</beans>

新建測試用例

package com.lyc.cn.day03;

import org.junit.After;
import org.junit.Before;
import org.junit.Test;
import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;

/**
 * @author: LiYanChao
 * @create: 2018-09-05 11:59
 */
public class MyTest {
	@Before
	public void before() {
		System.out.println("---測試開始---\n");
	}

	@After
	public void after() {
		System.out.println("\n---測試結束---");
	}

	@Test
	public void testStudentFactoryBean() {
		ApplicationContext applicationContext = new ClassPathXmlApplicationContext("day03.xml");
		System.out.println(applicationContext.getBean("student"));
		System.out.println(applicationContext.getBean("&student"));
	}
}

執行

---測試開始---

Student{name='張三', age=25, className='三年二班'}
org.springframework.beans.factory_bean.StudentFactoryBean@1ae369b7

---測試結束---

這樣我們就實現了通過BeanFactory介面達到了簡化配置檔案的作用。另外大家也可以發現getBean(“student”)返回的Student類的例項；而getBean("&student")返回的是StudentFactoryBean例項，即工廠bean其本身。

2.返回不同Bean的例項

既然FactoryBean是一種工廠bean，那麼我們就可以根據需要的型別，返回不同的bean的例項，通過程式碼簡單說明一下

新建bean

/**
 * @author: LiYanChao
 * @create: 2018-09-05 11:49
 */
public interface Animal {
	void sayHello();
}

/**
 * @author: LiYanChao
 * @create: 2018-09-05 15:10
 */
public class Cat implements Animal {
	@Override
	public void sayHello() {
		System.out.println("hello, 喵喵喵...");
	}
}

/**
 * @author: LiYanChao
 * @create: 2018-09-05 15:11
 */
public class Dog implements Animal {
	@Override
	public void sayHello() {
		System.out.println("hello, 汪汪汪...");
	}
}

建立了一個Animal介面極其兩個實現類Cat和Dog，並進行簡單輸出，那麼如何通過FactoryBean來通過配置返回不同的Animal例項呢

新建AnimalFactoryBean

package com.lyc.cn.day03;

import org.springframework.beans.factory.BeanFactory;
import org.springframework.beans.factory.FactoryBean;

/**
 * @author: LiYanChao
 * @create: 2018-09-05 15:11
 */
public class AnimalFactoryBean implements FactoryBean<Animal> {

	private String animal;

	@Override
	public Animal getObject() throws Exception {
		if (null == animal) {
			throw new IllegalArgumentException("'animal' is required");
		}
		if ("cat".equals(animal)) {
			return new Cat();
		} else if ("dog".equals(animal)) {
			return new Dog();
		} else {
			throw new IllegalArgumentException("animal type error");
		}
	}

	@Override
	public Class<?> getObjectType() {
		if (null == animal) {
			throw new IllegalArgumentException("'animal' is required");
		}
		if ("cat".equals(animal)) {
			return Cat.class;
		} else if ("dog".equals(animal)) {
			return Dog.class;
		} else {
			throw new IllegalArgumentException("animal type error");
		}
	}

	public void setAnimal(String animal) {
		this.animal = animal;
	}
}

修改day03.xml配置檔案，增加bean

<bean id="animal" class="com.lyc.cn.day03.AnimalFactoryBean" p:animal="cat"/>

在MyTest中新增測試用例

@Test
public void testAnimalFactoryBean() {
	ApplicationContext applicationContext = new ClassPathXmlApplicationContext("day03.xml");
	Animal animal = applicationContext.getBean("animal", Animal.class);
	animal.sayHello();
}

測試

---測試開始---

hello, 喵喵喵...

---測試結束---

可以看到，配置檔案裡我們將animal配置成了cat，那麼返回的就是cat的例項，也是簡單工廠的一個實現

3.FactoryBean原始碼

該介面的原始碼比較少，只聲明瞭三個介面

public interface FactoryBean<T> {

	//返回此工廠管理的物件的例項（可能Singleton和Prototype）
	//如果此FactoryBean在呼叫時尚未完全初始化（例如，因為它涉及迴圈引用），則丟擲相應的FactoryBeanNotInitializedException。
    //從Spring 2.0開始，允許FactoryBeans返回null 物件。工廠會將此視為正常使用價值; 在這種情況下，它不再丟擲FactoryBeanNotInitializedException。
    //鼓勵FactoryBean實現現在自己丟擲FactoryBeanNotInitializedException，視情況而定。
	T getObject() throws Exception;

	//返回此FactoryBean建立的物件型別,預設返回null
	Class<?> getObjectType();

    //例項是否單例模式,預設返回true
	default boolean isSingleton() {
		return true;
	}

}

關於FactoryBean就先分析到這裡了，上面在實現FactoryBean介面時沒有重寫其isSingleto()方法，Spring中大部分的bean都是單例bean，如果非單例bean的話，大家可以重寫該方法返回false即可。

12--Spring BeanFactory和FactoryBean的區別

1.簡化xml配置，隱藏細節

2.返回不同Bean的例項

3.FactoryBean原始碼

12--Spring BeanFactory和FactoryBean的區別

Spring原始碼--BeanFactory和FactoryBean區別

【Spring原始碼解讀】BeanFactory和FactoryBean區別及類裝載原始碼解讀

一文讀懂BeanFactory和FactoryBean區別

Spring中的BeanFactory和FactoryBean的區別

spring中BeanFactory和FactoryBean的區別

理解spring中的BeanFactory和FactoryBean的區別與聯絡

Spring BeanFactory與FactoryBean的區別及其各自的詳細介紹於用法

Spring Bean的生命週期之我的理解（三）------BeanFactory和FactoryBean

Spring原始碼學習之BeanFactory和FactoryBean

08--BeanFactory和FactoryBean的區別

BeanFactory 和FactoryBean的區別

BeanFactory和FactoryBean的區別

spring classpath:和classpath*:區別和實際應用

Spring:BeanFactory與FactoryBean

[spring]@Resource和@Autowired區別對比

Spring cloud和Dubbo區別

Spring @Configuration 和 @Component 區別(精簡彙總版)

BeanFactory與FactoryBean區別

spring BeanFactory和ApplicatContext

12--Spring BeanFactory和FactoryBean的區別

1.簡化xml配置，隱藏細節

2.返回不同Bean的例項

3.FactoryBean原始碼

相關推薦