[TOC]

Spring 框架學(xué)習(xí)（二）：Spring 應(yīng)用配置文件解析

初學(xué) Spring 的時(shí)候疗琉，只是照貓畫虎画饥，對(duì)于每一項(xiàng)配置的由來并不十分了解布疙。這里嗜历，我們深入了解一下邻吭，這些配置都起到了什么作用教沾？

web.xml

應(yīng)用啟動(dòng)的時(shí)候在抛，Tomcat 容器會(huì)讀取 web.xml 配置文件褥伴，一個(gè)正常的 web.xml 示例如下：

<?xml version="1.0" encoding="UTF-8"?>
<web-app version="3.0" xmlns="http://java.sun.com/xml/ns/javaee"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://java.sun.com/xml/ns/javaee
    http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd">
    
    <context-param>
        <param-name>contextConfigLocation</param-name>
        <param-value>classpath:spring/applicationContext.xml</param-value>
    </context-param>
    <listener>
        <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
    </listener>
    <listener>
        <listener-class>org.springframework.web.context.request.RequestContextListener</listener-class>
    </listener>

    <servlet>
        <servlet-name>spring</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
        <init-param>
            <param-name>contextConfigLocation</param-name>
            <param-value>classpath:spring/mvc.xml</param-value>
        </init-param>
        <load-on-startup>1</load-on-startup>
    </servlet>
    <servlet-mapping>
        <servlet-name>spring</servlet-name>
        <url-pattern>/</url-pattern>
    </servlet-mapping>

    <servlet-mapping>
        <servlet-name>default</servlet-name>
        <url-pattern>*.css</url-pattern>
    </servlet-mapping>
    <servlet-mapping>
        <servlet-name>default</servlet-name>
        <url-pattern>*.gif</url-pattern>
    </servlet-mapping>
    <servlet-mapping>
        <servlet-name>default</servlet-name>
        <url-pattern>*.jpg</url-pattern>
    </servlet-mapping>
    <servlet-mapping>
        <servlet-name>default</servlet-name>
        <url-pattern>*.js</url-pattern>
    </servlet-mapping>
    <servlet-mapping>
        <servlet-name>default</servlet-name>
        <url-pattern>*.html</url-pattern>
    </servlet-mapping>

    <filter>
        <filter-name>http_filter</filter-name>
        <filter-class>com.xxx.HttpFilter</filter-class>
    </filter>
    <filter-mapping>
        <filter-name>http_filter</filter-name>
        <url-pattern>/api/search.json</url-pattern>
    </filter-mapping>
</web-app>

context-param 節(jié)點(diǎn)存儲(chǔ)的鍵值對(duì)會(huì)被存入 ServletContext 中腥沽，后續(xù)可以通過其 getInitParameter 得到其值逮走，

ServletContext sc;
String configLocationParam = sc.getInitParameter("contextConfigLocation");

listener 節(jié)點(diǎn)存放的 ContextLoaderListene 類實(shí)現(xiàn)了接口 ServletContextListener，會(huì)監(jiān)聽 Web 容器的初始化和關(guān)閉今阳，做相應(yīng)的初始化和銷毀工作：

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 節(jié)點(diǎn)存放的另一個(gè)類 RequestContextListener 實(shí)現(xiàn)了接口 ServletRequestListener师溅，會(huì)監(jiān)聽每次 HTTP 請(qǐng)求，管理作用域?yàn)?Request 的 bean盾舌。對(duì)于作用域?yàn)?request 的 bean墓臭，就會(huì)在請(qǐng)求進(jìn)來的時(shí)候創(chuàng)建，結(jié)束的時(shí)候銷毀矿筝。

public interface ServletRequestListener extends EventListener {
    void requestDestroyed(ServletRequestEvent var1);
    void requestInitialized(ServletRequestEvent var1);
}

這其中 ContextLoaderListener 是必須的起便，RequestContextListener 是可選的。

servlet 節(jié)點(diǎn)用于配置處理 HTTP 請(qǐng)求的 HttpServlet 實(shí)現(xiàn)類，具體處理哪些請(qǐng)求是配置在 servlet-mapping 里的榆综。DispatcherServlet 實(shí)現(xiàn)的是 MVC 模式中的控制器妙痹，負(fù)責(zé)分發(fā)請(qǐng)求。所有的 Web 請(qǐng)求都需要經(jīng)過它來處理鼻疮，進(jìn)行轉(zhuǎn)發(fā)怯伊、匹配、數(shù)據(jù)處理后判沟，轉(zhuǎn)由頁面進(jìn)行呈現(xiàn)耿芹。在初始化時(shí)會(huì)解析 contextConfigLocation 參數(shù)配置的文件，建立 MVC 子容器挪哄。

