一文看懂HttpServletResponse

https://www.jianshu.com/p/8bc6b82403c5

Web服务器收到客户端的http请求,会针对每一次请求,分别创建一个用于代表请求的request对象、和代表响应的response对象。获取网页提交过来的数据,只需要找request对象就行了。要向网页输出数据,只需要找response对象。

一,HttpServletResponse对象介绍

1.jpg

HttpServletResponse对象代表服务器的响应。这个对象中封装了向客户端发送数据、发送响应头,发送响应状态码的方法。

二,HttpServletResponse对象常用方法

**1,负责向客户端(浏览器)发送数据的相关方法 **

getOutputStream()该方法用于返回Servlet引擎创建的字节输出流对象,Servlet程序可以按字节形式输出响应正文。
getWriter() 该方法用于返回Servlet引擎创建的字符输出流对象,Servlet程序可以按字符形式输出响应正文。

注意:

1,getOutputStream()和getWriter()这两个方法互相排斥,调用了其中的任何一个方法后,就不能再调用另一方法。

2,getOutputStream()返回的字节输出流对象,类型为:ServletOutputStream,直接输出字节数组中的二进制数据

3,getWriter()方法将Servlet引擎的数据缓冲区包装成P:rintWriter类型的字符输出流对象后返回,PrintWriter对象只能输出字符文本内容

2,负责向客户端(浏览器)发送响应头的相关方法

addDateHeader(String name ,long date)该方法是设置只有一个值且值的类型为long类型的响应头,例如expies响应头,表示过期时间
addHeader(String name,String value) 该方法是设置有多个值的响应头,参数name表示响应头名称,参数value表示响应头的值
addIntHeader(String name,int value) 该方法是设置有多个值且值的类型为int类型的响应头
setHeader(String name,String value) 该方法是设置只有一个值的响应头,参数name表示响应头名称,参数value表示响应头的值
setDateHeader(String name,long value) 该方法是设置只有一个值且值的类型为long类型的响应头,例如expies响应头,表示过期时间
setIntHeader(String name,int value) 该方法是设置只有一个值且值的类型为int类型的响应头,例如Content-Length响应头,该响应头是代表响应内容有多少字节数
//设置Content-Type响应头
resp.setHeader("Content-Type","text/html;charset=utf-8");
//添加一个响应头:xxx是表示某一响应头
resp.addHeader("xxx", "123");
//通知客户端响应内容长度为888个字节
resp.setIntHeader("Context-Length", 5);
//设置过期时间为:5000毫秒
resp.setDateHeader("", 5000);

3,负责向客户端(浏览器)发送响应状态码的相关方法

setStatus(int value)设置临时定向响应码

4,响应状态码的常量

HttpServletResponse定义了很多状态码的常量(具体可以查看Servlet的API),当需要向客户端发送响应状态码时,可以使用这些常量,避免了直接写数字,常见的状态码对应的常量:

SC_NOT_FOUND状态码404对应的常量
SC_OK 状态码200对应的常量
SC_INIERNAL_SERVER_ERROR 状态码500对应的常量

三,HttpServletResponse对象常见应用

1,向客户端浏览器输出数据

例子1:使用OutputStream流向客户端浏览器输出数据

public class HelloResponse extends HttpServlet{
 
    private static final long serialVersionUID = 3903946972744326948L;
    
    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        this.doPost(req, resp);
    }
    
    @Override
    protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        //设置Content-Type响应头,编码格式为UTF-8
        resp.setHeader("Content-Type","text/html;charset=utf-8");
        outPutOutputStream(resp);
    }
    /**
     * 
     * @方法名: outPutOutputStream
     * @描述: 使用OutputStream输出流输出数据
     * @param resp
     * @throws IOException 
     * @创建人 zender
     */
    private void outPutOutputStream(HttpServletResponse resp) throws IOException{
        String data = "输出的内容";
        //获取OutputStream输出流
        OutputStream outputStream = resp.getOutputStream();
        //将字符转换成字节数组,指定以UTF-8编码进行转换
        byte[] dataByteArr = data.getBytes("UTF-8");
        //使用OutputStream流向客户端输出字节数组
        outputStream.write(dataByteArr);
    }
}

