java实现文件的上传
一、准备工作
对于文件上传,浏览器在上传的过程中是将文件以流的形式提交到服务器端的。
一般采用Apache的开源工具common-fileupload这个文件上传组件。
common-fileupload是依赖于common-io这个包的,所以还需要下载这个包。
我们下载最新的jar包:
- common-io : https://mvnrepository.com/artifact/commons-io/commons-io
- commons-fileupload : https://mvnrepository.com/artifact/commons-fileupload/commons-fileupload
将其作为项目的jar包:
我们还可以使用maven构建,如下图:
二、实现文件的上传
2.1、编写上传与接收消息页面
代码如下:
-
上传页面的upload.jsp
<%@ page language="java" pageEncoding="UTF-8"%> <!DOCTYPE HTML> <html> <head> <title>文件上传</title> </head> <body> <form action="${pageContext.request.contextPath}/UploadHandleServlet" enctype="multipart/form-data" method="post"> 上传用户:<input type="text" name="username"><br/> 上传文件1:<input type="file" name="file1"><br/> 上传文件2:<input type="file" name="file2"><br/> <input type="submit" value="提交"> </form> </body> </html>
-
接收消息页面的msg.jsp
<%@ page language="java" pageEncoding="UTF-8"%> <!DOCTYPE HTML> <html> <head> <title>消息提示</title> </head> <body> ${msg} </body> </html>
2.2、文件上传注意事项
-
为保证服务器的安全,上传的文件应放在外界无法访问的目录下,如WEN-INF。
-
为防止同名文件产生覆盖现象,要为文件指定一个唯一的文件名。
-
要对上传文件的大小进行限制。
-
限制上传文件的类型,收到文件时,判断文件名是否合法。
-
为防止一个目录下面出现太多文件,可以使用hash算法打散存储。
2.3、需要使用的类与方法详细介绍
2.3.1、常用类介绍
-
ServletFileUpload负责处理上传的文件数据,并将表单中的每个输入项封装成一个FileItem对象,在使用ServletFileUpload对象解析请求时需要DiskFileItemFactory对象。所以,我们需要在进行解析工作前构造好DiskFileItemFactory对象,通过ServletFileItem对象的构造方法或setFileItemFactory()设置ServletFileUpload对象的fileItemFactory属性。
-
FileItem类
在HTML页面中必须要有name:
-
上传文件:
表单中如果包含一个文件上传项的话,这个表单的entype属性必须设置为multipart/form-data,浏览器的表单类型为multipart/form-data的话,服务器想获取数据就要通过流。
2.3.2、常用方法介绍
-
isFormFile方法用于判断FileItem类对象封装的数据是一个普通文本表单//还是一个文件表单,如果时普通表单字段则返回true,否则返回false
-
booleanisField();//getFieldName方法用于返回表单标签name属性的值
-
String getFieldName();//getString方法用于将FileItem对象中保存的数据流内容以一个字符串返回
-
String getString();//getName方法用于获得文件上传字段中的文件名。
-
String getName();//以流的形式返回上传文件的数据内容。
-
InputStream getInputStream();//delete方法用来清空FileItem类对象中存放的主体内容//如果主体内容被保存在临时文件中,delete方法将删除该临时文件
-
ServletFileUpload负责处理上传的文件数据,并将表单中的每个输入项封装成一个FileItem对象中,使用其parseRequest(HttpServletRequest)方法可以将通过表单中每一个HTML标签提交的数据封装成一个FileItem对象,然后以List列表的形式返回。使用该方法处理上传文件简单易用。
2.4、源代码
2.4.1、我们可以将常用方法封装在工具类中
package Utils;
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 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 uploadUtil {
public static DiskFileItemFactory getFactory(File file) {
DiskFileItemFactory factory = new DiskFileItemFactory();
//设置一个缓冲区,若文件大小超过缓冲区,放到临时路径
factory.setSizeThreshold(1024 * 1024 * 5);
factory.setRepository(file);
return factory;
}
public static ServletFileUpload getServletFileUpload(DiskFileItemFactory factory) {
ServletFileUpload upload = new ServletFileUpload(factory);
//监听文件上传进度
upload.setProgressListener (new ProgressListener() {
@Override
public void update(long pBytesRead, long pContentlenth, int pItems) {
//pContentlenth:文件大小
//pBytesRead:已读取文件大小
System.out.println("总大小:" + pContentlenth + " 已上传:" + pBytesRead);
}
});
//防止乱码
upload.setHeaderEncoding("UTF-8");
//设置上传单个文件最大值(1 M)
upload.setFileSizeMax(1024 * 1024);
//设置总共可以上传文件的大小
upload.setSizeMax(1024 * 1024 * 10);
return upload;
}
public static String upLoadParseRequest(ServletFileUpload upload, javax.servlet.http.HttpServletRequest request, String uploadPath) throws IOException, FileUploadException {
String msg = "";
//使用ServletFileUpload解析器解析上传数据,解析结果返回的是一个List<FileItem>集合,每一个FileItem对应一个Form表单的输入项
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 fileExtName = uploadFileName.substring(uploadFileName.lastIndexOf(".") + 1);
//文件后缀不符合,直接return,不处理
System.out.println("文件信息[ 文件名:" + fileName + "----文件类型:" + fileExtName + "]");
//=====================================文件处理完毕========================================
//=====================================存放地址处理========================================
//得到文件保存的名称
String saveFilename = makeFileName(fileName);
//得到文件的保存目录
String realPath = makePath(saveFilename, uploadPath);
//====================================存放地址处理完毕=====================================
//获得文件上传流
InputStream inputStream = fileItem.getInputStream();
//创建文件输出流
FileOutputStream fos = new FileOutputStream(realPath + "/" + fileName);
//创建缓冲区
byte[] buffer = new byte[1024 * 8];
//判断是否读取完毕
int len = 0;
//如果大于0,说明还存在数据
while ((len = inputStream.read(buffer)) > 0) {
fos.write(buffer, 0, len);
}
fos.close();
inputStream.close();
msg = "文件上传成功";
//清除临时文件
//fileItem.delete();
}
}
return msg;
}
/**
* @Method: makeFileName
* @Description: 生成上传文件的文件名,文件名以:uuid+"_"+文件的原始名称
* @param filename 文件的原始名称
* @return uuid+"_"+文件的原始名称
*/
public static String makeFileName(String filename){ //2.jpg
//为防止文件覆盖的现象发生,要为上传文件产生一个唯一的文件名
return UUID.randomUUID().toString() + "_" + filename;
}
/**
* 为防止一个目录下面出现太多文件,要使用hash算法打散存储
* @Method: makePath
* @param filename 文件名,要根据文件名生成存储目录
* @param savePath 文件存储路径
* @return 新的存储目录
*/
public static String makePath(String filename,String savePath){
//得到文件名的hashCode的值,得到的就是filename这个字符串对象在内存中的地址
int hashcode = filename.hashCode();
int dir1 = hashcode&0xf; //0--15
int dir2 = (hashcode&0xf0)>>4; //0-15
//构造新的保存目录
String dir = savePath + "\\" + dir1 + "\\" + dir2; //upload\2\3 upload\3\5
//File既可以代表文件也可以代表目录
File file = new File(dir);
//如果目录不存在
if(!file.exists()){
//创建目录
file.mkdirs();
}
return dir;
}
}
2.4.2、编写servlet
package servlet;
import org.apache.commons.fileupload.FileUploadException;
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.IOException;
import static Utils.uploadUtil.*;
@javax.servlet.annotation.WebServlet("/UploadHandleServlet")
public class UploadHandleServlet extends HttpServlet {
@Override
protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
try {
//判断上传的表单是否带文件
if (!ServletFileUpload.isMultipartContent(request)) {
//如果是普通文本表单,直接返回
return ;
}
//带文件的表单
//创建上传文件的保存路径,建议在WEB-INF下,安全
String uploadPath = this.getServletContext().getRealPath("/WEB-INF/upload");
File file1 = new File(uploadPath);
if (!file1.exists()) {
file1.mkdir();
}
//临时路径,文件超出预期大小,放这
String tempPath = this.getServletContext().getRealPath("/WEB-INF/temp");
System.out.println(tempPath);
File file = new File(tempPath);
if (!file.exists()) {
file.mkdir();
}
//1.创建DiskFileItemFactory对象,处理文件大小路径等
DiskFileItemFactory factory = getFactory(file);
//2.获取ServletFileUpload
ServletFileUpload upload = getServletFileUpload(factory);
//3.处理上传的文件
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 doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
this.doPost(request, response);
}
}
2.5、效果展示
再来查看WEB-INF文件下