filter 節(jié)點(diǎn)配置過濾器 Filter吧秕，可以對(duì) HTTP 請(qǐng)求做一些過濾、校驗(yàn)迹炼、日志監(jiān)控記錄的工作砸彬，具體適配的請(qǐng)求 url 配置在 filter-mapping 節(jié)點(diǎn)。

applicationContext.xml

ContextLoaderListener 會(huì)解析 applicationContext.xml 文件來初始化 Spring 容器斯入。常見的配置示例如下：

<?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:aop="http://www.springframework.org/schema/aop"
       xmlns:context="http://www.springframework.org/schema/context"
       xsi:schemaLocation="
       http://www.springframework.org/schema/beans 
       http://www.springframework.org/schema/beans/spring-beans-3.0.xsd
       http://www.springframework.org/schema/aop 
       http://www.springframework.org/schema/aop/spring-aop-3.0.xsd
       http://www.springframework.org/schema/context 
       http://www.springframework.org/schema/context/spring-context-3.0.xsd" default-autowire="byName">
    <!-- 加載參數(shù)配置 -->
    <context:property-placeholder location="classpath:config.properties" ignore-unresolvable="true"/>

    <!-- 自動(dòng)掃描 web 包 ,將帶有注解的類 納入 spring 容器管理 -->
    <context:component-scan base-package="com.xxx.web">
        <context:exclude-filter type="annotation" expression="org.springframework.stereotype.Controller" />
    </context:component-scan>

    <!-- 創(chuàng)建 bean -->
    <bean id="httpClient" class="com.xxx.http.HttpClient"/>

    <!-- 聲明自動(dòng)為spring容器中那些配置 @AspectJ 切面的 bean 創(chuàng)建代理 -->
    <aop:aspectj-autoproxy/>

    <!-- 加載其他配置文件砂碉，import 的使用使得配置文件也可以模塊化 -->
    <import resource="classpath:xxx.xml"/>
</beans>

我有一個(gè)疑問，為什么要在 component-scan 里 exclude 掉 Controller 呢刻两？這是因?yàn)?Spring 核心模塊并不處理 HTTP 請(qǐng)求增蹭，處理 HTTP 請(qǐng)求的是 Spring MVC 子模塊，兩者使用的是不同的容器：Spring Context 父容器和 Spring MVC 子容器磅摹。Controller 注解的 bean 要在 mvc 容器中創(chuàng)建才能起到作用滋迈，所以要在父容器的配置中排除掉。

在 《Spring 技術(shù)內(nèi)幕》這本書中提到“IOC 容器會(huì)首先向其雙親上下文去 getBean”偏瓤，這跟我們?nèi)粘＿\(yùn)行程序的感受不符杀怠，所以到底是先去父容器拿 bean 還是先去子容器拿 bean，我們還是深入源碼看看吧厅克。ApplicationContext 的 getBean 方法實(shí)現(xiàn)在 AbstractApplicationContext 類：

public abstract class AbstractApplicationContext extends DefaultResourceLoader implements ConfigurableApplicationContext, DisposableBean {
    public <T> T getBean(Class<T> requiredType) throws BeansException {
        return this.getBeanFactory().getBean(requiredType);
    }
}

