Servlet | ServletConfig接口、ServletContext接口详解

梦里梦外; 2024-04-01 13:14 7阅读 0赞

**目录**

一：ServletConfig接口

二：ServletContext接口

三：补充缓冲机制

--------------------

## 一：ServletConfig接口 ##

**（1）ServletConfig是什么？**

> javax.servlet.ServletConfig，显然ServletConfig是Servlet规范中的一员。  
> ServletConfig是一个接口。（javax.servlet.Servlet是一个接口。）

**（2）谁去实现了这个接口？ WEB服务器实现了**

public class org.apache.catalina.core.StandardWrapperFacade implements ServletConfig {}

> **结论：**Tomcat服务器实现了ServletConfig接口。  
> 思考：如果把Tomcat服务器换成jetty服务器，输出ServletConfig对象的时候，还是这个结果吗？不一定一样，包名类名可能和Tomcat不一样。但是他们都实现了ServletConfig这个规范。

**（3）一个Servlet对象中有一个ServletConfig对象。**

> Servlet和ServletConfig对象是一对一，100个Servlet，就应该有100个ServletConfig对象。

**（4）ServletConfig对象是谁创建的？在什么时候创建的？**

> Tomcat服务器（WEB服务器）创建了ServletConfig对象。  
> 在创建Servlet对象的时候，同时创建ServletConfig对象，然后才能调用init方法把ServletConfig对象传进去。

**（5）ServletConfig接口有什么用？**

> Config是哪个单词的缩写？Configuration（配置），所以ServletConfig对象被翻译为：Servlet对象的配置信息对象。**一个Servlet对象就有一个对应的配置信息对象！**

**（6）ServletConfig对象中包装了什么信息？**

> **ServletConfig对象中包装的信息是：web.xml文件中<servlet></servlet>标签的配置信息。** 
> Tomcat解析web.xml文件，将web.xml文件中<servlet></servlet>标签中的配置信息自动包装到ServletConfig对象中。

**（7）ServletConfig接口中有哪些方法？ServletConfig接口中有4个方法：**

> **方法1：public String getServletName()**
> 
> 可以获取到web.xml配置文件中<servlet-name></servlet-name>里面的名字
> 
> **方法2： public Enumeration<String> getInitParameterNames()**
> 
> 获取所有的初始化参数的name，返回一个集合
> 
> 实际上通过上面两种方法的联合使用：可以获取到web.xml文件中Servlet对象的初始化参数配置信息
> 
> **方法3：public String getInitParameter(String name)**
> 
> 遍历集合，拿到每一个name，然后根据name获取value 
> **方法4：public ServletContext getServletContext(); 后面会重点讲解**
> 
> ServletConfig对象对应整个web.xml文件 
> **以上的4个方法，有两种方法可以进行调用：**
> 
> **第一种：**调用getServletConfig()方法获取到ServletConfig对象，然后进行方法的调用
> 
> **第二种：**在自己编写的Servlet类当中也可以使用this去调用。因为通过原码发现GenericServlet也实现了ServletConfig接口， 而自己编写的Servlet类又要实现GenericServlet类，所以直接用this调用也行！

public abstract class GenericServlet implements 
    Servlet, ServletConfig, Serializable {}

**ConfigTestServlet类继承GenericServlet**

