ServletConfig、ServletContext超详细讲解

---

前言

ServletConfig接口代表了Servlet的配置信息，它允许Servlet获取初始化参数和Servlet容器提供的其他信息。而ServletContext接口则代表了整个Web应用的全局环境，提供了一种机制来存储和访问Web应用范围内的属性和资源。
理解这两个接口的工作原理和使用场景，对于构建可维护、可扩展的Web应用程序至关重要。它们不仅关系到Servlet的初始化和配置，还涉及到Web应用的上下文管理和资源共享。
本文将深入探讨ServletConfig和ServletContext的概念、用途以及它们在实际开发中的应用。我们将从基础概念讲起，逐步深入到高级特性和最佳实践，帮助读者全面掌握这两个接口的使用方法。

一、ServletConfig的使用

1.ServletConfig定义

为Servlet提供初始配置参数的一种对象，每个Servlet都有自己独立唯一的ServletConfig对象； 容器会为每个Servlet实例化一个ServletConfig对象，并通过Servlet生命周期的init方法传入给Servlet 作为属性；

2.ServletConfig的API

方法名	作用
getServletName()	获取HelloServlet定义的Servlet名称。
getServletContext()	获取ServletContext对象。
getInitParameter()	获取配置Servlet时设置的『初始化参数』，根据名字获取值。
getInitParameterNames()	获取所有初始化参数名组成的Enumeration对象。

3.ServletConfig的测试代码：

public class ServletA extends HttpServlet {
    @Override
    protected void service(HttpServletRequest req, HttpServletResponse resp) 
                                 throws ServletException, IOException {
        ServletConfig servletConfig=this.getServletConfig();
        // 根据参数名获取单个参数
        String value=servletConfig.getInitParameter("param1");
        System.out.println("param1:"+value);
        // 获取所有参数名
        Enumeration<String>parameterNames=servletConfig.getInitParameterNames();        
        // 迭代并获取参数名
        while (parameterNames.hasMoreElements()) {
                    StringparamaterName=parameterNames.nextElement();
           
 System.out.println(paramaterName+":"+servletConfig.getInitParameter(paramaterName));        }
    }
}

二、 ServletContext的使用

1.ServletContext定义

ServletContext对象有称呼为上下文对象，或者叫应用域对象(后面统一讲解域对象)；
容器会为每个app创建一个独立的唯一的ServletContext对象；
ServletContext对象为所有的Servlet所共享；
ServletContext可以为所有的Servlet提供初始配置参数；

2.ServletContext如何用

1.配置ServletContext参数

<?xmlversion="1.0" encoding="UTF-8"?>
<web-appxmlns="https://jakarta.ee/xml/ns/jakartaee"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="https://jakarta.ee/xml/ns/jakartaee https://jakarta.ee/xml/ns/jakartaee/web-app_5_0.xsd"
         version="5.0">
    <context-param>
        <param-name>paramA</param-name>
        <param-value>valueA</param-value>
    </context-param>
    <context-param>
        <param-name>paramB</param-name>
        <param-value>valueB</param-value>
    </context-param>
</web-app>

2.在Servlet中获取ServletContext并获取参数

public class ServletA extends HttpServlet {
    @Override
    protected void service(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException { 
        // 从ServletContext中获取为所有的Servlet准备的参数
        ServletContext servletContext=this.getServletContext();
                String valueA=servletContext.getInitParameter("paramA");
        System.out.println("paramA:"+valueA);
        // 获取所有参数名
        Enumeration<String>initParameterNames=
servletContext.getInitParameterNames();
        // 迭代并获取参数名
        while (initParameterNames.hasMoreElements()) {
            String paramaterName=initParameterNames.nextElement();
           
 System.out.println(paramaterName+":"+servletContext.getInitParameter(paramaterName));        }
    }
}

3. ServletContext其他重要API

获取资源的磁盘路径：	String realPath=servletContext.getRealPath("资源在web目录中的路径");
获取项目的上下文路径：	String contextPath=servletContext.getContextPath();

域对象的相关API：

API	功能解释
void setAttribute(String key,Object value);	向域中存储/修改数据
Object getAttribute(String key);	获得域中的数据
void removeAttribute(String key);	移除域中的数据

总结

以上就是今天要讲的内容，本文仅仅介绍了ServletConfig、ServletContext的使用，提供了一些常用的API，希望对各位小伙伴们有所帮助