运行结果如下:

image

例子2:使用PrintWriter流向客户端浏览器输出数据

public class PrintWriterResponse extends HttpServlet{
 
    private static final long serialVersionUID = 3903946972744326948L;
    
    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        this.doPost(req, resp);
    }
    
    @Override
    protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        //设置编码格式为UTF-8
        resp.setCharacterEncoding("UTF-8");
        //通过设置响应头控制浏览器以UTF-8的编码显示数据,如果不加这句话,那么浏览器显示的将是乱码
        resp.setHeader("content-type", "text/html;charset=UTF-8");
        outPutPrintWriter(resp);
    }
    /**
     * 
     * @方法名: outPutPrintWriter
     * @描述: 使用PrintWriter输出流输出数据
     * @param resp
     * @throws IOException 
     * @创建人 zender
     */
    private void outPutPrintWriter(HttpServletResponse resp) throws IOException{
        String data = "输出的内容";
        //获取PrintWriter输出流
        PrintWriter out = resp.getWriter();
        //使用PrintWriter流向客户端输出字符
        out.write(data);
    }
}

运行结果如下:

image

注意:

1,在获取PrintWriter输出流之前首先使用"response.setCharacterEncoding(charset)"设置字符以什么样的编码输出到浏览器,再使用response.getWriter();获取PrintWriter输出流,这两个步骤不能颠倒。

2,在开发过程中,如果希望服务器输出什么浏览器就能看到什么,那么在服务器端都要以字符串的形式进行输出。

2,文件下载

文件下载功能是web开发中经常使用到的功能,使用HttpServletResponse对象就可以实现文件的下载。

文件下载功能的实现思路:

  • 获取要下载的文件的绝对路径

  • 获取要下载的文件名

  • 设置content-disposition响应头控制浏览器以下载的形式打开文件

  • 获取要下载的文件输入流

  • 创建数据缓冲区

  • 通过response对象获取OutputStream流

  • 将FileInputStream流写入到buffer缓冲区

  • 使用OutputStream将缓冲区的数据输出到客户端浏览器

public class FileDownloadResponse extends HttpServlet{
 
    private static final long serialVersionUID = 3903946972744326948L;
    
    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        this.doPost(req, resp);
    }
    
    @Override
    protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        //获取要下载的文件的绝对路径
        String realPath = this.getServletContext().getRealPath("/下载.png");
        //获取要下载的文件名
        String fileName = realPath.substring(realPath.lastIndexOf("\")+1);
        //设置content-disposition响应头控制浏览器以下载的形式打开文件
        //中文文件名要使用URLEncoder.encode方法进行编码,否则会出现文件名乱码
        resp.setHeader("content-disposition", "attachment;filename=" + URLEncoder.encode(fileName, "UTF-8"));
        //获取文件输入流
        InputStream in = new FileInputStream(realPath);
        int len = 0;
        byte[] buffer = new byte[1024];
        OutputStream out = resp.getOutputStream();
        while ((len = in.read(buffer)) > 0) {
            out.write(buffer,0,len);//将缓冲区的数据输出到客户端浏览器
        }
        in.close();
        out.close();
    }
}
image

注意:

推荐使用OutputStream流,避免使用PrintWriter流,因为OutputStream流是字节流,可以处理任意类型的数据,而PrintWriter流是字符流,只能处理字符数据,如果用字符流处理字节数据,会导致数据丢失。

3,生成验证码

这个可以当做一个工具类来使用,不必自己写出来,要用的时候复制,然后可以局部的改改代码,就可以变成另外的验证码了。

