Tomcat 的 ErrorPage 实现原理分析

 

使用Tomcat,一定见到过404,500的时候,见到过Tomcat提供的错误页面,例如请求的资源找不到的时候,响应状态码为404,这个时候的错误页面是这样的:

这些错误页面是 如何生成及定位展示的 ,如果我们要 自定义一些错误页面 ,又要怎么做呢?今天我们一起来看看,Tomcat中提供的ErrorPage处理。

我们以Manager应用为例,来了解整个流程。

  1. 首先,Manager应用的web.xml中,包含如下关于ErrorPage的配置:

这些配置,在应用部署,解析web.xml文件的时候,都会生成ErrorPage对应,设置到对应Context应用的属性中。

for (ErrorPage errorPage : webxml.getErrorPages().values() ) {

context. addErrorPage (errorPage);

}

(web.xml文件解析及应用部署,可以参考前面的文章《 WEB应用是怎样部署的?》)

下面的代码,就是StandardContext添加ErrorPage的内容。我们看到,按照对应配置的状态码,每个对应一个errorPage对象,保存到Map中。

上面是context设置errorPage。在应用请求处理时,如果对应的资源不存在,或者产生异常时,此时就需要根据配置的errorPage,进行对应的展示。

例如下面的代码,是在对应用的资源树上查找,如果不存在就会直接以 SC_NOT_FOUND 响应。

sendError的作用,是进行一个error标识的设置,便于后面对于该状态的使用。在其内部主要进行errorState和状态码的设置。

public boolean setError() {

boolean result = errorState .compareAndSet(0, 1 );

if (result) {

Wrapper wrapper = getRequest().getWrapper();

if (wrapper != null) {

wrapper.incrementErrorCount();

}

}

return result;

}

我们前面介绍过,整个请求处理流程中,会在Pipeline中包含一系列的Valve。在资源找不到或者异常产生时,Valve的后处理逻辑中, 在StandardHostValve中,后处理的代码有如下的逻辑

// Look for (and render if found) an application level error page

if (response. isErrorReportRequired ()) {

if (t != null) {

throwable(request, response, t);

} else {

status (request, response);

}

}

这里的response.isErrorReportRequired获取的就是上面对于error标识的设置。在这里,如果有异常产生会打印异常,如果是其它的状态标识,会走status处理。

status方法中,最主要的逻辑,就是根据状态码,获取对应配置的错误页面。

int statusCode = response.getStatus();

ErrorPage errorPage = context.findErrorPage(statusCode);

if (errorPage == null) {

// Look for a default error page

errorPage = context.findErrorPage(0);

}

status的代码,在获取对应的errorPage之后,会进行一个custom的操作,定向到对应的错误页面。代码如下:

从上面的代码中,我们看到定向的方式,使用的是RequestDispatcher. forward

ServletContext servletContext =

request.getContext().getServletContext();

RequestDispatcher rd =

servletContext.getRequestDispatcher( errorPage.getLocation() );

rd.forward(request.getRequest(), response.getResponse());

上面就是整个自定义errorPage的处理流程,概括起来,就是根据指定的错误页面位置,再在对应的状态码match的时候,进行forward的处理。(重定向和转发,可以参见前面的文章《关于重定向和转发》)所以此处,我们可以进行一个个性化的404或者500的页面处理。

当然,ErrorPage的配置中,可以声明一个exceptionType,在指定的异常产生时,对应到相应的page上面,原理类似。

除上之外,需要说明的一点是,有些应用中,我们并没有显示的指定errorPage,但是在应用的请求中,依然可以看到熟悉的Tomcat错误页面。这个是因为,在Pipeline中,还有一个Vavle, ErrorReportValve

依然走前面的错误处理流程时,在根据错误码获取errorPage的时候,因为没有对应的配置,custom处理就跳过了。整个错误展示留给后面的ErrorReportValve。

在它的report方法中,对于状态码小于400的不做处理,其他的就会生成我们熟悉的错误页面,同时,加上对应的状态码,提示信息,如果有相应的stackTrace,会遍历显示到 页面上。 

所以,这个其实是Tomcat代码里硬编码的一个。内容基本是这个样子:

所以,对于未指定errorPage的应用,看到的是相同样式的错误页面的,就是因为上面的原因。

相关阅读

和Tomcat学设计模式 | Facade模式与请求处理

阀门(Valve)常打开 | Tomcat的AccessLogValve介绍

web.xml是怎么被解析的?

http://www.tuicool.com/articles/UfEnqie

时间: 2024-09-13 18:50:55

Tomcat 的 ErrorPage 实现原理分析的相关文章

ASP组件上传的三种机制和实现原理分析

上传 ASP 组件 FILE对象 当前,基于浏览器/服务器模式的应用比较流行.当用户需要将文件传输到服务器上时,常用方法之一是运行FTP服务器并将每个用户的FTP默认目录设为用户的Web主目录,这样用户就能运行FTP客户程序并上传文件到指定的 Web目录.这就要求用户必须懂得如何使用FTP客户程序.因此,这种解决方案仅对熟悉FTP且富有经验的用户来说是可行的. 如果我们能把文件上传功能与Web集成,使用户仅用Web浏览器就能完成上传任务,这对于他们来说将是非常方便的.但是,一直以来,由于File

