Spring核心——純Java運行與@Bean

3.0新增容器啓動方法

在3.0以前的Spring核心框架中,咱們啓動一個Spring容器必須使用一個XML文件。而到了3.X以後的版本Spring爲建立容器新增了一個入口類——AnnotationConfigApplicationContexthtml

AnnotationConfigApplicationContext和過去的ClassPathXmlApplicationContext、FileSystemXmlApplicationContext等方法不一樣的是他不用再指定任何XML配置文件,而是能夠經過指定類向容器添加Bean。咱們經過幾個簡單的例子來講明他的使用。java

(如下例子只用於說明問題,源碼請到 gitee 自行 clone,本節的代碼在 chkui.springcore.example.javabase.simple 包中)。git

直接添加Bean

咱們能夠經過AnnotationConfigApplicationContext直接向容器添加指定的類做爲Bean,先定義咱們的class:spring

package chkui.springcore.example.javabase.simple.pureBean;

class LolBean {
	public String toString() {
		return "I AM LOL!";
	}
}

class WowBean {
	public String toString() {
		return "I AM WOW!";
	}
}

而後向容器添加這些Bean:api

package chkui.springcore.example.javabase.simple;

public class WithoutAnnotation {
	public static void main(String[] args) {
		ApplicationContext ctx = new AnnotationConfigApplicationContext(WowBean.class, LolBean.class);
		System.out.println(ctx.getBean(WowBean.class));
		System.out.println(ctx.getBean(LolBean.class));
	}
}

這樣就啓動了一個Spring的容器,而且容器中包含了WowBean和LolBean這兩個類的單例。框架

替代<beans>標籤

@Configuration在以前介紹Spring核心容器的文章中出現過一兩次,配合各類註解的使用@Configuration能夠替代<beans>配置中的全部功能。基本上AnnotationConfigApplicationContext和@Configuration組合使用就能夠實現Spring容器純Java啓動。請看下面的例子。ide

咱們在前面例子的基礎上增長几個類:ui

package chkui.springcore.example.javabase.simple.bean;

public class DotaBean {
	public String toString() {
		return "I AM Dota!";
	}
}

@Component
public class PseBean {

	@Override
	public String toString() {
		return "I AM PSE!";
	}
}

注意DotaBean上是沒有@Component註解的。而後添加@Configuration配置:this

package chkui.springcore.example.javabase.simple.bean;

@Configuration
@ComponentScan("chkui.springcore.example.javabase.simple.bean")
public class Config {
	@Bean
	public DotaBean dotaBean() {
		return new DotaBean();
	}
}

最後運行他們:spa

package chkui.springcore.example.javabase.simple;

public class WithScan {
	public static void main(String[] args) {
		ApplicationContext ctx = new AnnotationConfigApplicationContext(Config.class, WowBean.class, LolBean.class);
		System.out.println(ctx.getBean(Config.class));
		System.out.println(ctx.getBean(PseBean.class));
		System.out.println(ctx.getBean(WowBean.class));
		System.out.println(ctx.getBean(LolBean.class));
		System.out.println(ctx.getBean(DotaBean.class));
	}
}

@Component已經在 Stereotype組件與Bean掃描 這篇文章介紹過,@ComponentScan的做用等價於<context:component-scan/>標籤,屬性參數都是一一對應的,只不過前者是駝峯命名規則(camelCase)——@ComponentScan(basePackages="..."),後者是短橫線命名規則(kebab-case)——<context:component-scan base-package="..."/>。實際上使用Annotation來替換XML配置中的內容,大部分都使用這種轉換方式。

@Configuration和@Bean標籤會在後續的內容中詳細介紹。@Bean主要用於方法標記,代表這個方法返回一個要添加到容器中的Bean。

AnnotationConfigApplicationContext的其餘使用方法

除了以上常規的使用方法,AnnotationConfigApplicationContext還有其餘方式向容器添加Bean。

可使用AnnotationConfigApplicationContext::register方法來添加配置和Bean:

public static void main(String[] args) {
    AnnotationConfigApplicationContext ctx = new AnnotationConfigApplicationContext();
    //動態添加配置文件
    ctx.register(Config1.class, Config2.class);
    //動態添加Bean
    ctx.register(Bean1.class);
    //刷新
    ctx.refresh();
}

