Servlet API 详解

不念不忘少年蓝@ 2024-02-19 12:07 92阅读 0赞

![在这里插入图片描述][a39c7566edfe483c8bc245ffa7190953.gif_pic_center]

#### 文章目录 ####

*  前言
 *  什么是Servlet
 *  HttpServlet
 *  HttpServletRequest
 *   *  1. form表单构造POST请求
     *  2. JSON形式表示body部分
 *  HttpServletResponse

## 前言 ##

前面为大家介绍了如何使用 servlet 写一个简单的网站，前面只是大概了解了如何使用简单的 servlet，而平时网站的逻辑肯定不会简单，所以就需要详细的了解 servlet，servlet 作为一个 API，里面含有很多的类，不同的类中又含有不同的方法，这篇文章将为大家详细的介绍 servlet API 当中常用的类和方法。

## 什么是Servlet ##

Servlet是一种使用Java编写的服务器端程序，也称为小服务程序或服务连接器。它具有独立于平台和协议的特性，主要功能在于交互式地浏览和生成数据，生成动态Web内容。它担当客户请求（Web浏览器或其他HTTP客户程序）与服务器响应（HTTP服务器上的数据库或应用程序）的中间层。

从原理上讲，Servlet可以响应任何类型的请求，但绝大多数情况下Servlet只用来扩展基于HTTP协议的Web服务器。最早支持Servlet标准的是JavaSoft的Java Web Server，此后，一些其它的基于Java的Web服务器开始支持标准的Servlet。

Servlet运行于支持Java的应用服务器中，如Tomcat、Jetty、Server等，被称为Servlet容器。Servlet容器负责调用和执行Servlet。在开发Servlet时，需要遵循Servlet规范，通过继承HttpServlet类来实现。  
![在这里插入图片描述][109ca319a37e41c5b4a96904295e2403.png]

## HttpServlet ##

我们在写 servlet 的代码的时候，类需要继承 HttpServlet 类，HttpServlet 中的主要方法有以下几种。

<table> 
 <thead> 
  <tr> 
   <th>方法名称</th> 
   <th>调用时机</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>init</td> 
   <td>在 HttpServlet 实例化之后被调用一次</td> 
  </tr> 
  <tr> 
   <td>destory</td> 
   <td>在 HttpServlet 实例不再使用的时候调用一次</td> 
  </tr> 
  <tr> 
   <td>service</td> 
   <td>收到 HTTP 请求的时候调用</td> 
  </tr> 
  <tr> 
   <td>doGet</td> 
   <td>收到 GET 请求的时候调用(由 service 方法调用)</td> 
  </tr> 
  <tr> 
   <td>doPost</td> 
   <td>收到 POST 请求的时候调用(由 service 方法调用)</td> 
  </tr> 
  <tr> 
   <td>doPut/doDelete/doOptions/…</td> 
   <td>收到其他请求的时候调用(由 service 方法调用)</td> 
  </tr> 
 </tbody> 
</table>

上面的几种方法都是 HTTP 服务器自动调用的，不需要我们手动调用，我们需要做的就是重写doGet、doPost、doPut……等这些方法，将我们的代码逻辑添加进去。

既然这样的话，就会有很多人觉得这样的设定被限制了，确实这样的设定，降低了上限，但是却提升了下线，并且在实际的开发中，不要求有多么高的上限，而是需要保证下线不能很低，所以这种模式在实际开发中更常用。

当 HttpServlet 实例被创建的时候，就会自动调用 init() 方法，对实例对象进行一系列的初始化；然后当 HTTP 服务器接收到客户端的请求了之后，就会调用 service() 方法，并且在这个 service() 方法中，会调用对应的 doGet()、doPost()、doPut()……等方法；当服务器处理完请求数据并且返回响应的时候，如果没有收到请求了之后，就会调用 destory() 方法进行释放资源的操作，但是很可惜，destory() 并不是每次都能被调用到。关闭 tomcat 的方法有两种，一种是直接在资源管理器中关闭这个进程，那么这时 HttpServlet 中就来不及调用 destory() 方法，而如果是通过 8005 端口访问 tomcat 的管理端对 tomcat 下达“关闭”命令的时候，HttpServlet 中才会调用到 destory() 方法。

![在这里插入图片描述][f3c57c5e128a4a3c81e4302a7e1d051f.png]

上面的描述也可以被称为 HttpServlet 的生命周期

## HttpServletRequest ##

HttpServletRequest 表示 HTTP 请求，当 HTTP 服务器接收到客户端发送来的请求之后，会创建出 HttpServletRequest 对象，并且通过请求的数据去构造这个 HttpServletRequet 对象，在 service() 方法中调用的 doGet()、doPost()、doPut()等方法中传递的 HttpServletRequest 对象都是被处理之后的对象。

以下是 HttpServletRequest 类中的几种常用方法。

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

