在之前的《使用jsp作为视图模板&常规部署》章节有过一个实践,需要启动类继承自SpringBootServletInitializer方可正常部署至常规tomcat下,其主要能够起到web.xml的作用。下面通过源码简单解析为何其能够替代web.xml。

本章概要
1、源码分析如何实现SpringBootServletInitializer整个加载过程;
2、实现自定义WebApplicationInitializer配置加载;
3、实现自定义ServletContainerInitializer 配置加载;

示例代码如下
1、首先web.xml主要配置各种servlet,filter,listener等,如常见的Log4jConfigListener、OpenSessionInViewFilter、CharacterEncodingFilter、DispatcherServlet等,此部分信息均是容器启动时加载。
2、在springboot中我们从SpringBootServletInitializer源码入手:

  1. public abstract class SpringBootServletInitializer implements WebApplicationInitializer{
  2. ..................
  3. public void onStartup(ServletContext servletContext) throws ServletException {
  4. this.logger = LogFactory.getLog(super.getClass());
  5. WebApplicationContext rootAppContext = createRootApplicationContext(servletContext);
  6. if (rootAppContext != null) {
  7. servletContext.addListener(new ContextLoaderListener(rootAppContext) {
  8. public void contextInitialized(ServletContextEvent event) {
  9. }
  10. });
  11. } else
  12. this.logger.debug(
  13. "No ContextLoaderListener registered, as createRootApplicationContext() did not return an application context");
  14. }
  15. ....................
  16. }

可以先关注此类实现了WebApplicationInitializer,那么实现了此接口又如何呢?

3、下面继续关注一个spring源码:

  1. <code class="language-java"><span style="font-size:14px;">@HandlesTypes({ WebApplicationInitializer.class })
  2. public class SpringServletContainerInitializer implements <span style="background-color:rgb(255,255,255);">ServletContainerInitializer </span>{
  3. public void onStartup(Set<Class<?>> webAppInitializerClasses, ServletContext servletContext)
  4. throws ServletException {
  5. List initializers = new LinkedList();
  6. if (webAppInitializerClasses != null) {
  7. for (Class waiClass : webAppInitializerClasses) {
  8. if ((!(waiClass.isInterface())) && (!(Modifier.isAbstract(waiClass.getModifiers())))
  9. && (WebApplicationInitializer.class.isAssignableFrom(waiClass))) {
  10. try {
  11. initializers.add((WebApplicationInitializer) waiClass.newInstance());
  12. } catch (Throwable ex) {
  13. throw new ServletException("Failed to instantiate WebApplicationInitializer class", ex);
  14. }
  15. }
  16. }
  17. }
  18. if (initializers.isEmpty()) {
  19. servletContext.log("No Spring WebApplicationInitializer types detected on classpath");
  20. return;
  21. }
  22. servletContext.log(initializers.size() + " Spring WebApplicationInitializers detected on classpath");
  23. AnnotationAwareOrderComparator.sort(initializers);
  24. for (WebApplicationInitializer initializer : initializers)
  25. initializer.onStartup(servletContext);
  26. }
  27. }</span></code>

  1. @HandlesTypes({ WebApplicationInitializer.class })
  2. public class SpringServletContainerInitializer implements ServletContainerInitializer {
  3. public void onStartup(Set<Class<?>> webAppInitializerClasses, ServletContext servletContext)
  4. throws ServletException {
  5. List initializers = new LinkedList();
  6. if (webAppInitializerClasses != null) {
  7. for (Class waiClass : webAppInitializerClasses) {
  8. if ((!(waiClass.isInterface())) && (!(Modifier.isAbstract(waiClass.getModifiers())))
  9. && (WebApplicationInitializer.class.isAssignableFrom(waiClass))) {
  10. try {
  11. initializers.add((WebApplicationInitializer) waiClass.newInstance());
  12. } catch (Throwable ex) {
  13. throw new ServletException("Failed to instantiate WebApplicationInitializer class", ex);
  14. }
  15. }
  16. }
  17. }
  18. if (initializers.isEmpty()) {
  19. servletContext.log("No Spring WebApplicationInitializer types detected on classpath");
  20. return;
  21. }
  22. servletContext.log(initializers.size() + " Spring WebApplicationInitializers detected on classpath");
  23. AnnotationAwareOrderComparator.sort(initializers);
  24. for (WebApplicationInitializer initializer : initializers)
  25. initializer.onStartup(servletContext);
  26. }
  27. }

4、继续关注3中红色标示部分,此时我们先来看ServletContainerInitializer的作用,其主要就是在启动容器时负责加载相关配置:
 public abstract interface ServletContainerInitializer {
public abstract void onStartup(Set<Class<?>> paramSet, ServletContext paramServletContext) throws ServletException;
}
容器启动时会自动扫描当前服务中ServletContainerInitializer的实现类,并调用其onStartup方法,其参数Set<Class<?>> c,可通过在实现类上声明注解javax.servlet.annotation.HandlesTypes(WebApplicationInitializer.class)注解自动注入,@HandlesTypes会自动扫描项目中所有的WebApplicationInitializer.class的实现类,并将其全部注入Set。