public class ResponseDemo4 extends HttpServlet {

    public static final int WIDTH = 120; // 生成的图片的宽度
    public static final int HEIGHT = 35; // 生成的图片的高度

    protected void doGet(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {

        // 在内存中创建一张图片
        BufferedImage image = new BufferedImage(WIDTH, HEIGHT, BufferedImage.TYPE_INT_RGB);
        // 得到图片
        Graphics g = image.getGraphics();

        // 1.设置图片的背景色
        setBackGround(g);

        // 2.设置图片的边框
        setBorder(g);

        // 3.在图片上画干扰线
        drawRandomLine(g);

        // 4.在图片上写随机数
        String random = drawRandomNum((Graphics2D) g);
        request.getSession().setAttribute("checkcode", random); // 将随机数存在session中

        /*
         * 5.图形写给浏览器
         */
        response.setContentType("image/jpeg")
        // 发响应头控制浏览器不要缓存图片
        response.setDateHeader("expries", -1);
        response.setHeader("Cache-Control", "no-cache");
        response.setHeader("Pragma", "no-cache");
        ImageIO.write(image, "jpg", response.getOutputStream());

    }

    /*
     * 设置图片的背景色
     */
    private void setBackGround(Graphics g) {
        // 设置颜色
        g.setColor(Color.WHITE);
        // 填充区域
        g.fillRect(0, 0, WIDTH, HEIGHT);
    }

    /*
     * 设置图片的边框
     */
    private void setBorder(Graphics g) {
        // 设置边框颜色
        g.setColor(Color.BLUE);
        // 边框区域
        g.drawRect(1, 1, WIDTH-2, HEIGHT-2);
    }

    /*
     * 在图片上画干扰线
     */
    private void drawRandomLine(Graphics g) {
        // 设置颜色
        g.setColor(Color.GREEN);
        // 设置线条个数并画线
        for(int i=0;i<5;i++) {
            // 生成干扰线随机的起始坐标
            int x1 = new Random().nextInt(WIDTH); // 生成0~WIDTH(不包括WIDTH)的随机数
            int y1 = new Random().nextInt(HEIGHT);

            // 生成干扰线随机的结束坐标
            int x2 = new Random().nextInt(WIDTH);
            int y2 = new Random().nextInt(HEIGHT);

            g.drawLine(x1, y1, x2, y2);
        }
    }

    /*
     * 在图片上写随机数
     */
    private String drawRandomNum(Graphics2D g) {
        // 设置颜色
        g.setColor(Color.RED);
        // 设置字体
        g.setFont(new Font("宋体", Font.BOLD, 20));
        // 常用的中国汉字(汉字区间:[u4e00-u9fa5])
        String base = "u7684u4e00u4e86u662fu6211u4e0du5728u4ebau4eecu6709u6765u4ed6u8fd9u4e0au7740u4e2au5730u5230u5927u91ccu8bf4u5c31u53bbu5b50u5f97u4e5fu548cu90a3u8981u4e0bu770bu5929u65f6u8fc7u51fau5c0fu4e48u8d77u4f60u90fdu628au597du8fd8u591au6ca1u4e3au53c8u53efu5bb6u5b66u53eau4ee5u4e3bu4f1au6837u5e74u60f3u751fu540cu8001u4e2du5341u4eceu81eau9762u524du5934u9053u5b83u540eu7136u8d70u5f88u50cfu89c1u4e24u7528u5979u56fdu52a8u8fdbu6210u56deu4ec0u8fb9u4f5cu5bf9u5f00u800cu5df1u4e9bu73b0u5c71u6c11u5019u7ecfu53d1u5de5u5411u4e8bu547du7ed9u957fu6c34u51e0u4e49u4e09u58f0u4e8eu9ad8u624bu77e5u7406u773cu5fd7u70b9u5fc3u6218u4e8cu95eeu4f46u8eabu65b9u5b9eu5403u505au53ebu5f53u4f4fu542cu9769u6253u5462u771fu5168u624du56dbu5df2u6240u654cu4e4bu6700u5149u4ea7u60c5u8defu5206u603bu6761u767du8bddu4e1cu5e2du6b21u4eb2u5982u88abu82b1u53e3u653eu513fu5e38u6c14u4e94u7b2cu4f7fu5199u519bu5427u6587u8fd0u518du679cu600eu5b9au8bb8u5febu660eu884cu56e0u522bu98deu5916u6811u7269u6d3bu90e8u95e8u65e0u5f80u8239u671bu65b0u5e26u961fu5148u529bu5b8cu5374u7ad9u4ee3u5458u673au66f4u4e5du60a8u6bcfu98ceu7ea7u8ddfu7b11u554au5b69u4e07u5c11u76f4u610fu591cu6bd4u9636u8fdeu8f66u91cdu4fbfu6597u9a6cu54eau5316u592au6307u53d8u793eu4f3cu58ebu8005u5e72u77f3u6ee1u65e5u51b3u767eu539fu62ffu7fa4u7a76u5404u516du672cu601du89e3u7acbu6cb3u6751u516bu96beu65e9u8bbau5417u6839u5171u8ba9u76f8u7814u4ecau5176u4e66u5750u63a5u5e94u5173u4fe1u89c9u6b65u53cdu5904u8bb0u5c06u5343u627eu4e89u9886u6216u5e08u7ed3u5757u8dd1u8c01u8349u8d8au5b57u52a0u811au7d27u7231u7b49u4e60u9635u6015u6708u9752u534au706bu6cd5u9898u5efau8d76u4f4du5531u6d77u4e03u5973u4efbu4ef6u611fu51c6u5f20u56e2u5c4bu79bbu8272u8138u7247u79d1u5012u775bu5229u4e16u521au4e14u7531u9001u5207u661fu5bfcu665au8868u591fu6574u8ba4u54cdu96eau6d41u672au573au8be5u5e76u5e95u6df1u523bu5e73u4f1fu5fd9u63d0u786eu8fd1u4eaeu8f7bu8bb2u519cu53e4u9ed1u544au754cu62c9u540du5440u571fu6e05u9633u7167u529eu53f2u6539u5386u8f6cu753bu9020u5634u6b64u6cbbu5317u5fc5u670du96e8u7a7fu5185u8bc6u9a8cu4f20u4e1au83dcu722cu7761u5174u5f62u91cfu54b1u89c2u82e6u4f53u4f17u901au51b2u5408u7834u53cbu5ea6u672fu996du516cu65c1u623fu6781u5357u67aau8bfbu6c99u5c81u7ebfu91ceu575au7a7au6536u7b97u81f3u653fu57ceu52b3u843du94b1u7279u56f4u5f1fu80dcu6559u70edu5c55u5305u6b4cu7c7bu6e10u5f3au6570u4e61u547cu6027u97f3u7b54u54e5u9645u65e7u795eu5ea7u7ae0u5e2eu5566u53d7u7cfbu4ee4u8df3u975eu4f55u725bu53d6u5165u5cb8u6562u6389u5ffdu79cdu88c5u9876u6025u6797u505cu606fu53e5u533au8863u822cu62a5u53f6u538bu6162u53d4u80ccu7ec6";

        StringBuffer sb = new StringBuffer();
        int x = 5;
        // 控制字数
        for(int i=0;i<4;i++) {

            int degree = new Random().nextInt()%30; //生成-30-30范围的随机数

            String ch = base.charAt(new Random().nextInt(base.length()))+"";
            sb.append(ch);
            // 写入字之前,设置好旋转
            g.rotate(degree*Math.PI/180, x, 20); // 设置字体旋转角度
            g.drawString(ch, x, 20);
            // 这次旋转不能影响下一次的旋转,所以要将上一次的旋转清掉,转回去
            g.rotate(-degree*Math.PI/180, x, 20);
            x+=30;
        }
        return sb.toString();
    }

    protected void doPost(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {
        doGet(request, response);
    }

}

运行结果如下:

2.jpg
4,设置响应头控制浏览器的行为

1,定时刷新页面

response.setHeader("refresh", "5");//设置refresh响应头控制浏览器每隔5秒钟刷新一次

2,禁止缓存当前文档内容

response.setDateHeader("expries", -1);

response.setHeader("Cache-Control", "no-cache");

response.setHeader("Pragma", "no-cache");

3,重定向

什么是重定向:一个web资源收到客户端请求后,通知客户端去访问另外一个web资源,这称之为请求重定向。

例如:

public class RedirectResponse extends HttpServlet{
 
    private static final long serialVersionUID = 3903946972744326948L;
    
    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        this.doPost(req, resp);
    }
    
    @Override
    protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        //endRedirect方法实现请求重定向
        resp.sendRedirect(req.getContextPath() + "/index.jsp");
    }
}

