Servlet学习笔记（五）：ServletConfig和ServletContext详解

一、ServletConfig 对象及其使用

1、补充：Context和ContextPath ： 一个Web工程，如名为JavaWeb，访问的路径为http://localhost:8080/JavaWeb，这整个web应用就成为一个Context，路径/JavaWeb被称为上下文路径(ContextPath )。request.getContextPath ()可以获取。

2、ServletConfig： 当servlet配置了初始化参数后，web容器在创建servlet实例对象时，会自动将这些初始化参数封装到ServletConfig对象中，并在调用servlet的init()方法时，将ServletConfig 对象传递给servlet。进而，通过ServletConfig对象就可以得到当前servlet的初始化参数。

1）初始化参数配置在<init-param>标签中，如：

[java]  view plain  copy

1. <servlet>  
2.   <servlet-name>ServletConfigServlet</servlet-name>  
3.   <servlet-class>servlet.base.ServletConfigServlet</servlet-class>  
4.   <init-param>  
5.     <param-name>userName</param-name>  
6.     <param-value>SAM-SHO</param-value>  
7.   </init-param>  
8. </servlet>  

2）服务器会自动封装在ServletConfig中，我们利用init()或者init(ServletConfig config)方法，可以只获取一次ServletConfig对象，然后通过其getInitParameter()方法，获取配置好的参数。ServletConfig对象也可以直接通过父类GenericServlet封装好的getServletConfig()方法获取或直接通过父类封装的getInitParameter()直接获取。

[java]  view plain  copy

1. @Override  
2. public void init(ServletConfig config) throws ServletException {  
3.       
4.     // 如果重写父类带参数的init()方法，这句一定写。  
5.     // 不然拿不到ServletConfig 对象，空指针。  
6.     // 原因在于,父类中代参的init()实现的时候，先this.config = config;然后调用无参this.init();  
7.     super.init(config);  
8.       
9.     String userName = config.getInitParameter("userName");  
10.       
11.     String userName2 = this.getInitParameter("userName");  
12.       
13.     String userName3 = this.getServletConfig().getInitParameter("userName");  
14.       
15.     logger.debug("初始化参数1： "+userName+" | "+"初始化参数2： "+userName2+" | 初始化参数3： "+userName3);  
16.       
17. }  
18.   
19. @Override  
20. public void init() throws ServletException {  
21.       
22.     String userName2 = this.getInitParameter("userName");  
23.       
24.     String userName3 = this.getServletConfig().getInitParameter("userName");  
25.       
26.     logger.debug("初始化参数4： "+userName2+" | 初始化参数5： "+userName3);  
27.       
28. }  

3)注意点：如果重写父类带参数的init()方法，这句一定写，super.init(config)，不然拿不到ServletConfig 对象，空指针。原因在于,父类中代参的init()实现的时候，先this.config = config;然后调用无参this.init()。其实你复写两个init()方法后，输出的顺序也解释了这一点。推荐使用不带参数的init()方法。父类代码以及上例输出如下：

[java]  view plain  copy

1.    public void init(ServletConfig config) throws ServletException {  
2. this.config = config;  
3. this.init();  
4.    }  

[java]  view plain  copy

1. 【输出】  
2. [JavaWeb] [2014-09-29 20:04:02,162] [DEBUG] [ServletConfigServlet:56] - 初始化参数4： SAM-SHO | 初始化参数5： SAM-SHO  
3. [JavaWeb] [2014-09-29 20:04:02,169] [DEBUG] [ServletConfigServlet:45] - 初始化参数1： SAM-SHO | 初始化参数2： SAM-SHO | 初始化参数3： SAM-SHO  

4）通过getInitParameterNames()，可以获取枚举类型的所有初始化参数。

5）实际项目中，参数放在xml与properites文件中更灵活，写程序获取即可。

二、ServletContext对象及其使用

1、简介：

1）生命周期：Web容器在启动时，它会为每个Web应用程序都创建一个对应的ServletContext对象，它代表当前Web应用。ServletContext对象只在Web应用被关闭时才被销毁；不同的Web应用，ServletContext各自独立存在。

2）获取：SevletConfig 对象中维护了 ServletContext 对象的引用，通过 SevletConfig.getServletContext()方法获取ServletContext 对象。或者直接调用封装好的getServletContext ()方法即可获取。 

3）作用：由于一个Web应用中的所有 Servlet 共享同一个ServletContext 对象，因此 Servlet  对象之间可以通过ServletContext  对象来实现通讯。 ServletContext 对象通常也对称之为context 域对象。

2、应用：

1）获取上下文参数。context-param 标签配置得参数是供web应用共享的，所有的servlet都可以访问。

[java]  view plain  copy

1. <!--上下文参数-->    
2. <context-param>  
3.         <param-name>B</param-name>  
4.         <param-value>2</param-value>  
5.     </context-param>  

[java]  view plain  copy

1. // 知识点二：获取上下文参数，上下文参数是给所有Servlet使用的  
2. String userName = servletContext.getInitParameter("userName");  
3. logger.debug("获取上下文参数: " + userName);  

2）利用ServletContext，实现 Servlet  对象之间通讯。 主要是4个有关 Attribute 的方法：setAttribute()、getAttribute()、removeAttribute()、getAttributeNames()。

[java]  view plain  copy

1. // 所有servlet实现通信  
2. servletContext.setAttribute("new_userName", userName);  
3. String new_userName = (String) servletContext.getAttribute("new_userName");  
4. logger.debug("所有servlet实现通信: " + new_userName);  
5. servletContext.removeAttribute("new_userName");  
6. servletContext.getAttributeNames();  

