Skip to content

Latest commit

 

History

History
152 lines (116 loc) · 6.44 KB

3.12.2-annotationconfigapplicationcontextspring.md

File metadata and controls

152 lines (116 loc) · 6.44 KB

3.12.2 使用AnnotationConfigApplicationContext实例化Spring容器

下Spring的AnnotationConfigApplicationContext部分,是Spring3.0中新增的。 这是一个强大的(译注原文中是多才多艺的versatile)ApplicationContext实现,不仅能解析@Configuration注解类,也能解析@Componnet注解的类和使用JSR-330注解的类。

当使用@Configuration类作为输入时,@Configuration类本身被注册为一个bean定义,类中所有声明的@Bean方法也被注册为bean定义。

当提供@Component和JSR-330类时,它们被注册为bean定义,并且假定在必要时在这些类中使用DI元数据,例如@Autowired@Inject

简单结构

Spring以XML作为配置元数据实例化一个ClassPathXmlApplicationContext,以@Configuration类作为配置元数据时,Spring以差不多的方式,实例化一个AnnotationConfigApplicationContext。因此,Spring 容器可以实现零XML配置。

public static void main(String[] args) {
	ApplicationContext ctx = new AnnotationConfigApplicationContext(AppConfig.class);
	MyService myService = ctx.getBean(MyService.class);
	myService.doStuff();
}

如上所述,AnnotationConfigApplicationContext不限于只使用@Configuration类任何@Component或JSR-330注解的类都能被提供给这个构造方法。 例如:

public static void main(String[] args) {
	ApplicationContext ctx = new AnnotationConfigApplicationContext(MyServiceImpl.class, Dependency1.class, Dependency2.class);
	MyService myService = ctx.getBean(MyService.class);
	myService.doStuff();
}

上面假设 MyServiceImplDependency1Dependency2使用Spring依赖注入注解,如@Autowired

使用register(Class<?>…​)编程式构造Spring容器

An AnnotationConfigApplicationContext may be instantiated using a no-arg constructor and then configured using the register() method. This approach is particularly useful when programmatically building an AnnotationConfigApplicationContext.

AnnotationConfigApplicationContext可以通过无参构造函数实例化然后, 然后调用register()方法进行配置。 这种方法在以编程方式构建一个AnnotationConfigApplicationContext时特别有用。

public static void main(String[] args) {
	AnnotationConfigApplicationContext ctx = new AnnotationConfigApplicationContext();
	ctx.register(AppConfig.class, OtherConfig.class);
	ctx.register(AdditionalConfig.class);
	ctx.refresh();
	MyService myService = ctx.getBean(MyService.class);
	myService.doStuff();
}

使用scan(String…)扫描组件

要启用组件扫描,只要像下面这样配置@Configuration类即可:

@Configuration
@ComponentScan(basePackages = "com.acme")
public class AppConfig  {
   	...
}

[Tip]

有经验的用户可能更熟悉使用等价的XML形式配置

<beans>

	<context:component-scan base-package="com.acme"/>
</beans>

上面的例子中,com.acme包会被扫描,只要是使用了@Component注解的类,都会被注册进容器中。同样地, AnnotationConfigApplicationContext暴露的scan(String...)方法也允许扫描类,完成相同的功能:

public static void main(String[] args) {
	AnnotationConfigApplicationContext ctx = new AnnotationConfigApplicationContext();
	ctx.scan("com.acme");
	ctx.refresh();
	MyService myService = ctx.getBean(MyService.class);
}
[Note]
请记住, @Configuration 类是被@Component元注解meta-annotated 注解的类 所以它们也会被扫描到.上面的例子中,假设AppConfig定义在com.acme包中(或更深的包中),调用scan()时它也会被扫描到,并且它里面配置的所有@Bean方法会在refresh()的时候被注册到容器中。

使用AnnotationConfigWebApplicationContext支持web应用

一个WebApplicationContext与AnnotationConfigApplicationContext的变种是AnnotationConfigWebApplicationContext。 这个实现可以用于配置SpringContextLoaderListener servlet监听器,Spring MVC的DispatcherServlet等时使用。下面是一个web.xml代码片段,用于配置典型的Spring MVC Web应用程序。 注意contextClass类的context-param和init-param:

<web-app>
	<!-- Configure ContextLoaderListener to use AnnotationConfigWebApplicationContext
		instead of the default XmlWebApplicationContext -->
	<context-param>
		<param-name>contextClass</param-name>
		<param-value>
			org.springframework.web.context.support.AnnotationConfigWebApplicationContext
		</param-value>
	</context-param>

	<!-- Configuration locations must consist of one or more comma- or space-delimited
		fully-qualified @Configuration classes. Fully-qualified packages may also be
		specified for component-scanning -->
	<context-param>
		<param-name>contextConfigLocation</param-name>
		<param-value>com.acme.AppConfig</param-value>
	</context-param>

	<!-- Bootstrap the root application context as usual using ContextLoaderListener -->
	<listener>
		<listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
	</listener>

	<!-- Declare a Spring MVC DispatcherServlet as usual -->
	<servlet>
		<servlet-name>dispatcher</servlet-name>
		<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
		<!-- Configure DispatcherServlet to use AnnotationConfigWebApplicationContext
			instead of the default XmlWebApplicationContext -->
		<init-param>
			<param-name>contextClass</param-name>
			<param-value>
				org.springframework.web.context.support.AnnotationConfigWebApplicationContext
			</param-value>
		</init-param>
		<!-- Again, config locations must consist of one or more comma- or space-delimited
			and fully-qualified @Configuration classes -->
		<init-param>
			<param-name>contextConfigLocation</param-name>
			<param-value>com.acme.web.MvcConfig</param-value>
		</init-param>
	</servlet>

	<!-- map all requests for /app/* to the dispatcher servlet -->
	<servlet-mapping>
		<servlet-name>dispatcher</servlet-name>
		<url-pattern>/app/*</url-pattern>
	</servlet-mapping>
</web-app>