访问:http://localhost:8081/ServletDemo/RedirectResponse.html,浏览器会跳转到:http://localhost:8081/ServletDemo/index.jsp

image

四、web工程中URL地址的推荐写法

在JavaWeb开发中,只要是写URL地址,那么建议最好以/开头,也就是使用相对路径的方式,那么这个/到底代表什么呢?可以用如下的方式来记忆/如果"/"是给服务器用的,则代表当前的web工程,如果"/"是给浏览器用的,则代表webapps目录。

3.1、"/"代表当前web工程的常见应用场景

①.ServletContext.getRealPath(String path)获取资源的绝对路径

/**
* 1.ServletContext.getRealPath("/download/1.JPG")是用来获取服务器上的某个资源,
* 那么这个"/"就是给服务器用的,"/"此时代表的就是web工程
 * ServletContext.getRealPath("/download/1.JPG")表示的就是读取web工程下的download文件夹中的1.JPG这个资源
* 只要明白了"/"代表的具体含义,就可以很快写出要访问的web资源的绝对路径
*/
this.getServletContext().getRealPath("/download/1.JPG");

②.在服务器端forward到其他页面

 /**
 * 2.forward
  * 客户端请求某个web资源,服务器跳转到另外一个web资源,这个forward也是给服务器用的,
 * 那么这个"/"就是给服务器用的,所以此时"/"代表的就是web工程
 */
 this.getServletContext().getRequestDispatcher("/index.jsp").forward(request, response);

