0 文件的上传和下载概述
文件的上传和下载,是非常常见的功能。很多的系统中,或者软件中都经常使用文件的上传和下载。
比如:QQ 头像,就使用了上传。
邮箱中也有附件的上传和下载功能。
OA 系统中审批有附件材料的上传。
1. 文件的上传介绍(重点)
- 要有一个 form 标签,method=post 请求(get请求有长度限制)
- form 标签的 encType 属性值必须为 multipart/form-data 值(这样表单提交的数据形式就由原来的键值对name=value方式,变为二进制形式提交数据到服务器,这样才能接收到文件)
- 在 form 标签中使用 input type=file 添加上传的文件
- 编写服务器代码(暂时使用Servlet 程序)接收,处理上传的数据。
encType=multipart/form-data 表示提交的数据,以多段(每一个表单项一个数据段)的形式进行拼 接,然后以二进制流的形式发送给服务器
1.1 文件上传,HTTP 协议的说明。
1.2 commons-fileupload.jar 常用 API 介绍说明
commons-fileupload.jar 需要依赖 commons-io.jar 这个包,所以两个包我们都要引入。
第一步,就是需要导入两个 jar 包:
commons-fileupload-1.2.1.jar
commons-io-1.4.jar
commons-fileupload.jar 和 commons-io.jar 包中,我们常用的类有哪些?
//常用类:
ServletFileUpload 类,用于解析上传的数据。
FileItem 类,表示每一个表单项。
//常用方法:
boolean ServletFileUpload.isMultipartContent(HttpServletRequest request);
判断当前上传的数据格式是否是多段的格式。
public List<FileItem> parseRequest(HttpServletRequest request)
解析上传的数据
boolean FileItem.isFormField()
判断当前这个表单项,是否是普通的表单项。还是上传的文件类型。
true 表示普通类型的表单项
false 表示上传的文件类型
String FileItem.getFieldName()
获取表单项的 name 属性值
String FileItem.getString()
获取当前表单项的值。
String FileItem.getName();
获取上传的文件名
void FileItem.write( file );
将上传的文件写到 参数file 所指的硬盘位置 。
1.3 fileupload 类库的使用:(上传流程)
测试:
web.xml:
<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_4_0.xsd"
version="4.0">
<servlet>
<servlet-name>UploadServlet</servlet-name>
<servlet-class>com.atguigu.servlet.UploadServlet</servlet-class>
</servlet>
<servlet-mapping>
<servlet-name>UploadServlet</servlet-name>
<url-pattern>/uploadServlet</url-pattern>
</servlet-mapping>
</web-app>
upload.jsp:
<%--
Created by IntelliJ IDEA.
User: Administrator
Date: 2020/2/4
Time: 16:21
To change this template use File | Settings | File Templates.
--%>
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>Title</title>
</head>
<body>
<form action="http://localhost:8080/dongtai-web-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>
</body>
</html>
UploadServlet类:
上传流程:客户通过浏览器向服务器发送一个请求(页面输入用户名,上传的文件,在点击提交按钮),请求中携带了需要上传的文件以及一些参数,之后服务器对其携带的数据先判断格式在进行解析为具体的类型,之后根据不同的类型进行不同的处理(eg:把上传的文件保存到磁盘中某一个位置)。
package com.atguigu.servlet;
import org.apache.commons.fileupload.FileItem;
import org.apache.commons.fileupload.FileItemFactory;
import org.apache.commons.fileupload.disk.DiskFileItemFactory;
import org.apache.commons.fileupload.servlet.ServletFileUpload;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.File;
import java.io.IOException;
import java.util.List;
public class UploadServlet extends HttpServlet {
private static final long serialVersionUID = -1244643665500418165L;
/**
* 用来处理上传的数据
* @param req
* @param resp
* @throws ServletException
* @throws IOException
*/
@Override
protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
//1. 先判断上传的数据是否多段数据(只有是多段的数据,才是文件上传的):
if (ServletFileUpload.isMultipartContent(req)) {//导包使用commons包下的
//2. 通过创建解析工具类对象将数据进行解析:
// 创建FileItemFactory工厂实现类,FileItemFactory是接口,所以想要new只能创建它的实现类。
FileItemFactory fileItemFactory = new DiskFileItemFactory();
// 创建用于解析上传数据的工具类ServletFileUpload类
ServletFileUpload servletFileUpload = new ServletFileUpload(fileItemFactory);
try {
// 解析上传的数据,得到每一个表单项FileItem
List<FileItem> list = servletFileUpload.parseRequest(req);//会产生异常
//3. 循环判断,每一个表单项,是普通类型,还是上传的文件(不同类型的表单处理方式不同)
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("d:\\" + fileItem.getName()));
}
}
} catch (Exception e) {
e.printStackTrace();
}
}
}
}
启动tomact服务器访问upload.jsp页面, 并在此页面上输入信息 选择图片进行上传。
可以看到在d盘目录下图片上传成功。
2. 文件下载
下载的常用 API 说明:
response.getOutputStream(); //获取响应输出流
servletContext.getResourceAsStream();//获取到下载的文件内容
servletContext.getMimeType();//获取取要下载的文件类型
response.setContentType();//设置响应类型
测试:
注意:它是浏览器发送请求后,后台执行完 页面会自动下载文件(浏览器默认设置保存在c盘,如果设置了下载时手动选择路径则可以手动选择下载),后台代码中没有设置下载的路径。
文件下载流程:
2.1 文件下载测试
servlet程序:Download
package com.atguigu.servlet;
import org.apache.commons.io.IOUtils;
import javax.servlet.ServletContext;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
public class Download extends HttpServlet {
private static final long serialVersionUID = 5720981984038301089L;
@Override
protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
//1.获取要下载的文件名 (图片目录结构:项目名/web/files/aa.jpg)
String downloadFileName = "aa.jpg";
//2.读取要下载的文件内容(通过ServletContext对象获取)
// 2.1 获取ServletContext对象
ServletContext servletContext = getServletContext();
//4.在回传前,通过响应头告诉客户端返回的数据类型
//获取要下载的文件类型(文件路径+文件名)
String mimeType = servletContext.getMimeType("/files/"+downloadFileName);
System.out.println("下载的文件类型:"+mimeType);//打桩测试
resp.setContentType(mimeType);
//5.还要告诉客户端收到的数据是用于下载使用(使用响应头)
//Content-Disposition响应头,表示收到的数据怎么处理
//attachment表示附件,表示下载使用
//fileName=表示指定下载的文件名,下载后的文件名可以和原来文件的名字不一样
// eg:原文件名为:downloadFileName=aa.jpg,在这个响应头中设置的是22.jpg,
// 那么下载后的文件名为22.jpg。
resp.setHeader("Content-Disposition", "attachment; fileName="+downloadFileName);
/**
* 2.2 获取到下载的文件内容 (通过文件路径+文件名)
* /斜杠被服务器解析表示地址为 http://ip:port/工程名/ 映射到 代码的web目录
*/
InputStream resourceAsStream = servletContext.getResourceAsStream("/files/"+downloadFileName);
//3.把下载的文件内容回传给客户端
//之前是io流:通过while循环读取缓存byte[1024]数组
//现在是:导入的commons-io-1.4.jar包中封装了这些io流操作
// 获取响应输出流
OutputStream outputStream = resp.getOutputStream();
//读取输入流的全部数据,复制给输出流,输出客户端
IOUtils.copy(resourceAsStream, outputStream);
}
}
web.xml:
<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_4_0.xsd"
version="4.0">
<servlet>
<servlet-name>Download</servlet-name>
<servlet-class>com.atguigu.servlet.Download</servlet-class>
</servlet>
<servlet-mapping>
<servlet-name>Download</servlet-name>
<url-pattern>/download</url-pattern>
</servlet-mapping>
</web-app>
启动tomact服务器进行测试:
在浏览器输入访问的servlet程序地址会进行下载
说明:
- response.setHeader(“Content-Disposition”, “attachment; fileName=1.jpg”);
- 这个响应头告诉浏览器。这是需要下载的。而attachment 表示附件,也就是下载的一个文件。fileName=后面, 表示下载的文件名。
完成上面的两个步骤,下载文件是没问题了。但是如果我们要下载的文件是中文名的话。你会发现,下载无法正确显示出正确的中文名。
原因是在响应头中,不能包含有中文字符,只能包含ASCII 码。
2.2 附件中文名乱码问题解决方案:
2.2.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);
测试:
web.xml:
<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_4_0.xsd"
version="4.0">
<servlet>
<servlet-name>Download</servlet-name>
<servlet-class>com.atguigu.servlet.Download</servlet-class>
</servlet>
<servlet-mapping>
<servlet-name>Download</servlet-name>
<url-pattern>/download</url-pattern>
</servlet-mapping>
</web-app>
package com.atguigu.servlet;
import org.apache.commons.io.IOUtils;
import javax.servlet.ServletContext;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.net.URLEncoder;
public class Download extends HttpServlet {
private static final long serialVersionUID = 5720981984038301089L;
@Override
protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
//1.获取要下载的文件名
String downloadFileName = "aa.jpg";
//2.读取要下载的文件内容
ServletContext servletContext = getServletContext();
//获取要下载的文件类型
String mimeType = servletContext.getMimeType("/files/"+downloadFileName);
System.out.println("下载的文件类型:"+mimeType);
//4.在回传前,通过响应头告诉客户端返回的数据类型
resp.setContentType(mimeType);
//5.还要告诉客户端收到的数据是用于下载使用(还是使用响应头)
//Content-Disposition响应头,表示收到的数据怎么处理
//attachment表示附件,表示下载使用
//fileName=表示指定下载的文件名
//注意:这个下载的文件名是由响应头决定的,这个下载的文件名可以和原来的文件名aa.jpg不同
//情况1:和原来的图片名相同
//resp.setHeader("Content-Disposition", "attachment; fileName="+downloadFileName);
//情况2:和原来的图片名不同
// 注意:响应头是k-v格式的,如果文件名是字符串用+拼接,如果是数字直接 =
// 只要最终是k-v结构就行,也不一定是这种。
//resp.setHeader("Content-Disposition", "attachment; fileName=22.jpg");
//情况3:含有中文名字需要进行编码才能正确下载
//url编码是把汉字转换为%xx%xx的格式
resp.setHeader("Content-Disposition", "attachment; fileName="+ URLEncoder.encode("图片.jpg", "UTF-8"));
/**
* /斜杠被服务器解析表示地址为 http://ip:port/工程名/ 映射到 代码的web目录
*/
InputStream resourceAsStream = servletContext.getResourceAsStream("/files/"+downloadFileName);
//获取响应输出流
OutputStream outputStream = resp.getOutputStream();
//3.把下载的文件内容回传给客户端
//读取输入流的全部数据,复制给输出流,输出客户端
IOUtils.copy(resourceAsStream, outputStream);
}
}
2.2.2 方案二:BASE64 编解码 解决 火狐浏览器的附件中文名问题
火狐新版本:用法和谷歌一样,可以解决中文乱码问题。
火狐老版本:如果客户端浏览器是火狐浏览器老版本。 那么我们需要对中文名进行 BASE64 的编码操作。详情查看:https://www.bilibili.com/video/BV1Y7411K7zz?p=219