ServletContext详解

Mr.he...大约 5 分钟

1. 概念

代表整个web应用，可以和程序的容器(服务器)来通信。

2. 获取ServletContext对象

通过request对象获取request.getServletContext();；
通过HttpServlet获取this.getServletContext();。

两个对象获取的ServletContext是没差别的，使用过程中一般通过HttpServlet获取。

3. ServletContext对象的功能

主要有获取MIME类型、域对象和获取文件的真实(服务器)路径。

3.1. 具体解析

3.1.1. 获取MIME类型

3.1.1.1. 概念

MIME类型是在互联网通信过程中定义的一种文件数据类型，格式为：大类型/小类型，例如：text/html，image/jpeg。

3.1.1.2. 常用方法

String getMimeType(String file)：获取MIME类型。

3.1.1.3. 核心代码

package io.gitee.hek97.web.servletcontext;

//去掉导包代码

@WebServlet("/servletContextDemo1")
public class ServletContextDemo1 extends HttpServlet {
    @Override
    protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        //1.获取ServletContext对象
        ServletContext context = this.getServletContext();
        //定义文件名称
        String filename = "a.jpg";
        //2.获取MIME类型
        String mimeType = context.getMimeType(filename);
        System.out.println(mimeType);//image/jpeg
    }

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

3.1.2. 域对象

3.1.2.1. 概念

主要用来在服务器内部共享数据。

