ServletConfig对象的简介和使用

Java知识点总结：想看的可以从这里进入

3.6 ServletConfig

在每个Servlet创建时，就会有一个与之对应的ServleConfig对象创建，它代表了Servlet在XML文件中的元素。所以它的生命周期和对应的Servlet相同 (但如果Servlet配置了<load-on-startup></load-on-startup>，那么ServletConfig会在应用加载时创建)。

在 init 初始化方法中的参数就是ServletConfig类型的，所以当Tomcat调用 init 方法时会传递ServletConfig对象，在 init 中就可以使用此对象。

ServletConfig只能在自己所对应的Servlet中使用，在init中和直接使用，在其他地方可以使用this.getServletConfig()获取（当类继承HttpServlet时，如果重写了init方法，必须加上 super.init(servletconfig)，才能使用getServletConfig获取到）。

ServletConfig有两种获取方式：

1. 通过设置类属性从init方法中获取

   //第一种获取方式
   public class UseHttpServletTest extends HttpServlet {
       private ServletConfig config;
        @Override
       public void init(ServletConfig config) throws ServletException {
           //从带参init方法中，提取ServletConfig对象
           this.config = config;
       }
       @Override
       protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
           this.doPost(request,response);
       }
       @Override
       protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
       }
   }
   

2. 使用getServletConfig()方法获取

   //第一种获取方式
   public class UseHttpServletTest extends HttpServlet {
       @Override
       protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
           this.doPost(request,response);
       }
       @Override
       protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
           //如果重写了 init方法，则在init方法内加上super.init(config);即可使用
           //不重写init方法，可直接使用
           ServletConfig servletConfig = this.getServletConfig();
       }
   }
   

ServletConfig提供了四个方法：

方法	功能描述
String getInitParameter(String name)	根据初始化参数名 name，返回对应的初始化参数值。
Enumeration getInitParameterNames()	返回 Servlet 所有的初始化参数名的枚举集合，如果该 Servlet 没有初始化参数，则返回一个空的集合。
ServletContext getServletContext()	返回一个代表当前 Web 应用的 ServletContext 对象。
String getServletName()	返回 Servlet 的名字，即 web.xml 中 元素的值。
ServletConfi主要作用是：

1. 可以获取servlet程序的别名servlet-name的值

2. 获取初始化参数init-param

3. 获取ServletContext对象

3.6.1 Servlet名

@Override
public void init(ServletConfig servletConfig) throws ServletException {
    //web.xml中每个Servlet类相对应的<servlet-name>中配置的别名
    ServletConfig config = this.getServletConfig();
    String servletName = config.getServletName();
    PrintWriter out = response.getWriter();
    out.write("获取到的servletName："+servletName+"<br/>");
}

3.6.2 初始化参数

<!--在xml的servlet中可以配置初始化的参数  -->
<servlet>
    <servlet-name>Test1Servlet</servlet-name>
    <servlet-class>com.yu.servlet.Test1Servlet</servlet-class>
    <init-param>	<!--初始化参数  -->
        <param-name>name</param-name>
        <param-value>羽</param-value>
    </init-param>
    <init-param>	<!--初始化参数  -->
        <param-name>gender</param-name>
        <param-value>男</param-value>
    </init-param>
</servlet>

//获取初始化的值
@Override
protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
    //设置字符编码
    request.setCharacterEncoding("utf-8");
    response.setContentType("text/html;charset = utf-8");
    PrintWriter out = response.getWriter();
	//获取 ServletConfig对象
    ServletConfig servletConfig = this.getServletConfig();
    if (servletConfig != null){
        //获取所有的param-name
        Enumeration<String> initParameterNames = servletConfig.getInitParameterNames();
        while (initParameterNames.hasMoreElements()){
            //获取每个param-name的值
            String paramName = initParameterNames.nextElement();
            //根据param-name获取param-value的值
            String paramValue = servletConfig.getInitParameter(paramName);
            out.write("param-name："+paramName+"。param-value:"+paramValue+"<br/>");
        }
    }else {
        response.getWriter().println("获取失败");
    }
}

3.6.3 获取Context

this.getServletContext()方法的实质是一样是通过ServletContext对象的getServletContext()方法获取的。

//获取ServletContext对象
ServletContext servletContext = servletConfig.getServletContext();