文件Upload及Download

文件的上传及下载

文件的上传和下载，是非常常见的功能。很多的系统中，或者软件中都经常使用文件的上传和下载。

1、文件的上传介绍

需要以下几个步骤：
1、要有一个 form 标签，method=post 请求
2、form 标签的 encType 属性值必须为 multipart/form-data 值
3、在 form 标签中使用 input type=file 添加上传的文件
4、编写服务器代码（Servlet 程序）接收，处理上传的数据。

encType=multipart/form-data 表示提交的数据，以多段（每一个表单项一个数据段）的形式进行拼接，然后以二进制流的形式发送给服务器

1.1、文件上传时发送的HTTP协议内容

1.2、commons-fileupload.jar 常用 API 介绍说明

commons-fileupload.jar 需要依赖 commons-io.jar 这个包，所以两个包我们都要引入。

第一步，引入Maven依赖

<!--强大的，高性能，文件上传工具类 https://mvnrepository.com/artifact/commons-fileupload/commons-fileupload -->
    <dependency>
      <groupId>commons-fileupload</groupId>
      <artifactId>commons-fileupload</artifactId>
      <version>1.2.1</version>
    </dependency>

 <!--针对开发IO流功能的工具类库 https://mvnrepository.com/artifact/commons-io/commons-io -->
    <dependency>
      <groupId>commons-io</groupId>
      <artifactId>commons-io</artifactId>
      <version>1.4</version>
    </dependency>

commons-fileupload.jar 和 commons-io.jar 包中，我们常用的类和方法

类名或方法	功能
ServletFileUpload	用于解析上传的数据。
FileItem	表示每一个表单项。
boolean ServletFileUpload.isMultipartContent(HttpServletRequest request);	判断当前上传的数据格式是否是多段的格式。
public List parseRequest(HttpServletRequest request)；	解析上传的数据
boolean FileItem.isFormField()；	判断当前这个表单项，是否是普通的表单项。还是上传的文件类型。true 表示普通类型的表单项、false 表示上传的文件类型
String FileItem.getFieldName()；	获取表单项的 name 属性值
String FileItem.getString()	获取当前表单项的值。
String FileItem.getName();	获取上传的文件名
void FileItem.write(file );	将上传的文件写到参数 file 所指向抽硬盘位置。

上传文件的表单：

<form action="http://192.168.0.100:8080/upload/uploadServlet" enctype="multipart/form-data" method="post">
        用户名：<input type="text" name="username"><br>
        图片：<input type="file" name="image"><br>
             <input type="submit" value="提交">
</form>

解析上传的数据代码：

/**
 * @Author cappuccino
 * @Date 2021-05-13 13:40
 */
public class UploadServlet extends HttpServlet {

    /**
     * 处理用户上传的数据
     * @param req
     * @param resp
     * @throws ServletException
     * @throws IOException
     */
    @Override
    protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        // 判断当前上传的数据格式是否是多段的格式
        if (ServletFileUpload.isMultipartContent(req)) {
            // 创建FileItemFactory工厂实现类
            DiskFileItemFactory fileItemFactory = new DiskFileItemFactory();
            // 创建用于解析上传数据的工具类ServletFileUpload类
            ServletFileUpload servletFileUpload = new ServletFileUpload(fileItemFactory);
            try {
                // 解析上传的数据，得到每一个表单项FileTime
                List <FileItem> list = servletFileUpload.parseRequest(req);
                // 循环判断，每一个表单项，是普通类型，还是上传的文件
                for (FileItem fileItem : list) {
                    if (fileItem.isFormField()) {
                        // 普通表单项
                        System.out.println("表单项的 name 属性值：" + fileItem.getFieldName());
                        // 参数 UTF-8.解决乱码问题
                        System.out.println("表单项的 value 属性值：" + fileItem.getString("UTF-8"));
                    } else {
                        // 上传的文件
                        System.out.println("表单项的 name 属性值：" + fileItem.getFieldName());
                        System.out.println("上传的文件名：" + fileItem.getName());
                        fileItem.write(new File("e:\\" + fileItem.getName()));
                    }
                }
            } catch (Exception e) {
                e.printStackTrace();
            }
        }
    }
}

2、文件下载

下载的常用 API：
response.getOutputStream();
servletContext.getResourceAsStream();
servletContext.getMimeType();
response.setContentType();

response.setHeader("Content-Disposition", "attachment; fileName=微信_20210429143003.jpg");这个响应头告诉浏览器。这是需要下载的。而 attachment 表示附件，也就是下载的一个文件。fileName=后面，表示下载的文件名。

/**
 *
 * @Author cappuccino
 * @Date 2021-05-13 14:40
 */
public class DownloadServlet extends HttpServlet {
    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        //1、获取要下载的文件名
        String downloadFileName = "微信_20210429143003.jpg";
        //2、读取要下载的文件内容
        ServletContext servletContext = getServletContext();
        String mimeType = servletContext.getMimeType("/image/" + downloadFileName);
        System.out.println("下载文件的数据类型：" + mimeType);
        //4、在回传前，通过响应头告诉客户端返回的数据类型
        resp.setContentType(mimeType);
        //5、还要告诉客户端收到的数据是用于下载使用（还是使用响应头）
        // Content-Disposition响应头，表示收到的数据怎么处理
        // attachment 表示附件的意思，参数表示下载使用
        // filename=文件名 表示指定下载的文件名
        resp.setHeader("Content-Disposition", "attachment; fileName=" + downloadFileName);
        // 单斜杆被服务器解析表示地址为http://ip:port/工程名/ 映射 到代码的Web目录
        InputStream resourceAsStream = servletContext.getResourceAsStream("/image/" + downloadFileName);
        // 获取响应的输出流
        OutputStream outputStream = resp.getOutputStream();
        //3、把下载的文件内容回传给客户端
        // 读取输入流中全部的数据，复制给输出流，输出给客户端  注意：导包org.apache.commons.io.IOUtils;
        IOUtils.copy(resourceAsStream,outputStream);

    }
}

