文件上传
在Web应用中，文件上传和下载功能是十分常见的功能，今天对狂神的文件上传进行总结。
1、准备工作
对于文件上传，浏览器在上传的过程中是将文件以流的形式提交到服务器端的。
一般选择采用apache的开源工具common-fileupload这个文件上传组件。
common-fileupload是依赖于common-io这个包的，所以还需要下载这个包。
- https://mvnrepository.com/artifact/commons-io/commons-io
- https://mvnrepository.com/artifact/commons-fileupload/commons-fileupload
导包问题
需要注意的点，将相关jar包导入lib目录下后。不建议直接右键Add as Library；正确完整的操作应该是File—>Project Structure—>Libraries进行添加，而此时会出现一个问题。
Artifact file:war exploded: library ‘lib’ required for module ‘file’ is missing from the artifact 。
Artifact 是maven中的一个概念，表示某个module要如何打包。这句话说明你的jar不会随着打包而添加到里面，我们如果想让整个项目完整，就必须将相关使用的lib也带上，所以以后建议这种导包方式。
2、文件上传注意事项(调优)
（1）为保证服务器安全，上传文件应该放在外界无法直接访问的目录下，比如放于WEB-INF目录下。
关于（1）：WEB-INF是安全目录，不能直接访问里面的页面。你的站点肯定有些页面是需要经过登录验证或其他验证后才能访问的，这些页面就放在WEB-INF里。如果是能不经过验证就访问的页面，比如主页、登录页、欢迎页这种，就不用放在WEB-INF里。不能通过URL直接访问，只能通过走Controller层进入。WEB-INF目录下一般存放的是lib文件夹（项目需要用到的jar包），服务器的配置文件web.xml，以及一些访问安全性较高的jsp/html页面（通常是后台管理页面）。只能通过重定向或转发去访问。
（2）为防止文件覆盖的现象发生，要为上传文件产生一个唯一的文件名。
关于（2）：解决方法：文件名+时间戳。时间戳是从1970.1.1开始所经过的秒数，不考虑溢出（2038问题）是可行的。但是如果就是遇到在同一时间不同用户传输文件名相同的文件还是不行的。所以进一步的解决方法文件名+UUID，UUID结合时间戳和机器MAC得到的，所以可以保证唯一性。
（3）要限制上传文件的最大值。
关于（3）：见贤思齐。为什么微信朋友圈不能上传一部电影呢？同时看那年今日很多照片和视频就看不了了。这就是文件大小起的作用，我们使用的VX，QQ毕竟是人家的产品，上传资源肯定也是人家的服务器，服务器资源是宝贵的，这么多用户不可能每个都给无限大的容量让你去用，所以好的服务器一定要设置相关上传文件的阈值。
（4）可以限制上传文件的类型，在收到上传文件名时，判断后缀名是否合法。
关于（4）：要规定上传文件的类型，否则如果被别有用心的人利用上传一个脚本文件，这个服务器就被入侵控制了。
3、需要用的类解释
ServletFileUpload负责处理上传的文件数据,并将表单中每个输入项封装成一个FileItem对象， 在使用ServletFileUpload对象解析请求时需要DiskFileItemFactory对象。所以，我们需要在进行解析工作前构造好DiskFileItemFactory对象，通过ServletFileUpload对象的构造方法或setFileItemFactory()方法设置ServletFileUpload对象的fileItemFactory属性。
FileItem类
在HTML页面input 必须有 name属性。<input type="file" name="filename">
表单如果包含一个文件上传输入项的话，这个表单的enctype属性就必须设置为multipart/form-data
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>Title</title>
</head>
<body>
<%--记得前面说的写路径把其子项目的根目录加上。同时JSTL表达式字符串拼接--%>
<%--post无大小限制，文件上传用post--%>
<form action="${pageContext.request.contextPath}/upload.do" method="post" enctype="multipart/form-data">
<label>上传用户:<input type="text" name="userName"></label>
<p><input type="file" name="file1"></p>
<p><input type="file" name="file2"></p>
<p><input type="submit"> | <input type="reset" name="" id=""></p>
</form>
</body>
</html>
浏览器表单的类型如果为multipart/form-data , 在服务器端想获取数据就要通过流。
ServletFileUpload类
ServletFileUpload负责处理上传的文件数据,并将表单中每个输入项封装成一个FileItem对象中 . 使用其parseRequest(HttpServletRequest) 方法可以将通过表单中每一个HTML标签提交的数据封装成一个FileItem对象，然后以List列表的形式返回。使用该方法处理上传文件简单易用。
4、代码编写
前台form表单 upload.jsp
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>文件上传</title>
</head>
<body>
<%--记得前面说的写路径把其子项目的根目录加上。同时JSTL表达式字符串拼接--%>
<%--post无大小限制，文件上传用post--%>
<form action="${pageContext.request.contextPath}/upload.do" method="post" enctype="multipart/form-data">
<label>上传用户:<input type="text" name="userName"></label>
<p><input type="file" name="file1"></p>
<p><input type="file" name="file2"></p>
<p><input type="submit"> | <input type="reset"></p>
</form>
</body>
</html>
msg.jsp
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>Title</title>
</head>
<body>
${msg}
</body>
</html>
后台servlet代码
package com.zmj.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;
//后台代码，表单点击提交经过web.xml映射到这个servlet。
public class FileServlet extends HttpServlet {
@Override
protected void doGet(HttpServletRequest req, HttpServletResponse resp) {
//文件上传不能用get，有大小限制
return;
}
@Override
protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
//判断上传的文件是普通的表单还是带multipart/属性的表单
if(!ServletFileUpload.isMultipartContent(req)) {
return;
//终止方法运行。栈顶指针回调。
//普通表单，直接返回。这一步也就是所谓的安全性检查，在工程代码中一开始其实有很多if进行安全性检查。
}
//创建上传文件的保存路径，建议在WEB-INF路径下，安全，用户无法直接访问上传的文件；TODO 文件上传调优一
//File uploadFile = new File(req.getContextPath() + "/WEB-INF/upload");经过检测上传位置不对
/*
System.out.println("1:" + req.getContextPath() + "/WEB-INF/upload");
//1:/fup/WEB-INF/upload
System.out.println("2:" + req.getServletPath() + "/WEB-INF/upload");
//2:/upload.do/WEB-INF/upload
System.out.println("3:" + this.getServletContext().getRealPath("/WEB-INF/upload"));
E:\\AKuangLearn\\FileUoload\\out\\artifacts\\file_war_exploded\\WEB-INF\\upload
注释也会转义，加杠
System.out.println("4:" + req.getServletContext().getContextPath());
// /fup
System.out.println("5:" + req.getServletContext().getRealPath("/WEB-INF/upload"));
// "E:\\AKuangLearn\\FileUoload\\out\\artifacts\\file_war_exploded\\WEB-INF\\upload"
req.getServletContext().getRealPath("");
System.out.println("6:" + req.getServletContext().getRealPath(""));
// "E:\\AKuangLearn\\FileUoload\\out\\artifacts\\file_war_exploded\\"
*/
File uploadFile = new File(req.getServletContext().getRealPath("") + "/WEB-INF/upload");
if(!uploadFile.exists()) {
uploadFile.mkdirs();
}
//临时路径，假如文件超过了预期的大小，我们就把他放到一个临时文件中，过几天自动删除，或者提醒用户转存为永久
File tempFile = new File(req.getServletContext().getRealPath("") + "/WEB-INF/temp");
if(!tempFile.exists()) {
tempFile.mkdirs();
}
//1.创建DiskFileItemFactory对象，处理文件上传路径或者大小限制的；
DiskFileItemFactory diskFileItemFactory = getDiskFileItemFactory(tempFile);
//2.获取ServletFileUpload
ServletFileUpload upload = getServletFileUpload(diskFileItemFactory);
//3.处理上传的文件
String msg = uploadParseRequest(upload, req, req.getServletContext().getRealPath("") + "/WEB-INF/upload");
req.setAttribute("msg",msg);
//req.getRequestDispatcher(req.getContextPath() + "/msg.jsp").forward(req,resp);
req.getRequestDispatcher("/msg.jsp").forward(req,resp);
//这个转发不需要加子项目路径，否则重复,因为转发肯定在当前子项目下
}
private DiskFileItemFactory getDiskFileItemFactory(File tempFile) {
DiskFileItemFactory factory = new DiskFileItemFactory();
//通过这个工厂设置一个缓冲区，当上传的文件大于这个缓冲区的时候，将他放到临时文件中；TODO 调优三
factory.setSizeThreshold(1024 * 1024);//缓存区大小为1M
factory.setRepository(tempFile);//临时目录的保存目录
return factory;
}
private 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");
//设置单个文件的最大值 TODO 调优三
upload.setFileSizeMax(1024 * 1024 * 10);
//设置总共能够上传文件的大小
//1024 = 1kb * 1024 = 1M * 10 = 10M
upload.setSizeMax(1024 * 1024 * 10);
return upload;
}
private String uploadParseRequest(ServletFileUpload upload,HttpServletRequest request,String uploadPath) {
String msg = "";
try {
//把前端请求解析，封装成一个FileItem对象
List<FileItem> fileItems = upload.parseRequest(request);
for (FileItem fileItem : fileItems) {
if(fileItem.isFormField()) {//判断包裹在这个form表单里的所有元素，区分哪个带/不带文件。
//getFieldName指的是前端表单控件的name；
String name = fileItem.getFieldName();
String value = fileItem.getString("UTF-8"); //处理乱码
System.out.println(name+":"+value);
//例如我们例子第一项是输入的用户名。
//可以在这里switch 进行判断然后操作。
} else { //有file属性，带文件
//=======================处理文件===============================//
//拿到文件名字
String uploadFileName = fileItem.getName();
System.out.println("上传的文件名："+uploadFileName);
if (uploadFileName == null || uploadFileName.trim().length() == 0) {
continue;
}
//获得上传的文件名 /images/girl/paojie.png
String fileName = uploadFileName.substring(uploadFileName.lastIndexOf("\\") + 1);
//获得文件的后缀名
String fileExtName = uploadFileName.substring(uploadFileName.lastIndexOf(".") + 1);
/*
如果文件后缀名 fileExtName 不是我们所需要的
就直接return，不处理，告诉用户文件类型不对。 TODO 优化四
*/
System.out.println("文件信息 [文件名："+fileName+"---文件类型"+fileExtName+"]");
//可以使用UUID（唯一识别的通用码），保证文件名唯一；
//UUID.randomUUID()，随机生一个唯一识别的通用码；
String uuidPath = UUID.randomUUID().toString();
//=======================处理文件完毕===============================//
//存到哪？ uploadPath
//文件真实存在的路径 realPath
String realPath = uploadPath+"\\"+uuidPath; //TODO 优化二 使用UUID和包机制保证唯一
//给每个文件创建一个对应的文件夹
File realPathFile = new File(realPath);
if (!realPathFile.exists()){
realPathFile.mkdirs();
}
//=======================存放地址完毕===============================//
//获得文件上传的流
InputStream inputStream = fileItem.getInputStream();
//创建一个文件输出流
//realPath = 真实的文件夹；
//差了一个文件; 加上输出文件的名字+"/"+uuidFileName
FileOutputStream fos = new FileOutputStream(realPath+"\\"+fileName);
//创建一个缓冲区
byte[] buffer = new byte[1024*1024];
//判断是否读取完毕
//int len = 0;
int len;
//如果大于0说明还存在数据；
while ((len=inputStream.read(buffer))>0){
fos.write(buffer,0,len);
}
//关闭流
fos.close();
inputStream.close();
msg = "文件上传成功！";
fileItem.delete(); //上传成功，清除临时文件
//=======================文件传输完毕===============================//
}
}
} catch (FileUploadException | IOException e) {
e.printStackTrace();
}
return msg;
}
}
写完（创建）一个servlet，立刻去web.xml将相关的servlet进行注册和绑定。
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.zmj.servlet.FileServlet</servlet-class>
</servlet>
<servlet-mapping>
<servlet-name>fileServlet</servlet-name>
<url-pattern>/upload.do</url-pattern>
<!--.do 早年structs流传下的传统，向老前辈致敬-->
</servlet-mapping>
</web-app>
测试运行OK。
但是遇见一个问题，文件上传到哪去了？并没有在旁边IDEA目录下，然后我就用软件Everything找，找到了，但发现位置和自己预期（项目打包的位置）的不一样。然后经过一些输出测试，才搞明白web项目中的路径（结合JavaWeb进行思考）。
1206
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
