ServletContext（之一）

API中ServletContext接口的定义：

public interface ServletContext

Defines a set of methods that a servlet uses to communicate with its servlet container, for example, to get the MIME type of a file, dispatch requests, or write to a log file.

There is one context per "web application" per Java Virtual Machine. (A "web application" is a collection of servlets and content installed under a specific subset of the server's URL namespace such as /catalog and possibly installed via a .war file.)

In the case of a web application marked "distributed" in its deployment descriptor, there will be one context instance for each virtual machine. In this situation, the context cannot be used as a location to share global information (because the information won't be truly global). Use an external resource like a database instead.

The ServletContext object is contained within the ServletConfig object, which the Web server provides the servlet when the servlet is initialized.

 

WEB容器在启动时，它会为每个WEB应用程序都创建一个对应的ServletContext对象，它代表当前web应用。

 由于一个WEB应用中的所有Servlet共享同一个ServletContext对象，因此Servlet对象之间可以通过ServletContext对象来实现通讯。ServletContext对象通常也被称之为context域对象。

如下是ServletContext接口中常见的一些方法：

（1）Object getAttribute(String name)    返回servlet上下文中具有指定名字的对象，或使用已指定名捆绑一个对象。从Web应用的标准观点看，这样的对象是全局对象，因为它们可以被同一servlet在另一时刻访问。或上下文中任意其他servlet访问。      
（2）void setAttribute(String name,Object obj)    设置servlet上下文中具有指定名字的对象。      
（3）Enumeration getAttributeNames()    返回保存在servlet上下文中所有属性名字的枚举。          
（4）String getInitParameter(String name)    返回指定上下文范围的初始化参数值。此方法与ServletConfig方法名称不一样，后者只应用于已编码的指定servlet。此方法应用于上下文中所有的参数。      
（5）Enumeration getInitParameterNames()    返回（可能为空）指定上下文范围的初始化参数值名字的枚举值。

（6）ServletContext getContext(java.lang.String uripath)

        利用Servlet的getServletContext().getContext()方法，可以得到应用程序的上下文。所以可以通过该方法和servlet容器进行通信，比如转发请求到另一个web应用的jsp上去，如getServletContext().getContext().RequestDispatcher("/a.jsp")。注意这是需要在servlet容器中（tomcat的话为配置文件中的context元素节点的crossContxt属性）指定crossContxt属性为true。不过为了安全起见一般的不这样搞。

 ServletContext的使用：

（一）

获取web.xml中的context-param和init-param定义的值

web.xml里面可以定义两种参数：
(1)application范围内的参数，存放在servletcontext中，在web.xml中配置如下：

xml 代码
<context-param>   
           <param-name>context/param</param-name>   
           <param-value>avalible during application</param-value>   
</context-param> 

(2)servlet范围内的参数，只能在servlet的init()方法中取得，在web.xml中配置如下：

xml 代码
<servlet>   
    <servlet-name>MainServlet</servlet-name>   
    <servlet-class>com.wes.controller.MainServlet</servlet-class>   
    <init-param>   
       <param-name>param1</param-name>   
       <param-value>avalible in servlet init()</param-value>   
    </init-param>   
    <load-on-startup>0</load-on-startup>   
</servlet> 

在servlet中可以通过代码分别取用：

java 代码
package com.test;    
   
import javax.servlet.ServletException;    
import javax.servlet.http.HttpServlet;    
   
public class TestServlet extends HttpServlet ...{    
   
    public TestServlet() ...{    
        super();    
     }    
    public void init() throws ServletException ...{    
         System.out.println("下面的两个参数param1是在servlet中存放的");    
         System.out.println(this.getInitParameter("param1"));    
         System.out.println("下面的参数是存放在servletcontext中的");    
         System.out.println(getServletContext().getInitParameter("context/param"));    
      }    
}  

第一种参数在servlet里面可以通过getServletContext().getInitParameter("context/param")得到
第二种参数只能在servlet的init()方法中通过this.getInitParameter("param1")取得

init-param属于一个servlet所有,context-param属于整个应用程序所有 ,不仅是在servlet中可以得到,jsp文件中也可以得到.

在jsp中config就相当于这里的servletContext,<%=config.getServletContext().getInitParameter("...") %>.
action中ServletActionContext.getServletContext().getInitParameter("...").

 

（二）

1.多个Servlet通过ServletContext对象实现数据共享。

在InitServlet的Service方法中利用ServletContext对象存入需要共享的数据

/*获取ServletContext对象*/  

ServletContext context = this.getServletContext();   

//存入共享的数据    

context.setAttribute("name", "haha"); 

在其它的Servlet中利用ServletContext对象获取共享的数据   

/*获取ServletContext对象*/  

ServletContext context = this.getServletContext();   

//获取共享的数据   

String name = context.getAttribute("name");   

System.out.println("共享的内容值是:"+name);  

 

 

2.获取WEB应用的初始化参数。

在web.xml文件中配置需要初始化的参数信息。

<web-app>   

 <context-param>   

     <param-name>url</param-name>   

     <param-value>jdbc:mysql://localhost:3306/4g</param-value>   

 </context-param>   

<context-param>   

    <param-name>password</param-name>   

    <param-value>1314qr</param-value>   

 </context-param>   

 <context-param>   

     <param-name>user</param-name>   

     <param-value>root</param-value>   

  </context-param>   

</web-app>  

在DemoServlet的doPost方法中测试获取初始化参数的步骤如下:   

/*获取ServletContext对象*/  

 ServletContext context = this.getServletContext();   

/*获取初始化参数*/  

//获取指定名称的初始化参数   

String url = context.getInitParameter("url"); 

 //获取web.xml文件中所有的初始化应用参数          

 Enumeration<String> enumer = context.getInitParameterNames();   

while(enumer.hasMoreElements()){   

       String name = enumer.nextElement();   

        String value = context.getInitParameter(name);   

        System.out.println(name+"=========="+value);   

 }   

 

 

 

3.实现Servlet的转发：

在测试的Servlet中实现转发的步骤如下:  

/*要利用ServletContext对象实现转发获取对象*/  

ServletContext context = this.getServletContext();   

 //在request对象中存入name属性    

request.setAttribute("name", "haha");   

 /*根据转发的地址获取 RequestDispatcher对象*/  

RequestDispatcher  rd  = context.getRequestDispatcher("/index.jsp");   

//调用转发方法 以下采用任意方法即可    

rd.forward(request, response);   

//rd.include(request, response);   

注意：forward与include的区别 

forward方法是把请求的内容转发到另外的一个servlet.而include是把另一个servlet处理过后的内容拿过来.（forward方法调用后在响应中的没有提交的内容被自动消除。将请求转发给其他的Servlet后，由被调用的Servlet负责对请求做出响应，而原先Servlet的执行则终止。include方法使原先的Servlet和转发到的Servlet都可以输出响应信息，即原先的Servlet还可以继续输出响应信息）

 

 

 

4.利用ServletContext对象读取资源文件。  

读取资源文件(properties文件（属性文件）)的三种方式

配置的properties的内容如下:   

url=jdbc\:mysql\://localhost\:3306/3g ; 

user=root;

password=root;  

获取实现的代码如下:   

/*获取ServletContext对象*/  

ServletContext context = this.getServletContext();     

//第一种方式    

URL url = context.getResource("WEB-INF/classes/db.properties");   

InputStream is =  url.openStream();   

//第二种方式   

 /*读取db.properties文件*/  

String path =context.getRealPath("WEB-INF/classes/db.properties");   

 /*根据文件的路径 构建文件对象*/  

File file = new File(path);   

 /*根据file文件对象 创建输入流*/  

InputStream is = new FileInputStream(file);   

//第三种方式   

InputStream is = context.getResourceAsStream("WEB-INF/classes/db.properties ");    

以三种方式任意一种可以：    

 /*解析properties的文件*/  

     Properties prop = new Properties();   

     //从输入流中读取属性列表（键和元素对）。   

      prop.load(is);   

      Set<String> set = prop.stringPropertyNames();   

       //遍历set集合   

       Iterator<String> it = set.iterator();   

       while(it.hasNext()){   

           String key = it.next();   

           String value = prop.getProperty(key);   

           System.out.println(key+"-----"+value);   

       }