5、通过4中的说明可以很清楚的理解其服务启动容器加载过程配置的装载过程,在SpringServletContainerInitializer中可以发现所有WebApplicationInitializer实现类在执行onStartup方法前需要根据其注解@order值排序,下面自定义一个WebApplicationInitializer实现类:

  1. package com.shf.springboot.config;
  2. import javax.servlet.ServletContext;
  3. import javax.servlet.ServletException;
  4. import org.slf4j.Logger;
  5. import org.slf4j.LoggerFactory;
  6. import org.springframework.core.annotation.Order;
  7. import org.springframework.web.WebApplicationInitializer;
  8. import com.shf.springboot.runner.MyStartupRunner1;
  9. @Order(1)
  10. public class MyWebApplicationInitializer implements WebApplicationInitializer {
  11. private Logger logger=LoggerFactory.getLogger(MyStartupRunner1.class);
  12. @Override
  13. public void onStartup(ServletContext paramServletContext) throws ServletException {
  14. logger.info("启动加载自定义的MyWebApplicationInitializer");
  15. System.out.println("启动加载自定义的MyWebApplicationInitializer");
  16. }
  17. }
打成WAR包部署至常规tomcat下启动服务验证:


注:之前有专门讲解如何装载servlet、filter、listener的注解,且可以通过两种不同的方式。那么第三种方式可以通过WebApplicationInitializer的实现类来进行装载配置。但此方式仅限部署至常规容器下生效,采用jar方式应用内置容器启动服务不加载

6、既然可以通过自定义的WebApplicationInitializer来实现常规容器启动加载,那么我们是否可以直接自定义ServletContainerInitializer来实现启动加载配置呢:
6.1、首先编写一个待注册的servlet:

  1. package com.shf.springboot.servlet;
  2. import java.io.IOException;
  3. import javax.servlet.ServletContext;
  4. import javax.servlet.ServletException;
  5. import javax.servlet.annotation.WebServlet;
  6. import javax.servlet.http.HttpServlet;
  7. import javax.servlet.http.HttpServletRequest;
  8. import javax.servlet.http.HttpServletResponse;
  9. import org.springframework.boot.web.servlet.ServletContextInitializer;
  10. public class Servlet4 extends HttpServlet {
  11. private static final long serialVersionUID = -4186518845701003231L;
  12. @Override
  13. protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
  14. System.out.println("Servlet4");
  15. resp.setContentType("text/html");
  16. resp.getWriter().write("Servlet4");
  17. }
  18. @Override
  19. public void init() throws ServletException {
  20. super.init();
  21. System.out.println("Servlet4 loadOnStart");
  22. }
  23. }
6.2、编写实现ServletContainerInitializer的自定义实现类:

  1. package com.shf.springboot.config;
  2. import java.util.Set;
  3. import javax.servlet.ServletContainerInitializer;
  4. import javax.servlet.ServletContext;
  5. import javax.servlet.ServletException;
  6. import javax.servlet.ServletRegistration;
  7. import org.slf4j.Logger;
  8. import org.slf4j.LoggerFactory;
  9. public class MyServletContainerInitializer implements ServletContainerInitializer {
  10. private Logger logger=LoggerFactory.getLogger(MyServletContainerInitializer.class);
  11. @Override
  12. public void onStartup(Set<Class<?>> set, ServletContext servletContext) throws ServletException {
  13. logger.info("启动加载自定义的MyServletContainerInitializer");
  14. System.out.println("启动加载自定义的MyServletContainerInitializer");
  15. ServletRegistration.Dynamic testServlet=servletContext.addServlet("servlet4","com.shf.springboot.servlet.Servlet4");
  16. testServlet.setLoadOnStartup(1);
  17. testServlet.addMapping("/servlet4");
  18. }
  19. }

6.3、对新增的servlet设置其请求路径,同时打成WAR包部署至tomcat启动服务,但请求http://localhost:8080/SpringBoot1/servlet4却失败,此时发现需要了解servlet3对于ServletContainerInitializer
的加载机制是如何的,在官方有类似这样的描述“该接口的实现必须声明一个JAR资源放到程序中的META-INF/services下,并且记有该接口实现类的全路径,才会被运行时(server)的查找机制或是其它特定机制找到”。那么我们先参考spring-web-4.3.2.RELEASE.jar中


我们可以将自定义的类配置到一个jar包下部署至WEB-INF\lib目录下,
6.3.1、首先新建如下目录结构的文件并填写内容如下:

6.3.2、然后通过如下命令生成jar包