package com.bjpowernode.javaweb.servlet;
 
 import javax.servlet.*;
 import java.io.IOException;
 import java.io.PrintWriter;
 import java.util.Enumeration;
 
 public class ConfigTestServlet extends GenericServlet {
 @Override
 public void service(ServletRequest request, ServletResponse response) throws ServletException, IOException {
 // 设置响应的内容类型
 response.setContentType("text/html");
 // 设置输出的位置
 PrintWriter out = response.getWriter();
 
 // 获取ServletConfig对象
 ServletConfig config = this.getServletConfig();
 // 输出该对象
 // org.apache.catalina.core.StandardWrapperFacade@7d72f398、
 out.print("ServletConfig对象是："+config.toString());
 out.print(" ");
 
 // 获取<servlet-name></servlet-name>
 String servletName = config.getServletName();
 out.print("<servlet-name>"+servletName+"</servlet-name>"); // configTest
 out.print(" ");
 
 // <servlet></servlet>标签中的<init-param></init-param>是初始化参数。
 // 这个初始化参数信息会自动被Tomcat封装到ServletConfig对象当中。下面就进行获取
 // 通过ServletConfig对象的两个方法，可以获取到web.xml文件中的初始化参数配置信息。
 // java.util.Enumeration<java.lang.String>	getInitParameterNames() 获取所有的初始化参数的name
 // java.lang.String	getInitParameter(java.lang.String name) 通过初始化参数的name获取value
 Enumeration<String> initParameterNames = config.getInitParameterNames();
 // 遍历集合
 while(initParameterNames.hasMoreElements()){ // 是否有更多元素
 // 取元素(每一个name)
 String parameterName = initParameterNames.nextElement();
 // 通过name获取value
 String parameterVal = config.getInitParameter(parameterName);
 // 进行输出打印
 out.print(parameterName+"="+parameterVal );
 out.print(" ");
 /*
 password=root1234
 driver=com.mysql.jdbc.Driver
 user=root
 url=jdbc:mysql://localhost:3306/bjpowernode
 */
 }
 
 
 // 重点：通过原码发现GenericServlet也实现了ServletConfig接口，
 // 而ConfigTestServlet类又实现了GenericServlet类，所以直接用this掉用也行
 Enumeration<String> names = this.getInitParameterNames();
 while(names.hasMoreElements()){
 String name = names.nextElement();
 // 通过name获取value
 String value = this.getInitParameter(name);
 // 输出到控制台
 System.out.println(name +"="+value);
 }
 
 
 }
 }

**web.xml配置信息**

<?xml version="1.0" encoding="UTF-8"?>
 <web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_4_0.xsd"
 version="4.0">
 <servlet>
 <servlet-name>configTest</servlet-name>
 <servlet-class>com.bjpowernode.javaweb.servlet.ConfigTestServlet</servlet-class>
 
 
 <init-param>
 <param-name>driver</param-name>
 <param-value>com.mysql.jdbc.Driver</param-value>
 </init-param>
 <init-param>
 <param-name>url</param-name>
 <param-value>jdbc:mysql://localhost:3306/bjpowernode</param-value>
 </init-param>
 <init-param>
 <param-name>user</param-name>
 <param-value>root</param-value>
 </init-param>
 <init-param>
 <param-name>password</param-name>
 <param-value>root1234</param-value>
 </init-param>
 </servlet>
 
 <servlet-mapping>
 <servlet-name>configTest</servlet-name>
 <url-pattern>/test</url-pattern>
 </servlet-mapping>
 </web-app>

**总结：**

> * **什么是ServletConfig？**
> 
> * Servlet对象的配置信息对象，一个Servlet对象就有一个ServletConfig(配置信息)。
> * ServletConfig对象中封装了<servlet></servlet>标签中的配置信息。（web.xml文件中servlet的配置信息）
> * **一个Servlet对应一个ServletConfig对象。**
> * **Servlet对象是Tomcat服务器创建，并且ServletConfig对象也是Tomcat服务器创建。并且默认情况下，他们都是在用户发送第一次请求的时候创建。**
> * **Tomcat服务器调用Servlet对象的init方法的时候需要传一个ServletConfig对象的参数给init方法。**
> * **ServletConfig接口的实现类是Tomcat服务器给实现的。（Tomcat服务器就是WEB服务器）**
> * **ServletConfig接口有哪些常用的方法？**
> * public String getInitParameter(String name); // 通过初始化参数的name获取value
> public Enumeration<String> getInitParameterNames(); // 获取所有的初始化参数的name
> public ServletContext getServletContext(); // 获取ServletContext对象
> public String getServletName(); // 获取Servlet的name
> * **以上四个方法在Servlet类当中，都可以使用this去调用。因为我们自己编写的类继承了GenericServlet，而GenericServlet又实现了ServletConfig接口。**

##  ##

## 二：ServletContext接口 ##

> **获取ServletContext对象的两种方式：**

// 第一种方式：通过ServletConfig对象获取ServletContext对象。
 ServletContext application = config.getServletContext();
 //org.apache.catalina.core.ApplicationContextFacade@f0fa019
 out.print(" " + application); 
 
 // 第二种方式：通过this也可以获取ServletContext对象。
 ServletContext application2 = this.getServletContext();
 //org.apache.catalina.core.ApplicationContextFacade@f0fa019
 out.print(" " + application2);

