一文弄懂Jasper引擎编译JSP文件的分析说明
基本概念
- 对于基于JSP的Web应用,可以在JSP页面直接编写Java代码,添加第三方库,使用EL表达式.但是最终输出到客户端浏览器的都是标准的HTML页面,包括js,css等等.并不包含Java相关的语法 .JSP可以看作是一种运行在服务器端的脚本,最终以HTML页面方式响应给客户端
- 使用Tomcat中的Jasper引擎将jsp文件转换为HTML页面文件:JSP本质上是一个ServletTomcat使用Jasper对JSP语法进行解析,生成Servlet并生成Class字节码文件用户在访问jsp文件时,会访问转换后的Servlet, 最终的访问结果以HTML页面的方式直接响应在浏览器端在运行过程中 ,Jasper引擎会检测jsp文件是否修改,如果修改则重新编译jsp文件
编译方式
运行时编译
- Tomcat不会在启动Web应用时自动编译JSP文件,而是在客户端第一次请求时,才编译需要访问的JSP文件
编译过程
- Tomcat在默认的web.xml中配置了org.apache.jasper.servlet.JspServlet, 用于处理所有的 .jsp和 .jspx结尾的请求
- JspServlet的实现就是运行编译时的入口
Bash
jsp
org.apache.jasper.servlet.JspServlet
fork
false
xpoweredBy
false
3
jsp
.jsp
.jspx
复制代码- JspServlet请求处理流程:
编译结果
- 如果在tomcat/conf/web.xml 中配置了参数scratchdir, 则jsp编译后的结果会输出到配置的目录下:
Bash
scratchdir
e:/jsp/
复制代码- 如果没有配置该选项,则jsp编译后的结果,将会存放在Tomcat的安装目录的work/Catalina/localhost/ 目录下
预编译
- 预编译: 直接在web项目启动时,一次性将web应用用的所有jsp页面一次性编译完成.这样在web项目运行过程中,可以不再需要实时编译,而是直接调用jsp页面对应的servlet完成请求处理,从而提升系统性能
- 要想进行预编译,必须首先确保下载并安装了Apache Ant
- Tomcat中提供了一个shell程序JspC用于支持jsp编译,而且在Tomcat安装目录下提供了一个catalina-tasks.xml文件声明了Tomcat支持的Ant任务,这样很容易使用Ant来执行jsp的预编译
编译原理
代码分析
- 生成的Java文件的类名为index_jsp.java, 继承自org.apache.jasper.runtime.HttpJspBase,该类是HttpServlet的子类.所以jsp的本质就是一个servlet
- 属性 _jspx_denpendants保存了当前jsp页面依赖的资源,包含引入的外部jsp页面,导入的标签,标签所在的jar包.便于后续处理过程中使用. 比如以Map形式保存了每个资源的上次修改时间便于重新编译检测
- 属性 _jspx_imports_packages存放导入的java包,默认导入javax.servlet, javax.servlet.http, javax.servlet.jsp
- 属性 _jspx_imports_classes存放导入的类 ,jsp页面中通过import标签导入的类都会包含在该集合 . _jspx_import_packages和 _jspx_import_classes属性主要用于配置EL引擎上下文
- 请求处理由 _jspService方法完成,在父类HttpJspBase中的service方法通过模板方法模式,调用了子类的 _jspService方法
- _jspService方法中定义了几个重要的局部变量 : pageContext, Session, application, config, out, page. 因为整个页面的输出都是由 _jspService方法完成,因此这些变量和参数会对整个jsp页面生效. 这个就是在jsp页面中能够使用变量的原因
- jsp页面中指定文档类型的page变标签的值最终作为response.setContentType() 使用
- 对于生成的html文件的静态内容,调用out.write() 输出
- 对于 <% ..> 标签中的代码,直接转换为Servlet类中的代码,如果在代码中嵌入了静态文件,同样会调用out.write() 输出
编译流程
- Jasper的编译流程主要包括代码生成和编译两部分
- Compiler通过一个PageInfo对象保存jsp页面编译过程中的各种配置. 这些配置可以是来自于web应用的初始化参数,也可以是来自于jsp页面的标签指令配置,比如page, include等
- 调用ParseController解析标签指令节点,验证标签指令是否合法,同时将配置信息保存到PageInfo中,用于控制代码生成
- 调用ParseController解析整个jsp页面,由于jsp是逐行解析,所以会对每一行创建一个具体的Node对象,比如静态文本TemplateText, Java代码Scriptlet, 定制标签CustomTag, Include标签指令IncludeDirective
- 验证标签指令外的其余节点的合法性. 比如脚本,定制标签 ,EL表达式等
- 获取标签指令以外的其余节点的页面配置信息
- 编译并加载当前jsp页面依赖的标签
- 对于jsp页面的EL表达式,生成对应的映射函数
- 生成jsp页面对应的servlet源代码
- 代码生成完成后 ,Compiler会生成SMAP信息. 如果配置生成了SMAP信息 ,Compiler则会在编译阶段将SMAP信息写到class文件中
- 在编译阶段 ,Compiler的两个实现AntCompiler和JDTCompiler分别调用相关框架的API进行源代码解析AntCompiler通过构造一个Ant的javac任务完成编译JDTCompiler通过调用org.eclipse.jdt.internal.compiler.Compiler完成编译