Java Servlet(三)：Servlet中ServletConfig对象和ServletContext对象

本文将记录ServletConfig/ServletContext中提供了哪些方法，及方法的用法。

ServletConfig是一个抽象接口，它是由Servlet容器使用，在一个servlet对象初始化时，Servlet容器传递信息给正在初始化的servlet对象。

public abstract interface javax.servlet.ServletConfig {
  public abstract java.lang.String getServletName();
  public abstract javax.servlet.ServletContext getServletContext();
  public abstract java.lang.String getInitParameter(java.lang.String arg0);
  public abstract java.util.Enumeration getInitParameterNames();
}

• getServletName()方法：

用来返回当前servlet在web.xml注册的servlet-name；

• getServletContext()方法：

获取servlet上下文信息。

• getInitParameter(String arg0)方法：

根据一个指定的参数名称，获取在servlet初始化时传递的参数值，而这样的参数信息往往配置在web.xml。

• getInitParameters()方法：

返回servlet初始化时，传递进来的所有参数名称集合。

为了能了解到ServletConfig相关的使用，我们需要在之前新建的MyServlet001工程中，修改web.xml，在<servlet>节点中添加<init-param>节点:

 <?xml version="1.0" encoding="UTF-8"?>
 <web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xmlns="http://java.sun.com/xml/ns/javaee"
     xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd"
     id="WebApp_ID" version="3.0">

     <!-- 配置和映射 servlet -->
     <servlet>
         <!-- Servlet注册的名字 -->
         <servlet-name>helloServlet</servlet-name>
         <!-- Servlet全类名 -->
         <servlet-class>com.dx.hello.HelloServlet</servlet-class>

         <!-- 配置Servlet的初始化参数。且节点必须在 load-on-startup节点的前边 -->
         <init-param>
             <param-name>username</param-name>
             <param-value>user001</param-value>
         </init-param>
         <init-param>
             <param-name>password</param-name>
             <param-value>123456</param-value>
         </init-param>

         <!-- 指定servlet被初始化的时机 -->
         <load-on-startup>-1</load-on-startup>
     </servlet>
     <servlet-mapping>
         <!-- 对应servlet节点下的servlet-name的注册名字一致 -->
         <servlet-name>helloServlet</servlet-name>
         <!-- 映射具体的访问路径，其中/代表当前web的根目录 -->
         <url-pattern>/hello</url-pattern>
     </servlet-mapping>

 </web-app>

在配置参数时，需要注意事项：

<load-on-startup>节点必须在<init-param>节点的下边，否则会抛出异常信息，配置不通过。

之后再HelloServlet的init方法中，添加代码：

 public void init(ServletConfig config) throws ServletException {
         System.out.println("init");

         // 根据ServletConfig的getInitParameter()方法，根据特定初始化参数名称，获取对应的初始化参数值。
         String username = config.getInitParameter("username");
         String password = config.getInitParameter("password");
         System.out.println("username:" + username);
         System.out.println("password:" + password);

         // 根据ServletConfig的getInitParameterNames()方法，获取初始化参数信息。
         Enumeration<String> names = config.getInitParameterNames();
         while (names.hasMoreElements()) {
             String name = names.nextElement();
             String value = config.getInitParameter(name);
             System.out.println(name + ":" + value);
         }

         // 获取Servlet名称。
         String servletName = config.getServletName();
         System.out.println(servletName);

         ServletContext servletContext = config.getServletContext();
     }

重新启动tomcat，并在浏览器中输入地址：http://localhost:8080/MyServlet001/hello,回车，之后查看tomcat服务器输出信息：

INFO: Server startup in 1262 ms
HelloServlet constructor
init
username:user001
password:123456
username:user001
password:123456
helloServlet
service

从上边的输出信息，及代码中，就可以理解，getInitParameter(),getInitParameters(),getServletName()的用法。

ServletContext servletContext=config.getServletContext();

这个ServletContext是怎么解释，有什么用处呢?

我们查看官网对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.

ServletContext接口：

1、Servlet引擎为每个web应用程序都创建了一个对应的ServletContext对象，ServletContext对象被包含在ServletConfig对象中，调用ServletConfig.getServletContext()方法就可以返回ServletContext对象的引用。

2、由于一个web应用程序中的所有Servlet都共享一个ServletContext对象，所以ServletContext对象被称之为application对象（web应用程序对象）。

3、功能：

获取web应用程序的初始化参数；

记录日志；

application域范围的属性；

访问资源文件；

获取虚拟路径所映射的本地路径；

web应用程序之间的访问；

ServletContext的其他方法。

• 获取web应用程序的初始化参数；

