【JavaWeb】一看就会的文件上传功能实现（附普通Servlet和SpringMVC完整实现代码）
程序员文章站
2022-06-11 15:53:38
...
【JavaWeb】一看就会的文件上传功能实现（附普通Servlet和SpringMVC完整实现代码）
需求
一般网站都可能存在上传文件、图片的功能，例如：常见的头像上传…
刚好课设和大创项目都需要实现上传图片的功能，于是乎开始了漫长的探寻过程。
可以说看了很多大牛的博客，但是似乎都并不是很适合小白阅读，一些原理也看的比较懵，最终还是来到了B站（最强大学习网站，hh），最终还是不负所望，get到需要的知识了，需求虽已实现，但技术仍需巩固，便有了这篇博客。
环境准备
1、任意JavaWeb项目
2、tomcat 8.0以上版本（不包括8.0，后续会介绍）
3、相关Jar包：common-fileupload、commos-io、javax.servlet-api（具体版本为：commons-fileupload-1.3.3.jar、commons-io-2.8.0.jar、javax.servlet-api-4.0.1.jar，当然maven工程，直接引依赖即可）
4、以下代码均使用IDEA实现
前端页面
1、上传文件页面（该项目具体文件为：index.jsp）
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<body>
<%--获取服务器路径--%>
<form action="${pageContext.request.contextPath}/upload" enctype="multipart/form-data" method="post">
<input type="file" name="file"/>
<input type="submit" value="upload">
</form>
</body>
</html>
需要注意，表单选项需要加上 enctype选项，使得上传的表单以二进制流的形式读取。
2、显示上传文件是否成功页面（该项目具体文件为：info.jsp)
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<body>
<%--获取服务器路径--%>
<form action="${pageContext.request.contextPath}/upload" enctype="multipart/form-data" method="post">
<input type="file" name="file"/>
<input type="submit" value="upload">
</form>
</body>
</html>
普通Servlet实现
处理上传文件，一般都是通过流来获取，我们可以使用request.getInputStream() 原生态的文件上传流获取，但是十分麻烦；
于是一般使用Apache的文件上传组件 common-fileupload 来实现，它需要依赖 commos-io 组件（这就是之前导包的原因）；
ServletFileUpload 负责处理上传的文件数据，并将表单中每一项封装成一个FileItem对象；
在使用 ServletFileUpload 对象解析请求时，需要用到 DiskFileItemFactory 对象于是，在进行解析工作前先构建出 DiskFileItemFactory 对象；
通过 ServletFileUpload 构造方法或 setter方法，为 ServletFileUpload 对象设置 DiskFileItemFactory 属性；
于是具体过程可以分解为三步（下面代码为三个封装的函数实现）：
//1.创建 DiskFileItemFactory 对象，处理文件上传路径或者限制大小
DiskFileItemFactory factory=getDiskFileItemFactory(uploadFile);
//2.获取 ServletFileUpload
ServletFileUpload upload=getServletFileUpload(factory);
//3.处理上传的文件
String msg= null;
msg = uploadParseRequest(upload,req,uploadPath);
关于DiskFileItemFactory、ServletFileUpload相关设置，都存在相关默认值，可以直接通过源码查看，但是在下面代码中均也做了设置，最终的便是第三步。
处理上传的文件：
3.1、判断上传的表单中文件是否符合需要的文件格式：
//======================处理文件=========================//
String uploadFileName=fileItem.getName();
//文件不合法
if(uploadFileName.trim().equals("")||uploadFileName==null){
continue;
}
//获取上传的文件名 例如：test/img1.png
String fileName=uploadFileName.substring(uploadFileName.lastIndexOf("/")+1);
//后缀
String fileSuffixName=uploadFileName.substring(uploadFileName.lastIndexOf(".")+1);
3.2、存放文件，通过UUID（唯一识别的通用码，防止文件出现重名情况，但是又需要保证文件原始名不变，于是直接用UUID创建一个目录，每一个文件放到相应的目录中，完美解决上述的两个问题）
//使用UUID（唯一识别的通用码），保证文件名唯一
// UUID.randomUUID() 随机生成一个通用码
String uuidPath=UUID.randomUUID().toString();
String realPath=uploadPath+"/"+uuidPath;
//给每个文件创建一个文件夹
File realPathFile=new File(realPath);
if(!realPathFile.exists()) realPathFile.mkdir();
3.3、文件传输（文件保存）
//获取文件上传的流
InputStream inputStream=fileItem.getInputStream();
//目录是唯一通用码，而目录中的文件名仍不变
FileOutputStream fileOutputStream=new FileOutputStream(realPath+"/"+fileName);
//创建一个缓冲区
byte[] buffer=new byte[1024*1024];
//判断是否读取完毕
int len=0;
//如果大于0，则表示还存在数据
while((len=inputStream.read())>0){
fileOutputStream.write(buffer,0,len);
}
//关闭流
fileOutputStream.close();
inputStream.close();
fileItem.delete(); //上传成功，删除临时文件
//msg保存图片路径
msg=realPath+"/"+fileName;
于是乎大功告成。UploadFileServlet完整代码如下：
package com.lb.servlet;
import org.apache.commons.fileupload.FileItem;
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.annotation.WebServlet;
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;
@WebServlet(name = "upload",urlPatterns = {"/upload"})
public class UploadFileServlet extends HttpServlet {
@Override
protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
//判断是普通表单还是带文件的表单
if(!ServletFileUpload.isMultipartContent(req)){
return; //如果是普通表单终止方法运行
}
//创建上传文件的保存路径，建议在WEB-INF路径下，安全，用户无法直接访问上传的文件
String uploadPath=this.getServletContext().getRealPath("/WEB-INF/upload");
File uploadFile=new File(uploadPath);
//如果不存在，则新建一个目录
if(!uploadFile.exists()){
uploadFile.mkdir();
}
//缓存，临时文件
//临时路径，假如文件超过了预期的大小，我们就把他放到一个临时文件中，过几天自动删除，或者提醒用户转存为永久
String tempPath=this.getServletContext().getRealPath("/WEB-INF/temp");
File tempFile=new File(tempPath);
if(!tempFile.exists()){
tempFile.mkdir(); //创建临时目录
}
/**
* ServletFileUpload 负责处理上传的文件数据，并将表单中每一项封装成一个FileItem对象
* 在使用 ServletFileUpload 对象解析请求时，需要用到 DiskFileItemFactory 对象
* 于是，在进行解析工作前先构建出 DiskFileItemFactory 对象
* 通过 ServletFileUpload 构造方法或 setter方法，为 ServletFileUpload 对象设置 DiskFileItemFactory 属性
*/
//处理上传的文件，一般都需要通过流来获取，我们可以使用request.getInputStream()原生态流的文件上传流获取，但是十分麻烦
//一般使用Apache的文件上传组件来实现，common-fileupload，它需要依赖于commos-io组件
try {
//1.创建 DiskFileItemFactory 对象，处理文件上传路径或者限制大小
DiskFileItemFactory factory=getDiskFileItemFactory(uploadFile);
//2.获取 ServletFileUpload
ServletFileUpload upload=getServletFileUpload(factory);
//3.处理上传的文件
String url= null;
url = uploadParseRequest(upload,req,uploadPath);
//servlet请求转发信息
req.setAttribute("msg",url);
req.getRequestDispatcher("info.jsp").forward(req,resp);
} catch (Exception e) {
e.printStackTrace();
}
}
/**
* 创建 DiskFileItemFactory 对象，处理文件上传路径或者限制大小
* @param file
* @return
*/
public static DiskFileItemFactory getDiskFileItemFactory(File file){
DiskFileItemFactory factory=new DiskFileItemFactory();
//通过这个工厂设置一个缓冲区，当上传文件大于这个缓冲区的时候，把他放到临时文件中
factory.setSizeThreshold(10*1024*1024); //缓存区大小为10M
factory.setRepository(file); //临时文件目录，需要一个File
return factory;
}
/**
* 获取 ServletFileUpload
* @param factory
* @return
*/
public static ServletFileUpload getServletFileUpload(DiskFileItemFactory factory){
ServletFileUpload upload=new ServletFileUpload(factory);
//监听文件上传精度
upload.setProgressListener(new ProgressListener() {
@Override
//pBytesRead：已经读取到的文件大小
//pContentLenght：文件大小
public void update(long pBytesRead, long pContentLenght, int pItem) {
System.out.println("总大小："+pContentLenght+"，已上传："+pBytesRead);
}
});
//处理乱码问题
upload.setHeaderEncoding("UTF-8");
//设置单个文件的最大值
upload.setFileSizeMax(10*1024*1024); //10M
//设置总共能够上传文件的大小
upload.setSizeMax(100*1024*1024); //100M
return upload;
}
/**
* 处理上传的文件
* @param upload
* @param request
* @param uploadPath
* @return
* @throws Exception
*/
public static String uploadParseRequest(ServletFileUpload upload, HttpServletRequest request, String uploadPath) throws Exception {
String msg="";
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();
//文件不合法
if(uploadFileName.trim().equals("")||uploadFileName==null){
continue;
}
//获取上传的文件名 例如：test/img1.png
String fileName=uploadFileName.substring(uploadFileName.lastIndexOf("/")+1);
//后缀
String fileSuffixName=uploadFileName.substring(uploadFileName.lastIndexOf(".")+1);
//======================存放文件=========================//
//使用UUID（唯一识别的通用码），保证文件名唯一
// UUID.randomUUID() 随机生成一个通用码
String uuidPath=UUID.randomUUID().toString();
String realPath=uploadPath+"/"+uuidPath;
//给每个文件创建一个文件夹
File realPathFile=new File(realPath);
if(!realPathFile.exists()) realPathFile.mkdir();
//======================文件传输=========================//
//获取文件上传的流
InputStream inputStream=fileItem.getInputStream();
//目录是唯一通用码，而目录中的文件名仍不变
FileOutputStream fileOutputStream=new FileOutputStream(realPath+"/"+fileName);
//创建一个缓冲区
byte[] buffer=new byte[1024*1024];
//判断是否读取完毕
int len=0;
//如果大于0，则表示还存在数据
while((len=inputStream.read())>0){
fileOutputStream.write(buffer,0,len);
}
//关闭流
fileOutputStream.close();
inputStream.close();
fileItem.delete(); //上传成功，删除临时文件
//msg保存图片路径
msg=realPath+"/"+fileName;
}
}
return msg;
}
}
普通Servlet实现效果
注意：
1、三个jar都必须要导，尤其是commos-io，之前因为没导就报错了
2、tomcat需要8.0以上，因为如果8.0及以下会存在tomcat中的jar与导入的jar存在冲突。
3、文件保存路径存放在服务器上（如果是本地运行的话：也就是在tomcat中webapps目录下的项目名中的WEB-INF的子文件夹中…/tomcat/webapps/WEB-INF/…，这样的比较安全，用户无法直接访问上传的文件
4、上述代码还实现了临时文件、临时缓冲区机制，如果文件较大时，则存储到临时文件中，过几天自动删除，或者提醒用户另存为。
SpringMVC实现
1、首先引入依赖
<!--spring 核心包-->
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-core</artifactId>
<version>5.2.7.RELEASE</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-web</artifactId>
<version>5.2.7.RELEASE</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-oxm</artifactId>
<version>5.2.7.RELEASE</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-tx</artifactId>
<version>5.2.7.RELEASE</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-jdbc</artifactId>
<version>5.2.7.RELEASE</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-webmvc</artifactId>
<version>5.2.7.RELEASE</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-aop</artifactId>
<version>5.2.7.RELEASE</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-context-support</artifactId>
<version>5.2.7.RELEASE</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-test</artifactId>
<version>5.2.7.RELEASE</version>
</dependency>
<!--日志-->
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-log4j12</artifactId>
<version>1.8.0-alpha0</version>
<scope>test</scope>
</dependency>
<!--j2ee相关包 servlet、jsp、jstl-->
<dependency>
<groupId>javax.servlet</groupId>
<artifactId>javax.servlet-api</artifactId>
<version>4.0.1</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>javax.servlet.jsp</groupId>
<artifactId>jsp-api</artifactId>
<version>2.2</version>
</dependency>
<dependency>
<groupId>javax.servlet</groupId>
<artifactId>jstl</artifactId>
<version>1.2</version>
</dependency>
<!-- json包-->
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-databind</artifactId>
<version>2.11.0</version>
</dependency>
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-core</artifactId>
<version>2.11.0</version>
</dependency>
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-annotations</artifactId>
<version>2.11.0</version>
</dependency>
<!--文件上传-->
<dependency>
<groupId>commons-fileupload</groupId>
<artifactId>commons-fileupload</artifactId>
<version>1.3.3</version>
</dependency>
<!--servlet-api导入高版本的-->
<dependency>
<groupId>javax.servlet</groupId>
<artifactId>javax.servlet-api</artifactId>
<version>4.0.1</version>
</dependency>
2、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_3_1.xsd"
version="3.1">
<welcome-file-list>
<welcome-file>index.jsp</welcome-file>
</welcome-file-list>
<servlet>
<servlet-name>springmvc</servlet-name>
<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
<init-param>
<param-name>contextConfigLocation</param-name>
<param-value>/WEB-INF/dispatcher-servlet.xml</param-value>
</init-param>
</servlet>
<servlet-mapping>
<servlet-name>springmvc</servlet-name>
<url-pattern>/</url-pattern>
</servlet-mapping>
</web-app>
3、配置 **dispatcher-servlet.xml **文件
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:context="http://www.springframework.org/schema/context"
xmlns:mvc="http://www.springframework.org/schema/mvc"
xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/context https://www.springframework.org/schema/context/spring-context.xsd http://www.springframework.org/schema/mvc https://www.springframework.org/schema/mvc/spring-mvc.xsd">
<!-- 开启注解-->
<context:component-scan base-package="com.lb"/>
<!-- 适配器注释-->
<mvc:annotation-driven/>
<bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">
<property name="prefix" value=""></property>
<property name="suffix" value=".jsp"></property>
</bean>
<!--文件上传配置-->
<bean id="multipartResolver" class="org.springframework.web.multipart.commons.CommonsMultipartResolver">
<!-- 请求的编码格式，必须和jSP的pageEncoding属性一致，以便正确读取表单的内容，默认为ISO-8859-1 -->
<property name="defaultEncoding" value="utf-8"/>
<!-- 上传文件大小上限，单位为字节（10485760=10M） -->
<!-- <property name="maxUploadSize" value="10485760"/>-->
<!-- <property name="maxInMemorySize" value="40960"/>-->
</bean>
</beans>
4、Controller层编写(FileUploadController类)
4.1、同样使用UUID为每个文件创建特有的文件夹
4.2、同样保存到服务器上
package com.lb.controller;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.multipart.commons.CommonsMultipartFile;
import javax.servlet.http.HttpServletRequest;
import java.io.*;
import java.util.UUID;
@Controller
public class FileUploadController {
//@RequestParam("file") 将name=file控件得到的文件封装成CommonsMultipartFile 对象
//批量上传CommonsMultipartFile则为数组即可
@RequestMapping("/upload")
public String fileUpload(@RequestParam("file") CommonsMultipartFile file , HttpServletRequest request, Model model) throws IOException {
//获取文件名 : file.getOriginalFilename();
String uploadFileName = file.getOriginalFilename();
//如果文件名为空，直接回到首页！
if ("".equals(uploadFileName)){
return "fail";
}
//获取上传的文件名 例如：test/img1.png
String fileName=uploadFileName.substring(uploadFileName.lastIndexOf("/")+1).toLowerCase();
//后缀
String fileSuffixName=uploadFileName.substring(uploadFileName.lastIndexOf(".")+1);
if(!(fileSuffixName.equals("png")||fileSuffixName.equals("jpg")
||fileSuffixName.equals("bmp")||fileSuffixName.equals("gif"))){
return "fail";
}
// System.out.println("上传文件名 : "+uploadFileName);
//上传路径保存设置
String uploadPath = request.getServletContext().getRealPath("/upload");
//如果路径不存在，创建一个
File realPath = new File(uploadPath);
if (!realPath.exists()){
realPath.mkdir();
}
System.out.println("上传文件保存地址："+realPath);
//使用UUID（唯一识别的通用码），保证文件名唯一
// UUID.randomUUID() 随机生成一个通用码
String uuidPath= UUID.randomUUID().toString();
String filePath=uploadPath+"/"+uuidPath;
//给每个文件创建一个文件夹
File realPathFile=new File(filePath);
if(!realPathFile.exists()) realPathFile.mkdir();
InputStream is = file.getInputStream(); //文件输入流
OutputStream os = new FileOutputStream(new File(realPathFile,uploadFileName)); //文件输出流
//读取写出
int len=0;
byte[] buffer = new byte[1024];
while ((len=is.read(buffer))!=-1){
os.write(buffer,0,len);
os.flush();
}
os.close();
is.close();
String url=realPathFile+"/"+uploadFileName;
System.out.println(url);
model.addAttribute("url",url);
return "success";
}
}
SpringMVC实现效果
github项目地址
待更新
完美撒花！
上一篇： 第1章 环境搭建（imx283）
下一篇： JSP之Request对象