Servlet API 详解（HttpServlet、HttpServletRequest、HttpServletResponse）

桃扇骨 2024-04-06 12:26 100阅读 0赞

## 系列文章目录 ##

[Servlet 的运行原理\_crazy\_xieyi的博客-CSDN博客][Servlet _crazy_xieyi_-CSDN]

[如何创建一个Servlet项目（Maven）？\_crazy\_xieyi的博客-CSDN博客][Servlet_Maven_crazy_xieyi_-CSDN]

[Tomcat下载、安装及使用介绍\_crazy\_xieyi的博客-CSDN博客][Tomcat_crazy_xieyi_-CSDN]

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

文章目录

*  **一、HttpServlet**
 *  **二、HttpServletRequest**
 *  **三、HttpServletResponse**

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

## **一、HttpServlet** ##

我们写 Servlet 代码的时候, 首先第一步就是先创建类, 继承自 HttpServlet, 并重写其中的某些方法。

<table style="width:500px;"> 
 <tbody> 
  <tr> 
   <td>方法名称</td> 
   <td>调用时机</td> 
  </tr> 
  <tr> 
   <td> 
    <div>
      init 
    </div> </td> 
   <td> 
    <div>
      在 HttpServlet 实例化之后被调用一次 
    </div> </td> 
  </tr> 
  <tr> 
   <td> 
    <div>
      destory 
    </div> </td> 
   <td> 
    <div>
      在 HttpServlet 实例不再使用的时候调用一次 
    </div> </td> 
  </tr> 
  <tr> 
   <td> 
    <div>
      service 
    </div> </td> 
   <td> 
    <div>
      收到 HTTP 请求的时候调用 
    </div> </td> 
  </tr> 
  <tr> 
   <td> 
    <div>
      doGet 
    </div> </td> 
   <td> 
    <div>
      收到 GET 请求的时候调用(由 service 方法调用) 
    </div> </td> 
  </tr> 
  <tr> 
   <td> 
    <div>
      doPost 
    </div> </td> 
   <td> 
    <div>
      收到 POST 请求的时候调用(由 service 方法调用) 
    </div> </td> 
  </tr> 
  <tr> 
   <td> 
    <div>
      doPut/doDelete/doOptions/... 
    </div> </td> 
   <td> 
    <div>
      收到其他请求的时候调用(由 service 方法调用) 
    </div> </td> 
  </tr> 
 </tbody> 
</table>

我们实际开发的时候主要重写 doXXX 方法, 很少会重写 init / destory / service 。**注意****:** HttpServlet 的实例只是在程序启动时创建一次. 而不是每次收到 HTTP 请求都重新创建实例。

**那么Servlet的生命周期是多少呢？**

Servlet在实例化之后调用一次 init 方法；Servlet在每次收到请求的时候调用一次service；Servlet在销毁之前调用一次destory。

###  ###

### 二、HttpServletRequest ###

当 Tomcat 通过 Socket API 读取 HTTP 请求(字符串), 并且按照 HTTP 协议的格式把字符串解析成

HttpServletRequest 对象。

<table style="width:500px;"> 
 <tbody> 
  <tr> 
   <td>方法</td> 
   <td>描述</td> 
  </tr> 
  <tr> 
   <td> 
    <div>
      String getProtocol() 
    </div> </td> 
   <td> 
    <div>
      返回请求协议的名称和版本 
    </div> </td> 
  </tr> 
  <tr> 
   <td> 
    <div>
      String getMethod() 
    </div> </td> 
   <td> 
    <div>
      返回请求的 HTTP 方法的名称，例如，GET、POST 或 PUT 
    </div> </td> 
  </tr> 
  <tr> 
   <td> 
    <div>
      String getRequestURI() 
    </div> </td> 
   <td> 
    <div>
      从协议名称直到 HTTP 请求的第一行的查询字符串中，返回该请求的 URL 的一部分 
    </div> </td> 
  </tr> 
  <tr> 
   <td> 
    <div>
      String getContextPath() 
    </div> </td> 
   <td> 
    <div>
      返回指示请求上下文的请求 URI 部分 
    </div> </td> 
  </tr> 
  <tr> 
   <td> 
    <div>
      String getQueryString() 
    </div> </td> 
   <td> 
    <div>
      返回包含在路径后的请求 URL 中的查询字符串 
    </div> </td> 
  </tr> 
  <tr> 
   <td> 
    <div>
      Enumeration 
    </div> 
    <div>
      getParameterNames() 
    </div> </td> 
   <td> 
    <div>
      返回一个 String 对象的枚举，包含在该请求中包含的参数的名称 
    </div> </td> 
  </tr> 
  <tr> 
   <td> 
    <div>
      String getParameter(String 
    </div> 
    <div>
      name) 
    </div> </td> 
   <td> 
    <div>
      以字符串形式返回请求参数的值，或者如果参数不存在则返回 null 
    </div> </td> 
  </tr> 
  <tr> 
   <td> 
    <div>
      String[] 
    </div> 
    <div>
      getParameterValues(String 
    </div> 
    <div>
      name) 
    </div> </td> 
   <td> 
    <div>
      返回一个字符串对象的数组，包含所有给定的请求参数的值， 如果参数不存在则返回 null 
    </div> </td> 
  </tr> 
  <tr> 
   <td> 
    <div>
      Enumeration 
    </div> 
    <div>
      getHeaderNames() 
    </div> </td> 
   <td> 
    <div>
      返回一个枚举，包含在该请求中包含的所有的头名 
    </div> </td> 
  </tr> 
  <tr> 
   <td> 
    <div>
      String getHeader(String 
    </div> 
    <div>
      name) 
    </div> </td> 
   <td> 
    <div>
      以字符串形式返回指定的请求头的值 
    </div> </td> 
  </tr> 
  <tr> 
   <td> 
    <div>
      String 
    </div> 
    <div>
      getCharacterEncoding() 
    </div> </td> 
   <td> 
    <div>
      返回请求主体中使用的字符编码的名称 
    </div> </td> 
  </tr> 
  <tr> 
   <td> 
    <div>
      String getContentType() 
    </div> </td> 
   <td> 
    <div>
      返回请求主体的 MIME 类型，如果不知道类型则返回 null 
    </div> </td> 
  </tr> 
  <tr> 
   <td> 
    <div>
      int getContentLength() 
    </div> </td> 
   <td> 
    <div>
      以字节为单位返回请求主体的长度，并提供输入流，或者如果 长度未知则返回 -1。 
    </div> </td> 
  </tr> 
  <tr> 
   <td> 
    <div>
      InputStream 
    </div> 
    <div>
      getInputStream() 
    </div> </td> 
   <td> 
    <div>
      用于读取请求的 body 内容. 返回一个 InputStream 对象 
    </div> </td> 
  </tr> 
 </tbody> 
