JavaWeb-文件上传
一、概述
- 使的用jar包
- 文件上传注意事项
- 为保证服务器安全,上传文件应放在外界无法直接访问的目录下,比如放于WEB-INF目录下
- 为防止文件覆盖的现象发生,要为上传文件产生一个唯一的文件名
- 要限制上传文件的最大值
- 可以限制上传文件的类型,在收到上传文件名时,判断后缀名是否合法
- 表单 method 属性应该设置为 POST 方法,不能使用 GET 方法
二、使用到的类
-
ServletFileUpload
负责处理上传的文件数据,并将表单中每个输入项封装成一个FileItem对象, 在使用ServletFileUpload对象解析请求时需要DiskFileItemFactory对象。所以,我们需要在进行解析工作前构造好DiskFileItemFactory对象,通过ServletFileUpload对象的构造方法或setFileItemFactory()方法设置ServletFileUpload对象的fileItemFactory属性。
-
FileItem
在HTML页面input 必须有 name
<input type="file" name="filename">
,表单如果包含一个文件上传输入项的话,这个表单的enctype属性就必须设置为multipart/form-data,在服务器端想获取数据也要通过流 -
DiskFileItemFactory
将请求消息实体中的每一个项目封装成单独的DiskFileItem (FileItem接口的实现) 对象的任务
由 org.apache.commons.fileupload.FileItemFactory 接口的默认实现
org.apache.commons.fileupload.disk.DiskFileItemFactory 来完成。当上传的文件项目比较小时,直接保存在内存中(速度比较快),比较大时,以临时文件的形式,保存在磁盘临时文件夹(虽然速度慢些,但是内存资源是有限的)。
三、代码实现逻辑
- 判断用户上传的文件是普通表单还是带文件的表单,如果是普通文件直接返回(return)
- 创建文件上传保存的路路径,在WEB-INF路径下是安全的,用户无法直接访问上传文件
- 创建临时路径,如果文件好过了预期大小,就把他放到一个临时文件中
- 创建DiskFileItemFactory对象,设置文件临时路径(setRepository)或大小的限制(设置一个缓冲区,setSizeThreshold)
- 获取ServletFileUpload对象,处理乱码问题(setHeaderEncoding),设置单个文件的最大值(setFileSizeMax),设置总共能够上传文件的大小(setSizeMax),还可选择监听文件上传进度(setProgressListener)
- 通过ServletFileUpload对象的parseRequest方法把前端请求解析,封装成一个FileItem对象,判断上传的文件是普通的表单还是带文件的表单(isFormField),getFieldName获取前端表单控件的name
- 通过FileItem的getName方法获取文件名字并判断是否为空,可以使用UUID保证文件名唯一
- 拼接文件真实存在路径,并给每个文件创建一个对应的文件夹
- 通过FileItem的getInputStream方法获取文件上传的流,并创建一个文件输出流将文件写入真实保存路径,最后关闭流
- 上传成功可将页面转发到新的提示页面
四、代码实现
FileServlet
package com.saxon.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.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.util.List;
import java.util.UUID;
public class FileServlet extends HttpServlet {
@Override
protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
//判断用户上传的文件是普通表单还是带文件的表单,如果是普通文件直接返回
if (!ServletFileUpload.isMultipartContent(request)) {
return;
}
//创建文件上传保存的路路径,在WEB-INF路径下是安全的,用户无法直接访问上传文件
String uploadPath = this.getServletContext().getRealPath("/WEB-INF/upload");
System.out.println(uploadPath);
File uploadFile = new File(uploadPath);
if (!uploadFile.exists()) {
uploadFile.mkdir();
}
//临时路径,如果文件好过了预期大小,就把他放到一个临时文件中,过几天自动删除,或者提醒用户转存为永久
String tmpPath = this.getServletContext().getRealPath("WEB-INF/tmp");
File file = new File(tmpPath);
if (!file.exists()) {
file.mkdir();
}
//处理上传的文件,一般通过流来获取,可以使用request.getInputStream(),原生态的文件上传流获取,十分麻烦
//建议使用 Apache的文件上传组件来实现,common-fileupload,它需要依赖于 commons-io组件;
//1、创建DiskFileItemFactory对象,处理文件上传路径或大小的限制
DiskFileItemFactory factory = getDiskFileItemFactory(file);
//2、获取ServletFileUpload
/* ServletFileUpload负责处理上传的文件数据,并将表单中每个输入项封装成一个FileItem对象,
在使用ServletFileUpload对象解析请求时需要DiskFileItemFactory对象。
所以,我们需要在进行解析工作前构造好DiskFileItemFactory对象,
通过ServletFileUpload对象的构造方法或setFileItemFactory()方法设置ServletFileUpload对象的fileItemFactory属性。
*/
ServletFileUpload upload = getServletFileUpload(factory);
//3、处理上传的文件
/*
如果文件后缀名fiLeExtName不是我们所需要的
就直接return,不处理,告诉用户文件类型不对。
*/
// 可以使用UUID(唯一识别的通用码),保证文件名唯一
// UUID.randomUUID(),随机生成一个唯一识别的通用码
// 网络中传输的东西,都需要序列化
// 之前写过的pojo实体类,如果想要在多个电脑上运行, 传输 ==> 需要把对象都序列化
// C:\Program Files\Java\jdk1.8.0_251\include下的JNI.h文件, JNI = java native interface
// 所以建议所有实体类都实现该接口: implements Serializable(该接口是标记接口) JVM --> 本地方法栈 native --> C++
try {
String msg = uploadParseRequest(upload, request, uploadPath);
request.setAttribute("msg", msg);
request.getRequestDispatcher("msg.jsp").forward(request, response);
} catch (FileUploadException e) {
e.printStackTrace();
}
}
@Override
protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
doGet(req, resp);
}
public static DiskFileItemFactory getDiskFileItemFactory(File file) {
DiskFileItemFactory factory = new DiskFileItemFactory();
//通过这个工厂设置一个缓冲区,当上传的文件大于这个缓冲区的时候,将他放到临时文件中
factory.setSizeThreshold(1024 * 1024); //缓冲区大小为1M
factory.setRepository(file);//临时文件保存的目录,需要一个File
return factory;
}
public static ServletFileUpload getServletFileUpload(DiskFileItemFactory factory) {
ServletFileUpload upload = new ServletFileUpload(factory);
//监听文件上传进度
upload.setProgressListener(new ProgressListener() {
@Override
//pBytesRead:已经读取到的文件大小
//pContentLength : 文件大小
public void update(long pBytesRead, long pContentLength, int pItems) {
System.out.println("总大小:" + pContentLength + "已上传" + pBytesRead);
}
});
//处理乱码问题
upload.setHeaderEncoding("utf-8");
//设置单个文件的最大值
upload.setFileSizeMax(1024 * 1024 * 10);
//设置总共能够上传文件的大小
upload.setSizeMax(1024 * 1024 * 10);
return upload;
}
public static String uploadParseRequest(ServletFileUpload upload, HttpServletRequest request, String uploadPath) throws FileUploadException, IOException, FileUploadException {
String msg = "";
//把前端请求解析,封装成一个FileItem对象
List<FileItem> fileItems = upload.parseRequest(request);
for (FileItem fileItem : fileItems) {
if (fileItem.isFormField()) {
String name = fileItem.getFieldName();
String value = fileItem.getString("UTF-8");
System.out.println(name + ":" + value);
} else {
//****************************处理文件****************************
//拿到文件名字
String uploadFileName = fileItem.getName();
System.out.println("上传的文件名:" + uploadFileName);
if (uploadFileName.trim().equals("") || uploadFileName == null) {
continue;
}
//获得上传的文件名
String fileName = uploadFileName.substring(uploadFileName.lastIndexOf("/") + 1);
//获得文件的后缀名
String fileExName = uploadFileName.substring(uploadFileName.lastIndexOf(".") + 1);
/*
* 如果文件后缀名fileExName不是所需的直接return,不进行处理,告诉用户文件类型不对
* */
System.out.println("文件信息 [文件名:" + fileName + "---文件类型" + fileExName + "]");
//可以使用UUID(唯一识别通用码)保证文件名唯一
String uuidPath = UUID.randomUUID().toString();
//****************************处理文件完毕****************************
//真实存在的路径
String realPath = uploadPath + "/" + uuidPath;
//给每个文件创建一个对应的文件夹
File realPathFile = new File(realPath);
if (!realPathFile.exists()) {
realPathFile.mkdir();
}
//****************************存放地址完毕*****************************
//获得文件上传的流
InputStream inputStream = fileItem.getInputStream();
//创建一个文件输出流
//realPath是真实的文件夹
FileOutputStream fos = new FileOutputStream(realPath + "/" + fileName);
//创建一个缓冲区
byte[] buffer = new byte[1024 * 1024];
//判断是否读取完毕
int len = 0;
while ((len = inputStream.read(buffer)) > 0) {
fos.write(buffer, 0, len);
}
//关闭流
fos.close();
inputStream.close();
msg = "文件上传成功";
fileItem.delete();//上传成功,清除临时文件
//*************************文件传输完毕**************************
}
}
return msg;
}
}
index.jsp
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>文件上传</title>
</head>
<body>
<%--${pageContext.request.contextPath}
代表获取服务器当前路径
--%>
<form action="${pageContext.request.contextPath}/upload.do" method="post" enctype="multipart/form-data">
上传用户: <input type="text" name="username"><br/>
上传文件:<input type="file" name="file"><br/>
<input type="submit" value="提交">
</form>
</body>
</html>
msg.jsp
<%--
Created by IntelliJ IDEA.
User: Administrator
Date: 2021/6/9
Time: 10:27
To change this template use File | Settings | File Templates.
--%>
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>消息提示</title>
</head>
<body>
${msg}
</body>
</html>
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>FileServlet</servlet-name>
<servlet-class>com.saxon.servlet.FileServlet</servlet-class>
</servlet>
<servlet-mapping>
<servlet-name>FileServlet</servlet-name>
<url-pattern>/upload.do</url-pattern>
</servlet-mapping>
</web-app>
最后存放的地址:E:\apache-tomcat-7.0.72\apache-tomcat-7.0.72\webapps\file_war\WEB-INF\upload(tomcat目录下)