Tomcat配置404错误页面的详细步骤是怎样的？

在Web应用的开发与运维中，用户访问一个不存在的URL时，服务器会返回“404 Not Found”错误，浏览器默认展示的404页面通常简陋且不友好，这会严重影响用户体验，Tomcat作为一款广泛使用的Java Web应用服务器，提供了灵活的配置方式，允许我们为Web应用定制美观、实用的404错误页面，这不仅能提升品牌形象，还能引导用户返回有效页面,减少用户流失。

理解Tomcat的错误处理机制

Tomcat处理错误页面的核心配置文件是web.xml，即Web应用的部署描述符，通过在该文件中添加特定的配置元素，我们可以告诉Tomcat当发生特定错误（如HTTP状态码404）或特定异常时,应该显示哪个自定义页面。

关键的配置元素是<error-page>,它包含两个主要的子元素：

• <error-code>：用于指定HTTP状态码，例如404、500等。
• <location>：用于指定当该错误发生时，服务器要转向的资源路径,这个路径是相对于Web应用根目录的。

本文将重点介绍如何针对404错误进行配置。

为单个Web应用配置404页面（推荐）

这是最常用且最推荐的方法，因为它只影响当前的Web应用,具有很好的隔离性。

第一步：创建自定义404页面

你需要设计并创建一个404错误页面，这个页面可以是一个静态的HTML文件，也可以是一个动态的JSP文件,建议内容应包含：

• 友好的错误提示信息,告知用户页面未找到。
• 与网站整体风格保持一致的设计。
• 提供返回首页、网站地图或搜索框的链接,帮助用户继续浏览。

将此页面（命名为html）放置在你的Web应用的根目录下，假设你的应用名为myapp,那么路径结构可能如下：

myapp/
├── index.html
├── 404.html
└── WEB-INF/
    └── web.xml

第二步：修改WEB-INF/web.xml文件

打开位于myapp/WEB-INF/目录下的web.xml文件，在<web-app>标签内,添加以下配置：

<error-page>
    <error-code>404</error-code>
    <location>/404.html</location>
</error-page>

配置详解：

• <error-page>：声明一个错误页面配置。
• <error-code>404</error-code>：指定此配置对应的HTTP状态码是404。
• <location>/404.html</location>：指定当发生404错误时，跳转到应用根目录（）下的html文件，这里的路径代表的是当前Web应用的根目录,而不是服务器的根目录。

如果你的web.xml文件中已经有<error-page>配置,只需再添加一个新的即可。

第三步：重新部署并测试

保存web.xml文件后，重新启动Tomcat服务器或重新加载你的Web应用，在浏览器中访问一个你确定不存在的URL，http://localhost:8080/myapp/a-non-existent-page.html，如果配置正确，浏览器应该会显示你自定义的html页面,而不是Tomcat默认的错误报告。

全局配置404页面（影响所有Web应用）

在某些情况下，你可能希望Tomcat下部署的所有Web应用都共享同一个404错误页面，这时,可以修改Tomcat的全局配置文件。

警告： 此方法会影响服务器上所有的Web应用，请谨慎操作,Tomcat版本升级可能会覆盖此配置文件。

第一步：将自定义页面放入ROOT应用

将你的自定义404页面（例如global_404.html）放置到Tomcat的ROOT应用目录下。ROOT应用是Tomcat的默认应用，路径为 $CATALINA_BASE/webapps/ROOT/。

第二步：修改全局conf/web.xml文件

打开Tomcat安装目录下的conf/web.xml文件，找到<web-app>标签,在其中添加以下配置：

<error-page>
    <error-code>404</error-code>
    <location>/global_404.html</location>
</error-page>

这里的<location>路径/global_404.html是相对于ROOT应用的。

第三步：重启Tomcat并测试

保存配置后，重启Tomcat服务器，访问任何部署在该Tomcat实例上且不存在于其自身应用中的URL（http://localhost:8080/any-app/non-existent.html）,都会显示这个全局的404页面。

配置方法对比

为了更清晰地理解两种方法的区别,下表进行了小编总结：

相关问答FAQs

问题1：我已经按照教程配置了404页面，但访问不存在的URL时仍然显示Tomcat默认的页面，可能是什么原因？

解答： 这是一个常见问题,可以从以下几个方面排查：

1. web.xml语法错误：检查你添加的<error-page>配置是否符合XML语法，标签是否正确闭合，是否放在了<web-app>根元素内。
2. 路径问题：确认<location>中指定的路径是否正确，对于单个应用配置，路径是相对于应用根目录的，如/404.html,确认你的404页面文件确实存在于该路径下。
3. 缓存问题：浏览器可能缓存了之前的响应，请尝试强制刷新浏览器（Ctrl+F5 或 Cmd+Shift+R）或者使用无痕/隐私模式访问。
4. 未重新部署/重启：修改web.xml后,需要重新部署应用或重启Tomcat服务器才能使配置生效。
5. 配置位置错误：确保你修改的是正确项目下的WEB-INF/web.xml，而不是Tomcat全局的conf/web.xml（除非你本意就是做全局配置）。

问题2：自定义404页面可以使用JSP或Servlet吗？和静态HTML有什么区别？

解答： 当然可以。<location>元素可以指向任何Web资源，包括JSP、Servlet等。

• 静态HTML：优点是简单、快速、服务器资源消耗小，适用于内容固定、无需与服务器交互的简单错误提示页面。
• JSP/Servlet：优点是功能强大、动态化，使用JSP或Servlet，你可以：
  • 记录404错误的发生时间、客户端IP、尝试访问的URL等信息,便于后续分析。
  • 在页面上动态显示用户尝试访问的错误URL,提供更友好的提示。
  • 集成搜索功能,直接在404页面提供站内搜索框。
  • 根据用户的登录状态或来源,展示不同的引导内容。

区别主要在于静态与动态，如果你的404页面仅仅是一个友好的提示和几个固定链接，HTML就足够了，如果你希望实现更复杂的功能，如日志记录、动态内容展示等,那么使用JSP或Servlet会是更好的选择。