下面我将用一些代码来展示这些方法的使用。

import javax.servlet.ServletException;
    import javax.servlet.annotation.WebServlet;
    import javax.servlet.http.HttpServlet;
    import javax.servlet.http.HttpServletRequest;
    import javax.servlet.http.HttpServletResponse;
    import java.io.IOException;
    import java.util.Enumeration;
    
    @WebServlet("/httpservletreq")
    public class HttpServletreq extends HttpServlet {
        
        @Override
        protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        
            StringBuilder sb = new StringBuilder();
            sb.append(req.getProtocol()); //返回协议名称和版本
            sb.append("<br>");
            sb.append(req.getMethod()); //返回HTTP请求的方法
            sb.append("<br>");
            sb.append(req.getRequestURI()); //返回从协议名开始直到HTTP请求中的query string
            sb.append("<br>");
            sb.append(req.getContextPath()); //返回HTTP请求的URI部分
            sb.append("<br>");
            sb.append(req.getQueryString()); //返回请求URL中的query string部分
            sb.append("<br>");
            Enumeration<String> parameter = req.getParameterNames(); //返回URL中query string的所有key
            while (parameter.hasMoreElements()) {
        
                String key = (String)parameter.nextElement(); //获取query string的指定key的value
                String value = req.getParameter(key);
                sb.append(key + ": " + value + "<br>");
            }
            Enumeration<String> enumeration = req.getHeaderNames(); //返回请求Header中的所有key
            while (enumeration.hasMoreElements()) {
        
                String key = enumeration.nextElement(); //获取Header中指定key的value
                String value = req.getHeader(key);
                sb.append(key + ": " + value + "<br>");
            }
            sb.append(req.getCharacterEncoding()); //返回请求主体使用的字符编码
            sb.append("<br>");
            sb.append(req.getContentType()); //返回请求主体的MIME类型
            sb.append("<br>");
            sb.append(req.getContentLength()); //返回请求主体body部分的长度
            resp.setContentType("test/html; charset=utf8"); //告诉浏览器我们返回的数据的数据类型
            resp.getWriter().write(sb.toString()); //将StringBuider对象中的内容返回给浏览器
        }
    }

当写出上面的代码之后，启动这个程序，并且我们使用 postman 来构造一个 HTTP 请求。

![在这里插入图片描述][0a4d535abdc74d079dc95f724db1d017.png]

![在这里插入图片描述][e32d2d13c24a4467ad9915929d5f0bbc.png]

![在这里插入图片描述][4056ff8451f94a2883e7196170e2ca41.png]

![在这里插入图片描述][3e5d8e225ea244b2ad211d287083216e.png]

`String[] getParameterValues(String name)`往往使用在一个key有多个value的时候，比如a=1&a=2。

URL和URI的区别

1.  含义不同：URI是uniform resource identifier，统一资源标识符，用来唯一的标识一个资源。URL是uniform resource locator，统一资源定位器，它是一种具体的URI，即URL可以用来标识一个资源，而且还指明了如何locate这个资源。
2.  格式不同：URL的格式一般由下列三部分组成：第一部分是协议（或称为服务方式）；第二部分是存有该资源的主机IP地址（有时也包括端口号）；第三部分是主机资源的具体地址。URI一般由三部分组成：访问资源的命名机制；存放资源的主机名；资源自身的名称，由路径表示。
3.  位置不同：绝对URL（absolute URL）显示文件的完整路径，这意味着绝对URL本身所在的位置与被引用的实际文件的位置无关。绝对的URI指以scheme（后面跟着冒号）开头的URI，你可以把绝对的URI看作是以某种方式引用某种资源，而这种方式对标识符出现的环境没有依赖。

简单来说，URL 是包含于 URI 的。

这里我们构造的 HTTP 请求中没有 query string 部分，所以`getQueryString()` `getParameterNames()`返回的都是null，这里我们可以添加 query string。

![在这里插入图片描述][07f4648773fb4a73b378802580ada6a6.png]

![在这里插入图片描述][241ce60f0a7f41dc8220a8eb1bb3e5ea.png]

除了 query string，我们还可以通过 POST 方法来通过 HTTP 请求的 body 来传递参数。

### 1. form表单构造POST请求 ###

使用 POST 方法就需要在我们的程序中重写 doPost 方法。

protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        
            StringBuilder sb = new StringBuilder();
            sb.append(req.getProtocol()); //返回协议名称和版本
            sb.append("<br>");
            sb.append(req.getMethod()); //返回HTTP请求的方法
            sb.append("<br>");
            sb.append(req.getRequestURI()); //返回从协议名开始直到HTTP请求中的query string
            sb.append("<br>");
            sb.append(req.getContextPath()); //返回HTTP请求的URI部分
            sb.append("<br>");
            sb.append(req.getQueryString()); //返回请求URL中的query string部分
            sb.append("<br>");
            Enumeration<String> parameter = req.getParameterNames(); //返回URL中query string的所有key
            while (parameter.hasMoreElements()) {
        
                String key = (String)parameter.nextElement(); //获取query string的指定key的value
                String value = req.getParameter(key);
                sb.append(key + ": " + value + "<br>");
            }
            Enumeration<String> enumeration = req.getHeaderNames(); //返回请求Header中的所有key
            while (enumeration.hasMoreElements()) {
        
                String key = enumeration.nextElement(); //获取Header中指定key的value
                String value = req.getHeader(key);
                sb.append(key + ": " + value + "<br>");
            }
            sb.append(req.getCharacterEncoding()); //返回请求主体使用的字符编码
            sb.append("<br>");
            sb.append(req.getContentType()); //返回请求主体的MIME类型
            sb.append("<br>");
            sb.append(req.getContentLength()); //返回请求主体body部分的长度
            resp.setContentType("test/html; charset=utf8"); //告诉浏览器我们返回的数据的数据类型
            resp.getWriter().write(sb.toString()); //将StringBuider对象中的内容返回给浏览器
        }

![在这里插入图片描述][aa0518bb7e454e9389e392aa33cfed7e.png]

postman form 表单构造 POST 请求。  
![在这里插入图片描述][e32bc66f6877410ba48f66ae097a8318.png]  
![在这里插入图片描述][ecbe2d65b33243649477be9d4ceb68c2.png]

Fiddler 抓取 HTTP 请求包。

![在这里插入图片描述][548c1cac3d5445d598cd7c7145471b42.png]  
form 表单实际上就是将query string部分给放入到 body 部分，我们还可以使用 JSON 的方式来表示 body 部分。

### 2. JSON形式表示body部分 ###

form 表单表示 body 的方法是 servlet 本身就支持的，而使用 JSON 格式则需要引入第三方库 Jackson。

![在这里插入图片描述][c173189422904d21bf2662598261b9af.png]  
然后选择一个版本，将坐标给导入到 maven 中。

![在这里插入图片描述][3c1460196fd84da386e5259b42ca0d42.png]  
jackson 中主要使用的就是一个类 ObjectMapper 和两个方法：read 方法——将 json 字符串映射为一个Java对象，write 方法——把一个Java对象映射为一个json字符串。

import com.fasterxml.jackson.databind.ObjectMapper;
    
    import javax.servlet.ServletException;
    import javax.servlet.annotation.WebServlet;
    import javax.servlet.http.HttpServlet;
    import javax.servlet.http.HttpServletRequest;
    import javax.servlet.http.HttpServletResponse;
    import java.io.IOException;
    
    class Request {
        
        public String username;
        public String password;
    }
    
    class Response {
        
        public boolean ok;
    }
    @WebServlet("/jsonpost")
    public class JsonPost extends HttpServlet {
        
        @Override
        protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        
            ObjectMapper objectMapper = new ObjectMapper();
            Request request = objectMapper.readValue(req.getInputStream(), Request.class);
            System.out.println("username: " + request.username);
            System.out.println("password: " + request.password);
    
            Response response = new Response();
            response.ok = true;
            String respJson = objectMapper.writeValueAsString(response);
            resp.setContentType("application/json; charset=utf8");
            resp.getWriter().write(respJson);
        }
    }

