ServletContext简介说明

下文笔者讲述"ServletContext简介"，如下所示

ServletContext简介

`ServletContext`是Java Servlet API中的一个核心接口
   指Web应用上下文环境
     它是整个Web应用程序的“全局对象”
	 在整个应用中共享
	 用于在多个 Servlet、Filter 和 listener 之间
	  传递数据或获取应用级别的资源

`ServletContext`功能

功能	描述
获取 Web 应用的全局信息	如应用名称、部署路径、初始化参数等
存储和共享全局数据	使用 `setAttribute()` / `getAttribute()` 在整个应用中共享数据
访问 Web 资源	如读取配置文件、静态资源（HTML、图片）等
日志记录	使用 `log()` 方法记录日志信息
获取类加载器	用于加载 Web 应用中的类或资源

`ServletContext`接口继承关系

public interface ServletContext {
    // 全局上下文方法定义
}

常用方法说明

获取上下文信息

方法名	描述
`getServletContextName()`	获取 Web 应用的名称（如在 `web.xml` 中配置）
`getContextPath()`	获取应用的上下文路径（如 `/myapp`）
`getInitParameter(String name)`	获取 Web 应用的初始化参数
`getInitParameterNames()`	获取所有初始化参数的名称枚举

例：

String appName = context.getServletContextName();
String path = context.getContextPath();
String param = context.getInitParameter("configLocation");

获取资源路径和输入流

方法名	描述
`getResourceAsStream(String path)`	获取 Web 应用中资源的输入流（如 `/WEB-INF/config.properties`）
`getRealPath(String path)`	获取资源在服务器上的真实路径（不推荐使用）
`getResource(String path)`	获取资源的 URL 对象

例：

InputStream is = context.getResourceAsStream("/WEB-INF/config.properties");
Properties props = new Properties();
props.load(is);

数据共享（全局属性）

方法名	描述
`setAttribute(String name, Object object)`	将对象绑定到 ServletContext，供其他组件访问
`getAttribute(String name)`	获取之前设置的属性
`removeAttribute(String name)`	移除指定属性

例：

context.setAttribute("appStartTime", System.currentTimeMillis());
Long startTime = (Long) context.getAttribute("appStartTime");

日志记录

方法名	描述
`log(String msg)`	写入日志信息到容器日志文件中
`log(String message, Throwable throwable)`	写入带异常的日志信息

例：

  context.log("应用启动时间：" + new Date(startTime));

例

@WebServlet("/init")
public class InitServlet extends HttpServlet {
    @Override
    protected void doGet(HttpServletRequest request, HttpServletResponse response)
            throws IOException {

        ServletContext context = getServletContext();

        // 获取初始化参数
        String configLocation = context.getInitParameter("configLocation");
        System.out.println("Config Location: " + configLocation);

        // 加载配置文件
        try (InputStream is = context.getResourceAsStream("/WEB-INF/app.properties")) {
            Properties props = new Properties();
            props.load(is);
            System.out.println("Loaded properties: " + props);
        }

        // 设置全局属性
        context.setAttribute("appStartTime", System.currentTimeMillis());

        // 返回响应
        response.setContentType("text/html");
        PrintWriter out = response.getWriter();
        out.println("<h1>ServletContext 初始化完成</h1>");
    }
}

对应`web.xml`配置

<context-param>
    <param-name>configLocation</param-name>
    <param-value>/WEB-INF/config.properties</param-value>
</context-param>

ServletContext相关说明

 `ServletContext` 是全局唯一的 
   所有用户、请求共享同一个上下文 
 属性生命周期长 
   从应用启动到关闭一直存在，注意内存泄漏风险 
 不适合存储大量数据 
    会影响性能，建议使用缓存框架替代 
 可用于监听器初始化
    在`ServletContextListener`中进行全局初始化操作

ServletContext适用场景

场景	使用方式
全局配置加载	在应用启动时加载配置文件
全局计数器	统计在线人数、访问次数等
日志统一管理	所有组件通过 `context.log()` 输出日志
资源共享	多个 Servlet 或 Filter 共享数据
应用级事件监听	在 `ServletContextListener` 中执行初始化/销毁逻辑