SpringMVC注解驱动开发

前言

此文章是对SpringMVC注解开发的demo配置以及通过Debug对启动流程做一个大概的分析。

介绍

通过SpringMVC注解驱动开发，我们就无需使用web.xml、springmvc配置文件对spring mvc进行配置。
SpringMVC注解驱动开发是基于Servlet3.0新特性的基础上实现的，准确来说是基于servlet3.0的ServletContainerInitializer接口实现的。

接口和类介绍：

public interface ServletContainerInitializer {//servlet3.0的新接口，tomcat会在启动时调用该接口的实现类方法。public void onStartup(Set<Class<?>> c, ServletContext ctx)throws ServletException;
}

//ServletContainerInitializer 接口的实现类，在spring的web包下，如果是基于springmvc注解驱开发，
//tomcat容器会在启动时加载工程时调用该类的onStartup方法。//真正处理springmvc启动的接口用该注解HandlesTypes定义。
@HandlesTypes(WebApplicationInitializer.class)
public class SpringServletContainerInitializer implements ServletContainerInitializer {/**** @param webAppInitializerClasses  该参数就是真正进行初始化的实现类对象集合，就是上面HandlesTypes注解的value值*                                  WebApplicationInitializer接口的所有实现类对象集合。* @param servletContext   servlet上下文* @throws ServletException*/@Overridepublic void onStartup(@Nullable Set<Class<?>> webAppInitializerClasses, ServletContext servletContext)throws ServletException {//定义初始化对象的集合List<WebApplicationInitializer> initializers = new LinkedList<>();if (webAppInitializerClasses != null) {//遍历webAppInitializerClassesfor (Class<?> waiClass : webAppInitializerClasses) {//这里做出一些判断、防止一些servlet容器为我们提供无效的处理类// 首先该类不能是接口，并且不能是抽象类，且必须是WebApplicationInitializer接口的实现类if (!waiClass.isInterface() && !Modifier.isAbstract(waiClass.getModifiers()) &&WebApplicationInitializer.class.isAssignableFrom(waiClass)) {try {//符合上面判断进入这里。//为符合规则的处理类（WebApplicationInitializer实现类）创建对象并添加到集合List中initializers.add((WebApplicationInitializer)ReflectionUtils.accessibleConstructor(waiClass).newInstance());}catch (Throwable ex) {throw new ServletException("Failed to instantiate WebApplicationInitializer class", ex);}}}}//如果集合为空，也就是没有处理对象。直接返回。if (initializers.isEmpty()) {servletContext.log("No Spring WebApplicationInitializer types detected on classpath");return;}servletContext.log(initializers.size() + " Spring WebApplicationInitializers detected on classpath");//排序AnnotationAwareOrderComparator.sort(initializers);for (WebApplicationInitializer initializer : initializers) {//遍历处理对象，执行处理方法onStartupinitializer.onStartup(servletContext);}}}

在spring-web包的META-INF.services下有一个javax.servlet.ServletContainerInitializer文件，文件的内容是org.springframework.web.SpringServletContainerInitializer ，这个是使用SPI机制创建的SpringServletContainerInitializer 对象。SPI机制详情查看相关文章。

//该接口是springmvc初始化的处理的顶级接口。
//类结构如下图
public interface WebApplicationInitializer {void onStartup(ServletContext servletContext ) throws ServletException;
}

spring为该接口的提供的都是抽象类，所以我们要使用注解驱动的springmvc，就要实现自己的实现类。我们可以通过继承AbstractDispatcherServletInitializer或者AbstractAnnotationConfigDispatcherServletInitializer抽象类实现自己的启动类。

这里就通过继承AbstractDispatcherServletInitializer实现吧。

所以要配置一个注解驱动的springmvc项目环境，基本有以下几步：
第一步：引入相关Jar包。
第二步：编写spring配置类，用于配置spring IOC父容器。
第三步：编写springmvc配置类，用于配置spring mvc子容器。
第四步：编写AbstractDispatcherServletInitializer实现类，完成对springmvc的初始化。

springmvc注解驱动环境搭建

第一步：引入jar包

