Java 响应对象详解

Dear 丶 2022-10-06 11:55 148阅读 0赞

### 文章目录 ###

*  1 响应对象
 *   *  1.1 响应对象概述
     *   *  1.1.1 关于响应
         *  1.1.2 常用响应对象
     *  1.2 常用方法介绍
     *   *  1.2.1 API 介绍
         *  1.2.2 常用响应状态码
     *  1.3 响应对象的使用示例
     *   *  1.3.1 响应字节流输出中文乱码问题
         *  1.3.3 响应-生成验证码
         *  1.3.4 设置响应消息头 —— 控制缓存
         *  1.3.5 设置响应消息头 —— 定时刷新
         *  1.3.6 请求重定向：注意地址栏发生改变。
         *  1.3.7 响应和消息头组合应用 —— 文件下载
         *  1.3.8 响应对象注意事项

# 1 响应对象 #

## 1.1 响应对象概述 ##

### 1.1.1 关于响应 ###

响应，它表示了服务器端收到请求，同时也已经处理完成，把处理的结果告知用户。简单来说，指的就是服务器把请求的处理结果告知客户端。在B/S架构中，响应就是把结果带回浏览器。

响应对象，顾名思义就是用于在JavaWeb工程中实现上述功能的对象。

### 1.1.2 常用响应对象 ###

响应对象也是是Servlet规范中定义的，它包括了协议无关的和协议相关的。

*  协议无关的对象标准是：ServletResponse接口
 *  协议相关的对象标准是：HttpServletResponse接口

类结构图如下：

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NTUyNTI3Mg_size_16_color_FFFFFF_t_70]

下面介绍涉及的响应对象都是和HTTP协议相关的。即使用的是HttpServletResponse接口的实现类。

这里有些同学可能会产生疑问，我们在使用Servlet时，需要定义一个类，然后实现Servlet接口（或者继承它的实现类）。现在我们想要实现响应功能，要不要定义一个类，然后实现HttpServletResponse接口呢？

**此问题的答案是否定的，我们无需这么做。**我们只需要在自己写的Servlet中直接使用即可，因为这个对象的实现类是由Tomcat提供的，无须我们自定义。同时它还会帮我们把对象创建出来并传入doGet和doPost方法中。

## 1.2 常用方法介绍 ##

### 1.2.1 API 介绍 ###

在官网中我们可以查看到：[https://javaee.github.io/javaee-spec/javadocs/][https_javaee.github.io_javaee-spec_javadocs]

在HttpServletResponse接口中提供了很多方法，接下来我们通过API文档，来了解一下这些方法。

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NTUyNTI3Mg_size_16_color_FFFFFF_t_70 1]

我们对上面函数进行中文解释，如下图。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NTUyNTI3Mg_size_16_color_FFFFFF_t_70 2]

### 1.2.2 常用响应状态码 ###

常用状态码：

<table> 
 <thead> 
  <tr> 
   <th align="center">状态码</th> 
   <th align="center">说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="center">200</td> 
   <td align="center">执行成功</td> 
  </tr> 
  <tr> 
   <td align="center">302</td> 
   <td align="center">它和307一样，都是用于重定向的状态码。只是307目前已不再使用</td> 
  </tr> 
  <tr> 
   <td align="center">304</td> 
   <td align="center">请求资源未改变，使用缓存。</td> 
  </tr> 
  <tr> 
   <td align="center">400</td> 
   <td align="center">请求错误。最常见的就是请求参数有问题</td> 
  </tr> 
  <tr> 
   <td align="center">404</td> 
   <td align="center">请求资源未找到</td> 
  </tr> 
  <tr> 
   <td align="center">405</td> 
   <td align="center">请求方式不被支持</td> 
  </tr> 
  <tr> 
   <td align="center">500</td> 
   <td align="center">服务器运行内部错误</td> 
  </tr> 
 </tbody> 
</table>

状态码首位含义：

<table> 
 <thead> 
  <tr> 
   <th align="center">状态码</th> 
   <th align="center">说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="center">1xx</td> 
   <td align="center">消息</td> 
  </tr> 
  <tr> 
   <td align="center">2xx</td> 
   <td align="center">成功</td> 
  </tr> 
  <tr> 
   <td align="center">3xx</td> 
   <td align="center">重定向</td> 
  </tr> 
  <tr> 
   <td align="center">4xx</td> 
   <td align="center">客户端错误</td> 
  </tr> 
  <tr> 
   <td align="center">5xx</td> 
   <td align="center">服务器错误</td> 
  </tr> 
 </tbody> 
