JavaWeb_文件上传/下载篇

Posted 2021-09-07 葡萄籽-June

文件的上传/下载

文件的上传和下载，是非常常见的功能。例如，头像图，就使用了上传；邮箱中也有附件的上传和下载功能；等等。

---

本文主要是基于Servlet程序，通过form标签以及commons-fileupload.jar的API接口等学习实践文件的上传与下载。

文章目录

• 文件的上传/下载
• 一、文件的上传
• • 1.1 文件上传时HTTP协议的说明
  • 1.2 常用API 介绍（commons-fileupload.jar）
  • • 1.2.1 常用的类
  • 1.3 fileupload 类库的使用
• 二、文件下载
• • 2.1 下载的常用API
  • 2.2 文件下载的步骤
  • 2.3 中文名乱码问题解决方案
  • • 2.3.1 URLEncoder 解决IE 和谷歌浏览器的中文名问题
    • 2.3.2 base64 编解码解决火狐浏览器的中文名问题

---

一、文件的上传

大致要求：

【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 常用API 介绍（commons-fileupload.jar）

前言：
commons-fileupload.jar 需要依赖 commons-io.jar 这个包，所以两个包我们都要引入。
在开始之前，先导入所需要的Jar包。（commons-fileupload-1.2.1.jar、commons-io-1.4.jar）

1.2.1 常用的类

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

1.3 fileupload 类库的使用

上传文件的表单：

<form action="http://192.168.31.74:8080/09_EL_JSTL/uploadServlet" method="post"
enctype="multipart/form-data">
	用户名：<input type="text" name="username" /> <br>
	头像：<input type="file" name="photo" > <br>
	<input type="submit" value="上传">
</form>

解析上传的数据的代码：