該方法調(diào)用了 BeanFactory 的 getBean 方法赔退，從 AbstractBeanFactory 類的 getBean 方法中看到，的確是優(yōu)先使用子容器的 bean：

    public Object getBean(String name) throws BeansException {
        return this.doGetBean(name, (Class)null, (Object[])null, false);
    }
    protected <T> T doGetBean(String name, Class<T> 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证舟，即當(dāng)前容器不存在 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<String, BeanDefinition> 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 配置在一起的參數(shù)抵知。

<?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"
       xmlns:context="http://www.springframework.org/schema/context"
       xmlns:util="http://www.springframework.org/schema/util"
       xmlns:mvc="http://www.springframework.org/schema/mvc"
       xsi:schemaLocation="
        http://www.springframework.org/schema/util
        http://www.springframework.org/schema/util/spring-util-3.2.xsd
        http://www.springframework.org/schema/beans
        http://www.springframework.org/schema/beans/spring-beans-3.2.xsd
        http://www.springframework.org/schema/context
        http://www.springframework.org/schema/context/spring-context-3.2.xsd
        http://www.springframework.org/schema/mvc
        http://www.springframework.org/schema/mvc/spring-mvc-3.2.xsd">
    <!-- 掃描 Controller -->
    <context:component-scan base-package="com.xxx.controller" use-default-filters="false">
        <context:include-filter type="annotation" expression="org.springframework.stereotype.Controller" />
        <context:exclude-filter type="annotation" expression="org.springframework.stereotype.Service" />
    </context:component-scan>
    <!-- HTTP 請(qǐng)求適配器 -->
    <bean class="org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter">
        <property name="messageConverters">
            <list>
                <!-- 使用 Jackson 的 ObjectMapper 讀取/編寫 JSON 數(shù)據(jù)墙基。它轉(zhuǎn)換媒體類型為 application/json 的數(shù)據(jù)软族。 -->
                <bean class="org.springframework.http.converter.json.MappingJacksonHttpMessageConverter"/>
            </list>
        </property>
    </bean>

    <!-- 配置 velocity 引擎 -->
    <bean id="velocityConfig" class="org.springframework.web.servlet.view.velocity.VelocityConfigurer">
        <property name="resourceLoaderPath" value="/WEB-INF/views/vm/" />
        <property name="configLocation" value="classpath:velocity.properties" />
    </bean>

    <!-- 配置視圖解析器 -->
    <bean class="org.springframework.web.servlet.view.ContentNegotiatingViewResolver">
        <property name="ignoreAcceptHeader" value="true"/>
        <property name="mediaTypes">
            <map>
                <entry key="json" value="application/json" />
                <entry key="xml" value="application/xml" />
                <entry key="jsonp" value="application/javascript" />
            </map>
        </property>
        <property name="favorParameter" value="false"/>
        <property name="viewResolvers">
            <list>
                <!-- vm 視圖解析器 -->
                <bean id="velocityViewResolver" class="org.springframework.web.servlet.view.velocity.VelocityViewResolver">
                    <property name="suffix" value=".vm" />
                </bean>
                <!-- jsp 視圖處理器 -->
                <bean id="jspViewResolver" class="org.springframework.web.servlet.view.InternalResourceViewResolver">
                    <property name="viewClass" value="org.springframework.web.servlet.view.JstlView"/>
                    <property name="prefix" value="/WEB-INF/views/jsp/"/>
                    <property name="suffix" value=".jsp"/>
                </bean>
                <bean class="org.springframework.web.servlet.view.BeanNameViewResolver" />
            </list>
        </property>
        <property name="defaultViews">
            <list>
                <bean class="org.springframework.web.servlet.view.json.MappingJacksonJsonView" />
            </list>
        </property>
    </bean>

    <mvc:interceptors>
        <mvc:interceptor>
            <!-- 對(duì)所有的請(qǐng)求使用 CommonInterceptor 處理 -->
            <mvc:mapping path="/**" />
            <bean class="com.xxx.web.interceptor.CommonInterceptor"></bean>
        </mvc:interceptor>
    </mvc:interceptors>
</beans>

此處的 component-scan 中要排除掉 Service 注解，那么如果不排除會(huì)有什么問題嗎残制？多數(shù)情況下也不會(huì)有問題立砸，但是如果你用到了 AOP，那么由于這里沒有排除 Service 注解初茶，Controller 用到的 Service 既會(huì)出現(xiàn)在父容器颗祝，也會(huì)出現(xiàn)在子容器，但是只有父容器中的 Service 會(huì)被 AOP 處理恼布，然而 Controller 優(yōu)先使用同一個(gè)容器中的 Service螺戳，就會(huì)導(dǎo)致其調(diào)用了沒有被 AOP 代理的服務(wù)。

總結(jié)一下折汞，mvc.xml 里存放的基本都是跟處理 HTTP 請(qǐng)求相關(guān)的配置倔幼。

參考資料

1. 關(guān)于XML文檔的xmlns、xmlns:xsi和xsi:schemaLocation