3） 利用ServletContext获取资源文件的方法。首先创建一个配置文件jdbc.properties，放在source文件夹comfig下；其次写一个配置文件读取方法：

[java]  view plain  copy

1. /** 
2.  * 抽出的方法,固定写法 
3.  * @param in 
4.  * @throws IOException 
5.  */  
6. private void getProperites(InputStream in) throws IOException {  
7.     Properties props = new Properties();  
8.     props.load(in);  
9.     String url = props.getProperty("url");  
10.     String username = props.getProperty("username");  
11.     String password = props.getProperty("password");  
12.       
13.     logger.debug(url);  
14.     logger.debug(username);  
15.     logger.debug(password);  
16. }  

A、getResource() ：获取资源文件的URL后，直接通过openStream()得到流。

[java]  view plain  copy

1. // 1-利用 getResource 得到URL ，然后直接 构建IO流  
2. URL url = servletContext.getResource("/WEB-INF/classes/jdbc.properties");//得到URL              
3. InputStream in_url = url.openStream();//直接得到流  
4. getProperites(in_url);//获取资源文件  

解释："/WEB-INF/classes/jdbc.properties"： 以“/”开头，代表web工程 部署好以后的配置文件的地址,src其实就是/WEB-INF的classes文件夹。

B、利用 getResourceAsStream() 获取配置文件。——最常用。

[java]  view plain  copy

1. // 2-1 利用 getResourceAsStream 获取配置文件  
2. // 以“/”开头，代表web工程 部署好以后的配置文件的地址,src其实就是/WEB-INF的classes文件夹  
3. InputStream in = servletContext.getResourceAsStream("/WEB-INF/classes/jdbc.properties");  
4. this.getProperites(in);  

C、getRealPath() 得到资源文件的绝对路径。利用文件流，获取资源文件。

注意，不能使用传统的相对路径获取资源文件。

如：FileInputStream fileIn = new FileInputStream("/classes/jdbc.properties");因为相对的是Java虚拟机的路径，即这边是tomcat的bin/start.bat所在的文件夹，这样肯定找不到资源文件。可以再toncat的bin下新classes/jdbc.properties,试验看看。

[java]  view plain  copy

1. <span style="font-size: 18px;">           // 2-2 getRealPath 得到资源文件的绝对路径  
2.             // 这种方式可以获取文件的名称，可以用于下载文件得开发。  
3.             String realPath = servletContext.getRealPath("/WEB-INF/classes/jdbc.properties");  
4.             logger.debug("资源文件的绝对路径 ： " + realPath);  
5.                           
6.             // 在web项目中不能直接使用传统相对路径访问文件，如  
7.             // FileInputStream fileIn = new FileInputStream("/classes/jdbc.properties");  
8.             // 因为相对的是Java虚拟机的路径，即这边是tomcat的bin/start.bat所在的文件夹，这样肯定找不到资源文件。http://  
9.             // 可以再toncat的bin下新建classes/jdbc.properties,试验看看  
10.             FileInputStream fileIn = new FileInputStream(realPath);  
11.             this.getProperites(fileIn);  
12. </span>  

D、地址的写法。地址给谁用的。如果是给服务器用的，以"/"代表当前web应用; 如果是给浏览器用的，代表网址。

[java]  view plain  copy

1. /* 
2.          * 原则：地址给谁用的。如果是给服务器用的，以"/"代表当前web应用; 如果是给浏览器用的，代表网址。 
3.          */  
4.           
5.           
6.         //转发 -服务器使用,"/"是当前web应用  
7.         request.getRequestDispatcher("/my.jsp").forward(request, response);  
8.           
9.         //重定向-浏览器使用，增加上下文路径  
10.         response.sendRedirect("/JavaWeb/my.jsp");  
11.           
12.         //获取资源-getRealPath。  
13.         this.getServletContext().getRealPath("/my.jsp");  
14.           
15.         //获取资源-getResourceAsStream  
16.         this.getServletContext().getResourceAsStream("/my.jsp");  
17.           
18.         //页面地址的-浏览器使用  
19. //      <form action="/JavaWeb/my.jsp">  

4）利用ClassLoader获取资源文件。在《java进阶（六）：Java类加载器》中已经有涉及到。这边作补充。

A、getResourceAsStream() 。利用classLoader获取资源文件 不能以'/'打头

[java]  view plain  copy

1. // 3-1 利用classLoader获取资源文件 不能以'/'打头  
2. // 新建一个与src同级别的source文件夹comfig,里面存放 jdbc.properties文件  
3. InputStream is = this.getClass().getClassLoader().getResourceAsStream("jdbc.properties");  
4. this.getProperites(is);  
5.   
6. // 3-1-1 变化的 classLoader获取资源文件 ，项目中常用。  
7.       ClassLoader loader = Thread.currentThread().getContextClassLoader();  
8.       InputStream resourceAsStream = loader.getResourceAsStream("jdbc.properties");  
9.       this.getProperites(resourceAsStream);  

B、getResource()：得到绝对路径，然后获取配置文件。

[java]  view plain  copy

1. // 3-2 利用类加载器读取配置文件，不能实时的获取最新的配置文件信息。类加载器加载过的类，就不会再加载  
2. // getResource()返回的是URL,然后getPath()再获取绝对路径,这样就可以获取更新后的数据  
3. URL classUrl = this.getClass().getClassLoader().getResource("jdbc.properties");  
4. String path = classUrl.getPath();  
5. logger.debug("利用getResource() 获取配置文件的路径： "+path);  
6. this.getProperites(new FileInputStream(path));