首先，需要在web.xml中配置应用程序级别（<context-param>）的参数信息；

 <?xml version="1.0" encoding="UTF-8"?>
 <web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xmlns="http://java.sun.com/xml/ns/javaee"
     xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd"
     id="WebApp_ID" version="3.0">

     <!-- 配置当前web应用的初始化参数 -->
     <context-param>
         <param-name>driver</param-name>
         <param-value>com.mysql.jdbc.Driver</param-value>
     </context-param>
     <context-param>
         <param-name>jdbcUrl</param-name>
         <param-value>jdbc:mysql://test</param-value>
     </context-param>

     <!-- 配置和映射 servlet -->
     <servlet>
         <!-- Servlet注册的名字 -->
         <servlet-name>helloServlet</servlet-name>
         <!-- Servlet全类名 -->
         <servlet-class>com.dx.hello.HelloServlet</servlet-class>

         <!-- 配置Servlet的初始化参数。且节点必须在 load-on-startup节点的前边 -->
         <init-param>
             <param-name>username</param-name>
             <param-value>user001</param-value>
         </init-param>
         <init-param>
             <param-name>password</param-name>
             <param-value>123456</param-value>
         </init-param>

         <!-- 指定servlet被初始化的时机 -->
         <load-on-startup>-1</load-on-startup>
     </servlet>
     <servlet-mapping>
         <!-- 对应servlet节点下的servlet-name的注册名字一致 -->
         <servlet-name>helloServlet</servlet-name>
         <!-- 映射具体的访问路径，其中/代表当前web的根目录 -->
         <url-pattern>/hello</url-pattern>
     </servlet-mapping>

 </web-app>

注意：

　　这里的context-param是应用程级别的初始化参数，<servlet>节点下的<init-param>属于servlet局部的初始化参数，他们具有作用域范围不同。

然后，使用：

     public void init(ServletConfig config) throws ServletException {
         System.out.println("init");

         // 根据ServletConfig的getInitParameter()方法，根据特定初始化参数名称，获取对应的初始化参数值。
         String username = config.getInitParameter("username");
         String password = config.getInitParameter("password");
         System.out.println("username:" + username);
         System.out.println("password:" + password);

         // 根据ServletConfig的getInitParameterNames()方法，获取初始化参数信息。
         Enumeration<String> names = config.getInitParameterNames();
         while (names.hasMoreElements()) {
             String name = names.nextElement();
             String value = config.getInitParameter(name);
             System.out.println(name + ":" + value);
         }

         // 获取Servlet名称。
         String servletName = config.getServletName();
         System.out.println(servletName);

         // 使用getServletContext(),获取ServletContext对象。
         ServletContext servletContext = config.getServletContext();

         // ServletContext获取初始化参数函数getInitParameter(String arg0)
         String driver=servletContext.getInitParameter("driver");
         String jdbc=servletContext.getInitParameter("jdbc");
         System.out.println("driver:"+driver);
         System.out.println("jdbc:"+jdbc);

         // ServletContext获取初始化参数集合函数getInitParameterNames()
         Enumeration<String> names2= servletContext.getInitParameterNames();
         while (names2.hasMoreElements()) {
             String name = names2.nextElement();
             String value = servletContext.getInitParameter(name);
             System.out.println(name + ":" + value);
         }
     }

查看输出信息：

HelloServlet constructor
init
username:user001
password:123456
username:user001
password:123456
helloServlet
driver:com.mysql.jdbc.Driver
jdbcUrl:jdbc:mysql://test
driver:com.mysql.jdbc.Driver
jdbcUrl:jdbc:mysql://test
service

• 访问资源文件(获取当前web应用的某一个文件对应的输入流。)；

     // 获取当前web应用的某一个文件对应的输入流。
         try {
             ClassLoader classLoader = this.getClass().getClassLoader();
             InputStream stream = classLoader.getResourceAsStream("jdbc.properties");
             //stream with method0:java.io.BufferedInputStream@1cd3bd82
             System.out.println("stream with method0:"+stream);
         } catch (Exception e) {
             e.printStackTrace();
         }

         try {
             InputStream stream = servletContext.getResourceAsStream("/WEB-INF/classes/jdbc.properties");
             // stream with method1:java.io.FileInputStream@113eb097
             System.out.println("stream with method1:"+stream);
         } catch (Exception e) {
             e.printStackTrace();
         }

• 获取当前web应用的某一个文件，在服务器上的一个绝对路径

         // 获取当前web应用的某一个文件，在服务器上的一个绝对路径：
         // D:\java\workset\.metadata\.plugins\org.eclipse.wst.server.core\tmp0\wtpwebapps\MyServlet001\WEB-INF\web.xml
         String realPath=servletContext.getRealPath("/WEB-INF/web.xml");
         System.out.println(realPath);

• 获取web当前应用的名称；

        // 获取web当前应用的名称
        String webName=servletContext.getContextPath();
        // "/MyServlet001"
        System.out.println(webName);