Java web开发中常用JSP作为的视图,由于目前系统几乎都采用MVC分层架构,这样会存在一个问题,用户的请求地址有的时候并不会包含JSP文件路径的相关信息,这无疑会给开发调试带来不便,特别是JSP如果使用大量include指令或标签,找起来就头疼了,在这里我提供一个小技巧,通过增加两行代码,就可以直观的在前端HTML的注解中看到对应的JSP文件路径。
大家应该都比较清楚,JSP最终还是会被解析成Servlet,所以JSP的第一次被调用时会有几个过程,首先,tomcat会读取JSP文件,然后进行解析,包括解析标签,指令等,然后会生成对应的Servlet源文件,然后进行动态编译加载,如果下一次请求过来时,会通过文件修改时间等条件来判断是否需要重新生成Servlet,还是直接使用,OK,知道这些后就开始进入正题,思路很简单,JSP解析不管怎么复杂,第一步肯定是读取JSP文件,我们只要在读出文件的时候,在文件内容的开始和结束部分加上注解: ,是不是很简单,步骤如下:
apache-tomcat-7.0.42版本为例,
先到Tomcat官网下载Tomcat的源码,所有历史版本下载地址:
http://archive.apache.org/dist/tomcat/
Tomcat对JSP解析的代码是放在 apache-tomcat-7.0.42/lib/jasper.jar中,首先找到读取JSP文件的类:org.apache.jasper.compiler.JspReader.java,修改pushFile方法,增加黄色部分代码,然后重新打入jasper.jar中,重启Tomcat,大工告成。
/**
* Push a file (and its associated Stream) on the file stack. THe
* current position in the current file is remembered.
*/
private void pushFile(String file, String encoding,
InputStreamReader reader) throws JasperException {
...
CharArrayWriter caw = new CharArrayWriter();
caw.write("<!-- SRC: "+ file +" start -->");
char buf[] = new char[1024];
for (int i = 0 ; (i = reader.read(buf)) != -1 ;)
caw.write(buf, 0, i);
caw.write("<!-- SRC: "+ file +" end -->");
caw.close();
...
}
最终效果: index.jsp
<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%>
<body>
<%@include file="directive_include.jsp" %>
<jsp:include page="tag_include.jsp"></jsp:include>
</body>
</html>
directive_include.jsp
<div>directive_include.jsp</div>
tag_include.jsp
<div>tag_include.jsp</div>
访问index.jsp后,在浏览器看到的html为:
<!--SRC: /index.jsp start-->
<html><head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Insert title here</title>
</head>
<body>
<!--SRC: /directive_include.jsp start--><div>directive_include.jsp</div><!--SRC: /directive_include.jsp end-->
<!--SRC: /tag_include.jsp start--><div>tag_include.jsp</div><!--SRC: /tag_include.jsp end-->
</body></html>
<!--SRC: /index.jsp end-->
不同版本的tomcat中的org.apache.jasper.compiler.JspReader.java会有点不同,但是思路一样,例如apache-tomcat-8.0.21需要修改JspReader.java的构造方法,如下
public JspReader(JspCompilationContext ctxt,
String fname,
InputStreamReader reader,
ErrorDispatcher err)
throws JasperException {
this.context = ctxt;
this.err = err;
try {
CharArrayWriter caw = new CharArrayWriter();
caw.write("<!-- SRC: " + fname + "start -->");
char buf[] = new char[1024];
for (int i = 0 ; (i = reader.read(buf)) != -1 ;)
caw.write(buf, 0, i);
caw.write("<!-- SRC: " + fname + "end -->");
caw.close();
current = new Mark(this, caw.toCharArray(), fname);
} catch (Throwable ex) {
ExceptionUtils.handleThrowable(ex);
log.error("Exception parsing file ", ex);
err.jspError("jsp.error.file.cannot.read", fname);
} finally {
if (reader != null) {
try {
reader.close();
} catch (Exception any) {
if(log.isDebugEnabled()) {
log.debug("Exception closing reader: ", any);
}
}
}
}
}
类似思路在理论上也可以用在定位原文件类型本来就是html的情况,我还没有试过,如果有兴趣大家可以研究一下。