Javaweb —— ServletConfig和ServletContext接口

ゝ一纸荒年。 2024-04-19 09:48 79阅读 0赞

### 文章目录 ###

*   *  ServletConfig接口
     *  ServletContext接口

## ServletConfig接口 ##

在运行 Servlet 程序时，可能需要一些辅助信息，例如，文件使用的编码、使用 Servlet 程序的共享信息等，这些信息可以在 web.xml 文件中使用一个或多个 元素进行配置。当 Tomcat 初始化一个 Servlet 时，会将该 Servlet 的配置信息封装到 ServletConfig 对象中，此时可以通过调用 init（ServletConfig config）方法将 ServletConfig 对象传递给 Servlet。

ServletConfig 接口中定义了一系列获取配置信息的方法，如表 1 所示。  
表 1 ServletConfig接口的常用方法  
![在这里插入图片描述][20190916193736323.png]  
下面以 getInitParameter() 方法为例，分步骤讲解该方法的使用。  
**1）创建Servlet**  
在 com.mengma.servlet 包中创建一个名称为 TestServlet02 的 Servlet 类，并在类中编写用于读取 web.xml 文件中参数信息的代码，如下所示。

package com.mengma.servlet;
    
    import java.io.IOException;
    import java.io.PrintWriter;
    
    import javax.servlet.ServletConfig;
    import javax.servlet.ServletException;
    import javax.servlet.http.HttpServlet;
    import javax.servlet.http.HttpServletRequest;
    import javax.servlet.http.HttpServletResponse;
    
    public class TestServlet02 extends HttpServlet {
    
        protected void doGet(HttpServletRequest request,HttpServletResponse response) throws ServletException, IOException {
            PrintWriter out = response.getWriter();
            ServletConfig config = this.getServletConfig(); //获得ServletConfig对象
            String param = config.getInitParameter("encoding");
            out.println("encoding=" + param);
        }
    
        protected void doPost(HttpServletRequest request,HttpServletResponse response) throws ServletException, IOException {
            this.doGet(request, response);
        }
    
    }

**2）配置参数信息**  
在 web.xml 文件中为 Servlet 配置一些参数信息，具体的配置代码如下所示：

<servlet>
      <servlet-name>TestServlet02</servlet-name>
      <servlet-class>com.mengma.servlet.TestServlet02</servlet-class>
      <init-param>
          <param-name>encoding</param-name>
          <param-value>UTF-8</param-value>
      </init-param>
    </servlet>
    <servlet-mapping>
      <servlet-name>TestServlet02</servlet-name>
      <url-pattern>/TestServlet02</url-pattern>
    </servlet-mapping>

在上面的参数信息中， 节点表示要设置的参数，该节点中的 表示参数的名称， 表示参数的值，在 节点中为 TestServlet02 配置了一个名为 encoding 的参数，并设置其参数的值为 UTF-8。  
**3）运行项目并查看结果**  
启动 Tomcat 服务器，在浏览器的地址栏中输入地址 http://localhost:8080/servletDemo01/TestServlet02 访问 TestServlet02，结果如图 1 所示。  
![在这里插入图片描述][20190916193957630.png]  
从图 1 中可以看出，web.xml 文件中为 TestServlet02 配置的编码信息被读取了出来。由此可见，通过 ServletConfig 对象可以获得 web.xml 文件中的参数信息。

## ServletContext接口 ##

当 Tomcat 启动时，Tomcat 会为每个 Web 应用创建一个唯一的 ServletContext 对象代表当前的 Web 应用，该对象封装了当前 Web 应用的所有信息。可以利用该对象获取 Web 应用程序的初始化信息、读取资源文件等。下面对 ServletContext 接口的不同作用分别进行讲解。

**1. 获取 Web 应用程序的初始化参数**  
在 web.xml 文件中，不仅可以配置 Servlet 的映射信息，还可以配置整个 Web 应用的初始化信息。Web 应用初始化参数的配置方式具体如下所示：

<context-param>
        <param-name>XXX</param-name>
        <param-value>xxx</param-value>
    </context-param>
    <context-param>
        <param-name>AAA</param-name>
        <param-value>aaa</param-value>
    </context-param>

在上面的示例中， 元素位于根元素 中，它的子元素 和 分别用于指定参数的名字和参数值。要想获取这些参数名和参数值的信息，可以使用 ServletContext 接口中定义的 getInitParameterNames() 和 getInitParameter（String name）方法分别获取。  
下面通过案例演示如何使用 ServletContext 接口获取 Web 应用程序的初始化参数。

1）在 servletDemo01 项目的 web.xml 文件中配置初始化参数信息和 Servlet 信息，其代码如下所示：

<context-param>
        <param-name>username</param-name>
        <param-value>admin</param-value>
    </context-param>
    <context-param>
        <param-name>password</param-name>
        <param-value>1234</param-value>
    </context-param>
    <servlet>
        <servlet-name>TestServlet03</servlet-name>
        <servlet-class>com.mengma.servlet.TestServlet03</servlet-class>
    </servlet>
    <servlet-mapping>
        <servlet-name>TestServlet03</servlet-name>
        <url-pattern>/TestServlet03</url-pattern>
    </servlet-mapping>