 <dependency><groupId>org.springframework</groupId><artifactId>spring-webmvc</artifactId><version>5.1.9.RELEASE</version></dependency><dependency><groupId>org.springframework</groupId><artifactId>spring-context</artifactId><version>5.1.9.RELEASE</version></dependency><dependency><groupId>org.springframework</groupId><artifactId>spring-context-support</artifactId><version>5.1.9.RELEASE</version></dependency><!--必须3.0以上版本--><dependency><groupId>javax.servlet</groupId><artifactId>javax.servlet-api</artifactId><version>3.1.0</version><scope>provided</scope></dependency><dependency><groupId>javax.servlet.jsp</groupId><artifactId>javax.servlet.jsp-api</artifactId><version>2.3.1</version><scope>provided</scope></dependency>

第二步：编写spring配置文件和springmvc配置文件


/*** @author YeHaocong* @decription spring配置文件 用于创建IOC父容器*/@Configuration
//扫描com.spring.springmvcdemo包及其子包，但是排除Controller注解，这是为了实现父子容器，表现层的Bean保存在子容器WEB IOC容器
//其他Bean保存在父容器中，子容器可以访问父容器的bean，父容器不能访问子容器的bean。
@ComponentScan(basePackages = "com.spring.springmvcdemo",excludeFilters = {@ComponentScan.Filter(type = FilterType.ANNOTATION,value = {Controller.class})})
public class SpringConfig {}/*** @author YeHaocong* @decription springMVC配置文件，用于配置Bean到子容器中。*/@Configuration
//扫描web包及其子包
@ComponentScan(basePackages = "com.spring.springmvcdemo.web")
public class SpringMVCConfig {//配置一个视图解析器到springmvc子容器中。@Beanpublic ViewResolver viewResolver(){InternalResourceViewResolver viewResolver = new InternalResourceViewResolver();viewResolver.setPrefix("/WEB-INF/pages/");viewResolver.setSuffix(".jsp");return viewResolver;}
}

第三步：编写springmvc初始化类

这里选择继承AbstractDispatcherServletInitializer。

public abstract class AbstractDispatcherServletInitializer extends AbstractContextLoaderInitializer {/*** DispatcherServlet   servlet名称*/public static final String DEFAULT_SERVLET_NAME = "dispatcher";//初始化方法@Overridepublic void onStartup(ServletContext servletContext) throws ServletException {//先调用父类的onStartup方法super.onStartup(servletContext);//该类的onStartup方法主要是注册一个DispatcherServlet到servletContext中，用于完成对请求的分发。registerDispatcherServlet(servletContext);}/*** 注册一个DispatcherServlet*/protected void registerDispatcherServlet(ServletContext servletContext) {//获取servlet名称 dispatcherString servletName = getServletName();Assert.hasLength(servletName, "getServletName() must not return empty or null");WebApplicationContext servletAppContext = createServletApplicationContext();Assert.notNull(servletAppContext,"createServletApplicationContext() did not return an application " +"context for servlet [" + servletName + "]");//创建一个dispatcherServletFrameworkServlet dispatcherServlet = createDispatcherServlet(servletAppContext);dispatcherServlet.setContextInitializers(getServletApplicationContextInitializers());//注册到servletContext上下文中ServletRegistration.Dynamic registration = servletContext.addServlet(servletName, dispatcherServlet);Assert.notNull(registration,"Failed to register servlet with name '" + servletName + "'." +"Check if there is another servlet registered under the same name.");registration.setLoadOnStartup(1);//添加mapping 前缀，就是类似项目名称，端口号localhost:8080/前缀/真正的requestmappingregistration.addMapping(getServletMappings());//设置是否支持异步registration.setAsyncSupported(isAsyncSupported());//获取过滤器Filter[] filters = getServletFilters();if (!ObjectUtils.isEmpty(filters)) {for (Filter filter : filters) {//把过滤器注册到servletContext上下文中registerServletFilter(servletContext, filter);}}//自定义注册customizeRegistration(registration);}/*** */protected String getServletName() {return DEFAULT_SERVLET_NAME;}/*** 创建一个web容器*/protected abstract WebApplicationContext createServletApplicationContext();/****/protected FrameworkServlet createDispatcherServlet(WebApplicationContext servletAppContext) {return new DispatcherServlet(servletAppContext);}/*** */@Nullableprotected ApplicationContextInitializer<?>[] getServletApplicationContextInitializers() {return null;}/*** */protected abstract String[] getServletMappings();/*** 获取过滤器，返回空，如果要在springmvc启动时注册过滤器可以覆盖该方法*/@Nullableprotected Filter[] getServletFilters() {return null;}/*** 注册过滤器到servletContext上下文中*/protected FilterRegistration.Dynamic registerServletFilter(ServletContext servletContext, Filter filter) {String filterName = Conventions.getVariableName(filter);Dynamic registration = servletContext.addFilter(filterName, filter);if (registration == null) {int counter = -1;while (counter == -1 || registration == null) {counter++;registration = servletContext.addFilter(filterName + "#" + counter, filter);Assert.isTrue(counter < 100,"Failed to register filter '" + filter + "'." +"Could the same Filter instance have been registered already?");}}registration.setAsyncSupported(isAsyncSupported());registration.addMappingForServletNames(getDispatcherTypes(), false, getServletName());return registration;}private EnumSet<DispatcherType> getDispatcherTypes() {return (isAsyncSupported() ?EnumSet.of(DispatcherType.REQUEST, DispatcherType.FORWARD, DispatcherType.INCLUDE, DispatcherType.ASYNC) :EnumSet.of(DispatcherType.REQUEST, DispatcherType.FORWARD, DispatcherType.INCLUDE));}/*** */protected boolean isAsyncSupported() {return true;}/*** */protected void customizeRegistration(ServletRegistration.Dynamic registration) {}}

我的实现类：

public class WebAnnotationInitializer extends AbstractDispatcherServletInitializer {//创建一个Springmvc子容器。@Overrideprotected WebApplicationContext createServletApplicationContext() {//创建容器对象AnnotationConfigWebApplicationContext servletContext = new AnnotationConfigWebApplicationContext();//使用SpringMVCConfig配置类对容器进行初始化。servletContext.register(SpringMVCConfig.class);//返回return servletContext;}//设置项目访问url的前缀，比如如下设置，访问hello接口就要 http://localhost:8080/springmvc/hello//如果不想用前缀，就使用   “/”就好。@Overrideprotected String[] getServletMappings() {return new String[]{"/springmvc/*"};}//创建spring IOC的父容器/根容器  @Overrideprotected WebApplicationContext createRootApplicationContext() {//创建AnnotationConfigWebApplicationContext rootContext = new AnnotationConfigWebApplicationContext();//传入SpringConfig配置类对容器进行初始化rootContext.register(SpringConfig.class);//返回return rootContext;}/*** 在springmvc初始化时添加一些过滤器* @return*/@Overrideprotected Filter[] getServletFilters() {//添加一个编码过滤器CharacterEncodingFilter filter = new CharacterEncodingFilter();filter.setEncoding("UTF-8");return new Filter[]{filter};}
}

最后一步：编写controller类用于测试：

/*** @author YeHaocong* @decription controller*/@Controller
public class SpringMVCDemoController {@RequestMapping("/hello")public String springMVCDemo(){System.out.println("进入此方法");//返回视图return "springmvc";}
}

jsp所在位置

添加web容器，我这里是tomcat8.5。

启动tomcat。运行结果如下：

该项目的详细启动流程如下：

tomcat启动时调用从SpringServletContainerInitializer的onStartup方法。找到我们自定义的初始化类。

从上图可以看出是使用了我们的自定义初始化类WebAnnotationInitializer 。
为我们的初始化类创建对象，并且调用它的onStartup()方法。
由于我们没有复写父类AbstractDispatcherServletInitializer 的onStartup方法，所以实际上是调用AbstractDispatcherServletInitializer 的onStartup方法。
AbstractDispatcherServletInitializer 的onStartup方法首先调用了它的父类AbstractContextLoaderInitializer的onStartup方法。

该方法主要是注册一个上下文的监听器和创建IOC父容器。
创建IOC父容器。

因为我们的自定义初始化类中复写了该方法，所以实际调用的是我们的自定义初始化类的方法。
调用完父类的onStartup方法，就返回到AbstractDispatcherServletInitializer的onStartup方法。

注册一个DispatcherServlet到servlet上下文中。

注册springmvc子容器，因为我们的自定义初始化类中复写了该方法，所以实际调用的是我们的自定义初始化类的方法。

创建DispatcherServlet并注册到servletContext中。
添加Mapping的前缀。

因为我们的自定义初始化类中复写了该方法，所以实际调用的是我们的自定义初始化类的方法。
获取Filter并添加到servletContext中

因为我们的自定义初始化类中复写了该方法，所以实际调用的是我们的自定义初始化类的方法。
执行一些自定义的注册，由于我们demo没有复写该具体方法，所以不做任何事。

至此，基本初始化完毕，可以接收请求了。