web开发之Servlet 三

昨天我们学习了Servlet的运行过程和生命周期，那么今天我们学习下Servlet中非常重要的两个类：ServletConfig  ServletContext

我们可以看到，与顶层Servlet主动关联的是ServletConfig  ServletRequest ServletResponse ,它们通过容器传递给Servlet;其中Servlet初始化时候使用ServletConfig,另外两个是请求时调用传给Servlet.

一、ServletConfig 讲解

ServletConfig:代表的是当前Servlet在web.xml 中的配置信息，它的方法主要有：

*String getServletName()   -- 获取当前Servlet在web.xml中配置的名字

*String getInitParameter(String name)  --- 获取当前Servlet指定名称key的初始化参数的值

*Enumeration getInitParameterNames()  -- 获取当前Servlet所有初始化参数的名字组成的枚举

*ServletContext getServletContext()  -- 获取代表当前web应用的ServletContext对象

在Servlet的配置文件中，可以使用一个或多个<init-param>标签为servlet配置一些初始化参数。

 <servlet>
    <description>This is the description of my J2EE component</description>
    <display-name>This is the display name of my J2EE component</display-name>
    <servlet-name>ServletDemo01</servlet-name>
    <servlet-class>mdj.servlet.study.ServletDemo01</servlet-class>
     <!--配置ServletDemo01的初始化参数 -->
    <init-param>
        <param-name>name</param-name>
        <param-value>test</param-value>
    </init-param>
     <init-param>
        <param-name>password</param-name>
        <param-value>123</param-value>
    </init-param>
    <init-param>
        <param-name>charset</param-name>
        <param-value>UTF-8</param-value>
    </init-param>
  </servlet>

  <servlet-mapping>
    <servlet-name>ServletDemo01</servlet-name>
    <url-pattern>/servlet/ServletDemo01</url-pattern>
  </servlet-mapping>

当上述servlet配置了初始化参数以后，web容器在创建Servlet实例对象的时候，会自动将这些初始化参数封装到ServletConfig对象中，并在调用servlet的init方法时候，将ServletConfig对象传递给servlet.从而，程序员可以通过ServletConfig对象可以获得当前servlet的初始化参数信息。

好处：如果数据库信息，编码方式等配置信息放在web.xml中，如果以后数据库的用户名、密码改变了，那么直接可以很方便的通过修改web.xml就行了，这样避免了修改代码源码的麻烦。

代码如下：