③.使用include指令或者<jsp:include>标签引入页面

 <%@include file="/jspfragments/head.jspf" %>
 <jsp:include page="/jspfragments/demo.jsp" />

此时"/"代表的都是web工程。

3.2、"/"代表webapps目录的常见应用场景

①.使用sendRedirect实现请求重定向

 response.sendRedirect("/JavaWeb_HttpServletResponse_Study_20140615/index.jsp");

服务器发送一个URL地址给浏览器,浏览器拿到URL地址之后,再去请求服务器,所以这个"/"是给浏览器使用的,此时"/"代表的就是webapps目录,/JavaWeb_HttpServletResponse_Study_20140615/index.jsp这个地址指的就是webappsJavaWeb_HttpServletResponse_Study_20140615index.jsp

response.sendRedirect("/项目名称/文件夹目录/页面");这种写法是将项目名称写死在程序中的做法,不灵活,万一哪天项目名称变了,此时就得改程序,所以推荐使用下面的灵活写法:

 response.sendRedirect("/JavaWeb_HttpServletResponse_Study_20140615/index.jsp");

这种写法改成

response.sendRedirect(request.getContextPath()+"/index.jsp");

request.getContextPath()获取到的内容就是/JavaWeb_HttpServletResponse_Study_20140615,这样就比较灵活了,使用request.getContextPath()代替"/项目名称",推荐使用这种方式,灵活方便!

