Servlet教程

ServletConfig对象

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

ServletConfig 接口中定义了一系列获取配置信息的方法,如表 1 所示。

表 1 ServletConfig接口的常用方法

方法说明

功能描述

String getInitParameter(String name)

根据初始化参数名返回对应的初始化参数值

Enumeration getInitParameterNames()

返回一个 Enumeration 对象,其中包含了所有的初始化参数名

ServletContext getServletContext()

返回一个代表当前 Web 应用的 ServletContext 对象

String getServletName()

返回 Servlet 的名字,即 web.xml 中  元素的值

下面以 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();
        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>

在上面的参数信息中,<init-param> 节点表示要设置的参数,该节点中的 表示参数的名称, <param-value>表示参数的值,在 <init-param>节点中为 TestServlet02 配置了一个名为 encoding 的参数,并设置其参数的值为 UTF-8。

3、运行项目并查看结果

启动 Tomcat 服务器,在浏览器的地址栏中输入地址 http://localhost:8080/servletDemo01/TestServlet02 访问 TestServlet02,结果如图 1 所示。

图 1 运行结果

从图 1 中可以看出,web.xml 文件中为 TestServlet02 配置的编码信息被读取了出来。由此可见,通过 ServletConfig 对象可以获得 web.xml 文件中的参数信息。