框架(比如Spring)如何在没有web.xml的情况下配置Servlet容器？

Question

< sub >(我已经知道了答案，但是因为我经常发现自己在重新寻找答案，所以我把它贴在这里作为自己和他人的文档。这是Stackoverflow上鼓励的。)

许多 Servlet 开发人员都读过《Head First Serlet》一书

在Servlet 2.4及更低版本中，web.xml用于完全配置Web应用程序。但是更高版本似乎有其他方法来配置Web应用程序，无需触及web.xml和注释。例如，以. jar文件提供的Web框架能够以某种方式连接到Servlet容器并添加url映射。

这个机制是如何工作的？

Answer 1

在Servlet 2.4（2003年11月）中，Servlet容器（如Tomcat和Jetty）通过查找文件＜code＞web-INF/web来简单地启动web应用程序。xml（部署描述符）。文件网络。xml包含对servlet、过滤器和侦听器的引用，以及它们相关的url模式和参数。使用web。servlet容器确切地知道在哪里查找所有内容以及如何配置它们。

自Servlet3.0（2009年12月）以来，web。xml是可选的，您也可以使用注释或编程配置。

注释使用起来更简单。它们位于javax.servlet中。注释包，并允许您使用@WebServlet注释servlet，使用@WebFilter注释筛选器，使用@WebListener注释侦听器。servler容器将自动查找并检测这些类。然而，注释提供的配置功能比web少。xml和编程配置。

本文进一步关注如何配置编程配置以及如何启动Spring MVC。它比注释稍微复杂一些，但确实让你和框架设计人员更好地控制了引导过程。

如果您想在Servlet版本3.0之前使用web框架，则必须在web中添加Servlet或过滤器。xml并从那里配置框架。初始化之后，您可以开始编写web框架已知的类（通常是非Servlet类），以创建web应用程序。

从Servlet 3.0开始，系统是模块化的。这允许框架和库设计人员初始化servlet容器，而无需您通过web.xml.配置框架。您可以立即开始编写Web框架特定的类来创建Web应用程序，而无需触及Servlet类。（在Servlet 3.0中也可以创建自己的web.xml，并且仍然让框架来初始化框架，而无需在web.xml.中定义）

启动时，Servlet容器首先查找位于< code>WEB-INF/web.xml的部署描述符。如果这个文件的< code>metadata-complete属性设置为false，或者根本没有定义，那么容器也会搜索带注释的类，比如@WebServlet。

除了查找 web.xml和带注释的类之外，从 Servlet 3.0 开始，容器还将在位于 WEB-INF/lib 目录中的.jar文件中查找 META-INF/web-fragment.xml 文件。

文件web-fragment.xml是一个web片段，它是（引用自JavaServlet规范）

web应用程序的逻辑分区，使得web应用程序中使用的框架可以定义所有工件，而无需要求开发人员在web.xml中编辑或添加信息。它可以包含几乎所有与web相同的元素。使用的xml描述符。但是，描述符的顶级元素必须是web片段，相应的描述符文件必须称为web-fragment.xml。web片段之间的排序相关元素也不同。xml和web.xml

web-fragment.xml的内容类似于web.xml，但使用了< code>web-fragment根元素，而不是< code>web-app元素:

<web-fragment 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 
              https://java.sun.com/xml/ns/javaee/web-fragment_3_0.xsd"
              version="3.0">
  <filter>
    <filter-name>FrameworkFilter</filter-name>
    <filter-class>framework.FrameworkFilter</filter-class>
  </filter>

  <filter-mapping>
    <filter-name>FrameworkFilter</filter-name>
    <url-pattern>/*</url-pattern>
  </filter-mapping>
</web-fragment>

可以使用配置单个web.xml和多个web-fragment.xml文件加载的确切顺序

除了Web片段之外，还有一种编程方法来对Web应用程序进行分区：通过编写javax.servlet.ServletContainerInitializer接口的实现。ServletContainerInitializer 允许访问 ServletContext，其中包含以编程方式添加 Servlet、过滤器和侦听器的方法。要使用 ServletContainerInitializer，必须在位于 META-INF/services/javax.servlet.ServletContainerInitializer 中的文件中指定它。此文件的内容必须是实现类的完全限定路径。

尽管Spring MVC确实包含一个web-fragment.xml，但它没有定义任何servlet、过滤器或侦听器。Spring使用META-INF/services/javax.servlet.ServletContainerInitializer文件来引用它自己的ServletContainerLaunalizer实现类，它就是类SpringServletContainerLaunalizer。

SpringServletContainerInitializer是一个ServletContrainerInitializer，因此它在启动时接收ServletContext。SpringServletContainerInitializer的目标是将servletContext传递给开发人员更友好的＜code＞WebApplicationInitializer，以便您可以添加Servlet，例如Springs＜code＜DispatcherServlet，它是一个前端控制器，将传入请求引导到其他控制器。（有关如何将DispatcherServlet配置到spring，请参阅spring框架参考。）

Spring MVC没有提供WebApplication ationLaunalizer的具体实现，只有一些抽象类，这样您就可以控制引导过程。在Spring Boot的情况下，提供了一个具体的实现：SpringApplication ationWebApplication ationLaunalizer以减少样板代码的数量。

有关Servlet容器引导过程的详细描述可以在官方的JavaServlet规范中找到。有关Spring MVC的更多信息可以在Spring Framework参考中找到。