6.3.3、将myTest.jar放置WEB-INF\lib目录下重启服务,再次请求:


注:与5中实现WebApplicationInitializer一样,该方式仅限于部署常规容器生效。故jar通过内置容器启动的服务无法加载servlet4配置。

常规容器下SpringBootServletInitializer如何实现web.xml作用解析的更多相关文章

  1. 转 web项目中的web.xml元素解析

    转 web项目中的web.xml元素解析 发表于1年前(2014-11-26 15:45)   阅读(497) | 评论(0) 16人收藏此文章, 我要收藏 赞0 上海源创会5月15日与你相约[玫瑰里 ...

  2. javaweb项目中关于配置文件web.xml的解析

    一..启动tomcat,加载项目中的web.xml文件,创建servercontext上下文对象. 可以通过servercontext对象在应用中获取web.xml文件中的值. web应用加载的顺序与 ...

  3. 使用Eclipse创建Web项目时WEB-INF下找不到web.xml问题详解

    版权声明:本文为博主原创文章,遵循CC 4.0 BY-SA版权协议,转载请附上原文出处链接和本声明. 本文链接:https://blog.csdn.net/yjrguxing/article/deta ...

  4. ssm web.xml配置解析

    以下为web.xml的配置<?xml version="1.0" encoding="UTF-8"?><web-app xmlns:xsi=& ...

  5. ssm web.xml文件解析

    转   以下为web.xml的配置<?xml version="1.0" encoding="UTF-8"?><web-app xmlns:x ...

  6. javaweb学习总结十七(web应用组织结构、web.xml作用以及配置虚拟主机搭建网站)

    一:web应用组织结构 1:web应用组成结构 2:安装web组成机构手动创建一个web应用程序目录 a:在webapps下创建目录web b:在web目录下创建html.jsp.css.js.WEB ...

  7. struts2中struts.xml和web.xml文件解析及工作原理

    web.xml <?xml version="1.0" encoding="UTF-8"?> <web-app id="WebApp ...

  8. JSF技术web.xml配置解析

    对Java tutorial-examples中jsf hell1的web.xml配置文件的解析 <?xml version="1.0" encoding="UTF ...

  9. hello1 web项目中web.xml作用分析

    该web.xml文件包含Facelets应用程序所需的几个元素.使用NetBeans IDE创建应用程序时,将自动创建以下所有内容. 指定项目阶段的上下文参数: <context-param&g ...

随机推荐

  1. 调色板原理 & 编程

    调色板原理 & 编程 逻辑调色板结构LOGPALETTE,该结构定义如下: typedef struct tagLOGPALETTE { WORD palVersion; //调色板的板本号, ...

  2. 快速创建SSH信任实现无密码登录

    1. 生成本机的公私钥匙对[oracle@Oracle11_2 scripts]$ -t rsa Generating public/private rsa key pair. Enter file ...

  3. 微服务实战(四):服务发现的可行方案以及实践案例 - DockOne.io

    原文:微服务实战(四):服务发现的可行方案以及实践案例 - DockOne.io 这是关于使用微服务架构创建应用系列的第四篇文章.第一篇介绍了微服务架构的模式,讨论了使用微服务架构的优缺点.第二和第三 ...

  4. NSNotificationCenter消息通信(KVO)

    NSNotificationCenter是程序不同类间的消息通信. 注册消息通知: [[NSNotificationCenter defaultCenter]addObserver:self sele ...

  5. libjpeg用法

    libjpeg是一个完全用C语言编写的库,包含了被广泛使用的JPEG解码.JPEG编码和其他的JPEG功能的实现.这个库由独立JPEG工作组维护.最新版本号是6b,于1998年发布.可以参考维基百科关 ...

  6. [PReact] Integrate Redux with Preact

    Redux is one of the most popular state-management libraries and although not specific to React, it i ...

  7. jQuery常用方法(持续更新)(转)

    0.常用代码: 请容许我在1之前插入一个0,我觉得我有必要把最常用的代码放在第一位,毕竟大部分时间大家都是找代码的. (1)AJAX请求 $(function() { $('#send').click ...

  8. 使用JQuery将前端form表单数据转换为JSON字符串传递到后台处理

    一般地,我们在处理表单(form表单哦)数据时,传输对象或字符串到后台,Spring MVC或SpringBoot的Controller接收时使用一个对象作为参数就可以被正常接收并封装到对象中.这种方 ...

  9. form表单嵌套,用标签的form属性来解决表单嵌套的问题

    <!DOCTYPE html> <html> <head> <meta charset="utf-8"> <title> ...

  10. NET WinForm 开发所见即所得的 IDE 开发环境

    Github 开源:使用 .NET WinForm 开发所见即所得的 IDE 开发环境(Sheng.Winform.IDE)[2.源代码简要说明]   GitHub:https://github.co ...