</table>

## 1.3 响应对象的使用示例 ##

### 1.3.1 响应字节流输出中文乱码问题 ###

内容过多，请移驾我的另一篇博客：  
[https://yangyongli.blog.csdn.net/article/details/117877830][https_yangyongli.blog.csdn.net_article_details_117877830]

### 1.3.3 响应-生成验证码 ###

内容过多，请移驾我的另一篇博客：  
[https://yangyongli.blog.csdn.net/article/details/117878306][https_yangyongli.blog.csdn.net_article_details_117878306]

### 1.3.4 设置响应消息头 —— 控制缓存 ###

/** * 设置缓存时间 * 使用缓存的一般都是静态资源 * 动态资源一般不能缓存。 * 我们现在目前只掌握了Servlet，所以用Servlet做演示 * */
    public class ResponseDemo4 extends HttpServlet { 
    
        public void doGet(HttpServletRequest request, HttpServletResponse response)
                throws ServletException, IOException { 
            String str = "设置缓存时间";
            /* * 设置缓存时间，其实就是设置响应消息头：Expires 但是值是一个毫秒数。 * 使用的是 * response.setDateHeader(); * * 缓存1小时，是在当前时间的毫秒数上加上1小时之后的毫秒值 */
            response.setDateHeader("Expires",System.currentTimeMillis()+1*60*60*1000);
            response.setContentType("text/html;charset=UTF-8");
            response.getOutputStream().write(str.getBytes());
        }
    
        public void doPost(HttpServletRequest request, HttpServletResponse response)
                throws ServletException, IOException { 
            doGet(request, response);
        }
    
    }

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NTUyNTI3Mg_size_16_color_FFFFFF_t_70 3]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NTUyNTI3Mg_size_16_color_FFFFFF_t_70 4]

### 1.3.5 设置响应消息头 —— 定时刷新 ###

/** * 设置响应消息头： * 通过定时刷新演示添加消息头 */
    public class ResponseDemo5 extends HttpServlet { 
    
        public void doGet(HttpServletRequest request, HttpServletResponse response)
                throws ServletException, IOException { 
            String str = "用户名和密码不匹配，2秒后转向登录页面...";
            response.setContentType("text/html;charset=UTF-8");
            PrintWriter out = response.getWriter();
            out.write(str);
            //定时刷新，其实就是设置一个响应消息头
            response.setHeader("Refresh", "2;URL=/login.html");//Refresh设置的时间单位是秒，如果刷新到其他地址，需要在时间后面拼接上地址
        }
    
        public void doPost(HttpServletRequest request, HttpServletResponse response)
                throws ServletException, IOException { 
            doGet(request, response);
        }
    
    }

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NTUyNTI3Mg_size_16_color_FFFFFF_t_70 5]

### 1.3.6 请求重定向：注意地址栏发生改变。 ###

/** * 设置响应状态码，实现重定向 * 重定向的特点： * 两次请求，地址栏改变，浏览器行为，xxxx * */
    public class ResponseDemo6 extends HttpServlet { 
    
        public void doGet(HttpServletRequest request, HttpServletResponse response)
                throws ServletException, IOException { 
            //1.设置响应状态码
    // response.setStatus(302);
            //2.定向到哪里去: 其实就是设置响应消息头，Location
    // response.setHeader("Location", "ResponseDemo7");
    
            //使用重定向方法
            response.sendRedirect("ResponseDemo7");//此行做了什么事，请看上面
        }
    
        public void doPost(HttpServletRequest request, HttpServletResponse response)
                throws ServletException, IOException { 
            doGet(request, response);
        }
    
    }

重定向到了这

/** * 重定向的目的地 */
    public class ResponseDemo7 extends HttpServlet { 
    
        public void doGet(HttpServletRequest request, HttpServletResponse response)
                throws ServletException, IOException { 
            response.getWriter().write("welcome to ResponseDemo7");
        }
    
        public void doPost(HttpServletRequest request, HttpServletResponse response)
                throws ServletException, IOException { 
            doGet(request, response);
        }
    
    }

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NTUyNTI3Mg_size_16_color_FFFFFF_t_70 6]

### 1.3.7 响应和消息头组合应用 —— 文件下载 ###

首先，在工程的web目录下新建一个目录uploads，并且拷贝一张图片到目录中，如下图所示：

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NTUyNTI3Mg_size_16_color_FFFFFF_t_70 7]

文件下载的Servlet代码如下：

