Tomcat 在 web.xml 中包含另一个 xml 文件

Posted 2023-02-26

【中文标题】Tomcat 在 web.xml 中包含另一个 xml 文件

【英文标题】：Tomcat include another xml file to web.xml

【发布时间】：2014-11-13 17:28:06

【问题描述】：

大家好，

由于我的 web.xml 中有很多 servlet 映射，我想知道是否可以将所有映射存储到单独的文件中，然后将其包含到 web.xml 中。

servervlet-mapping.xml

<servlet>
    <servlet-name>red</servlet-name>
    <servlet-class>Test.Red</servlet-class>
</servlet>

<servlet-mapping>
    <servlet-name>red</servlet-name>
    <url-pattern>/blue</url-pattern>
</servlet-mapping>

<servlet>
    <servlet-name>blue</servlet-name>
    <servlet-class>Test.Blue</servlet-class>
</servlet>

<servlet-mapping>
    <servlet-name>blue</servlet-name>
    <url-pattern>/blue</url-pattern>
</servlet-mapping>

web.xml

<include file="servlet_mapping.xml"/>

这样可以在struts.xml 中加载xml 文件。 （不确定在 web.xml 中是否可以）

这样的事情可能吗？或者有没有其他方法可以让它工作？

（为我的英语不好道歉）

提前致谢， 亚历克斯

【问题讨论】：

您拥有它们是因为您之前的问题的答案是......也许在技术上是正确的，但不是您问题的最佳解决方案。

【参考方案1】：

编辑：

来自@BalusC 下面的评论：

不要这样做！您基本上使用的是 Tomcat 特定的安全漏洞，该漏洞在较新的 Tomcat 版本中已修复，不一定存在于不同的服务器中。换句话说，带有这样一个 web.xml 的 webapp 是不可移植的。相关问题报告：bugzilla.redhat.com/show_bug.cgi?id=1069911

在这里留下答案，以便阅读此内容的人知道它是错误的。

原答案

您可以尝试以下方法（基于外部 XML 实体的概念）：

web.xml

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE web-app
 PUBLIC "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN"
"http://java.sun.com/dtd/web-app_2_3.dtd" [
 <!ENTITY textreplacements SYSTEM "textreplacements.xml">
]>
<web-app>
<filter>
    <filter-name>TextReplaceFilter</filter-name>
    <filter-class>TextReplaceFilter</filter-class>
    &textreplacements;
</filter>

textreplacements.xml

<init-param>
  <param-name>whatever</param-name>
  <param-value>whenever</param-value>
</init-param>

【讨论】：

不要这样做！您基本上使用的是 Tomcat 特定的安全漏洞，该漏洞在较新的 Tomcat 版本中已修复，不一定存在于不同的服务器中。换句话说，带有这样一个 web.xml 的 webapp 是不可移植的。相关问题报告：bugzilla.redhat.com/show_bug.cgi?id=1069911

【参考方案2】：

Servlet 3.0 引入了 Web 片段的概念，它解决了您关于将 web.xml 拆分为多个文件的问题。这些片段可以通过包含 META-INF/web-fragment.xml 来包含 Web 部署描述符的一部分（或全部）

<web-fragment metadata-complete="true" 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-fragment_3_0.xsd">
  <name>fragment1</name>
    <servlet>
        <servlet-name>red</servlet-name>
        <servlet-class>Test.Red</servlet-class>
    </servlet>

    <servlet-mapping>
        <servlet-name>red</servlet-name>
        <url-pattern>/blue</url-pattern>
    </servlet-mapping>

    <servlet>
        <servlet-name>blue</servlet-name>
        <servlet-class>Test.Blue</servlet-class>
    </servlet>

    <servlet-mapping>
        <servlet-name>blue</servlet-name>
        <url-pattern>/blue</url-pattern>
    </servlet-mapping>
</web-fragment>

在 web.xml 中

...
    <welcome-file-list>
        <welcome-file>index.html</welcome-file>
    </welcome-file-list>
    <servlet>
        <servlet-name>MyWelcomePage</servlet-name>
        <servlet-class>MyWelcomePage</servlet-class>
        <load-on-startup>1</load-on-startup>
    </servlet>
    <servlet-mapping>
        <servlet-name>MyWelcomePage</servlet-name>
        <url-pattern>/MyWelcomePage/*</url-pattern>
    </servlet-mapping>    
    <session-config>
        <session-timeout>30</session-timeout>
    </session-config>

    <absolute-ordering>
         <name>fragment1</name>
    </absolute-ordering>
</web-app>

【参考方案3】：

如果您的 servlet 版本低于 3.0，则不能。

如果您使用的是 3.0，则有一个 possibility

在 JSR 315：Java Servlet 3.0 规范中，引入了 web-fragment.xml 以实现 WEB-INF/lib 下打包的库 jar 的可插入性。 web.xml 和 web-fragment.xml 的内容几乎相同。可以在那里定义 servlet、过滤器和侦听器。还可以在给定的 web-fragment.xml 中指定 metadata-complete=true。在后一种情况下，将跳过该 jar 中类的注释处理。借助 web-fragment.xml，库 jar 可以自包含并提供与 Web 相关的元数据信息。

但是有两个XML 可能会让你感到困惑。试试这个吧。