作用:用于获取全局共享的应用级属性,并允许跨 Servlet 共享数据。
ServletContext 是 Java Servlet API 中的一个重要接口,它表示整个 Web 应用的上下文环境,允许 Servlet 和 JSP 之间共享配置信息、资源、属性等。
ServletContext 提供了访问 Web 应用级别的配置信息、文件资源、应用级别的初始化参数等功能。
11.9.14.1.什么是ServletContext
ServletContext 是由 Servlet 容器创建的,并且是 Web 应用级别的对象。
提供了多种方法,用于在 Web 应用的各个 Servlet 和 JSP 之间共享数据和资源。
可以通过 ServletContext 对象访问整个 Web 应用的资源、属性、日志等信息。
11.9.14.2.获取 ServletContext 对象
ServletContext 对象通常通过以下方式获取:
1)从 HttpServlet 中获取:可以通过 getServletContext() 方法获取。
|-----------------------------------------------|
| ServletContext context = getServletContext(); |
2)从 ServletConfig 中获取:在 init() 方法中,通过 ServletConfig 对象获取 ServletContext。
|------------------------------------------------------|
| ServletContext context = config.getServletContext(); |
11.9.14.3.ServletContext 的常用方法
ServletContext 提供了多种方法来管理和访问 Web 应用的资源和配置,下面列出了几个常用方法。
1 )获取初始化参数
通过 ServletContext 获取应用级的初始化参数,通常这些参数是在 web.xml 配置文件中定义的。
如果web.xml 中配置了如下内容:
|--------------------------------------------------------------------------------------------------------------------------------------------------|
| <web-app> <context-param> <param-name>appConfig</param-name> <param-value>config_value</param-value> </context-param> </web-app> |
通过 ServletContext 获取 appConfig 参数的值:
|-----------------------------------------------------------|
| String appConfig = context.getInitParameter("appConfig"); |
2 )获取 Web 应用的资源路径
ServletContext 提供了 getRealPath() 方法,用于获取 Web 应用内的文件路径。这个方法返回的是文件在文件系统中的实际路径。
|-----------------------------------------------------------------|
| String realPath = context.getRealPath("/WEB-INF/someFile.txt"); |
注意:getRealPath() 返回的是文件系统路径,只有在部署在本地文件系统时才有效。如果在某些容器(如 Tomcat)内部署时,可能返回 null,因此不推荐将其用于生产环境中的绝对路径引用。
3 )获取 Web 应用的资源(如文件)
ServletContext 还提供了 getResource() 和 getResourceAsStream() 方法,可以用于获取 Web 应用中的静态资源或输入流。
获取资源的 URL :
|--------------------------------------------------------------|
| URL resource = context.getResource("/WEB-INF/someFile.txt"); |
获取资源的输入流:
|------------------------------------------------------------------------------------|
| InputStream resourceStream = context.getResourceAsStream("/WEB-INF/someFile.txt"); |
4 )设置和获取属性
ServletContext 可以用于存储共享数据,通过 setAttribute() 和 getAttribute() 方法将数据存储在 Web 应用的上下文中。
设置属性:
|-------------------------------------------------|
| context.setAttribute("sharedData", someObject); |
获取属性:
|---------------------------------------------------------|
| Object sharedData = context.getAttribute("sharedData"); |
这种方式允许不同的 Servlet 或 JSP 共享数据,适用于 Web 应用中的全局信息。
5 )记录日志
ServletContext 提供了 log() 方法,用于记录 Web 应用的日志信息。
可以帮助你在开发和生产环境中记录调试信息或错误信息。
记录日志:
|--------------------------------------------------------------------------------|
| context.log("This is a log message"); context.log("Error message", exception); |
6 )获取 ServletContext 的版本和信息
ServletContext 还提供了一些方法来获取 Web 应用的版本信息和相关属性:
获取 Web 应用的版本:
|-------------------------------------------|
| String version = context.getServerInfo(); |
该方法返回 Web 服务器的信息,如 "Apache Tomcat/9.0.31"。
7 )获取上下文路径
通过 getContextPath() 方法获取 Web 应用的根路径。
|------------------------------------------------|
| String contextPath = context.getContextPath(); |
例如,如果 Web 应用部署在 http://localhost:8080/myapp,则 getContextPath() 返回 "/myapp"。
11.9.14.4.ServletContext 在分布式环境中的应用
在分布式 Web 应用中,ServletContext 主要用于提供跨 Servlet 和 JSP 的共享资源。由于 ServletContext 是 Web 应用级别的,它适用于不同的客户端请求之间共享的资源,如配置参数、数据库连接池等。
1)跨请求共享数据:使用 setAttribute() 和 getAttribute() 在 Web 应用的多个请求之间共享数据。需要注意的是,ServletContext 属性是应用级别的,因此它的生命周期与 Web 应用的生命周期一致。
2)跨 Servlet 和 JSP 共享数据:可以通过 ServletContext 共享数据,使得不同 Servlet 和 JSP 能够访问和修改这些共享数据。