**（1）ServletContext是什么？**

> ServletContext是一个接口，Tomcat服务器对ServletContext接口进行了实现。

**（2）ServletContext是谁实现的？**

> Tomcat服务器（WEB服务器）实现了ServletContext接口。
> 
> **一个Servlet对象对应一个ServletConfig**。100个Servlet对象则对应100个ServletConfig对象。但是只要在同一个webapp当中，只要在同一个应用当中，**所有的Servlet对象都是共享同一个ServletContext对象的。**

public class org.apache.catalina.core.ApplicationContextFacade 
    implements ServletContext {}

**（3）ServletContext对象是谁创建的？在什么时候创建的？**

> ServletContext对象是WEB服务器创建的。
> 
> **ServletContext对象WEB服务器启动的时候创建，在服务器关闭的时候销毁！**
> 
> 这就是ServletContext对象的生命周期，**ServletContext对象是应用级对象。**  
> Tomcat服务器中有一个webapps，这个webapps下可以存放webapp，可以存放多个webapp，假设有100个webapp，那么就有100个ServletContext对象。但是总之**一个应用，一个webapp肯定是只有一个ServletContext对象。**

**（4）ServletContext怎么理解？**

> context是什么意思：Servlet对象的环境对象。（**Servlet对象的上下文对象**）  
> **一个ServletContext对象其实对应的就是整个web.xml文件。**  
> 理解：50个学生，每个学生都是一个Servlet，这50个学生都在同一个教室当中。那么这个教室就相当于ServletContext对象。并且放在ServletContext对象当中的数据，所有Servlet一定是共享的。  
> 例如：一个教室中的空调是所有学生共享的，一个教室中的语文老师是所有学生共享的。  
> **Tomcat是一个容器，一个容器当中是可以放多个webapp，但是一个webapp只对应一个ServletContext对象。**

**（5）验证ServletContext对象是共享的！**

> 定义一个Aservlet和一个Bservlet，通过这两个类都继承GenericServlet，然后调用getServletContext()方法获得ServletContext对象，发现是同一个对象。

**Aservlet**

package com.bjpowernode.javaweb.servlet;
    
    import javax.servlet.*;
    import java.io.IOException;
    import java.io.PrintWriter;
    
    
    public class Aservlet extends GenericServlet {
        @Override
        public void service(ServletRequest request, ServletResponse response) throws ServletException, IOException {
            // 设置响应代码类型
            response.setContentType("text/html");
            PrintWriter out = response.getWriter();
            // 获取ServletContext对象
            ServletContext application = this.getServletContext();
            // 输出打印
            // org.apache.catalina.core.ApplicationContextFacade@3d8fcad7
            out.print(application);
    
        }
    }

**Bservlet**

package com.bjpowernode.javaweb.servlet;
    
    import javax.servlet.*;
    import java.io.IOException;
    import java.io.PrintWriter;
    
    
    public class Bservlet extends GenericServlet {
        @Override
        public void service(ServletRequest request, ServletResponse response) throws ServletException, IOException {
            // 设置响应代码类型
            response.setContentType("text/html");
            PrintWriter out = response.getWriter();
            // 获取ServletContext对象
            ServletContext application = this.getServletContext();
            // 输出打印
            // org.apache.catalina.core.ApplicationContextFacade@3d8fcad7
            out.print(application);
    
        }
    }

**配置文件web.xml**

**执行结果**

![6a178f70da594995a94e7a63999cadbb.png][]

![01909dddad4749409b50b399d3e115a5.png][]

**（6）ServletContext接口中有哪些常用的方法？**

> ①public String getInitParameter(String name) 通过初始化参数的name获取value 
> ②public Enumeration<String> getInitParameterNames() 获取所有的初始化参数的name

> ServletContext对象中也有这两个方法，这个两个方法获取的是**上下文的初始化参数配置信息<context-param></context-param>；这些配置信息用ServletContext对象来获取。**

**增加配置信息**

> **注意：**
> 
> ①以下的配置信息属于**应用级的配置信息**（相当于全局的配置信息），一般一个项目中共享的配置信息会放到以下的**<context-param>标签**当中，**使用ServletContext对象来获取**。 
> ②如果你的配置信息只是想给**某一个servlet**作为参考，那么你配置到 **<init-param>**标签当中即可，**使用ServletConfig对象来获取**。

