1、文件上传
1)导包
<!--文件上传包-->
<dependency>
<groupId>commons-fileupload</groupId>
<artifactId>commons-fileupload</artifactId>
<version>1.4</version>
</dependency>
<!--IO包-->
<dependency>
<groupId>commons-io</groupId>
<artifactId>commons-io</artifactId>
<version>2.11.0</version>
</dependency>
2)使用类介绍
(1)ServletFileUpload
负责处理上传的文件数据,并将表单中每个输入项封装成一个FileItem对象(表单输入项), 在使用ServletFileUpload对象解析请求时需要DiskFileItemFactory对象。所以,我们需要在进行解析工作前构造好DiskFileItemFactory对象,通过ServletFileUpload对象的构造方法或setFileItemFactory()方法设置ServletFileUpload对象的fileItemFactory属性。
(2)FileItem
表单输入项
(3)DiskFileItemFactory
将请求消息实体中的每一个项目封装成单独的DiskFileItem (FileItem接口的实现) 对象的任务
由 org.apache.commons.fileupload.FileItemFactory 接口的默认实现
org.apache.commons.fileupload.disk.DiskFileItemFactory 来完成。当上传的文件项目比较小时,直接保存在内存中(速度比较快),比较大时,以临时文件的形式,保存在磁盘临时文件夹(虽然速度慢些,但是内存资源是有限的)
3)实现流程
- 判断用户上传的文件是普通表单还是带文件的表单,如果是普通文件直接返回(return)
- 创建文件上传保存的路路径,在WEB-INF路径下是安全的,用户无法直接访问上传文件
- 创建临时路径,如果文件好过了预期大小,就放到一个临时文件中
- 创建DiskFileItemFactory对象,设置文件临时路径(setRepository)或大小的限制(setSizeThreshold)
- 获取ServletFileUpload对象,处理乱码问题(setHeaderEncoding),设置单个文件的最大值(setFileSizeMax),设置总共能够上传文件的大小(setSizeMax),还可选择监听文件上传进度(setProgressListener)
- 通过ServletFileUpload对象的parseRequest方法把前端请求解析,封装成一个FileItem对象列表,判断上传的文件是普通的表单还是带文件的表单(isFormField),getFieldName获取前端表单控件的name
- 通过FileItem的getName方法获取文件名字并判断是否为空,可以使用UUID保证文件名唯一
- 拼接文件真实存在路径,并给每个文件创建一个对应的文件夹
- 通过FileItem的getInputStream方法获取文件上传的流,并创建一个文件输出流将文件写入真实保存路径,最后关闭流
- 上传成功可将页面转发到新的提示页面
4)注意事项
- 为保证服务器安全,上传文件应放在外界无法直接访问的目录下,比如放于WEB-INF目录下
- 为防止文件覆盖的现象发生,要为上传文件产生一个唯一的文件名(加时间戳,加UUID)
- 要限制上传文件的最大值
- 可以限制上传文件的类型,在收到上传文件名时,判断后缀名是否合法
- 表单 method 属性应该设置为 POST 方法,不能使用 GET 方法
5)源码
(1)前端页面
- 上传页面
在HTML页面input 必须有 name
<input type="file" name="filename">
,表单如果包含一个文件上传输入项的话,这个表单的enctype属性就必须设置为multipart/form-data,服务器端想获取数据也要通过流
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<body>
<h2>文件上传</h2>
<form action="${pageContext.request.contextPath}/upload.do" method="post" enctype="multipart/form-data">
<label for="username">
用户名:<input type="text" id="username" name="username"/>
</label>
<br/><br/>
<label for="file">
文件:<input type="file" id="file" name="fiel"/>
</label>
<br/><br/>
<input type="submit" value="上传"/>
</form>
</body>
</html>
- 成功页面
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>Title</title>
</head>
<body>
${msg}
</body>
</html>
(2)Servlet
package com.tuwer.servlet;
import org.apache.commons.fileupload.FileItem;
import org.apache.commons.fileupload.FileUploadException;
import org.apache.commons.fileupload.ProgressListener;
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.*;
import java.util.List;
import java.util.UUID;
/**
* @author 土味儿
* Date 2021/12/22
* @version 1.0
*/
public class FileUploadServlet extends HttpServlet {
@Override
protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
// ----------判断表单类型-----------
// 判断用户上传的是普通表单还是带文件的表单,如果是普通表单直接返回
boolean isMultipartContent = ServletFileUpload.isMultipartContent(req);
// 普通表单(不是带文件的表单)
if (!isMultipartContent) {
return;
}
// ----------创建文件保存的路径-----------
// 在WEB-INF路径下是安全的,用户无法直接访问上传文件
// 1、符合规定的小文件路径
String uploadPath = this.getServletContext().getRealPath("/WEB-INF/upload");
System.out.println(uploadPath);
File uploadFile = new File(uploadPath);
if (!uploadFile.exists()) {
uploadFile.mkdir();
}
// 2、超出规定的大文件临时路径
String tempPath = this.getServletContext().getRealPath("/WEB-INF/temp");
File tempFile = new File(tempPath);
if (!tempFile.exists()) {
tempFile.mkdir();
}
// ----------处理上传的文件-----------
// 方案一:使用request.getInputStream(),原生态的文件上传流获取,麻烦
// 方案二:使用 Apache 的文件上传组件来实现,common-fileupload,需要依赖于 commons-io组件
// 1、创建DiskFileItemFactory对象,处理文件上传路径或大小的限制
DiskFileItemFactory factory = getDiskFileItemFactory(1024 * 1024, tempFile, "utf8");
// 2、获取ServletFileUpload
ServletFileUpload upload = getServletFileUpload(factory);
// 3、处理上传的文件
try {
String msg = uploadParseRequest(upload, req, uploadPath);
//将数据发给前端
req.setAttribute("msg",msg);
req.getRequestDispatcher("info.jsp").forward(req,resp);
} catch (FileUploadException e) {
e.printStackTrace();
}
}
/**
* 获取 DiskFileItemFactory 对象
*
* @param fileSize 允许上传的文件最大字节数;等于0时,使用默认值 10M
* @param tempPath 超出大小限制的文件临时存放目录
* @param charset 文件字符编码;等于null,或者空时,使用默认值 ISO-8859-1
* @return factory
*/
private DiskFileItemFactory getDiskFileItemFactory(int fileSize, File tempPath, String charset) {
DiskFileItemFactory factory = new DiskFileItemFactory();
if (charset != null && charset.length() > 0) {
// 设置字符:默认 ISO-8859-1
factory.setDefaultCharset(charset);
}
if (fileSize > 0) {
// 设置文件最大允许的大小:默认 10240字节(10M)
factory.setSizeThreshold(fileSize);
}
// 设置超出大小限制的文件临时存放目录
factory.setRepository(tempPath);
return factory;
}
/**
* 获取 ServletFileUpload 对象
* 监听文件上传进度
* 处理乱码
* 设置单个文件的最大值
* 设置总共能够上传文件的最大值
*
* @param factory DiskFileItemFactory 对象
* @return
*/
private ServletFileUpload getServletFileUpload(DiskFileItemFactory factory) {
ServletFileUpload upload = new ServletFileUpload(factory);
// 监听文件上传进度
upload.setProgressListener(new ProgressListener() {
/**
* 上传进度
* @param l 已上传大小
* @param l1 总大小
* @param i 表单项序号
*/
public void update(long l, long l1, int i) {
//System.out.println(l +"/"+ l1 + " 表单:" + i);
System.out.println(l/1024 +"k/"+ l1/1024 + "k 表单:" + i);
}
});
// 处理乱码
upload.setHeaderEncoding("utf8");
// 设置单个文件的最大值
upload.setFileSizeMax(1024 * 1024 * 10);
// 设置总共能够上传文件的最大值
upload.setSizeMax(1024 * 1024 * 10);
return upload;
}
/**
* 解析请求并处理
* @param upload ServletFileUpload 对象
* @param request 请求
* @param uploadPath 文件保存目录
* @return 处理结果信息
* @throws FileUploadException 上传异常
* @throws IOException IO异常
*/
private String uploadParseRequest(ServletFileUpload upload, HttpServletRequest request, String uploadPath) throws FileUploadException, IOException {
String msg = "";
// 解析请求,封装成一个 FileItem 对象(对应表单中的每一个输入项)
List<FileItem> fileItems = upload.parseRequest(request);
// 遍历fileItems
for (FileItem fileItem : fileItems) {
// 普通表单项
if (fileItem.isFormField()) {
// 打印表单名字及值
String name = fileItem.getFieldName();
String value = fileItem.getString("utf8");
System.out.println(name + " : " + value);
}
// 文件表单项
else {
// -----------获取文件信息-----------
// 获取文件名字(包括路径)
String uploadFileName = fileItem.getName();
// 判断文件是否存在;不存在继续下次循环
if (uploadFileName == null || uploadFileName.trim().length() < 1) {
continue;
}
// 获取上传的文件名(不含路径)
String fileName = uploadFileName.substring(uploadFileName.lastIndexOf("/") + 1);
// 获取文件后缀名
String fileExName = fileName.substring(fileName.lastIndexOf(".") + 1);
/*
* 如果文件后缀名fileExName不是所需的直接return,不进行处理,告诉用户文件类型不对
*/
System.out.println("文件信息 [文件名:" + fileName + "---文件类型" + fileExName + "]");
// -----------构建文件存放地址-----------
String uuidPath = UUID.randomUUID().toString();
// 真实存放的路径
String realPath = uploadPath + "/" + uuidPath;
// 给每个文件创建一个对应的文件夹
File realPathFile = new File(realPath);
if (!realPathFile.exists()) {
realPathFile.mkdir();
}
// -----------文件上传-----------
// 获取文件输入流
InputStream is = fileItem.getInputStream();
// 获取文件输出流
FileOutputStream fos = new FileOutputStream(realPath + "/" + fileName);
// 创建缓冲区
byte[] buf = new byte[1024 * 1024 * 2];
// 上传
int len = 0;
while((len = is.read(buf)) > 0){
fos.write(buf,0,len);
}
// 关闭流
fos.close();
is.close();
msg = "文件上传成功";
// 上传成功,清除临时文件
fileItem.delete();
}
}
return msg;
}
}
(3)配置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"
metadata-complete="true">
<servlet>
<servlet-name>fileUpload</servlet-name>
<servlet-class>com.tuwer.servlet.FileUploadServlet</servlet-class>
</servlet>
<servlet-mapping>
<servlet-name>fileUpload</servlet-name>
<url-pattern>/upload.do</url-pattern>
</servlet-mapping>
</web-app>