与[请求转发]({% post_path 'JavaWEB-4.Servlet&HTTP&Request-note' %}#请求转发)的域对象相比，ServletContext的域对象的范围更大，请求转发的域对象只存在于转发和被转发的请求之前，ServletContext对象范围为所有用户所有请求的数据（不太安全）；
ServletContext对象存在生命周期太长，服务器创建便存在，服务器销毁才跟着销毁，所以使用很谨慎，很少使用。

3.1.2.2. 常用方法

setAttribute(String name,Object value)：设置域对象；
getAttribute(String name)：获取域对象；
removeAttribute(String name)：移除域对象。

3.1.2.3. 核心代码

package io.gitee.hek97.web.servletcontext;

//去掉导包代码

@WebServlet("/servletContextDemo2")
public class ServletContextDemo2 extends HttpServlet {
    @Override
    protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        //1.通过HttpServlet获取ServletContext对象
        ServletContext context = this.getServletContext();
        //2.设置数据
        context.setAttribute("msg","haha");
    }

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

package io.gitee.hek97.web.servletcontext;

//去掉导包代码

@WebServlet("/servletContextDemo3")
public class ServletContextDemo3 extends HttpServlet {
    @Override
    protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        //1.通过HttpServlet获取ServletContext对象
        ServletContext context = this.getServletContext();
        //2.设置数据
        Object msg = context.getAttribute("msg");
        System.out.println(msg);
    }

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

3.1.3. 获取文件的真实(服务器)路径

用来获取一些文件的真实路径。使用方法：String getRealPath(String path)，核心代码如下：

package io.gitee.hek97.web.servletcontext;

//去掉导包代码

@WebServlet("/servletContextDemo4")
public class ServletContextDemo4 extends HttpServlet {
    @Override
    protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        //1.通过HttpServlet获取ServletContext对象
        ServletContext context = this.getServletContext();
        //2.获取文件的服务器路径
        String b = context.getRealPath("/b.txt");//web目录下资源访问
        System.out.println(b);
        //C:\Users\HK\IdeaProjects\Test\out\artifacts\Response_war_exploded\b.txt
        String c = context.getRealPath("/WEB-INF/c.txt");//WEB-INFm
        System.out.println(c);
        //C:\Users\HK\IdeaProjects\Test\out\artifacts\Response_war_exploded\WEB-INF\c.txt
        String a = context.getRealPath("/WEB-INF/classes/a.txt");//src目录下的资源访问
        System.out.println(a);
        //C:\Users\HK\IdeaProjects\Test\out\artifacts\Response_war_exploded\WEB-INF\classes\a.txt
        //src下的文件经过编译后会被放到WEB-INF/classes文件下。
    }

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

4. 案例：文件下载

4.1. 文件下载需求

页面显示超链接；
点击超链接后弹出下载提示框；
完成图片文件下载。

4.2. 分析

未设置过的超链接指向的资源如果能够被浏览器解析，则在浏览器中展示，如图片，如果不能解析，则弹出下载提示框，如视频。不满足需求；
要求任何资源都必须弹出下载提示框；
使用响应头设置资源的打开方式。核心代码：content-disposition:attachment;filename=xxx

4.3. 使用步骤

定义页面，编辑超链接href属性，指向Servlet，传递资源名称filename
定义Servlet
1. 获取文件名称；
2. 使用字节输入流加载文件进内存；
3. 指定response的响应头： content-disposition:attachment;filename=xxx；
4. 将数据写出到response输出流。

4.4. 中文文件乱码问题

获取客户端使用的浏览器版本信息；
根据不同的版本信息，设置filename的编码方式不同。

核心代码

下载的页面；

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>下载练习</title>
</head>
<body>
<a href="/today/downloadServlet?filename=2.jpg">图片下载</a>
<a href="/today/downloadServlet?filename=九尾.jpg">中文图片下载</a>
<a href="/today/downloadServlet?filename=1.avi">视频下载</a>
</body>
</html>

实现的Servlet；

package io.gitee.hek97.web.download;

//省略导包代码

@WebServlet("/downloadServlet")
public class DownloadServlet extends HttpServlet {
    @Override
    protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        //1.通过获取请求参数，获取文件名称
        String filename = request.getParameter("filename");
        //2.使用字节输入流加载文件进内存
        //2.1找到文件的真实路径
        ServletContext ServletContext = this.getServletContext();
        String realPath = ServletContext.getRealPath("/img/" + filename);
        //2.2用字节流关联
        FileInputStream fis = new FileInputStream(realPath);
        //3.设置response的响应头
        //3.1设置响应头类型content-type
        String mimeType = ServletContext.getMimeType(filename);//获取文件的类型
        response.setHeader("content-type",mimeType);
        //解决中文乱码问题
        //1.获取user-agent中的浏览器信息
        String agent = request.getHeader("user-agent");
        //2.使用工具类解决中文乱码问题，返回设置好格式的字符串
        filename = DownLoadUtils.getFileName(agent, filename);
        //3.2设置响应头content-disposition以附件的形式打开，也就是下载
        response.setHeader("content-disposition","attachment;filename="+filename);
        //4.将输出流的数据写出到输出流中
        ServletOutputStream sos = response.getOutputStream();
        byte[] buff = new byte[1024 * 8];
        int len =0;
        while(((len=fis.read(buff))!=-1)){
            sos.write(buff,0,len);
        }
        fis.close();//g
    }

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

中文乱码的工具类。

package io.gitee.hek97.web.utils;

import java.io.UnsupportedEncodingException;

public class DownLoadUtils {
    public static String getFileName(String agent, String filename) throws UnsupportedEncodingException {
        // 针对IE或者以IE为内核的浏览器：
        if (agent.contains("MSIE") || agent.contains("Trident")) {
            filename = java.net.URLEncoder.encode(filename, "UTF-8");
        } else {
            // 非IE浏览器的处理：
            filename = new String(filename.getBytes("UTF-8"), "ISO-8859-1");
        }
        return filename;
    }
}

ServletContext详解

# 1. 概念

# 2. 获取ServletContext对象

# 3. ServletContext对象的功能

# 3.1. 具体解析

# 3.1.1. 获取MIME类型

# 3.1.1.1. 概念

# 3.1.1.2. 常用方法

# 3.1.1.3. 核心代码

# 3.1.2. 域对象

# 3.1.2.1. 概念

# 3.1.2.2. 常用方法

# 3.1.2.3. 核心代码

# 3.1.3. 获取文件的真实(服务器)路径

# 4. 案例：文件下载

# 4.1. 文件下载需求

# 4.2. 分析

# 4.3. 使用步骤

# 4.4. 中文文件乱码问题