Servlet系列学习笔记2 --- getServletConfig与getServletContext

目录

一、ServletConfig（配置对象）

二、ServletContext（上下文对象）

三、总结

---

一、ServletConfig（配置对象）

       在Servlet容器初始化Servlet时，Servlet容器将ServletConfig传给Servlet的init方法。ServletConfig封装可以通过@WebServlet或部署描述符传给一个Servlt配置信息。以这种方式传递的每一条信息都称作某个初始参数。初始参数由两个组成：键和值。

       想要获取初始参数的值，调用ServletConfig对象的getInitParameter方法。另外，getInitParameter方法返回的是初始参数名称的Enumeration。接下来让我们来看一则例子：

import java.io.IOException;
import java.io.PrintWriter;
import javax.servlet.Servlet;
import javax.servlet.ServletConfig;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
import javax.servlet.annotation.WebServlet;
import javax.servlet.annotation.WebInitParam; //引入
@WebServlet(
			name = "ServletConfigDemo",
			urlPatterns = {"/ServletConfigDemo"},
			initParams = {
				@WebInitParam(name="Name",value="LaoYe"),
				@WebInitParam(name="sex",value="Male")
			}
		)
public class ServletConfigDemo implements Servlet {
	private transient ServletConfig servletConfig;
	public void init(ServletConfig servletConfig) throws ServletException {
		this.servletConfig = servletConfig;
	}
	public void service(ServletRequest request, ServletResponse response) throws ServletException, IOException {
		ServletConfig servletConfig = getServletConfig();
		String name = servletConfig.getInitParameter("Name");
		String sex = servletConfig.getInitParameter("sex");
		
		response.setContentType("text/html;charset=utf-8");
		PrintWriter writer = response.getWriter();
		writer.print("初始化参数Name = "+name+" , Sex = "+sex);
	}
	public void destroy() {
		System.out.println("执行销毁Servlet");
	}
	public ServletConfig getServletConfig() {
		return servletConfig;
	}
	public String getServletInfo() {
		return "My Servlet"; 
	}
}

       上面的案例中，在类名外部的 @WebServlet 注解中定义了初始化函数Name和Sex。在service方法中通过ServletConfig的实例对象调用getInitParameter()方法来获取指定的参数化参数的名称。结果如下所示

       

       配置ServletConfig对象，还可以在web.xml中添加内部初始化参数。例如下面代码所示：

<servlet>
    <servlet-name>ServletConfigDemo</servlet-name>
    <servlet-class>page.ServletConfigDemo</servlet-class>
    <init-param>
        <param-name>Name</param-name>
        <param-value>Laoye</param-value>
    </init-param>
    <init-param>
        <param-name>Sex</param-name>
        <param-value>Male</param-value>
    </init-param>
</servlet>
<servlet-mapping>
    <servlet-name>ServletConfigDemo</servlet-name>
    <url-pattern>/ServletConfig</url-pattern>
</servlet-mapping>

       需要明白的是@WebServlet注解里面的路径对应浏览器的路径，例如：@WebServlet(“/ServletConfigDemo”)对应路径 xxx/app01/ServletConfig 。它和配置文件里面的<url-pattern>/ServletConfig</url-pattern>目的是一样的，两者都是告知浏览器，如果URL的请求是ServletConfig，则由ServletConfigDemo类来提供服务。所以，两种配置方式如果路径重名会使Servlet容器启动不了，一般来说配置一种就好了。

二、ServletContext（上下文对象）

       当Servlet容器启动时，会为每个Web应用程序创建一个唯一的ServletContext对象代表当前Web应用。该对象不仅封装了当前Web应用的所有信息，而且实现了多个Servlet之间的数据共享。接下来，我们针对ServletContext接口的不同作用进行讲解。

1、获取Web应用的初始化参数

       通过web.xml文件，我们不仅可以配置Servlet的初始化信息，还可以配置整个Web应用的初始化信息。

<context-param>
  	<param-name>Name</param-name>
  	<param-value>Laoye</param-value>
</context-param>
<context-param>
  	<param-name>Sex</param-name>
  	<param-value>Male</param-value>
</context-param>

       配好Web应用的初始化参数之后，接下来我们可以使用ServletContext接口来获取这些初始化参数的信息。

import java.io.IOException;
import java.io.PrintWriter;
import javax.servlet.Servlet;
import javax.servlet.ServletConfig;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
import javax.servlet.annotation.WebServlet;
import javax.servlet.ServletContext;
import java.util.Enumeration;
@WebServlet("/ServletContext01")
public class ServletContext01 implements Servlet {
private transient ServletConfig servletConfig;
	public void init(ServletConfig servletConfig) throws ServletException {
		this.servletConfig = servletConfig;
	}
	public void service(ServletRequest request, ServletResponse response) throws ServletException, IOException {
		//获取ServletContext对象
		ServletContext servletContext = request.getServletContext();
		//得到包含所有初始化参数名的Enumeration对象
		Enumeration<String> paramNames = servletContext.getInitParameterNames();
		
		response.setContentType("text/html;charset=utf-8");
		PrintWriter writer = response.getWriter();
		//遍历所有初始化参数名，得到相应参数值，打印到控制台
		while(paramNames.hasMoreElements()){
			String name = paramNames.nextElement();
			String value = servletContext.getInitParameter(name);
			writer.println("初始化参数Name = " + name + " , value = " + value + "<br>");
		}
	}
	public void destroy() {
		System.out.println("执行销毁Servlet");
	}
	public ServletConfig getServletConfig() {
		return servletConfig;
	}
	public String getServletInfo() {
		return "My Servlet"; 
	}
}

       启动Tomcat服务器之后，访问ServletContext01，显示结果如下图

       

       通过getInitParameterNames获取ServletContext中所有的初始化参数名。之后通过遍历，获取当前遍历的属性名，之后通过getInitParameter获取指定参数名的参数值。

       ServletContext还提供了额外的四个接口分别用于增、删、改、查，设置ServletContext域中参数的4个方法。

方法名称	功能描述
Enumeration getAttributeName()	返回ServletContext域中的所有参数名
Object getAttribute(String name)	返回指定的参数名的值
void removeAttribute(String name)	删除指定的参数
void setAttribute(String name,Object value)	添加新的参数

       实例代码如下所示

response.setContentType("text/html;charset=utf-8");
PrintWriter writer = response.getWriter();
//获取ServletContext对象
ServletContext servletContext = request.getServletContext();
//设置新的初始化参数
servletContext.setAttribute("Age","18");
servletContext.setAttribute("phone","123456789");
//获取指定参数
writer.println("Age：" + servletContext.getAttribute("Age"));
writer.println("phone：" + servletContext.getAttribute("phone"));
//修改指定参数的值
servletContext.setAttribute("phone","987654321");
writer.println("phone：" + servletContext.getAttribute("phone"));
//删除指定参数
servletContext.removeAttribute("phone");
writer.println("phone：" + servletContext.getAttribute("phone"));

       启动Tomcat服务器，访问ServletContext01，可以得到如下图结果

       

       需要注意的是，以上四种操作均无法修改配置在web.xml中的初始参数。

三、总结

       ServletConfig对象叫Servlet配置对象。主要用于加载配置文件的初始化参数。ServletConfig对象在servlet对象创建之后，调用init方法之前创建，之后ServletConfig对象随着init()方法传入到Servlet中。

       ServletContext对象叫Servlet上下文对象。每当一个web应用被加载时，Servlet容器就会为这个web应用创建一个对象，代表当前web应用的环境。在当前web应用中所有的servlet都共享一个ServletContext对象。