public void doGet(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {
        System.out.println("Servlet 中service 方法被调用... ... ... ");
        ServletConfig servletConfig = this.getServletConfig();
        //获取当前servlet的名字
        String servletname = servletConfig.getServletName();
        response.getWriter().print(servletname);
        response.getWriter().print(";");
        //根据key值获取对应的value值
        String charset = servletConfig.getInitParameter("charset");
        response.getWriter().print(charset);
        response.getWriter().print(";");
        
        //获取所有的init-param 参数
        Enumeration<String> e  = servletConfig.getInitParameterNames();
        while(e.hasMoreElements()){
            String name = e.nextElement();
            String value = servletConfig.getInitParameter(name);
            response.getWriter().print(name + "=" + value + "");
        }
        
    }

我们看下结果：

可以看到，结果输出是正确的。

核心代码是通过this.getServletConfig()方法拿到init方法中的ServletConfig对象，然后获取配置信息。

二、ServletContext

Web容器在启动的时候，我们知道会为每一个Servlet创建一个唯一的Servlet实例对象，而ServletConfig 也是在init初始的时候传递到servlet中来的，从上面的层次图也可以看出，但同时它会为每个WEB应用程序都创建一个对应的ServletContext对象，它代表的当前的web应用，上面的ServletConfig 代表的当前的Servlet.

ServletConfig对象中维护了ServletConfig对象的引用，开发人员在编写servlet时候，可以通过ServletConfig.getServletContext方法获取ServletContext对象。

怎么来理解引用，就是说我们在web.xml 中可以配置很多servlet，那么对应在初始化的时候就创建出很多的ServletConfig实例对象，这些实例对象都是共用同一个ServletContext,因此是这个ServletContext的引用。

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

context域对象：1.是一个容器，2，作为范围是整个应用程序。

三、ServletContext的应用

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

比如:ServletContextDemo1和ServletContextDemo02通过ServletContext对象实现数据共享

package mdj.servlet.study;

import java.io.IOException;

import javax.servlet.ServletContext;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

public class ServletContextDemo1 extends HttpServlet {
    public void doGet(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {
        String data = "servletcontextdemo01";
        /**
         * ServletConfig对象中维护了ServletContext对象的引用，开发人员在编写servlet时，  *
         * 可以通过ServletConfig.getServletContext方法获得ServletContext对象。
         */
        ServletContext context = this.getServletConfig().getServletContext();// 获得ServletContext对象
        context.setAttribute("data", data);// 将data存储到ServletContext对象中
    }

    public void doPost(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {
        this.doGet(request, response);
    }
}

package mdj.servlet.study;

import java.io.IOException;

import javax.servlet.ServletContext;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

public class ServletContextDemo02 extends HttpServlet {
    public void doGet(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {
        ServletContext context = this.getServletConfig().getServletContext();// 获得ServletContext对象
        String data = (String) context.getAttribute("data");
        response.getWriter().println(data);
    }

    public void doPost(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {
        this.doGet(request, response);
    }
}

<servlet>
      <servlet-name>ServletContextDemo1</servlet-name>
      <servlet-class>mdj.servlet.study.ServletContextDemo1</servlet-class>
  </servlet>    
  <servlet-mapping>
       <servlet-name>ServletContextDemo1</servlet-name>
       <url-pattern>/servlet/ServletContextDemo1</url-pattern>
  </servlet-mapping>
    
  <servlet>
      <servlet-name>ServletContextDemo02</servlet-name>
      <servlet-class>mdj.servlet.study.ServletContextDemo02</servlet-class>
  </servlet>    
  <servlet-mapping>
       <servlet-name>ServletContextDemo02</servlet-name>
       <url-pattern>/servlet/ServletContextDemo02</url-pattern>
  </servlet-mapping>    

我们先直接访问下ServletContextDemo02 看下效果是什么样：

结果是null;

然后我们先运行ServletContextDemo1，将数据data存储到ServletContext对象中，然后运行ServletContextDemo02就可以从ServletContext对象中取出数据了，这样就实现了数据共享，如下图所示：

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

通过<init-param>标签为某一个单独的servlet加配置信息，这种配置信息在其他的Servlet中是无法访问到的。可如果我们使用<context-param>标签（与Servlet标签并列）为整个Web应用配置属性的话，那所有的Servlet就都能访问里面的参数了。例如：可以把数据库的配置信息放在这里。

     注意：

• 请求参数 parameter --- 浏览器发送过来的请求中的参数信息
• 初始化参数 initparameter --- 在web.xml中为Servlet或ServletContext配置的初始化时带有的基本参数
• 域属性 attribute --- 四大作用域中存取的键值对

举例如下：

package mdj.servlet.study;

import java.io.IOException;

import javax.servlet.ServletContext;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

public class ServletContextDemo3 extends HttpServlet {
    
    public void doGet(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {
    
        ServletContext context = this.getServletConfig().getServletContext();// 获得ServletContext对象
        //获取整个web站点的初始化参数
        String contextInitParam = context.getInitParameter("url");
        response.getWriter().print(contextInitParam);
    }

    public void doPost(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {
        this.doGet(request, response);
    }
}

<!-- 配置WEB应用的初始化参数 -->
    <context-param>
        <param-name>url</param-name>
        <param-value>jdbc:mysql://localhost:3306/test</param-value>
    </context-param>
    
  <servlet>
      <servlet-name>ServletContextDemo3</servlet-name>
      <servlet-class>mdj.servlet.study.ServletContextDemo3</servlet-class>
  </servlet>    
  <servlet-mapping>
       <servlet-name>ServletContextDemo3</servlet-name>
       <url-pattern>/servlet/ServletContextDemo3</url-pattern>
  </servlet-mapping>

3、用servletContext实现请求转发

package mdj.servlet.study;

import java.io.IOException;

import javax.servlet.RequestDispatcher;
import javax.servlet.ServletContext;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

public class ServletContextDemo4 extends HttpServlet {

    public void doGet(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {
        String data = "<h1><font color='red'>zhuanfa</font></h1>";
        response.getOutputStream().write(data.getBytes());
        ServletContext context = this.getServletContext();// 获取ServletContext对象
        RequestDispatcher rd = context
                .getRequestDispatcher("/servlet/ServletContextDemo5");// 获取请求转发对象(RequestDispatcher)
        rd.forward(request, response);// 调用forward方法实现请求转发
    }

    public void doPost(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {
    }
}

package mdj.servlet.study;

import java.io.IOException;

import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

public class ServletContextDemo5 extends HttpServlet {
    public void doGet(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {
        response.getOutputStream().write("servletDemo5".getBytes());
    }

    public void doPost(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {
        this.doGet(request, response);
    }
}

接着，我们访问下servetContextDemo4,效果如下：

可以看到：访问的是ServletContextDemo4，浏览器显示的却是ServletContextDemo5的内容，这就是使用ServletContext实现了请求转发；注意和重定向要区分开来。

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

我们要开始分别读取test.properties --- test4.properties

package mdj.servlet.study;

import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.InputStream;
import java.text.MessageFormat;
import java.util.Properties;

import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

public class ServletContextDemo6 extends HttpServlet {
      
    public void doGet(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException { 
        /**
         * response.setContentType("text/html;charset=UTF-8");目的是控制浏览器用UTF-8进行解码；
         * 这样就不会出现中文乱码了
         */
        response.setHeader("content-type","text/html;charset=UTF-8");
        try {
            readSrcDirPropCfgFile(response);//读取src目录下的properties配置文件
            response.getWriter().println("<hr/>");
            
            readWebRootDirPropCfgFile(response);//读取WebRoot目录下的properties配置文件
            response.getWriter().println("<hr/>");
            
            readPropCfgFile(response);//读取src目录下的mdj.test包中的properties配置文件
            response.getWriter().println("<hr/>");
            
            readPropCfgFile2(response);//读取src目录下的mdj.servlet.study包中的properties配置文件
        } catch (Exception e) {
            // TODO Auto-generated catch block
            e.printStackTrace();
        }
        
    }

    private void readPropCfgFile2(HttpServletResponse response) throws Exception {
            InputStream in = this.getServletContext().getResourceAsStream("/WEB-INF/classes/mdj/servlet/study/test.properties");
            Properties prop = new Properties();
            prop.load(in);
            String driver = prop.getProperty("driver");
            String url = prop.getProperty("url");
            String username = prop.getProperty("username");
            String password = prop.getProperty("password");
            response.getWriter().println("读取src目录下的mdj.servlet.study包中的test.properties配置文件：");
            response.getWriter().println(
                    MessageFormat.format(
                            "driver={0},url={1},username={2},password={3}", 
                            driver,url, username, password));
        
    }

    private void readPropCfgFile(HttpServletResponse response) throws Exception {
        //通过ServletContext获取web资源的绝对路径
        String path = this.getServletContext().getRealPath("/WEB-INF/classes/mdj/test/test2.properties");
        InputStream in = new FileInputStream(path);
        Properties prop = new Properties();
        prop.load(in);
        String driver = prop.getProperty("driver");
        String url = prop.getProperty("url");
        String username = prop.getProperty("username");
        String password = prop.getProperty("password");
        response.getWriter().println("读取src目录下的mdj.test包中的properties配置文件：");
        response.getWriter().println(
                MessageFormat.format(
                        "driver={0},url={1},username={2},password={3}", 
                        driver,url, username, password));
        
    }

    // 通过ServletContext对象读取WebRoot目录下的properties配置文件
    private void readWebRootDirPropCfgFile(HttpServletResponse response) throws Exception {
         /**
         * 通过ServletContext对象读取WebRoot目录下的properties配置文件
         * “/”代表的是项目根目录
         */
        InputStream in = this.getServletContext().getResourceAsStream("/test4.properties");
        Properties prop = new Properties();
        prop.load(in);
        String driver = prop.getProperty("driver");
        String url = prop.getProperty("url");
        String username = prop.getProperty("username");
        String password = prop.getProperty("password");
        response.getWriter().println("读取WebRoot目录下的test4.properties配置文件：");
        response.getWriter().print(
                MessageFormat.format(
                        "driver={0},url={1},username={2},password={3}", 
                        driver,url, username, password));
        
    }

    //通过ServletContext对象读取src目录下的properties配置文件
    private void readSrcDirPropCfgFile(HttpServletResponse response) throws Exception {
        /**
         * 通过ServletContext对象读取src目录下的test3.properties配置文件
         */
        InputStream in = this.getServletContext().getResourceAsStream("/WEB-INF/classes/test3.properties");
        Properties prop = new Properties();
        prop.load(in);
        String driver = prop.getProperty("driver");
        String url = prop.getProperty("url");
        String username = prop.getProperty("username");
        String password = prop.getProperty("password");
        response.getWriter().println("读取src目录下的test3.properties配置文件：");
        response.getWriter().println(
                MessageFormat.format(
                        "driver={0},url={1},username={2},password={3}", 
                        driver,url, username, password));
    }
    
    public void doPost(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {

        this.doGet(request, response);
    }
}

运行效果图：

可以看到都是以部署的we应用为起点进行的资源路径寻找。

使用类装载器读取资源文件

 

 /**
     * 读取类路径下的资源文件
     * @param response
     * @throws IOException
     */
    private void test1(HttpServletResponse response) throws IOException {
        //获取到装载当前类的类装载器
        ClassLoader loader = ServletContextDemo7.class.getClassLoader();
        //用类装载器读取src目录下的db1.properties配置文件
        InputStream in = loader.getResourceAsStream("test3.properties");
        Properties prop = new Properties();
        prop.load(in);
        String driver = prop.getProperty("driver");
        String url = prop.getProperty("url");
        String username = prop.getProperty("username");
        String password = prop.getProperty("password");
        response.getWriter().println("用类装载器读取src目录下的test3.properties配置文件：");
        response.getWriter().println(
                MessageFormat.format(
                        "driver={0},url={1},username={2},password={3}", 
                        driver,url, username, password));
    }

package mdj.servlet.study;

import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.text.MessageFormat;
import java.util.Properties;

import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

/**
 * 用类装载器读取资源文件
 * 通过类装载器读取资源文件的注意事项:不适合装载大文件，否则会导致jvm内存溢出
 * @author gacl
 *
 */
public class ServletContextDemo7 extends HttpServlet {

    public void doGet(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {
        /**
         * response.setContentType("text/html;charset=UTF-8");目的是控制浏览器用UTF-8进行解码；
         * 这样就不会出现中文乱码了
         */
        response.setHeader("content-type","text/html;charset=UTF-8");
        test1(response);
        response.getWriter().println("<hr/>");
        test2(response);
        response.getWriter().println("<hr/>");
        //test3();
       // test4();
        
    }
    
    /**
     * 读取类路径下的资源文件
     * @param response
     * @throws IOException
     */
    private void test1(HttpServletResponse response) throws IOException {
        //获取到装载当前类的类装载器
        ClassLoader loader = ServletContextDemo7.class.getClassLoader();
        //用类装载器读取src目录下的db1.properties配置文件
        InputStream in = loader.getResourceAsStream("test3.properties");
        Properties prop = new Properties();
        prop.load(in);
        String driver = prop.getProperty("driver");
        String url = prop.getProperty("url");
        String username = prop.getProperty("username");
        String password = prop.getProperty("password");
        response.getWriter().println("用类装载器读取src目录下的test3.properties配置文件：");
        response.getWriter().println(
                MessageFormat.format(
                        "driver={0},url={1},username={2},password={3}", 
                        driver,url, username, password));
    }

    /**
     * 读取类路径下面、包下面的资源文件
     * @param response
     * @throws IOException
     */
    private void test2(HttpServletResponse response) throws IOException {
        //获取到装载当前类的类装载器
        ClassLoader loader = ServletContextDemo7.class.getClassLoader();
        //用类装载器读取src目录下的mdj.servlet.study包中的test.properties配置文件
        InputStream in = loader.getResourceAsStream("mdj/servlet/study/test.properties");
        Properties prop = new Properties();
        prop.load(in);
        String driver = prop.getProperty("driver");
        String url = prop.getProperty("url");
        String username = prop.getProperty("username");
        String password = prop.getProperty("password");
        response.getWriter().println("用类装载器读取src目录下的mdj.servlet.study包中的test.properties配置文件：");
        response.getWriter().println(
                MessageFormat.format(
                        "driver={0},url={1},username={2},password={3}", 
                        driver,url, username, password));
    }
    
    /**
     * 通过类装载器读取资源文件的注意事项:不适合装载大文件，否则会导致jvm内存溢出
     */
    public void test3() {
        /**
         * 01.avi是一个150多M的文件，使用类加载器去读取这个大文件时会导致内存溢出：
         * java.lang.OutOfMemoryError: Java heap space
         */
        InputStream in = ServletContextDemo7.class.getClassLoader().getResourceAsStream("01.avi");
        System.out.println(in);
    }
    
    /**
     * 读取01.avi,并拷贝到e:根目录下
     * 01.avi文件太大，只能用servletContext去读取
     * @throws IOException
     */
    public void test4() throws IOException {
      
        String path = this.getServletContext().getRealPath("/WEB-INF/classes/01.avi");
        /**
         * path.lastIndexOf("\") + 1是一个非常绝妙的写法
         */
        String filename = path.substring(path.lastIndexOf("\") + 1);//获取文件名
        InputStream in = this.getServletContext().getResourceAsStream("/WEB-INF/classes/01.avi");
        byte buffer[] = new byte[1024];
        int len = 0;
        OutputStream out = new FileOutputStream("e:\" + filename);
        while ((len = in.read(buffer)) > 0) {
            out.write(buffer, 0, len);
        }
        out.close();
        in.close();
    }

    public void doPost(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {

        this.doGet(request, response);
    }

}

运行结果：

5、在客户端缓存Servlet的输出

对于不经常变化的数据，在servlet中可以为其设置合理的缓存时间值，以避免浏览器频繁向服务器发送请求，提升服务器的性能。

通过：

      

/**
* 设置数据合理的缓存时间值，以避免浏览器频繁向服务器发送请求，提升服务器的性能
* 这里是将数据的缓存时间设置为1天
*/
response.setDateHeader("expires",System.currentTimeMillis() + 24 * 3600 * 1000);

最后总结：

ServletContext用于Servlet交互的场景参数集合。Servlet的运行模式是一种典型的“握手型“交互运行模式，即两个参与交互的模块，在交互时会准备一个交互场景，这个交互场景将一直存在，直到交互完成。这个交互场景的初始化由交互对象指定的参数进行定制，而所谓”指定的参数“通常是一个配置类。因此，在这里，交互场景由ServletContext来描述，ServletRequest和ServletResponse就是参与交互的具体对象。

到此，Servlet的学习告一段落。