注意最後的refresh方法,這個方法來源於ConfigurableApplicationContext接口,而後是在AbstractApplicationContext中實現的。他的過程至關於銷燬以前已經建立的資源,而後再從新建立了一個新的容器。這裏的代碼會執行如下幾步:

  1. new AnnotationConfigApplicationContext():建立一個新的容器,容器中沒有自定義的Bean。
  2. AnnotationConfigApplicationContext::register:向容器添加BeanDefinition,可是這些BeanDefinition並無轉化爲容器中的Bean。
  3. ConfigurableApplicationContext::refresh():歸入新添加的BeanDefinition重建容器。

還能夠直接使用AnnotationConfigApplicationContext::scan方法掃描指定的路徑:

public static void main(String[] args) {
    AnnotationConfigApplicationContext ctx = new AnnotationConfigApplicationContext();
    ctx.scan("com.acme");
    ctx.refresh();
}

 執行原理和上面介紹的同樣。

須要注意的是:若是你的工程中須要使用AnnotationConfigApplicationContext::register、AnnotationConfigApplicationContext::scan等方法建立容器和其中Bean的依賴關係,全部的Bean都只能在register或scan中添加。若是你既在AnnotationConfigApplicationContext的構造方法中添加了Bean,又使用AnnotationConfigApplicationContext::refresh()方法會拋出一個重複執行refresh的異常。AnnotationConfigApplicationContext::refresh()方法全局也只能被調用一次。

@Bean註解

@Bean註解等價於配置文件中的<bean>標籤,對應的參數也是將短橫線命名切換爲駝峯命名——<bean init-method="..."> => @Bean(initMethod="...")。@Bean註解只能使用在方法上,方法必須是在@Configuration標記的類或者其餘Bean中,二者存在的差別會在後續的文章中介紹。下面經過一個例子來講明Bean的使用。

(如下例子只用於說明問題,源碼請到 gitee 自行 clone,本節的代碼在 chkui.springcore.example.javabase.beanAnnotation 包中)。

定義兩個要添加到容器中的Bean:

package chkui.springcore.example.javabase.beanAnnotation.bean;

class FinalFantasy {
	@Override
	public String toString() {
		return "Final Fantasy 1~15";
	}
	public void init() {
		System.out.println("Final Fantasy init!");
	}
	
	public void destroy() {
		System.out.println("Final Fantasy destroy!");
	}
}

class DragonQuest {
	public String toString() {
		return "Dragon Quest 1~11";
	}
	
	@PostConstruct
	public void init() {
		System.out.println("Dragon Quest init!");
	}
	
	@PreDestroy
	public void destroy() {
		System.out.println("Dragon Quest destroy!");
	}
}

定義一個功能接口及其實現類:

package chkui.springcore.example.javabase.beanAnnotation.bean;

interface Support {
	void setFinalFantasy(FinalFantasy ff);
	FinalFantasy getFinalFantasy();
}
class SupportImpl implements Support {
	private FinalFantasy ff; 
	public void setFinalFantasy(FinalFantasy ff) {
		this.ff = ff;
	}
	public FinalFantasy getFinalFantasy() {
		return ff;
	}
}

而後頂一個@Configuration類:

package chkui.springcore.example.javabase.beanAnnotation.bean;

public class BeanAnnotationConfig {
	@Bean
	public Support support(FinalFantasy ff) {
		Support support = new SupportImpl();
		support.setFinalFantasy(ff);
		return support;
	}
	
	@Bean(initMethod="init", destroyMethod="destroy")
	@Description("Final Fantasy")
	public FinalFantasy finalFantasy() {
		return new FinalFantasy();
	}
	
	@Bean(name= {"dragon-quest", "DragonQuest"})
	public DragonQuest dragonQuest() {
		return new DragonQuest();
	}
}

最後運行他們:

public class BeanAnnotApp {

	public static void main(String[] args) {
		ApplicationContext ctx = new AnnotationConfigApplicationContext(BeanAnnotationConfig.class);
		Support support = ctx.getBean(Support.class);
		System.out.println(support.getFinalFantasy());
		System.out.println(ctx.getBean(DragonQuest.class));
	}

}

在配置類BeanAnnotationConfig中,咱們配置了3個Bean。這裏的寫在方法上的@Bean註解和寫在配置文件中的<bean>註解一個效果:

  • @Bean中的initMethoddestroyMethod對應<bean>標籤中的init-methoddestroy-method屬性。
  • @Bean中的name參數只有一個值時至關於id,有多個的時候至關於設置了多個別名
  • Support support(FinalFantasy ff):咱們能夠直接在方法中暴露參數來引入其餘Bean,這就相似於配置中ref的功能。
  • 若是不指定initMethoddestroyMethod,使用JSR-330的生命週期註解(@PostConstruct、@PreDestroy)一樣有效
相關文章
相關標籤/搜索