上一篇
我想在Tomcat项目里设置一个友好的404提示页面，该怎么配置？
当用户在网站上尝试访问一个不存在的URL时,服务器会返回一个HTTP 404状态码，表示“未找到”，Tomcat服务器默认的404错误页面非常简陋，不仅用户体验不佳，也无法体现网站的专业性和品牌形象，配置一个友好、美观且实用的自定义404页面是Web开发中一个重要的环节，本文将详细介绍在Tomcat中配置404页面的多种方法、最佳实践以及常见问题的解答。
通过 web.xml 文件进行配置
在Java Web应用中，web.xml（部署描述符）是配置应用行为的核心文件，通过它，我们可以精确地定义当特定错误发生时，服务器应该跳转到哪个页面，这是最标准、最推荐的配置方式。
为特定Web应用配置
这种方式仅对当前部署的Web应用生效,具有很好的隔离性，配置文件位于您应用的 WEB-INF/web.xml。
在web.xml文件中，我们需要添加 <error-page> 标签，该标签用于指定错误代码或异常类型与错误页面之间的映射关系。
配置步骤如下：
-
创建自定义404页面：在您的Web应用中创建一个HTML或JSP页面，error404.html，这个页面可以包含您的网站Logo、一段友好的提示信息、一个返回首页的链接以及一个站内搜索框。
-
编辑 web.xml：打开 WEB-INF/web.xml 文件，在其中添加以下配置：
<web-app ...> ... 其他配置 ... <!-- 配置404错误页面 --> <error-page> <error-code>404</error-code> <location>/error404.html</location> </error-page> ... 其他配置 ... </web-app>
代码解析：
- <error-page>：定义一个错误页面的映射。
- <error-code>404</error-code>：指定要处理的HTTP状态码，这里是404。
- <location>/error404.html</location>：指定当发生404错误时，服务器要展示的页面的路径，这个路径是相对于Web应用根目录的，如果您的应用部署在 /myapp，那么服务器实际寻找的资源就是 /myapp/error404.html。
除了按错误码配置,<error-page> 还支持按Java异常类型进行配置，
<error-page> <exception-type>java.lang.NullPointerException</exception-type> <location>/error.jsp</location> </error-page>
下表小编总结了两种配置方式的区别：
| 配置方式 | 子元素 | 描述 | 适用场景 |
|---|---|---|---|
| 按错误码 | <error-code> | 针对特定的HTTP状态码进行配置，如404, 500等。 | 处理客户端请求错误或服务器通用错误。 |
| 按异常类型 | <exception-type> | 针对应用中抛出的特定Java异常进行配置。 | 处理应用程序内部的逻辑错误，提供更详细的错误信息。 |
为Tomcat全局配置
如果您希望Tomcat服务器下部署的所有Web应用都使用同一个404页面,可以直接修改Tomcat的全局配置文件。
配置步骤如下：
-
创建全局404页面：将您的自定义404页面（error404.html）放置到Tomcat的根目录下，即 $CATALINA_BASE/webapps/ROOT/ 目录中。
-
编辑全局 web.xml：打开Tomcat安装目录下的 conf/web.xml 文件，在末尾的 </web-app> 标签前添加如下配置：
<error-page> <error-code>404</error-code> <location>/error404.html</location> </error-page>
注意： 此修改会影响该Tomcat实例上运行的所有Web应用，如果某个应用自身也配置了404页面，那么应用的配置优先级更高，会覆盖全局配置，修改全局 conf/web.xml 后，需要重启Tomcat服务才能生效。
自定义404页面的最佳实践
仅仅配置跳转是不够的,一个优秀的404页面应该具备以下特点：
- 友好的用户体验：避免使用冰冷的“404 Not Found”等技术术语，用更人性化的语言告知用户他们访问的页面不存在，哎呀，您要找的页面好像迷路了”。
- 清晰的导航指引：提供明确的导航选项，帮助用户快速离开错误页面，最重要的就是提供一个返回网站首页的链接，您还可以提供网站地图、热门文章或产品分类的链接。
- 品牌一致性：确保404页面的设计风格（Logo、配色、字体）与您的网站主站保持一致，这能增强用户对品牌的信任感。
- 返回正确的HTTP状态码：这是至关重要的一点，无论您的自定义页面内容多么丰富，服务器在响应浏览器时，其头部信息必须包含 HTTP/1.1 404 Not Found，这样搜索引擎（如Google）才能知道这是一个错误页面，从而不会将其收录为有效内容，避免产生大量重复或无效的索引，使用web.xml配置可以自动处理这一点，无需在JSP或Servlet中手动设置状态码。
- 保持页面轻量：404页面不应加载过多、过大的资源（如高清图片、复杂脚本），确保它能够快速加载，尤其是在网络状况不佳时。
相关问答 (FAQs)
我已经按照要求修改了 web.xml 文件，但为什么自定义的404页面还是没有生效？
解答： 这是一个常见问题，可能的原因有以下几点：
- 路径错误：请仔细检查 <location> 标签中的路径是否正确，它是一个相对于Web应用根目录的路径，请确保文件确实存在于该位置。
- 语法错误：web.xml 是XML文件，对格式要求严格，请检查标签是否闭合，是否有拼写错误，或者是否将配置放在了错误的标签内，一个无效的XML会导致整个Web应用启动失败或配置被忽略。
- 未重启或重新加载：对 web.xml 的修改通常需要重新启动Tomcat服务器，或者在支持热部署的情况下，重新加载（reload）您的Web应用，配置才能生效。
- 缓存问题：浏览器可能缓存了之前的404页面，尝试清除浏览器缓存或使用隐私模式访问不存在的URL进行测试。
- 全局配置覆盖：如果您修改的是应用内的 web.xml，但效果不正确，请检查Tomcat的全局 conf/web.xml 是否有冲突的配置，应用内的配置优先级更高，但确认一下总是好的。
我的自定义404页面可以是动态页面（如JSP或Servlet）吗？
解答： 当然可以。<location> 标签不仅可以指向静态的HTML文件，也可以指向一个动态资源，/error404.jsp 或一个处理错误请求的Servlet路径 /ErrorHandler，这样做的好处是，您可以实现更复杂的功能，在JSP页面中，您可以记录下用户访问的错误URL、Referer（来源页面）、访问时间等信息到日志或数据库中，这对于分析网站问题、发现失效链接非常有帮助，您还可以在Servlet中根据不同的错误类型动态生成不同的错误内容，但请确保，无论处理逻辑多复杂，最终返回给客户端的HTTP状态码依然是404，在Servlet中，您可以通过 response.sendError(HttpServletResponse.SC_NOT_FOUND) 来实现。
