7.1.1 自定义DispatcherServlet配置

程序清单7.1的外观上不能完全反映Abstract AnnotationConfigDispatcherServletInitializer的功能
SpittrWebAppInitializer中的三个方法是必须要重载的抽象方法
实际上还有更多的方法可以进行重载，以实现额外的配置

customizeRegistration()方法

ConfigDispatcherServletInitializer将DispatcherServlet注册到Servlet容器中
注册完成后，会调用customizeRegistration()方法，并将Registration.Dynamic传递进来
通过重载customizeRegistration()方法，可以对DispatcherServlet进行额外的配置

例如，在本章稍后的内容中（7.2节），我们将会看到如何在Spring MVC中处理multipart请求和文件上传。

如果计划使用Servlet 3.0对multipart配置的支持，那么需要使用DispatcherServlet的registration来启用multipart请求。

我们可以重载customizeRegistration()方法来设置MultipartConfigElement，如下所示：

@Override
protected void customizeRegistration(ServletRegistration.Dynamic registration) {
    registration.setMultipartConfig(new MultipartConfigElement("/tmp/spittr/uploads"));
}

使用customizeRegistration()方法中的ServletRegistration.Dynamic完成多项任务。

方法	功能
setLoadOnStartup()方法	设置load-on-startup优先级
调用setInitParameter()方法	设置初始化参数
调用setMultipartConfig()方法	配置Servlet 3.0对multipart的支持

通过这些方法，我们能够更灵活地管理和配置Servlet。

在前面的样例中，我们设置了对multipart的支持，将上传文件的临时存储目录设置在“/tmp/spittr/uploads”中。

7.1.2 添加其他的Servlet和Filter

按照AbstractAnnotationConfigDispatcherServletInitializer的定义，它会创建DispatcherServlet和ContextLoaderListener。但是，如果你想注册其他的Servlet、Filter或Listener的话，那该怎么办呢？

基于Java的初始化器（initializer）的一个好处就在于我们可以定义任意数量的初始化器类。因此，如果我们想往Web容器中注册其他组件的话，只需创建一个新的初始化器就可以了。最简单的方式就是实现Spring的WebApplicationInitializer接口。

例如，如下的程序清单展现了如何创建WebApplicationInitializer实现并注册一个Servlet：

import javax.servlet.ServletContext;
import javax.servlet.ServletException;
import javax.servlet.ServletRegistration;

import org.springframework.web.WebApplicationInitializer;
import org.springframework.web.servlet.DispatcherServlet;

public class MyWebAppInitializer implements WebApplicationInitializer {

    @Override
    public void onStartup(ServletContext servletContext) throws ServletException {
        // Register the main DispatcherServlet
        ServletRegistration.Dynamic dispatcher = servletContext.addServlet("dispatcher", new DispatcherServlet());
        dispatcher.setLoadOnStartup(1);
        dispatcher.addMapping("/");
        // Register other Servlets, Filters, or Listeners
        // ...
    }
}

如何使用WebApplicationInitializer接口来注册其他的Servlet、Filter或Listener。您强调了可以创建任意数量的初始化器类，并举例说明了如何创建一个新的初始化器来注册一个Servlet。

程序清单7.1 通过实现WebApplicationInitializer来注册Servlet

package com.spring.servlet;

import org.springframework.web.WebApplicationInitializer;

import javax.servlet.ServletContext;
import javax.servlet.ServletException;
import javax.servlet.ServletRegistration.Dynamic;

/**
 * @author huyang
 */
public class MyServletInitializer  implements WebApplicationInitializer {
    @Override
    public void onStartup(ServletContext servletContext) throws ServletException {
        //注册servlet
        Dynamic myServlet = servletContext.addServlet("myServlet", MyServlet.class);
       //映射servlet
        myServlet.addMapping("/custom/**");
    }
}

程序清单7. 1是相当基础的Servlet注册初始化器类。它注册了一个 Servlet并将其映射到一个路径上。我们也可以通过这种方式来手动注册DispatcherServlet。 (但这并没有必要，因为AbstractAnnotationConfigDispatcherServletInitiali 没用太多代码就将这项任务完成得很漂亮。)

类似地，我们还可以创建新的WebApplicationInitializer实现来注册Listener和Filter 。例如，如下的程序清单展现了如何注册Filter。

程序清单7.2 注册Filter的WebApplicationInitializer

package com.spring.servlet;

import javax.servlet.*;
import java.io.IOException;

public class MyFilter implements Filter {
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        Filter.super.init(filterConfig);
    }

    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {

    }

    @Override
    public void destroy() {
        Filter.super.destroy();
    }
}