/** * 文件下载 * */
    public class ResponseDemo8 extends HttpServlet { 
    
        public void doGet(HttpServletRequest request, HttpServletResponse response)
                throws ServletException, IOException { 
            /* * 文件下载的思路： * 1.获取文件路径 * 2.把文件读到字节输入流中 * 3.告知浏览器，以下载的方式打开（告知浏览器下载文件的MIME类型） * 4.使用响应对象的字节输出流输出到浏览器上 */
            //1.获取文件路径（绝对路径）
            ServletContext context = this.getServletContext();
            String filePath = context.getRealPath("/uploads/6.jpg");//通过文件的虚拟路径，获取文件的绝对路径
            //2.通过文件路径构建一个字节输入流
            InputStream in  = new FileInputStream(filePath);
            //3.设置响应消息头
            response.setHeader("Content-Type", "application/octet-stream");//注意下载的时候，设置响应正文的MIME类型，用application/octet-stream
            response.setHeader("Content-Disposition", "attachment;filename=1.jpg");//告知浏览器以下载的方式打开
            //4.使用响应对象的字节输出流输出
            OutputStream out = response.getOutputStream();
            int len = 0;
            byte[] by = new byte[1024];
            while((len = in.read(by)) != -1){ 
                out.write(by, 0, len);
            }
            in.close();
        }
    
        public void doPost(HttpServletRequest request, HttpServletResponse response)
                throws ServletException, IOException { 
            doGet(request, response);
        }
    
    }

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NTUyNTI3Mg_size_16_color_FFFFFF_t_70 8]

### 1.3.8 响应对象注意事项 ###

**第一： response得到的字符流和字节流互斥，只能选其一**

**第二：response获取的流不用关闭，由服务器关闭即可**

/** * 使用Response对象获取流时候的注意事项： * 1.我们使用response获取的流，可以不用关闭。服务器会给我们关闭。 * 2.在response对象中，字节流和字符流互斥，输出的时候，只能选择一个 * */
    public class ResponseDemo9 extends HttpServlet { 
    
        public void doGet(HttpServletRequest request, HttpServletResponse response)
                throws ServletException, IOException { 
            String str = "test";
            response.getOutputStream().write(str.getBytes());
            //response.getWriter().write(str);
    // response.getOutputStream().write("haha".getBytes());
    
        }
    
        public void doPost(HttpServletRequest request, HttpServletResponse response)
                throws ServletException, IOException { 
            doGet(request, response);
        }
    
    }

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NTUyNTI3Mg_size_16_color_FFFFFF_t_70 9]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NTUyNTI3Mg_size_16_color_FFFFFF_t_70]: /images/20221005/5c4ee0adc2c742009242c001fe473eae.png
[https_javaee.github.io_javaee-spec_javadocs]: https://javaee.github.io/javaee-spec/javadocs/
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NTUyNTI3Mg_size_16_color_FFFFFF_t_70 1]: /images/20221005/4b1a3553c7a4467e848840dfe5e07c94.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NTUyNTI3Mg_size_16_color_FFFFFF_t_70 2]: /images/20221005/4e356d6a78bf4982afe98e4ab6bf4838.png
[https_yangyongli.blog.csdn.net_article_details_117877830]: https://yangyongli.blog.csdn.net/article/details/117877830
[https_yangyongli.blog.csdn.net_article_details_117878306]: https://yangyongli.blog.csdn.net/article/details/117878306
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NTUyNTI3Mg_size_16_color_FFFFFF_t_70 3]: /images/20221005/df8df512dfa84dac893b323439b117ec.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NTUyNTI3Mg_size_16_color_FFFFFF_t_70 4]: /images/20221005/d6bf4c3642a8454c8a148ad04e3a5cae.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NTUyNTI3Mg_size_16_color_FFFFFF_t_70 5]: /images/20221005/221b00f616be4f60a9779e494a84e26d.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NTUyNTI3Mg_size_16_color_FFFFFF_t_70 6]: /images/20221005/4287777a95494e7bb767dd67a0a36c6c.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NTUyNTI3Mg_size_16_color_FFFFFF_t_70 7]: /images/20221005/754cf553aee84e0bad63cb8bf12588f9.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NTUyNTI3Mg_size_16_color_FFFFFF_t_70 8]: /images/20221005/deb4a46807e14d3381e8d53537eced1d.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80NTUyNTI3Mg_size_16_color_FFFFFF_t_70 9]: /images/20221005/432fd8b124eb4f48a16bcc0e352c6d1c.png