完成上面的步骤，下载文件是没问题了。但是如果我们要下载的文件是中文名的话。你会发现，下载无法正确显示出正确的中文名。
原因是在响应头中，不能包含有中文字符，只能包含 ASCII 码。
微信图片_20210513170323.png

2.1、附件中文名乱码问题解决方案：

方案一：URLEncoder 解决 IE 和谷歌浏览器的附件中文名问题。

如果客户端浏览器是 IE 浏览器或者是谷歌浏览器。我们需要使用URLEncoder 类先对中文名进行 UTF-8 的编码操作。
因为 IE 浏览器和谷歌浏览器收到含有编码后的字符串后会以 UTF-8 字符集进行解码显示。

// 把中文名进行 UTF-8 编码操作。
String str = "attachment; fileName=" + URLEncoder.encode("微信_20210429143003.jpg", "UTF-8");
// 然后把编码后的字符串设置到响应头中
response.setHeader("Content-Disposition", str);

方案二：BASE64 编解码解决火狐浏览器的附件中文名问题

如果客户端浏览器是火狐浏览器。那么我们需要对中文名进行 BASE64 的编码操作。
这时候需要把请求头 Content-Disposition: attachment; filename=中文名
编码成为：Content-Disposition: attachment; filename==?charset?B?xxxxx?=
=?charset?B?xxxxx?= 现在我们对这段内容进行一下说明。
=? 表示编码内容的开始
charset 表示字符集(UTF-8、GBK、ISO-88591-1...)
B
xxxx
?=BASE64 编解码操作：
因为火狐使用的是 BASE64 的编解码方式还原响应中的汉字。所以需要使用 BASE64Encoder 类进行编码操作。

// 使用下面的格式进行 BASE64 编码后
String str = "attachment; fileName=" + "=?utf-8?B?"
+ new BASE64Encoder().encode("微信_20210429143003.jpg".getBytes("utf-8")) + "?=";
// 设置到响应头中
response.setHeader("Content-Disposition", str);

那么我们如何解决上面两种不同编解码方式呢。我们只需要通过判断请求头中 User-Agent 这个请求头携带过来的
浏览器信息即可判断出是什么浏览器。
如下：

String ua = request.getHeader("User-Agent");
// 判断是否是火狐浏览器
if (ua.contains("Firefox")) {
// 使用下面的格式进行 BASE64 编码后
String str = "attachment; fileName=" + "=?utf-8?B?"
+ new BASE64Encoder().encode("微信_20210429143003.jpg".getBytes("utf-8")) + "?=";
// 设置到响应头中
response.setHeader("Content-Disposition", str);
} else {
// 把中文名进行 UTF-8 编码操作。
String str = "attachment; fileName=" + URLEncoder.encode("微信_20210429143003.jpg", "UTF-8");
// 然后把编码后的字符串设置到响应头中
response.setHeader("Content-Disposition", str);
}

最终代码!

/**
 *
 * @Author cappuccino
 * @Date 2021-05-13 14:40
 */
public class DownloadServlet extends HttpServlet {
    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        //1、获取要下载的文件名
        String downloadFileName = "微信_20210429143003.jpg";
        //2、读取要下载的文件内容
        ServletContext servletContext = getServletContext();
        String mimeType = servletContext.getMimeType("/image/" + downloadFileName);
        System.out.println("下载文件的数据类型：" + mimeType);
        //4、在回传前，通过响应头告诉客户端返回的数据类型
        resp.setContentType(mimeType);
        //5、还要告诉客户端收到的数据是用于下载使用（还是使用响应头）
        // Content-Disposition响应头，表示收到的数据怎么处理
        // attachment 表示附件的意思，参数表示下载使用
        // filename=文件名 表示指定下载的文件名
        // url编码是把汉字转换成为%E5%BE%AE%E4%BF%A1的格式
        String ua = req.getHeader("User-Agent");
        // 判断是否是火狐浏览器
        if (ua.contains("Firefox")) {
        // 是火狐浏览器则使用下面的格式进行 BASE64 编码后
            String str = "attachment; fileName=" + "=?utf-8?B?" + new BASE64Encoder().encode(downloadFileName.getBytes("UTF-8")) + "?=";
        // 设置到响应头中
            resp.setHeader("Content-Disposition", str);
        } else {
        // 把中文名进行 UTF-8 编码操作。
            String str = "attachment; fileName=" + URLEncoder.encode(downloadFileName, "UTF-8");
        // 然后把编码后的字符串设置到响应头中
            resp.setHeader("Content-Disposition", str);
        }
        // 单斜杆被服务器解析表示地址为http://ip:port/工程名/ 映射 到代码的Web目录
        InputStream resourceAsStream = servletContext.getResourceAsStream("/image/" + downloadFileName);
        // 获取响应的输出流
        OutputStream outputStream = resp.getOutputStream();
        //3、把下载的文件内容回传给客户端
        // 读取输入流中全部的数据，复制给输出流，输出给客户端  注意：导包org.apache.commons.io.IOUtils;
        IOUtils.copy(resourceAsStream,outputStream);

    }
}

cappuccino