JavaWeb--文件上传
Posted Z && Y
tags:
篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了JavaWeb--文件上传相关的知识，希望对你有一定的参考价值。
1. 准备工作(搭建项目)
搭建一个web项目
2. 文件上传
文件传输原理
2.1 依赖准备
- 对于文件上传，浏览器在上传的过程中是将文件以流的形式提交到服务器端的。
- 一般选择采用apache的开源工具common-fileupload这个文件上传组件。
- common-fileupload是依赖于common-io这个包的，所以还需要下载这个包。
Maven依赖: pom.xml
<dependencies>
<!-- https://mvnrepository.com/artifact/javax.servlet/javax.servlet-api -->
<dependency>
<groupId>javax.servlet</groupId>
<artifactId>javax.servlet-api</artifactId>
<version>3.1.0</version>
</dependency>
<!-- https://mvnrepository.com/artifact/javax.servlet.jsp/javax.servlet.jsp-api -->
<dependency>
<groupId>javax.servlet.jsp</groupId>
<artifactId>javax.servlet.jsp-api</artifactId>
<version>2.3.1</version>
</dependency>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.11</version>
<scope>test</scope>
</dependency>
<!-- https://mvnrepository.com/artifact/commons-io/commons-io -->
<dependency>
<groupId>commons-io</groupId>
<artifactId>commons-io</artifactId>
<version>2.4</version>
</dependency>
<!-- https://mvnrepository.com/artifact/commons-fileupload/commons-fileupload -->
<dependency>
<groupId>commons-fileupload</groupId>
<artifactId>commons-fileupload</artifactId>
<version>1.3.1</version>
</dependency>
</dependencies>
2.2 文件上传的注意事项
- 为保证服务器安全，上传文件应该放在外界无法直接访问的目录下，比如放于WEB-NF目录下。
- 为防止文件覆盖的现象发生，要为上传文件产生—个唯一的文件名。（可以使用时间戳、UUID、MD5、自定义位运算)
- 要限制上传文件的最大值。
- 可以限制上传文件的类型，在收到上传文件名时，判断后缀名是否合法。
2.3 需要用到的类详解
- ServletrileUpload负责处理上传的文件数据,并将表单中每个输入项封装成一个Fileltem对象，在使用ServletFileUpload对象解析请求时需要DiskFileltemFactory对象。所以，我们需要在进行解析工作前构造好DiskFleltemFactory对象，通过SevletFileUJpload对象的构造方法或setFileltemFactory()方法设置ServletFileUpload对象的fileltemFactory属性。
2.3.1 Fileltem类
在html页面input必须有name <input type="file" name="filename">
- 表单如果包含一个文件上传输入项的话，这个表单的enctype属性就必须设置为multipart/form-data
- 浏览器表单的类型如果为multipart/form-data ,在服务器端想获取数据就要通过流。
常用方法介绍:
2.3.2 ServletFileUpload类
- ServletFileUpload负责处理上传的文件数据,并将表单中每个输入项封装成一个Fileltem对象中.使用其parseRequest(HttpServletRequest)方法可以将通过表单中每一个HTML标签提交的数据封装成一个Fileltem对象，然后以List列表的形式返回。使用该方法处理上传文件简单易用。
2.4 代码编写
2.4.1 前端页面
index.jsp
<html>
<body>
<%--
通过表单上传文件
get: 上传文件大小有限制
post: 上传文件大小每有限制
--%>
<form action="${pageContext.request.contextPath}/upload.do" method="post" enctype="multipart/form-data">
UserName: <input type="text" name="username"><br>
<input type="file" name="file01"><br>
<input type="file" name="file02"><br>
<input type="submit">|<input type="reset">
</form>
</body>
</html>
info.jsp
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>Title</title>
</head>
<body>
${msg}
</body>
</html>
运行结果:
2.4.2 后端接口
FileUploadServlet.java
package com.tian.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;
/**
* ClassName: FileUploadServlet
* Description: 文件上传
*
* @author Tianjiao
* @date 2021/8/12 19:53
*/
public class FileUploadServlet extends HttpServlet {
@Override
protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
this.doPost(request, response);
}
@Override
protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
// 判断是普通的表单还是带文件的表单
if (!ServletFileUpload.isMultipartContent(request)) {
// 若是普通的表单, 则终止方法的运行.
return;
}
// 创建文件上传的保存路径,建议保存在WEB-INF路径下面.安全,用户无法直接访问这个路径
String uploadPath = this.getServletContext().getRealPath("WEB-INF/upload");
File uploadFile = new File(uploadPath);
if (!uploadFile.exists()) {
// 如果这个目录不存在,就创建这个目录
uploadFile.mkdir();
}
// 缓存,存放临时文件
// 临时路径,加入这个文件的带线啊哦超出了预期,我们把它放到一个临时文件中,过几天自动删除,或者提醒用户转存为永久
String tmpPath = this.getServletContext().getRealPath("WEB-INF/tmp");
File tmpFile = new File(tmpPath);
if (!tmpFile.exists()) {
// 如果这个目录不存在,就创建这个目录
tmpFile.mkdir();
}
/*
处理上传的文件,一般都需要通过流来获取,我们可以使用 request, getInputstream(),
原生态的文件上传流获取,十分麻烦
但是我们都建议使用 Apache的文件上传组件来实现, common-fileupload,它需要旅 commons-io组件;
*/
// 1、创建DiskFileItemFactory对象，处理文件路径或者大小限制
DiskFileItemFactory factory = getDiskFileItemFactory(tmpFile);
// 2、获取ServletFileUpload
ServletFileUpload upload = getServletFileUpload(factory);
// 3、处理上传文件
// 把前端请求解析，封装成FileItem对象，需要从ServletFileUpload对象中获取
String msg = null;
try {
msg = uploadParseRequest(upload, request, uploadPath);
} catch (FileUploadException e) {
e.printStackTrace();
}
// Servlet请求转发消息
System.out.println(msg);
if (msg == "文件上传成功!") {
// Servlet请求转发消息
} else {
msg = "请上传文件";
}
request.setAttribute("msg", msg);
request.getRequestDispatcher("info.jsp").forward(request, response);
}
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() {
// pBYtesRead:已读取到的文件大小enctype="multipart/form-data"
// pContextLength:文件大小
public void update(long pBytesRead, long pContentLength, int pItems) {
System.out.println("总大小：" + pContentLength + "已上传：" + pBytesRead + "，进度：" + ((double) pBytesRead / pContentLength) * 100 + "%");
}
});
// 处理乱码问题
upload.setHeaderEncoding("UTF-8");
// 设置单个文件的最大值
upload.setFileSizeMax(1024 * 1024 * 10);
// 设置总共能够上传文件的大小
// 1024 = 1kb * 1024 = 1M * 10 = 10м
return upload;
}
public static String uploadParseRequest(ServletFileUpload upload, HttpServletRequest request, String uploadPath)
throws FileUploadException, IOException {
String msg = "";
// 把前端请求解析，封装成FileItem对象
List<FileItem> fileItems = upload.parseRequest(request);
for (FileItem fileItem : fileItems) {
// 判断上传的文件是普通的表单还是带文件的表单
if (fileItem.isFormField()) {
// getFieldName指的是前端表单控件的name;
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;
}
// 获得上传的文件名/images/girl/paojie.png
String fileName = uploadFileName.substring(uploadFileName.lastIndexOf("/") + 1);
// 获得文件的后缀名
String fileExtName = uploadFileName.substring(uploadFileName.lastIndexOf(".") + 1);
/*
* 如果文件后缀名fileExtName不是我们所需要的 就直按return.不处理,告诉用户文件类型不对。
*/
System.out.println("文件信息[件名: " + fileName + " ---文件类型" + fileExtName + "]");
// 可以使用UID（唯一识别的通用码),保证文件名唯
// 0UID. randomUUID(),随机生一个唯一识别的通用码;
String uuidPath = UUID.randomUUID().toString();
// ================处理文件完毕==============
// 存到哪? uploadPath
// 文件真实存在的路径realPath
String realPath = uploadPath + "/" + uuidPath;
// 给每个文件创建一个对应的文件夹
File realPathFile = new File(realPath);
if (!realPathFile.exists()) {
realPathFile.mkdir();
}
// ==============存放地址完毕==============
// 获得文件上传的流
InputStream inputStream = fileItem.getInputStream();
// 创建一个文件输出流
// realPath =真实的文件夹;
// 差了一个文件;加上翰出文件的名产"/"+uuidFileName
FileOutputStream fos = new FileOutputStream(realPath + "/" + fileName);
// 创建一个缓冲区
byte[] buffer = new byte[1024 * 1024];
// 判断是否读取完毕
int len = 0;
// 如果大于0说明还存在数据;
while ((len = inputStream.read(buffer)) > 0) {
fos.write(buffer, 0, len);
}
// 关闭流
fos.close();
inputStream.close();
msg = "文件上传成功!";
fileItem.delete(); // 上传成功,清除临时文件
//=============文件传输完成=============
}
}
return msg;
}
}
注册Servlet
web.xml
<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://xmlns.jcp.org/xml/ns/javaee"
xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd"
id="WebApp_ID" version="3.1">
<display-name>Archetype Created Web Application</display-name>
<!--注册servlet-->
<servlet>
<servlet-name>FileUploadServlet</servlet-name>
<servlet-class>com.tian.servlet.FileUploadServlet</servlet-class>
</servlet>
<!--servlet的请求路径-->
<servlet-mapping>
<servlet-name>FileUploadServlet</servlet-name>
<!--早期JavaWeb开发用的strus框架 这个框架的请求都是以.do结尾 我们这样命名是为了
向前辈们致敬-->
<url-pattern>/upload.do</url-pattern>
</servlet-mapping>
</web-app>
2.5 运行结果
以上是关于JavaWeb--文件上传的主要内容，如果未能解决你的问题，请参考以下文章