使用WebApplicationInitializer在支持Servlet 3.0的容器中注册Servlet、Filter和Listener。
在AbstractAnnotationConfigDispatcherServletInitializer中，有一种快捷方式可以只注册Filter，并且该Filter只会映射到DispatcherServlet上。

注册Filter并将其映射到DispatcherServlet的方法。

通过重载AbstractAnnotationConfigDispatcherServletInitializer的getServletFilters()方法实现注册Filter的示例代码。

Javaimport org.springframework.web.filter.CharacterEncodingFilter;
import org.springframework.web.servlet.support.AbstractAnnotationConfigDispatcherServletInitializer;

public class MyWebAppInitializer extends AbstractAnnotationConfigDispatcherServletInitializer {

    @Override
    protected Filter[] getServletFilters() {
        CharacterEncodingFilter filter = new CharacterEncodingFilter();
        filter.setEncoding("UTF-8");
        filter.setForceEncoding(true);
        return new Filter[] { filter };
    }

    @Override
    protected Class<?>[] getRootConfigClasses() {
        return new Class[] { RootConfig.class };
    }

    @Override
    protected Class<?>[] getServletConfigClasses() {
        return new Class[] { ServletConfig.class };
    }

    @Override
    protected String[] getServletMappings() {
        return new String[] { "/" };
    }
}

AbstractAnnotationConfigDispatcherServletInitializer中注册Filter并将其映射到DispatcherServlet。您强调了重载getServletFilters()方法，并举例说明了如何注册一个CharacterEncodingFilter。

getServletFilters()方法返回的是一个javax.servlet.Filter的数组。
在这个例子中，只返回了一个Filter，但实际上可以返回任意数量的Filter。
不需要为这些Filter声明映射路径，它们会自动映射到DispatcherServlet上。
在Servlet 3.0容器中注册Servlet、Filter和Listener的多种方式。不创建web.xml文件的替代方案。将应用部署到不支持Servlet 3.0的容器中或使用web.xml文件的情况。通过web.xml配置Spring MVC的传统方式。

7.1.3 在web.xml中声明DispatcherServlet

在典型的Spring MVC应用中，我们会需要DispatcherServlet和 Context-Loader

Listener。

AbstractAnnotationConfigDispatcherServlet 会自动注册它们，但是如果需要在web.xml中注册的话，那就需要我们自己来完成这项任务了。

如下是一个基本的web.xml文件，它按照传统的方式搭建了 DispatcherServlet和ContextLoaderListener。

程序清单7.3 在web.xml中搭建Spring MVC

引言：介绍了在第5章中提到的ContextLoaderListener和DispatcherServlet分别加载Spring应用上下文，并指出上下文参数contextConfigLocation用于指定XML文件的地址。
根应用上下文加载：根据程序清单7.3，根应用上下文从“/WEB-INF/spring/root-context.xml”中加载bean定义。
DispatcherServlet加载应用上下文：介绍了DispatcherServlet会根据Servlet的名字找到一个文件，并基于该文件加载应用上下文。
程序清单7.3中的示例：指出程序清单7.3中的Servlet名字为appServlet，因此DispatcherServlet会从“/WEB-INF/appServlet-context.xml”文件中加载其应用上下文。
指定DispatcherServlet配置文件位置：提到如果希望指定DispatcherServlet配置文件的位置，可以在Servlet上指定一个contextConfigLocation初始化参数。

例如，如下的配置中，DispatcherServlet会从“/WEB-INF/spring/appServlet/servlet-context.xml”加载它的bean：

引言：指出前面讨论的是如何从XML中加载DispatcherServlet和ContextLoaderListener的应用上下文，但本书更倾向于使用基于Java的配置。
使用基于Java的配置：介绍了在Spring MVC中使用基于Java的配置需要告诉DispatcherServlet和ContextLoaderListener使用AnnotationConfigWebApplicationContext，并设置相应的上下文参数和初始化参数。
示例程序清单：提到一个新的web.xml示例，其中展示了使用基于Java的Spring配置的Spring MVC搭建方式

程序清单7.4 设置web.xml使用基于Java的配置

现在我们已经看到了如何以多种不同的方式来搭建Spring MVC，那么接下来我们会看一下如何使用Spring MVC来处理文件上传。

[第二章—Spring MVC的高级技术] 2.1Spring MVC配置的替代方案

7.1.1 自定义DispatcherServlet配置

7.1.2 添加其他的Servlet和Filter

7.1.3 在web.xml中声明DispatcherServlet