</table>

通过这些方法可以获取到一个请求中的各个方面的信息，

请求对象是服务器收到的内容, 不应该修改. 因此上面的方法也都只是 "读" 方法, 而不是 "写"

方法。

### 三、HttpServletResponse ###

Servlet 中的 doXXX 方法的目的就是根据请求计算得到相应, 然后把响应的数据设置到

HttpServletResponse 对象中。然后 Tomcat 就会把这个 HttpServletResponse 对象按照 HTTP 协议的格式, 转成一个字符串, 并通过 Socket 写回给浏览器。

<table style="width:500px;"> 
 <tbody> 
  <tr> 
   <td>方法</td> 
   <td>描述</td> 
  </tr> 
  <tr> 
   <td> 
    <div>
      void setStatus(int sc) 
    </div> </td> 
   <td> 
    <div>
      为该响应设置状态码 
    </div> </td> 
  </tr> 
  <tr> 
   <td> 
    <div>
      void setHeader(String name, 
    </div> 
    <div>
      String value) 
    </div> </td> 
   <td> 
    <div>
      设置一个带有给定的名称和值的 header. 如果 name 已经存在, 则覆盖旧的值 
    </div> </td> 
  </tr> 
  <tr> 
   <td> 
    <div>
      void addHeader(String 
    </div> 
    <div>
      name, String value) 
    </div> </td> 
   <td> 
    <div>
      添加一个带有给定的名称和值的 header. 如果 name 已经存在, 不覆盖旧的值, 并列添加新的键值对 
    </div> </td> 
  </tr> 
  <tr> 
   <td> 
    <div>
      void setContentType(String 
    </div> 
    <div>
      type) 
    </div> </td> 
   <td> 
    <div>
      设置被发送到客户端的响应的内容类型 
    </div> </td> 
  </tr> 
  <tr> 
   <td> 
    <div>
      void 
    </div> 
    <div>
      setCharacterEncoding(String 
    </div> 
    <div>
      charset) 
    </div> </td> 
   <td> 
    <div>
      设置被发送到客户端的响应的字符编码（MIME 字符集）例如，UTF-8 
    </div> </td> 
  </tr> 
  <tr> 
   <td> 
    <div>
      void sendRedirect(String 
    </div> 
    <div>
      location) 
    </div> </td> 
   <td> 
    <div>
      使用指定的重定向位置 URL 发送临时重定向响应到客户端 
    </div> </td> 
  </tr> 
  <tr> 
   <td> 
    <div>
      PrintWriter getWriter() 
    </div> </td> 
   <td> 
    <div>
      用于往 body 中写入文本格式数据 
    </div> </td> 
  </tr> 
  <tr> 
   <td> 
    <div>
      OutputStream 
    </div> 
    <div>
      getOutputStream() 
    </div> </td> 
   <td> 
    <div>
      用于往 body 中写入二进制格式数据 
    </div> </td> 
  </tr> 
 </tbody> 
</table>

**注意** **:** 响应对象是服务器要返回给浏览器的内容, 这里的重要信息都是程序猿设置的. 因此上面的方

法都是 "写" 方法。对于状态码/响应头的设置要放到 getWriter / getOutputStream 之前. 否则可能设置失效。

###  ###

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

###  ###

[Servlet _crazy_xieyi_-CSDN]: https://blog.csdn.net/crazy_xieyi/article/details/126997927?spm=1001.2014.3001.5501
[Servlet_Maven_crazy_xieyi_-CSDN]: https://blog.csdn.net/crazy_xieyi/article/details/126864119?spm=1001.2014.3001.5501
[Tomcat_crazy_xieyi_-CSDN]: https://blog.csdn.net/crazy_xieyi/article/details/126858014?spm=1001.2014.3001.5501