Java Web中的include

上周在工作上遇到了一件糗事。在写jsp的过程中，经常会遇到将jsp文件模块化，然后通过include的方式将一个个模块进行组装。这个过程中，经常会在各个模块之间共享变量，那么变量的范围是什么呢？自己因为忘记这个知识点而调试了好长时间。知识点虽然简单，但是这个是Java web经典的问题，即对于include，Java web到底是怎么实现的？

jsp文件到底是什么？

jsp-servlet-tomcat.png

• JSP是Servlet的一种特殊形式，每个JSP页面就是一个Servlet实例
• JSP页面由系统编译成Servlet，Servlet再负责响应用户请求
• Tomcat负责执行Servlet文件

准备实验

因此在我机器上实验了一把，实验的环境如下：

名称	配置
系统	Mac OS
IDE	IntelliJ IDEA 2017.2 Help
容器	Tomcat 7.04

项目的文件路径如下所示：

项目路径.png

在Mac OS下，Intellij IDEA将jsp文件编译成相应的servlet文件，那么该文件的位置是：
/Users/garybhwang/Library/Caches/IntelliJIdea2017.2/tomcat
然后根据相应的项目名称找到相应的java文件：
/Unnamed_项目名/work/Catalina/localhost/_/org/apache/jsp
相应的目录结构如下所示：

jsp-servlet目录.png

实验方式

common.jsp 页面去包含header.jsp 页面，header.jsp 代码如下：

<%@ page contentType="text/html;charset=UTF-8" language="java" %>


    


    
This is header page!

include三种方式

• jsp页面的include指令
  <%@ include file="/WEB-INF/header.jsp"%>
  common.jsp 页面的代码如下：

<%@ page contentType="text/html;charset=UTF-8" language="java" %>


    


    
This is common page!
    <%@ include file="/WEB-INF/header.jsp"%>

那么common.jsp 编译成为servlet文件只有的内容如下：

(common_jsp.java).png

从上面的源码可以看到，<%@ include file = "*******" %>最终是将header.jsp 文件进行编译，然后将其内容包含进来。因此include指令包含的是页面的内容。

• jsp页面的include动作元素
  
  common.jsp 页面的代码如下：

<%@ page contentType="text/html;charset=UTF-8" language="java" %>


    


    
This is common page!
    

那么按照这种包含的方式，common.jsp 编译的servlet源码如下所示：

(common_jsp.java).png

从common_jsp.java的servlet文件中可以看到 ，并不是像include指令那样包含内容，而是通过Tomcat容器中的JspRuntimeLibrary类的include方法进行包含。查看Tomcat容器的源码可以看到，可以看到：

tomcat 源码.png

从Tomcat源码可以分析出，的实质是，在common_jsp.java 文件中，执行 RequestDispatcher的include方法，而这个方法使得 common_jsp.java 中的request 对象、response对象和header.jsp中的response对象、request对象是共享的。

• RequestDispatcher类的include方法
  request.getRequestDispatcher("/WEB-INF/header.jsp").include(request,response);
  同上分析。

include和共享对象

对象	作用
request	页面和页面构成forward以及include关系，达成共享
pageContext	在一个页面中共享
session	在整个会话期间共享

因此，有上述的分析可以得出这样的结论：

• 对于 <%@ include file %> 而言，子页面只是将内容包含在父页面之中，因此只有子页面和父页面之间的request对象以及pageContext对象是共享的
• 对于 而言，父页面通过RequestDispatcher的include方法将子页面包含进来，因此只有父页面和子页面之间request对象是共享的

include方式	父子页面共享对象
<%@ include file %>	pageContext对象以及request对象
同	request对象，不共享pageContext对象
RequestDispatcher类的include方法	request对象，不共享pageContext对象