[Java知识库]ServletConfig接口的学习

ServletConfig接口的学习

1. ServletConfig是什么？

   ServletConfig是一个接口。（jakarta.servlet.Servlet是一个接口。）Servlet对象的配置信息对象。

2. 谁去实现了这个接口呢？ WEB服务器实现了

   public class org.apache.catalina.core.StandardWrapperFacade implements ServletConfig {}
   

   结论：Tomcat服务器实现了ServletConfig接口。

   思考：如果把Tomcat服务器换成jetty服务器，输出ServletConfig对象的时候，还是这个结果吗？

   不一定一样，包名类名可能和Tomcat不一样。但是他们都实现了ServletConfig这个规范。

3. 一个Servlet对象中有一个ServletConfig对象。（Servlet和ServletConfig对象是一对一。）

   100个Servlet，就应该有100个ServletConfig对象。

4. Tomcat服务器调用Servlet对象的init方法的时候需要传一个ServletConfig对象的参数给init方法。

5. ServletConfig对象是谁创建的？在什么时候创建的？

   Tomcat服务器（WEB服务器）创建了ServletConfig对象。在创建Servlet对象的时候，同时创建ServletConfig对象。默认情况下，他们都是在用户发送第一次请求的时候创建。

6. ServletConfig接口到底是干啥的？有什么用呢？

   Config是哪个单词的缩写？Configuration

   ServletConfig对象被翻译为：Servlet对象的配置信息对象。

   一个Servlet对象就有一个配置信息对象。两个Servlet对象就有两个配置信息对象。

7. ServletConfig对象中到底包装了什么信息呢？

   ServletConfig对象中包装的信息是：web.xml文件中<servlet></servlet>标签的配置信息。

   Tomcat解析web.xml文件，将web.xml文件中<servlet></servlet>标签中的配置信息自动包装到ServletConfig对象中。

   <servlet>
   	<servlet-name>ConfigTest01</servlet-name>
       <servlet-class>ConfigTestServlet01</servlet-class>
       <!--这里是可以配置一个Servlet对象的初始化信息的。-->
       <init-param>
       	<param-name>key</param-name>
           <param-value>value</param-value>
   	</init-param>
   </servlet>
   

   以上<servlet></servlet>标签中的<init-param></init-param>是初始化参数。这个初始化参数信息会自动被Tomcat封装到ServletConfig对象当中。

8. ServletConfig接口中有哪些方法？

   ServletConfig接口中有4个方法：

   public String getInitParameter(String name); // 根据<param-name></param-name>中的内容获取对应的<param-value></param-value>值，参数是<param-name></param-name>的值
   public Enumeration<String> getInitParameterNames(); // 获取所有的初始化参数<param-name></param-name>标签中的内容(name)
   public ServletContext getServletContext();
   public String getServletName();
   

   以上的4个方法，在自己编写的Servlet类当中也可以使用this去调用。（这个Servlet继承了GenericServlet）

import jakarta.servlet.*;

import java.io.IOException;
import java.io.PrintWriter;
import java.util.Enumeration;

public class ConfigTestServlet01 extends GenericServlet {
    @Override
    public void service(ServletRequest request, ServletResponse response) throws ServletException, IOException {
        response.setContentType("text/html");
        PrintWriter printWriter = response.getWriter();
        // 获取ServletConfig对象
        ServletConfig servletConfig = this.getServletConfig();
        // 输出该对象
        printWriter.println("ServletConfig01对象是:"+servletConfig+"<br/>");
        // ServletConfig01对象是:org.apache.catalina.core.StandardWrapperFacade@8021894

        // 获取<servlet-name></servlet-name>
        String servletName = servletConfig.getServletName();
        printWriter.println("<servlet-name>"+servletName+"<servlet-name>"+"<br/>");

        // 通过ServletConfig对象的两个方法，可以获取到web.xml文件中的初始化参数配置信息。
        Enumeration<String> initParameterNames = servletConfig.getInitParameterNames(); // 获取所有的初始化参数的name
        // 遍历集合
        while (initParameterNames.hasMoreElements()){ // 是否有更多元素
            String parameterName = initParameterNames.nextElement(); // 取元素
            // String initParameter = servletConfig.getInitParameter(parameterName); // 通过name获取value
            String initParameter = this.getInitParameter(parameterName); // 与上面的方式等价，因为这个类继承了GenericServlet，而GenericServlet中实现了getInitParameter这个方法
            printWriter.println(parameterName+"="+initParameter+"<br/>");
        }
    }
}