<context-param>
 <param-name>pageSize</param-name>
 <param-value>10</param-value>
 </context-param>
 <context-param>
 <param-name>startIndex</param-name>
 <param-value>0</param-value>
 </context-param>

**增加通过方法调用获取到配置信息**

// 获取上下文的初始化参数
 Enumeration<String> initParameterNames = application.getInitParameterNames();
 while(initParameterNames.hasMoreElements()){
 // 获取每一个对象
 String name = initParameterNames.nextElement();
 // 通过name获取value
 String value = application.getInitParameter(name);
 out.print(name+"="+value);
 out.print(" ");
 }
 /*
 startIndex=0
 pageSize=10
 */

> ③public String getContextPath() 获取应用的根路径，相当于拿到了项目名！

// 动态获取context path （获取应用上下文的根）
 String contextPath = application.getContextPath();
 out.print(contextPath+" "); // "/servlet04"

> ④public String getRealPath(String path) 获取文件的绝对路径（真实路径）

> 例如：我们都知道web是根目录，那么就在web根目录下面创建一个common目录；然后在common目录下在创建一个common.html文件。

![66b95aab96af4e43be44162bc1262594.png][]

> 后面的这个路径，加了一个“/”，这个“/”代表的是web的根；不加“/”，默认也是从根下开始找

// 获取文件的绝对路径，“/”加不加都行，默认都是从web的根下开始找的
    String realPath = application.getRealPath("/common/commom.html");
    String realPath = application.getRealPath("commom.html");
    //C:\Users\86177\IdeaProjects\JavaWeb\out\artifacts\servlet04_war_exploded\common\commom.html
    out.print(realPath);

> ⑤通过ServletContext对象调用下面两个无参方法也是可以记录日志的

> public void log(String message) 记录日志的方法  
> public void log(String message, Throwable t) 记录日志的方法
> 
> 注意：如果使用文本编译器，这个日志会自动记录到CATALINA\_HOME/logs目录下。
> 
> 如果使用IDEA，IDEA可以创建多个Tomcat服务器；所以日志文件肯定是和IDEA相关的目录下；启动Tomcat找到下面这句话：Using CATALINA\_BASE: "C:\\Users\\86177\\.IntelliJIdea2018.3\\system\\tomcat\\Tomcat\_9\_0\_68\_JavaWeb"； 这些是参照CATALINA\_HOME下的资源生成的一个Tomcat副本：

![11e15db7d4e04c928b965b09a723123e.png][]

> 启动Tomcat服务器会生成两个日志文件：
> 
> catalina.2022-11-03.log 服务器端的java程序运行的控制台信息。
> 
>  catalina.2022-11-03.log 客户端发出请求的访问日志。
> 
> 客户端发出请求又生成一个日志文件：
> 
>  localhost.2022-11-03.log ServletContext对象的log方法记录的日志信息存储到这个文件中。

> 也可以多传一个处理异常的参数！

int age = 17; // 17岁
 // 当年龄小于18岁的时候，表示非法，记录日志
 if(age < 18) {
 application.log("对不起，您未成年，请绕行！", new RuntimeException("小屁孩，快走开，不适合你！"));
 }

**（7）ServletContext对象还有另一个名字：应用域（后面还有其他域，例如：请求域、会话域）**

> 如果所有的用户共享一份数据，并且这个数据很少的被修改，并且这个数据量很少，可以将这些数据放到ServletContext这个应用域中：
> 
> ①为什么是所有用户共享的数据？ 
> 
> 不是共享的没有意义。因为ServletContext这个对象只有一个。只有共享的数据放进去才有意义。
> 
> ②为什么数据量要小？
> 
> 因为数据量比较大的话，太占用堆内存，并且这个对象的生命周期比较长，服务器关闭的时候，这个对象才会被销毁。大数据量会影响服务器的性能。占用内存较小的数据量可以考虑放进去。
> 
> ③为什么这些共享数据很少的修改，或者说几乎不修改？  
> 所有用户共享的数据，如果涉及到修改操作，必然会存在线程并发所带来的安全问题。所以放在ServletContext对象中的数据一般都是只读的。数据量小、所有用户共享、又不修改，这样的数据放到ServletContext这个应用域当中，会大大提升效率。因为应用域相当于一个缓存，放到缓存中的数据，下次在用的时候，不需要从数据库中再次获取，大大提升执行效率。