②.使用超链接跳转

 <a href="/JavaWeb_HttpServletResponse_Study_20140615/index.jsp">跳转到首页</a>

这是客户端浏览器使用的超链接跳转,这个"/"是给浏览器使用的,此时"/"代表的就是webapps目录。

使用超链接访问web资源,绝对路径的写法推荐使用下面的写法改进:

<a href="${pageContext.request.contextPath}/index.jsp">跳转到首页</a>

这样就可以避免在路径中出现项目的名称,使用${pageContext.request.contextPath}取代"/JavaWeb_HttpServletResponse_Study_20140615"

③.Form表单提交

 <form action="/JavaWeb_HttpServletResponse_Study_20140615/servlet/CheckServlet" method="post">    
         <input type="submit" value="提交">
 </form>

这是客户端浏览器将form表单提交到服务器,所以这个"/"是给浏览器使用的,此时"/"代表的就是webapps目录。

对于form表单提交中action属性绝对路径的写法,也推荐使用如下的方式改进:

 <form action="${pageContext.request.contextPath}/servlet/CheckServlet" method="post">
          <input type="submit" value="提交">
 </form>

${pageContext.request.contextPath}得到的就是"/JavaWeb_HttpServletResponse_Study_20140615"

${pageContext.request.contextPath}的效果等同于request.getContextPath(),两者获取到的都是"/项目名称"

④.js脚本和css样式文件的引用

  <%--使用绝对路径的方式引用js脚本--%>
  <script type="text/javascript" src="${pageContext.request.contextPath}/js/index.js"></script>
  <%--${pageContext.request.contextPath}与request.getContextPath()写法是得到的效果是一样的--%>
  <script type="text/javascript" src="<%=request.getContextPath()%>/js/login.js"></script>
  <%--使用绝对路径的方式引用css样式--%>
  <link rel="stylesheet" href="${pageContext.request.contextPath}/css/index.css" type="text/css"/>

综合范例:

<%@ page language="java" import="java.util.*" pageEncoding="UTF-8"%>

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
  <head>
    <title>"/"代表webapps目录的常见应用场景</title>
    <%--使用绝对路径的方式引用js脚本--%>
    <script type="text/javascript" src="${pageContext.request.contextPath}/js/index.js"></script>
    <%--${pageContext.request.contextPath}与request.getContextPath()写法是得到的效果是一样的--%>
    <script type="text/javascript" src="<%=request.getContextPath()%>/js/login.js"></script>
    <%--使用绝对路径的方式引用css样式--%>
      <link rel="stylesheet" href="${pageContext.request.contextPath}/css/index.css" type="text/css"/>
  </head>
  
  <body>
      <%--form表单提交--%>
       <form action="${pageContext.request.contextPath}/servlet/CheckServlet" method="post">
           <input type="submit" value="提交">
       </form>
       <%--超链接跳转页面--%>
       <a href="${pageContext.request.contextPath}/index.jsp">跳转到首页</a>
  </body>
</html>

五、response细节问题

getOutputStream和getWriter方法分别用于得到输出二进制数据、输出文本数据的ServletOuputStream、Printwriter对象。
  
getOutputStream和getWriter这两个方法互相排斥,调用了其中的任何一个方法后,就不能再调用另一方法。
  
Servlet程序向ServletOutputStream或PrintWriter对象中写入的数据将被Servlet引擎从response里面获取,Servlet引擎将这些数据当作响应消息的正文,然后再与响应状态行和各响应头组合后输出到客户端。
  
Serlvet的service方法结束后,Servlet引擎将检查getWriter或getOutputStream方法返回的输出流对象是否已经调用过close方法,如果没有,Servlet引擎将调用close方法关闭该输出流对象。

参考资料

原文地址:https://www.cnblogs.com/xiang--liu/p/11541774.html