`Request request = objectMapper.readValue(req.getInputStream(), Request.class);` 这个方法首先会执行 `req.getInputStream()` 方法，获取到 InputStream 流，然后 `readValue()` 方法会读取这个 InputStream 中的所有数据，并且将这里面的数据按照 JSON 的格式进行解析，解析成 Map(键值对）的形式；然后 readValue() 方法就会调用反射的 API，创建出 Request.class 实例，获取到 Request 类中的所有属性——username和password，然后在前面解析成的 Map 中查找 Request 中的属性，并且将查找的结果复制给对应属性。

`objectMapper.writeValueAsString(response)` 这个方法则是通过传入的参数获取到类对象，获取到类中的属性，然后在这个类中查找这个属性的值，并且按照 JSON 的格式，将属性和属性值构造成字符串。形如：“\{ok:true\}”

服务器部分代码编写完成之后，我们就来构造一个 JSON 表示body的 HTTP 请求。

![在这里插入图片描述][63e88d7ef2ac41cb9b58a92036b405ed.png]  
![在这里插入图片描述][537730e6ff504872bc64abbc17012104.png]  
Fiddler 抓取 HTTP 请求。

![在这里插入图片描述][a298db64186a4d9caba0700fc9421dba.png]

## HttpServletResponse ##

HttpServletResponse 是服务端根据客户端发来的请求做出响应的类，HttpServletResponse中也包含了很多的方法。

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

`setStatus(int sc)` 这个方法如果不显式指出状态码的话，会默认为200。

![在这里插入图片描述][cdb1cf6d373c4351b38d904e17c8d4fc.png]

这里我们给相应的 Header 中设置一个刷新页面的key-value。

![在这里插入图片描述][16d59053a03e4717b3a87500a7e04e44.png]  
![在这里插入图片描述][6acb8da34dc24bb996487f9043fc2fda.png]

postman 不能显示出动态变化的页面，所以我们需要在浏览器中才能看到这个变化。

![在这里插入图片描述][1464375ea1f54d9bb0a5e057981cc86e.png]  
![在这里插入图片描述][63eccc72c4404977a488fcf9915f3a8a.png]  
当在 Header 中添加进去 refresh 键值对的时候，页面会根据后面设置的时间进行刷新。。

`setContenType()` 和 `setCharacterEncoding()` 这两个方法作用其实是差不多的，但是我们更建议使用 `setContenType()` 方法，因为这个方法还可以指定字符编码集。`resp.setContentType("test/html; charset=utf8")`

`sendRedirect(String location)` 方法会设置页面重定向到哪里，也就是当状态码返回3xx的时候的重定向位置。

![在这里插入图片描述][250ca70991184c1bb490756a531e240b.png]

上面设置状态码为3xx，然后设置重定向位置这两个操作可以合并为一个操作。

@WebServlet("/redirect")
    public class HttpRedirect extends HttpServlet {
        
        @Override
        protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        
    //        resp.setStatus(302);
    //        resp.setHeader("Location", "https://www.baidu.com");
            resp.sendRedirect("http://www.baidu.com");
        }
    }

`getWriter()` 和 `getOutputStream()` 方法则是将响应写入 body 中，这里不过多解释。

[a39c7566edfe483c8bc245ffa7190953.gif_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/19/8f0eb9e9500742419d3c6e2222c5bc0b.png
[109ca319a37e41c5b4a96904295e2403.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/19/5c72058dc08b4381875352dd48b6e461.png
[f3c57c5e128a4a3c81e4302a7e1d051f.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/19/be996d29694c439f883421f4b71cfd5f.png
[0a4d535abdc74d079dc95f724db1d017.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/19/440a75085cf74f2583e8c5390a6f434f.png
[e32d2d13c24a4467ad9915929d5f0bbc.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/19/9b9f67c9237743a8a6f642d16bb9b407.png
[4056ff8451f94a2883e7196170e2ca41.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/19/bb646e29106749e79a95735376bf7a75.png
[3e5d8e225ea244b2ad211d287083216e.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/19/79237329445345cbbfe3b985efea9b5d.png
[07f4648773fb4a73b378802580ada6a6.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/19/8821dd8c9a3c4ae0991efcdffe8e91aa.png
[241ce60f0a7f41dc8220a8eb1bb3e5ea.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/19/1b17cedc9e724a0dbee668dad03242b1.png
[aa0518bb7e454e9389e392aa33cfed7e.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/19/32309fadcd1f471d9c31c8c6b210a13a.png
[e32bc66f6877410ba48f66ae097a8318.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/19/bb9e291e3fd249a39586a43a25372f38.png
[ecbe2d65b33243649477be9d4ceb68c2.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/19/ee30a403329b4dd78bc518efe271d1ee.png
[548c1cac3d5445d598cd7c7145471b42.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/19/d094c358e11d42de87b1dc66ea8776b2.png
[c173189422904d21bf2662598261b9af.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/19/becaedac4bd94af199db07cb1329d0be.png
[3c1460196fd84da386e5259b42ca0d42.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/19/a556e971065c486abba062b1ce782325.png
[63e88d7ef2ac41cb9b58a92036b405ed.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/19/e9ba68fa6d434c3890ca3b56438b6099.png
[537730e6ff504872bc64abbc17012104.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/19/8e5c72d15e4e47da99a3d983ec06c7d9.png
[a298db64186a4d9caba0700fc9421dba.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/19/3007b8b6d7204ee5bffbd382db4eb5ca.png
[cdb1cf6d373c4351b38d904e17c8d4fc.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/19/ebdb253596d14bf784bbbca310f6b56b.png
[16d59053a03e4717b3a87500a7e04e44.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/19/afe2c70ba9b74907ba91d0fd3486535d.png
[6acb8da34dc24bb996487f9043fc2fda.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/19/9ac35b40173c4c459671e0fb8bb44b54.png
[1464375ea1f54d9bb0a5e057981cc86e.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/19/818faef31d1d477bb1928845b99d0a8a.png
[63eccc72c4404977a488fcf9915f3a8a.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/19/ff3c68ee8ee14fbb9db2c5175580cb3d.png
[250ca70991184c1bb490756a531e240b.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/19/ee78cbcb4aa945e58c95e6e4b020fd06.png