[TOC]
Spring 框架学习(二):Spring 应用配置文件解析
初学 Spring 的时候,只是照猫画虎,对于每一项配置的由来并不十分了解。这里,我们深入了解一下,这些配置都起到了什么作用?
web.xml
应用启动的时候,Tomcat 容器会读取 web.xml 配置文件,一个正常的 web.xml 示例如下:
contextConfigLocation
classpath:spring/applicationContext.xml
org.springframework.web.context.ContextLoaderListener
org.springframework.web.context.request.RequestContextListener
spring
org.springframework.web.servlet.DispatcherServlet
contextConfigLocation
classpath:spring/mvc.xml
1
spring
/
default
*.css
default
*.gif
default
*.jpg
default
*.js
default
*.html
http_filter
com.xxx.HttpFilter
http_filter
/api/search.json
context-param 节点存储的键值对会被存入 ServletContext 中,后续可以通过其 getInitParameter 得到其值,
ServletContext sc;
String configLocationParam = sc.getInitParameter("contextConfigLocation");
listener 节点存放的 ContextLoaderListene 类实现了接口 ServletContextListener,会监听 Web 容器的初始化和关闭,做相应的初始化和销毁工作:
public interface ServletContextListener extends EventListener {
void contextInitialized(ServletContextEvent var1);
void contextDestroyed(ServletContextEvent var1);
}
Spring 容器就是在 ContextLoaderListener 的 contextInitialized 方法中被初始化:
public class ContextLoaderListener extends ContextLoader implements ServletContextListener {
public void contextInitialized(ServletContextEvent event) {
this.contextLoader = this.createContextLoader();
if(this.contextLoader == null) {
this.contextLoader = this;
}
this.contextLoader.initWebApplicationContext(event.getServletContext());
}
}
listener 节点存放的另一个类 RequestContextListener 实现了接口 ServletRequestListener,会监听每次 HTTP 请求,管理作用域为 Request 的 bean。对于作用域为 request 的 bean,就会在请求进来的时候创建,结束的时候销毁。
public interface ServletRequestListener extends EventListener {
void requestDestroyed(ServletRequestEvent var1);
void requestInitialized(ServletRequestEvent var1);
}
这其中 ContextLoaderListener 是必须的,RequestContextListener 是可选的。
servlet 节点用于配置处理 HTTP 请求的 HttpServlet 实现类,具体处理哪些请求是配置在 servlet-mapping 里的。DispatcherServlet 实现的是 MVC 模式中的控制器,负责分发请求。所有的 Web 请求都需要经过它来处理,进行转发、匹配、数据处理后,转由页面进行呈现。在初始化时会解析 contextConfigLocation 参数配置的文件,建立 MVC 子容器。
filter 节点配置过滤器 Filter,可以对 HTTP 请求做一些过滤、校验、日志监控记录的工作,具体适配的请求 url 配置在 filter-mapping 节点。
applicationContext.xml
ContextLoaderListener 会解析 applicationContext.xml 文件来初始化 Spring 容器。常见的配置示例如下:
我有一个疑问,为什么要在 component-scan 里 exclude 掉 Controller 呢?这是因为 Spring 核心模块并不处理 HTTP 请求,处理 HTTP 请求的是 Spring MVC 子模块,两者使用的是不同的容器:Spring Context 父容器和 Spring MVC 子容器。Controller 注解的 bean 要在 mvc 容器中创建才能起到作用,所以要在父容器的配置中排除掉。
在 《Spring 技术内幕》这本书中提到“IOC 容器会首先向其双亲上下文去 getBean”,这跟我们日常运行程序的感受不符,所以到底是先去父容器拿 bean 还是先去子容器拿 bean,我们还是深入源码看看吧。ApplicationContext 的 getBean 方法实现在 AbstractApplicationContext 类:
public abstract class AbstractApplicationContext extends DefaultResourceLoader implements ConfigurableApplicationContext, DisposableBean {
public T getBean(Class requiredType) throws BeansException {
return this.getBeanFactory().getBean(requiredType);
}
}
该方法调用了 BeanFactory 的 getBean 方法,从 AbstractBeanFactory 类的 getBean 方法中看到,的确是优先使用子容器的 bean:
public Object getBean(String name) throws BeansException {
return this.doGetBean(name, (Class)null, (Object[])null, false);
}
protected T doGetBean(String name, Class requiredType, final Object[] args, boolean typeCheckOnly) throws BeansException {
final String beanName = this.transformedBeanName(name);
Object sharedInstance = this.getSingleton(beanName);
Object bean;
if(sharedInstance != null && args == null) {
// 省略
} else {
if(this.isPrototypeCurrentlyInCreation(beanName)) {
throw new BeanCurrentlyInCreationException(beanName);
}
BeanFactory ex = this.getParentBeanFactory();
// containsBeanDefinition 返回 false,即当前容器不存在 bean,才去父容器获取
if(ex != null && !this.containsBeanDefinition(beanName)) {
String var21 = this.originalBeanName(name);
if(args != null) {
return ex.getBean(var21, args);
}
return ex.getBean(var21, requiredType);
}
// 省略其他。。。
}
private final Map beanDefinitionMap = new ConcurrentHashMap();
// 此方法在 DefaultListableBeanFactory 类中
public boolean containsBeanDefinition(String beanName) {
Assert.notNull(beanName, "Bean name must not be null");
return this.beanDefinitionMap.containsKey(beanName);
}
mvc.xml
spring mvc 子容器初始化依赖 mvc.xml,此文件具体名称是和 DispatcherServlet 配置在一起的参数。
此处的 component-scan 中要排除掉 Service 注解,那么如果不排除会有什么问题吗?多数情况下也不会有问题,但是如果你用到了 AOP,那么由于这里没有排除 Service 注解,Controller 用到的 Service 既会出现在父容器,也会出现在子容器,但是只有父容器中的 Service 会被 AOP 处理,然而 Controller 优先使用同一个容器中的 Service,就会导致其调用了没有被 AOP 代理的服务。
总结一下,mvc.xml 里存放的基本都是跟处理 HTTP 请求相关的配置。
参考资料
- 关于XML文档的xmlns、xmlns:xsi和xsi:schemaLocation