文件上传
1. Servlet3.0 新的API Part接口
1.1 展示层 - 前台JSP
- 前台页面比较简单, 只是需要注意form表单中的下面几个点
- <form>表单中, 需要添加 enctype='multipart/form-data'
- <form>表单中, 需要指定 method='post'; <form action="/uploadServlet" method="post" enctype='multipart/form-data'>
- <input> 需要使用 file 控件; <＼input type='file' name="upload">
1.2 展示层 - 后台Servlet
- Part是一个接口, 可以方便的进行文件的上传
- 通过 HttpServletRequest 的 getPart() 方法获取Part对象
- 在Servlet后台代码中, 需要添加 @MultipartConfig()注解
1.2.1 Part接口 API
- 获取part: Part part = request.getPart();
-
void write(String fileName) : 将文件内容写入指定的磁盘位置(参数就是磁盘的地址)
- long getSize() : 获取上传文件的大小
-
String getName() : 获取file控件的name属性
-
String getHeader(String name): 获取指定的请求头(如请求头: Content-Desposition:form-data; name="photo"; filename="xxxxxx.png")
- Collection<String> getHeadres(String name) : 获取指定header名称的集合数据
- String getContentTpye() : 获取文件的MIME类型 (如类型: Content-Type: image/png)
- InputStream getInputStream() : 获取输入流用于检索文件的内容
- void delete() : 删除Part数据和临时目录数据, 默认不会删除
- String getSubmittedFileName() : 获取上传文件名 Servlet3.1和Tomcat8之后实现
1.2.2 @MultipartConfig 注解参数
-
String location: 指定文件上传的目录, 要求是绝对路径
- int fileSize Threshold : 指定缓存大小, 超过会先写入临时目录, 默认是0
- long maxFileSize : 单个上传文件最大值, 默认是-1, 表示没有限制, 单位是byte
- long maxRequestSize : 限制该multipart/form-data请求中数据的大小,默认是-1,表示没有限制,单位是byte
- multipart/form-data 发送的每个内容区段, 都会有(Content-Desposition:form-data; name="photo"; filename="xxxxxx.png"; Content-Type: image/png) 的标头信息, 这其中就有上传的该文件的文件名;
- 通过 Part 对象的 getHeader("Content-Disposition") 方法可以拿到String类型Content-Disposition的值, 然后通过 subString("截取的开始位置", "截取的结束位置") 来拿到该文件名
1.2.3展示层前台 - JSP代码示例
<%-- filename: upload.jsp --%>
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>Upload</title>
</head>
<body>
<%-- 文件上传前台表单 --%>
<form action="uploadServlet.do" method="post" enctype="multipart/form-data">
选择文件: <input type="file" name="upload">
<input type="submit" name="提交">
</form>
</body>
</html>
1.2.4 展示层后台 - Servlet代码示例
package xyz.xmcs;
import javax.servlet.ServletException;
import javax.servlet.annotation.MultipartConfig;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.Part;
import java.io.IOException;
/**
* @author jefxff
* @date 2020/3/5 - 11:19
* 使用Part接口通过Servlet实现文件的上传
*/
@MultipartConfig(location = "D:\\upload") // location属性的值就是文件上传的路径
@WebServlet(name = "PartUploadServlet", urlPatterns = "/partUploadServlet.do")
public class PartUploadServlet extends HttpServlet {
protected void doPost(HttpServletRequest request,
HttpServletResponse response) throws ServletException, IOException {
// 设置请求编码
request.setCharacterEncoding("UTF-8");
// 设置响应编码
response.setCharacterEncoding("UTF-8");
// 设置展示编码
response.setContentType("text/html;charset=UTF-8");
// 通过 request获取Part对象(参数是input标签中的, name属性)
Part part = request.getPart("upload");
// 获取文件的文件名
String fileName = getName(part);
part.write(fileName);
System.out.println(fileName + " Upload OK!");
}
// 获取文件名
private String getName(Part part){
String headr = part.getHeader("Content-Disposition");
String fileName = headr.substring(headr.indexOf("filename=\"") + 10, headr.lastIndexOf("\""));
return fileName;
}
protected void doGet(HttpServletRequest request,
HttpServletResponse response) throws ServletException, IOException {
doPost(request, response);
}
}
2. Apache Commons FileUpload
2.1 展示层前台 - JSP文件
- 前台展示层和Part时的没有区别, 主要就是注意 <from>标签中的 method, enctype属性, 以及 <input> 标签中的 file 控件
2.2 展示层后台 - Servlet
- 使用 Commons FileUpload 实现文件的上传, 需要用到两个jar包, commons-fileupload-1.3.1.jar, commons-io-2.4.jar; 其中前一个jar包依赖与后一个jar包
- 通过 ServletFileUpload.isMultipartContent(request) 来判断request请求中是否有 multipart/form-data 属性
- 文件上传最关键的类是 ServletFileUpload类, 创建该类的实例时, 需要一个 FileItemFactory 实例, FileItemFactory是一个接口, 其最常用的实现类是 DiskFileItemFactory
- 使用fileUpload固定步骤：
- 创建工厂类：DiskFileItemFactory factory=new DiskFileItemFactory();
- 创建解析器：ServletFileUpload upload=new ServletFileUpload(factory);
- 使用解析器解析request对象：List<FileItem> list=upload.parseRequest(request);
2.2.1 FileItemFactory 接口及 DiskFileItemFactory 实现类
- 用于将请求消息实体中的每一个项目封装成单独的DiskFileItem (FileItem接口的实现) 对象, DiskFileItemFactory 是默认实现类
- DiskFileItemFactory 属性:
- public static final int DEFAULT_SIZE_THRESHOLD ：将文件保存在内存还是磁盘临时文件夹的默认临界值，值为10240，即10kb
- private File repository：用于配置在创建文件项目时，当文件项目大于临界值时使用的临时文件夹，默认采用系统默认的临时文件路径，可以通过系统属性 java.io.tmpdir获取。如下代码:System.getProperty("java.io.tmpdir");
- private int sizeThreshold：用于保存将文件保存在内存还是磁盘临时文件夹的临界值
- DiskFileItemFactory 构造方法:
- public DiskFileItemFactory() : 采用默认临界值和系统临时文件夹构造文件项工厂对象
- public DiskFileItemFactory(int sizeThreshold,File repository) : 采用参数指定临界值大小和系统临时文件夹位置来构造文件项工厂对象
- DiskFileItemFactory常用方法:
-
void setSizeThreshold(int sizeThreshold) : 设置是否将上传文件以临时文件的形式保存在磁盘的临界值（参数是以字节为单位的int值）
-
void setRepository(File repository) : 设置当上传文件尺寸大于setSizeThreshold方法设置的临界值时，将文件以临时文件形式保存在磁盘上的存放目录
- void getRepository() : 获取临时文件夹
2.2.2 ServletFileUpload 类
- ServletFileUpload 是 Apache 上传文件的核心类
2.2.2.1 常用方法:
- boolean isMultipartContent(HttpServletRequest request) : 判断request请求中是否有 multipart/form-data 属性, 如果有返回true
- List<FileItem> parseRequest(HttpServletRequest request) : 返回对request解析的 List<FileItem> 类型的值
- Map<String, List<FileItem>> parseParameterMap(HttpServletRequest request) : 返回对request解析的 Map<String, List<FileItem>> 类型的属性名和值
- FileItemIterator getItemIterator(HttpServletRequest request) : 返回request的 FileItemIterator
- setFileSizeMax(long fileSizeMax) : 设置单个上传文件的大小的最大值,
- setSizeMax(long sizeMax) : 设置上传文件总量的最大值, 最大值等于同时上传多个文件的大小的最大值之和
2.2.3 展示层前台 - JSP代码示例
<%--
Created by IntelliJ IDEA.
Filename: apcheupload.jsp
Date: 2020/3/5
Time: 11:11
To change this template use File | Settings | File Templates.
--%>
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>Upload</title>
</head>
<body>
<%-- 文件上传前台表单 --%>
<form action="commonsUploadServlet.do" method="post" enctype="multipart/form-data">
姓名: <input type="text" name="sname"><br/>
选择文件: <input type="file" name="upload"><br/>
<input type="submit" name="提交"><br/>
</form>
</body>
</html>
2.2.4 展示层后台 - Servlet代码示例
package xyz.xmcs;
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.annotation.WebServlet;
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.text.SimpleDateFormat;
import java.util.Date;
import java.util.List;
/**
* @author jefxff
* @date 2020/3/5 - 13:59
*/
@WebServlet(name = "CommonsUploadServlet", urlPatterns = "/commonsUploadServlet.do")
public class CommonsUploadServlet extends HttpServlet {
protected void doPost(HttpServletRequest request,
HttpServletResponse response) throws ServletException, IOException {
// 设置请求编码
request.setCharacterEncoding("UTF-8");
// 设置响应编码
response.setCharacterEncoding("UTF-8");
// 设置展示编码
response.setContentType("text/html;charset=UTF-8");
try {
// 判断前台提交request请求中含有 multipart/form-data 属性
if (ServletFileUpload.isMultipartContent(request)){
// 创建 ServletFileUpload对象, 其参数是一个FileItemFactory类型的实例
// FileItemFactory 是一个接口, 所以需要它的实现类
FileItemFactory factory = new DiskFileItemFactory();
ServletFileUpload upload = new ServletFileUpload(factory);
// 通过parseRequest解析form表单中的所有请求字段, 并保存items中
// 即本例中 前台传递的 sname upload
List<FileItem> items = upload.parseRequest(request);
String name = null;
// 可以采用 Iterator 或者 forEach 等方法来遍历
for (FileItem item : items){
if (item.isFormField()){ // 此处为真的, item,就是普通表单文件
if (item.getFieldName().equals("sname")){
name = item.getString("UTF-8");
}
} else { // 否则就是待上传的文件
// getFieldName() 获取普通表单的Name, getName() 获取文件的Name
String fileName = item.getName();
// 获取服务器路径, 上传文件至服务器, 也可以指定路径
String path = request.getSession().getServletContext().getRealPath("upload");
//System.out.println(name);
// 取出当前时间
String nowTime = new SimpleDateFormat("yyyyMMdd_HHmmss").format(new Date());
fileName = name + "_" + nowTime + "_" + fileName;
//System.out.println(fileName);
File file = new File(path, fileName);
item.write(file);
// 上传完毕, 可以输出提示, 也可以直接return; 结束方法
System.out.println(fileName + " 上传成功!");
}
}
} else{
System.out.println("这里编写解析普通form表单的代码");
}
} catch (Exception e){
e.printStackTrace();
}
}
protected void doGet(HttpServletRequest request,
HttpServletResponse response) throws ServletException, IOException {
doPost(request, response);
}
}
3. 文件下载
3.1 展示层前台 - JSP 文件
- 一般情况下, 展示层前台即前端页面只是留一个下载链接
- 如: <a href="downloadServlet?fileName=Xxx.png">点击下载Xxx.png</a>
3.2 展示层后台 - Servlet
- 需要注意设置request 和 response 编码
- <form> 和 <a> 标签中, 都是通过 request.getParamter("name") 来获取文件名或值
- 下载需要设置响应头
- response.addHeader("contentType","application/octet-stream") ; 记住: MIME类型:二进制(适合任意文件)
- response.addHeader("content-Disposition", "attachment; fileName="+ fileName); 其中这里需要注意, 如果fileName中如果出现了中文名, 会在浏览器中出现乱码, 不同浏览器出现的乱码时,解决的办法也不一样
- 通过 getServletContent().getResourceAsStream("/download/网页.html"); 来获取InputStream输入流
- 通过 response.getOutputStream(); 来获取输出流, 通过常用的方法将输入流编程输出流即可完成下载
3.2.1 展示层前台 - JSP代码示例
<%--
Created by IntelliJ IDEA.
Filename: apcheupload.jsp
Date: 2020/3/5
Time: 11:11
To change this template use File | Settings | File Templates.
--%>
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>Upload</title>
</head>
<body>
<%-- 文件上传前台表单 --%>
<form action="commonsUploadServlet.do" method="post" enctype="multipart/form-data">
姓名: <input type="text" name="sname"><br/>
选择文件: <input type="file" name="upload"><br/>
<input type="submit" name="提交"><br/>
</form>
<br/>
<a href="downloadServlet?fileName=13009726_JSP&Servlet.pdf">点击下载:13009726_JSP&Servlet.pdf</a>
</body>
</html>
3.2.2 展示层后台 - Servlet代码示例
package xyz.xmcs.download;
import javax.servlet.ServletException;
import javax.servlet.annotation.WebServlet;
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;
/**
* @author jefxff
* @date 2020/3/6 - 10:02
*/
@WebServlet(name = "DownloadServlet", urlPatterns = {"/downloadServlet"})
public class DownloadServlet extends HttpServlet {
protected void doPost(HttpServletRequest request,
HttpServletResponse response) throws ServletException, IOException {
doGet(request, response);
}
protected void doGet(HttpServletRequest request,
HttpServletResponse response) throws ServletException, IOException {
// 设置request编码
request.setCharacterEncoding("UTF-8");
response.setCharacterEncoding("UTF-8");
// 获取文件名
String fileName = request.getParameter("fileName");
// 设置响应标头信息
response.addHeader("contentType","application/octet-stream");
response.addHeader("content-disposition", "attachment; fileName=" + URLEncoder.encode(fileName, "UTF-8"));
// 获取InputStream
InputStream in = getServletContext().getResourceAsStream("/download/13009726_JSP&Servlet.pdf");
OutputStream out = response.getOutputStream();
byte[] buffer = new byte[1024];
int len = -1;
while ((len=in.read(buffer)) != -1){
out.write(buffer, 0, len);
}
out.close();
in.close();
}
}
