ServletConfig是什么

(*-*)浩 原创: 2020-09-15 14:36:17 6387浏览

ServletConfig是指当前servlet在web.xml文件中的配置信息。开发者通过ServletConfig对象就可以得到当前servlet的初始化参数信息。

刚开始接触Spring MVC框架，对框架了解之后很想知道这个框架是怎么运行，就慢慢地摸索着看看源码。第一个拦路虎就是Servletconfig。发现在servlet的实现类中经常出现。不仅就要问这个是干什么的？

推荐课程：Java教程

ServletConfig

ServletConfig代表的是当前servlet在web.xml中的配置信息

String getServletName()  -- 获取当前Servlet在web.xml中配置的名字
String getInitParameter(String name) -- 获取当前Servlet指定名称的初始化参数的值
Enumeration getInitParameterNames()  -- 获取当前Servlet所有初始化参数的名字组成的枚举
ServletContext getServletContext()  -- 获取代表当前web应用的ServletContext对象

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

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

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

代码实例：

<servlet>
        <servlet-name>ServletConfigTest</servlet-name>
        <servlet-class>com.vae.servlet.ServletConfigTest</servlet-class>
        <init-param>
            <param-name>name1</param-name>
            <param-value>value1</param-value>
        </init-param>
        <init-param>
            <param-name>encode</param-name>
            <param-value>utf-8</param-value>
        </init-param>
</servlet>

然后在代码中获取上面的两个参数。代码实现如下：

package com.vae.servlet;
 
import java.io.IOException;
import java.util.Enumeration;
 
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 ServletConfigTest extends HttpServlet {
 
    public void doGet(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {
 
        ServletConfig config = this.getServletConfig();  //拿到init方法中的ServletConfig对象
 
        // --获取当前Servlet 在web.xml中配置的名称（用的不多）
         String sName = config.getServletName();
         System.out.println("当前Servlet 在web.xml中配置的名称:"+sName);
         
        // --获取当前Servlet中配置的初始化参数（只能获取一个）经常用到
        // String value = config.getInitParameter("name2");
        // System.out.println(value);
 
        // --获取当前Servlet中配置的初始化参数（全部获取）经常用到
         Enumeration enumration = config.getInitParameterNames();
         while(enumration.hasMoreElements()){
         String name = (String) enumration.nextElement();
         String value = config.getInitParameter(name);
         System.out.println(name+":"+value);
         }
    }
 
    public void doPost(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {
        doGet(request, response);
    }
}

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

运行程序，后台打印日志如下：