**（8）怎么向ServletContext应用域中存数据、取数据、删数据？**

> ①存（怎么向ServletContext应用域中存数据）  
>  public void setAttribute(String name, Object value);   
> ②取（怎么从ServletContext应用域中取数据）  
>  public Object getAttribute(String name);   
> ③删（怎么删除ServletContext应用域中的数据）  
>  public void removeAttribute(String name); 
> 
> 注：很像Map集合(key,value)；分别对应着：map.put(k, v)方法、Object v = map.get(k)方法、map.remove(k)方法。

// 准备数据
    Date date = new Date();
    SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
    // 向ServletContext应用域当中存储数据
    application.setAttribute("nowDate",sdf.format(date));
    // 取出来，输出到浏览器
    Object nowDate = application.getAttribute("nowDate");
    out.print(nowDate); // 2022-11-03 20:24:23
    // 删除数据
    application.removeAttribute("nowDate");
    out.print(application.getRealPath("nowDate"));

**总结**

> 以后编写Servlet类的时候，实际上是不会去直接继承GenericServlet类的，因为B/S结构的系统是基于HTTP超文本传输协议的，在Servlet规范当中，提供了一个类叫做HttpServlet，它是专门为HTTP协议准备的一个Servlet类。编写的Servlet类要直接继承HttpServlet（HttpServlet是HTTP协议专用的）使用HttpServlet处理HTTP协议更便捷。但是需要知道它的继承结构：

jakarta.servlet.Servlet（接口）【爷爷】
    jakarta.servlet.GenericServlet implements Servlet（抽象类）【儿子】
    jakarta.servlet.http.HttpServlet extends GenericServlet（抽象类）【孙子】

## 三：补充缓冲机制 ##

> **到目前为止都接触过的缓存机制！**
> 
>  *  堆内存当中的字符串常量池
>     
>      *  "abc" 先在字符串常量池中查找，如果有，直接拿来用。如果没有则新建，然后再放入字符串常量池。
>  *  堆内存当中的整数型常量池
>     
>      *  \[-128 ~ 127\] 一共256个Integer类型的引用，放在整数型常量池中。没有超出这个范围的话，直接从常量池中取。
>  *  连接池(Connection Cache)
>     
>      *  这里所说的连接池中的连接是java语言连接数据库的连接对象：java.sql.Connection对象。
>      *  JVM是一个进程，MySQL数据库是一个进程。进程和进程之间建立连接，打开通道是很耗费资源的。怎么办？可以提前先创建好N个Connection连接对象，将连接对象放到一个集合当中，我们把这个放有Connection对象的集合称为连接池。每一次用户连接的时候不需要再新建连接对象，省去了新建的环节，直接从连接池中获取连接对象，大大提升访问效率。
>      *  连接池
>         
>          *  设置最小连接数
>          *  设置最大连接数
>          *  连接池可以提高用户的访问效率。当然也可以保证数据库的安全性。
>  *  线程池
>     
>      *  Tomcat服务器本身就是支持多线程的。
>      *  Tomcat服务器是在用户发送一次请求，就新建一个Thread线程对象吗？
>         
>          *  当然不是，实际上是在Tomcat服务器启动的时候，会先创建好N多个线程Thread对象，然后将线程对象放到集合当中，称为线程池。用户发送请求过来之后，需要有一个对应的线程来处理这个请求，这个时候线程对象就会直接从线程池中拿，效率比较高。
>          *  所有的WEB服务器，或者应用服务器，都是支持多线程的，都有线程池机制。
>  *  redis
>     
>      *  比如：NoSQL数据库、非关系型数据库、缓存数据库。
>  *  向ServletContext应用域中存储数据，也等于是将数据存放到缓存cache当中。

[6a178f70da594995a94e7a63999cadbb.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/c1a9c2e6c93f48d29a9d7b4e32b52dbc.png
[01909dddad4749409b50b399d3e115a5.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/242f11b85f6444cf94874346695b5436.png
[66b95aab96af4e43be44162bc1262594.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/2b5bdf0b962b45879210b6838e8e69cd.png
[11e15db7d4e04c928b965b09a723123e.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/01/84b795feb1e2403d82ce87eda49c0b72.png