搜索引擎判断网站是否作弊的原理分析(三)

广州SEO陈永继续为大家讲解搜索引擎判断网站如何判断网站是否作弊的原理,上节讲解完TrustRank算法,这一节将详细讲解BadRank算法. BadRank据传是Google采用的反链接作弊算法.它是一种典型的不信任传播模型,即首先构建作弊网页集合,之后利用链接关系来讲这种不信任分值传递到其他网页. BadRank包含的基本假设是:如果一个网页将其链接指向作弊页面,则这个网页也很可能是作弊网页:而如果一个网页被作弊网页指向,则不能说明这个网页是有问题的,因为作弊网页也经常将其链接指向一些知名网

搜索引擎判断网站是否作弊的原理分析(二)

承接搜索引擎判断网站是否作弊的原理分析(一) 广州SEO陈永继续为大家分析信任传播模型.不信任传播模型及异常发现模型3个代表算法,它们分别是TrustRank算法.BadRank算法和SpamRank算法. 我们先详细介绍TrustRank算法 TrustRank算法属于信任传播模型,基本遵循信任传播模型的流程,即算法流程如下两个步骤组成. 步骤一:确定值得信任的网页集合 TrustRank算法需要靠人工审核来判断某个网页应该被放入网页集合,考虑到人工审核工作量大,所以提出了两种初选信任网页集合

IOS开发:Cocos2d触摸分发原理分析

  触摸是iOS程序的精髓所在,良好的触摸体验能让iOS程序得到非常好的效果,例如Clear.鉴于同学们只会用cocos2d的 CCTouchDispatcher 的 api 但并不知道工作原理,但了解触摸分发的过程是极为重要的.毕竟涉及到权限.两套协议等的各种分发. 本文以cocos2d-iphone源代码为讲解.cocos2d-x 于此类似,就不过多赘述了. 零.cocoaTouch的触摸 在讲解cocos2d触摸协议之前,我觉得我有必要提一下CocoaTouch那四个方法.毕竟cocos2

Photoshop图层与色彩原理分析

  PS入门教程 Photoshop图层与色彩原理分析   教程结束,以上就是Photoshop图层与色彩原理分析,希望大家看完这篇教程之后能有一定的帮助! 分类: PS入门教程

web上存漏洞及原理分析、防范方法(文件名检测漏洞)

我们通过前篇:<web上存漏洞及原理分析.防范方法(安全文件上存方法) >,已经知道后端获取服务器变量,很多来自客户端传入的.跟普通的get,post没有什么不同.下面我们看看,常见出现漏洞代码.1.检测文件类型,并且用用户上存文件名保存 复制代码 代码如下: if(isset($_FILES['img'])) { $file = save_file($_FILES['img']); if($file===false) exit('上存失败!'); echo "上存成功!"

色彩搭配原理分析及技巧

色彩搭配原理分析及技巧: 研究色彩是为了使用色彩,也就是说最大限度地发挥色彩的作用.色彩的意义与内容在艺术创造和表现方面是复杂多变的,但在欣赏和解释方面又有共通的国际特性,可见它在人们心目中不但是活的,也是一种很美的大众语言.所以,通过对色彩的各种心理分析,找出它们的各种特性,可以做到合理而有效地使用色彩. 一.红色系 红色系是从色相环上的红紫色到朱红色之间的色彩.它的刺激作用很大,具有很高的注目性和视认性.大红色是暖色系里温度最高的色彩,红色系原色彩对人的心理能产生很大的鼓舞作用. 1.纯色使

ToyBricks简介以及原理分析

ToyBricks背景 我始终认为,在高内聚,低耦合的原则下,进行组件化,模块化,插件化都是移动应用开发的趋势. 为什么这么说呢?下面我们举个栗子:大家都知道,以前Android应用开发中,可以使用HttpClient或者HttpUrlConnection来进行http访问.这里假设有一个耦合严重,但代码量巨大的项目,使用了基于HttpClient封装的loopj/android-async-http来进行http访问.但是,后来,Google明确支持使用HttpUrlConnection.此时

ShellShock漏洞原理分析

9月24日,广泛存在于Linux的bash漏洞曝光.因为此漏洞可以执行远程命令,所以极为危.危害程度可能超过前段时间的心脏流血漏洞. 漏洞编号CVE-2014-6271,以及打了补丁之后被绕过的CVE-2014-7169,又称ShellShock漏洞. 漏洞起因: 要是用一句话概括这个漏洞,就是代码和数据没有正确区分. 此次漏洞很像SQL注入,通过特别设计的参数使得解析器错误地执行了参数中的命令.这其实是所有解析性语言都可能存在的问题. 1 env x='() { :;}; echo vulne