ServletContext 详解

ServletContext 详解

ServletContext 是 Java Servlet API 中的核心接口，代表整个 Web 应用程序的运行环境，也称为"应用上下文"。

一、ServletContext 核心概念

1. 基本特征

• 全局唯一性：每个 Web 应用有且只有一个 ServletContext 对象
• 生命周期：从应用启动到关闭一直存在
• 共享性：所有 Servlet 和用户共享同一个上下文
• 资源访问：提供访问 Web 应用资源的统一入口

2. 获取方式

// 通过 ServletConfig 获取
ServletContext context = getServletConfig().getServletContext();

// GenericServlet 和 HttpServlet 提供的快捷方式
ServletContext context = getServletContext();

二、核心功能详解

1. 获取应用初始化参数

配置在 web.xml 中的 <context-param>：

<context-param>
    <param-name>appName</param-name>
    <param-value>MyWebApp</param-value>
</context-param>

获取方式：

String appName = getServletContext().getInitParameter("appName");
Enumeration<String> paramNames = getServletContext().getInitParameterNames();

2. 属性操作（应用作用域）

// 设置属性
getServletContext().setAttribute("userCount", 100);

// 获取属性
Integer count = (Integer) getServletContext().getAttribute("userCount");

// 移除属性
getServletContext().removeAttribute("userCount");

// 获取所有属性名
Enumeration<String> attrs = getServletContext().getAttributeNames();

3. 资源访问

// 获取真实路径
String realPath = getServletContext().getRealPath("/WEB-INF/web.xml");

// 获取资源流
InputStream is = getServletContext().getResourceAsStream("/WEB-INF/web.xml");

// 获取资源目录
Set<String> paths = getServletContext().getResourcePaths("/");

4. 日志记录

getServletContext().log("用户登录异常", exception);

5. 获取服务器信息

String serverInfo = getServletContext().getServerInfo();
int majorVersion = getServletContext().getMajorVersion();
int minorVersion = getServletContext().getMinorVersion();

三、ServletContext 实际应用

1. 全局计数器示例

// 初始化计数器
public class CounterListener implements ServletContextListener {
    @Override
    public void contextInitialized(ServletContextEvent sce) {
        sce.getServletContext().setAttribute("counter", new AtomicInteger(0));
    }
}

// 使用计数器
public class VisitServlet extends HttpServlet {
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) {
        AtomicInteger counter = (AtomicInteger) getServletContext().getAttribute("counter");
        int visits = counter.incrementAndGet();
        resp.getWriter().write("总访问量: " + visits);
    }
}

2. 配置文件加载

public class ConfigLoader {
    private static Properties props;
    
    public static void load(ServletContext context) {
        try (InputStream is = context.getResourceAsStream("/WEB-INF/config.properties")) {
            props = new Properties();
            props.load(is);
        } catch (IOException e) {
            context.log("加载配置文件失败", e);
        }
    }
    
    public static String getProperty(String key) {
        return props.getProperty(key);
    }
}

四、ServletContext 与 ServletConfig 对比

五、高级特性

1. 动态注册组件（Servlet 3.0+）

ServletRegistration.Dynamic registration = 
    getServletContext().addServlet("dynamic", DynamicServlet.class);
registration.addMapping("/dynamic/*");

2. 获取 MIME 类型

String mimeType = getServletContext().getMimeType("example.pdf");
// 返回 "application/pdf"

3. 请求分发

RequestDispatcher dispatcher = 
    getServletContext().getRequestDispatcher("/otherServlet");
dispatcher.forward(request, response);

六、最佳实践

1. 合理使用应用作用域：

   • 适合存储只读或线程安全的对象
   • 避免存储大对象

2. 资源管理：

   • 使用 getResourceAsStream() 替代文件操作
   • 注意及时关闭资源流

3. 初始化操作：

   • 使用 ServletContextListener 进行应用初始化
   • 避免在 Servlet 中直接初始化全局资源

4. 线程安全：

   • 对共享可变数据使用同步机制
   • 考虑使用 ConcurrentHashMap 等线程安全集合

5. 合理使用日志：

   • 区分不同级别的日志信息
   • 记录有意义的上下文信息