2）在项目的 com.mengma.servlet 包中创建一个名称为 TestServlet03 的类，该类中使用 ServletContext 接口获取 web.xml 中的配置信息，如下所示。

package com.mengma.servlet;
    
    import java.io.IOException;
    import java.io.PrintWriter;
    import java.util.Enumeration;
    
    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 TestServlet03 extends HttpServlet {
    
        public void doGet(HttpServletRequest request, HttpServletResponse response)
          throws ServletException, IOException {
    
            response.setContentType("text/html;charset=utf-8");
            PrintWriter out = response.getWriter();
            // 得到ServletContext对象
            ServletContext context = this.getServletContext();
            // 得到包含所有初始化参数名的Enumeration对象
            Enumeration<String> paramNames = context.getInitParameterNames();
            // 遍历所有的初始化参数名，得到相应的参数值并打印
            while (paramNames.hasMoreElements()) {
              String name = paramNames.nextElement();
              String value = context.getInitParameter(name);
              out.println(name + ":" + value);
              out.println("<br/>");
        }
    }
    
        public void doPost(HttpServletRequest request, HttpServletResponse response)
          throws ServletException, IOException {
            this.doGet(request, response);
        }
    }

上述代码中，当通过 this.getServletContext() 方法获取到 ServletContext 对象后，首先调用 getInitParameterNames() 方法，获取到包含所有初始化参数名的 Enumeration 对象，然后遍历 Enumeration 对象，根据获取到的参数名，通过 getInitParamter（String name）方法得到对应的参数值。

3）启动 Tomcat 服务器，在浏览器的地址栏中输入地址 http://localhost:8080/servletDemo01/TestServlet03 访问 TestServlet03，浏览器的显示结果如图 2 所示。  
![在这里插入图片描述][2019091619433219.png]  
从图 2 中可以看出，web.xml 文件中配置的信息被读取了出来。由此可见，通过 ServletContext 对象可以获取 Web 应用的初始化参数。

**2. 读取 Web 应用下的资源文件**  
在实际开发中，有时会需要读取 Web 应用中的一些资源文件，如配置文件和日志文件等。为此，在 ServletContext 接口中定义了一些读取 Web 资源的方法，这些方法是依靠 Servlet 容器实现的。Servlet 容器根据资源文件相对于 Web 应用的路径，返回关联资源文件的 I/O 流或资源文件在系统的绝对路径等。

表 2 中列举了 ServletContext 接口中用于获取资源路径的相关方法。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xhbjM2Mjk3OTY_size_16_color_FFFFFF_t_70]  
了解了 ServletContext 接口中用于获得 Web 资源路径的方法后，下面通过案例分步骤演示如何使用 ServletContext 对象读取资源文件。  
案例分步骤演示如何使用 ServletContext 对象读取资源文件。

1）在 servletDemo01 项目的 src 目录中创建一个名称为 itcast.properties 的文件，在创建好的文件中输入如下所示的配置信息：

username=admin
    password=1234

2）在 com.mengma.servlet 包中创建一个名称为 TestServlet04 的 Servlet 类，使用该类读取 itcast.properties 资源文件的内容，其实现代码如下所示。

package com.mengma.servlet;
    
    import java.io.IOException;
    import java.io.InputStream;
    import java.io.PrintWriter;
    import java.util.Properties;
    
    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 TestServlet04 extends HttpServlet {
    
        public void doGet(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {
    
            response.setContentType("text/html;charset=utf-8");
            ServletContext context = this.getServletContext();
            PrintWriter out = response.getWriter();
            // 获取相对路径中的输入流对象
            InputStream in = context
                .getResourceAsStream("/WEB-INF/classes/itcast.properties");
            Properties pros = new Properties();
            pros.load(in);
            out.println("username=" + pros.getProperty("username") + "<br/>");
            out.println("password=" + pros.getProperty("password") + "<br/>");
        }
    
        public void doPost(HttpServletRequest request, HttpServletResponse response)
          throws ServletException, IOException {
    
            this.doGet(request, response);
        }
    }

在上述代码中，使用 ServletContext 的 getResourceAsStream（String path）方法获得了关联 itcast.properties 资源文件的输入流对象，其中的 path 参数必须以正斜线（/）开始，表示 itcast.properties 文件相对于 Web 应用的相对路径。

3）启动 Tomcat 服务器，在浏览器的地址栏中输入地址 http://localhost:8080/servletDemo01/TestServlet04 访问 TestServlet04，浏览器的显示结果如图 3 所示。  
![在这里插入图片描述][20190916194635766.png]  
从图 3 中可以看出，itcast.properties 资源文件中的内容已经被读取了出来。由此可见，使用 ServletContext 可以读取 Web 应用中的资源文件。

[20190916193736323.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/18/1b43fa781399494b80933601008db764.png
[20190916193957630.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/18/e7017ec670234326a8e1e65e30488269.png
[2019091619433219.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/18/2ddc3c5bbbd44c4286da3e430066eb52.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xhbjM2Mjk3OTY_size_16_color_FFFFFF_t_70]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/18/181ba2ed3b184a96a7676415057236b8.png
[20190916194635766.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/18/885cc029a6104dba995d7e85b2966ba3.png