/**
* 用来处理上传的数据
* @param req
* @param resp
* @throws ServletException
* @throws IOException
*/
@Override
protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException,IOException {
	//1 先判断上传的数据是否多段数据（只有是多段的数据，才是文件上传的）
	if (ServletFileUpload.isMultipartContent(req)) {
		// 创建FileItemFactory 工厂实现类
		FileItemFactory fileItemFactory = new DiskFileItemFactory();
		// 创建用于解析上传数据的工具类ServletFileUpload 类
		ServletFileUpload servletFileUpload = new ServletFileUpload(fileItemFactory);
		try {
			// 解析上传的数据，得到每一个表单项FileItem
			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.1 下载的常用API

API	作用
response.getOutputStream()	获得字节流，通过该字节流的write(byte[] bytes)可以向response缓冲区中写入字节，再由Tomcat服务器将字节内容组成Http响应返回给浏览器。response.getWriter().write(“字符串”)，这个方法只能写字符串。如果要写字节，需要用getOutputStream()
servletContext.getResourceAsStream();	返回文件流；这个好处是可以使用相对于根目录的路径访问到web目录下的所有文件，而不必知道绝对路径。
servletContext.getMimeType()	获取文件mime类型：getMimeType(文件名称)
response.setContentType();	使客户端浏览器,区分不同种类的数据,并根据不同的MIME调用浏览器内不同的程序嵌入模块来处理相应的数据。

response.setHeader(“Content-Disposition”, “attachment; fileName=demo.jpg”);

// Content-Disposition响应头，表示收到的数据怎么处理
// attachment表示附件，表示下载使用
// filename= 表示指定下载的文件名
// url编码是把汉字转换成为%xx%xx的格式

这个响应头告诉浏览器。这是需要下载的。而attachment 表示附件，也就是下载的一个文件。fileName=后面，表示下载的文件名。
【注】在响应头中，不能包含有中文字符，只能包含ASCII 码。

2.2 文件下载的步骤

1、 获取要下载的文件名
2、读取要下载的文件内容 (通过ServletContext对象可以读取)
3、把下载的文件内容回传给客户端
4、在回传前，通过响应头告诉客户端返回的数据类型（这步一般在第3步之前）
5、要通知客户端收到的数据是用于下载使用；还是使用响应头。（这步一般在第3步之前，第4步之后）

public class Download extends HttpServlet {

    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
//        1、获取要下载的文件名
        String downloadFileName = "demo.jpg";
//        2、读取要下载的文件内容 (通过ServletContext对象可以读取)
        ServletContext servletContext = getServletContext();
        // 获取要下载的文件类型
        String mimeType = servletContext.getMimeType("/file/" + downloadFileName);
        System.out.println("下载的文件类型：" + mimeType);
//        4、在回传前，通过响应头告诉客户端返回的数据类型
        resp.setContentType(mimeType);
//        5、通知客户端收到的数据是用于下载使用（使用响应头）
        resp.setHeader("Content-Disposition", "attachment; filename=" +downloadFileName );
        /**
         * /斜杠被服务器解析表示地址为http://ip:prot/工程名/  映射到代码的Web目录
         */
        InputStream resourceAsStream = servletContext.getResourceAsStream("/file/" + downloadFileName);
        // 获取响应的输出流
        OutputStream outputStream = resp.getOutputStream();
        //        3、把下载的文件内容回传给客户端
        // 读取输入流中全部的数据，复制给输出流（输出给客户端）
        IOUtils.copy(resourceAsStream, outputStream);
    }
}

2.3 中文名乱码问题解决方案

2.3.1 URLEncoder 解决IE 和谷歌浏览器的中文名问题

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

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

2.3.2 base64 编解码解决火狐浏览器的中文名问题

如果客户端浏览器是火狐浏览器,那么我们需要对中文名进行Base64 的编码操作。
这时候需要把请求头[Content-Disposition: attachment; filename=中文名 ]编码成为：[Content-Disposition: attachment; filename==?charset?B?xxxxx?=]

因为火狐使用的是Base64 的编解码方式还原响应中的汉字。所以需要使用Base64Encoder 类进行编码操作。

	// 使用下面的格式进行Base64 编码后
	String str = "attachment; fileName=" + "=?utf-8?B?"
+ new BASE64Encoder().encode("中文.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("中文.jpg".getBytes("utf-8")) + "?=";
		// 设置到响应头中
		response.setHeader("Content-Disposition", str);
	} else {
		// 把中文名进行UTF-8 编码操作。
		String str = "attachment; fileName=" + URLEncoder.encode("中文.jpg", "UTF-8");
		// 然后把编码后的字符串设置到响应头中
		response.setHeader("Content-Disposition", str);
	}

上述完整代码展示：

【注】url编码是把汉字转换成为%xx%xx的格式

public class Download extends HttpServlet {

    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
//        1、获取要下载的文件名
        String downloadFileName = "2.jpg";
//        2、读取要下载的文件内容 (通过ServletContext对象可以读取)
        ServletContext servletContext = getServletContext();
        // 获取要下载的文件类型
        String mimeType = servletContext.getMimeType("/file/" + downloadFileName);
        System.out.println("下载的文件类型：" + mimeType);
//        4、在回传前，通过响应头告诉客户端返回的数据类型
        resp.setContentType(mimeType);
//        5、还要告诉客户端收到的数据是用于下载使用（还是使用响应头）
        if (req.getHeader("User-Agent").contains("Firefox")) {
            // 如果是火狐浏览器使用Base64编码
            resp.setHeader("Content-Disposition", "attachment; filename==?UTF-8?B?" + new BASE64Encoder().encode("中国.jpg".getBytes("UTF-8")) + "?=");
        } else {
            // 如果不是火狐，是IE或谷歌，使用URL编码操作
            resp.setHeader("Content-Disposition", "attachment; filename=" + URLEncoder.encode("中国.jpg", "UTF-8"));
        }
        /**
         * /斜杠被服务器解析表示地址为http://ip:prot/工程名/  映射 到代码的Web目录
         */
        InputStream resourceAsStream = servletContext.getResourceAsStream("/file/" + downloadFileName);
        // 获取响应的输出流
        OutputStream outputStream = resp.getOutputStream();
        //        3、把下载的文件内容回传给客户端
        // 读取输入流中全部的数据，复制给输出流，输出给客户端
        IOUtils.copy(resourceAsStream, outputStream);
    }
}