16.1、Java实现文件上传
1.准备工作
对于文件上传,浏览器在上传的过程中是将文件以流的形式提交到服务器端的。
一般采用Apache的开源工具common-fileupload这个文件上传组件。
common-fileupload是依赖于common-io这个包的,所以还需要下载这俩个包。
<!-- https://mvnrepository.com/artifact/commons-fileupload/commons-fileupload -->
<dependency>
<groupId>commons-fileupload</groupId>
<artifactId>commons-fileupload</artifactId>
<version>1.4</version>
</dependency>
<!-- https://mvnrepository.com/artifact/commons-io/commons-io -->
<dependency>
<groupId>commons-io</groupId>
<artifactId>commons-io</artifactId>
<version>2.11.0</version>
</dependency>
2.使用类介绍
【文件上传注意事项】(调优)
①为保证服务器的安全,上传的文件应放在外界无法访问的目录下,如WEN-INF。
②为防止同名文件产生覆盖现象,要为文件指定一个唯一的文件名。
txt、txt -时间戳 -uuid -md5 -位运算
③要对上传文件的大小进行限制。
④限制上传文件的类型,收到文件时,判断文件名十分合法。
3.需要用到的类详解
ServletFileUpload负责处理上传的文件数据,并将表单中的每个输入项封装成一个FileItem对象,在使用ServletFileUpload对象解析请求时需要DiskFileItemFactory对象。
所以,我们需要在进行解析工作前构造好DiskFileItemFactory对象,通过ServletFileItem对象的构造方法或setFileItemFactory()设置ServletFileUpload对象的fileItemFactory属性。
4.Fileltem类
HTML页面中必须要有name:<**input type="file" name="filename"**>
表单如果包含一个文件上传输入项的话, 这个表单的enctype属性就必须设置为multipart/form-data
常用方法介绍:
//isFormFile方法用于判断FileItem类对象封装的数据是一个普通文本表单
//还是一个文件表单,如果时普通表单字段则返回true,否则返回false
boolean isField();
//getFieldName方法用于返回表单标签name属性的值
String getFieldName();
//getString方法用于将FileItem对象中保存的数据流内容以一个字符串返回
String getString();
//getName方法用于获得文件上传字段中的文件名。
String getName();
//以流的形式返回上传文件的数据内容。
InputStream getInputStream();
//delete方法用来清空FileItem类对象中存放的主体内容
//如果主体内容被保存在临时文件中,delete方法将删除该临时文件
void delete();
5.ServletFileUpload类
ServletFileUpload负责处理上传的文件数据,并将表单中的每个输入项封装成一个FileItem对象中,使用其**parseRequest(HttpServletRequest)**方法可以将通过表单中每一个HTML标签提交的数据封装成一个FileItem对象,然后以List列表的形式返回。使用该方法处理上传文件简单易用。
public class FileServlet_ 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.mkdirs();//创建这个目录及父目录
}
//三、缓存, 临时文件
// 临时路径,如果上传的文件超过预期的大小,
// 我们将它存放到一个临时目录中,过几天自动删除,或者提醒用户转存为永久
String tmpPath = this.getServletContext().getRealPath("/WEB-INF/tmp");
File tmpFile = new File(tmpPath);
if (!tmpFile.exists()) {
tmpFile.mkdirs();//创建这个目录及父目录
}
//四、处理上传的文件
// 一般需要通过流来获取,我们可以通过request.getInputstream(),原生态文件上传流获取,十分麻烦
// 但是我们都建议使用Apache的文件上传组件来实现,common-fileupload,它需要依赖于common-io组件;
/*ServletFileUpload负责处理上传的文件数据,并将表单中的每个输入项封装成一个FileItem对象,
在使用ServletFileUpload对象解析请求时需要DiskFileItemFactory对象。
所以,我们需要在进行解析工作前构造好DiskFileItemFactory对象,
通过ServletFileItem对象的构造方法或setFileItemFactory()
设置ServletFileUpload对象的fileItemFactory属性。*/
//1.创建DiskFileItemFactory对象, 处理文件上传路径和大小
DiskFileItemFactory factory = getDisFileItemFactory(tmpFile);
//2.获取ServletFileUpload
ServletFileUpload upload = getServletFileUpload(factory);
//3.处理上传文件
String msg = uploadParseRequest(upload, req, uploadPath);
//request请求转发消息
req.setAttribute("msg", msg);
req.getRequestDispatcher("info.jsp").forward(req, resp);
}
//1.创建DiskFileItemFactory对象, 处理文件上传路径和大小
public static DiskFileItemFactory getDisFileItemFactory(File tmpFile) {
//创建DiskFileItemFactory对象, 处理文件上传路径和大小
DiskFileItemFactory factory = new DiskFileItemFactory();
//通过这个工厂设置一个缓冲区,当上传的文件大小大于缓冲区的时候,将它放到临时文件中;
factory.setSizeThreshold(1024 * 1024);//缓冲区大小为1M
factory.setRepository(tmpFile);//临时的保存目录, 需要一个File
return factory;
}
//2.获取ServletFileUpload
public static ServletFileUpload getServletFileUpload(DiskFileItemFactory factory) {
//获取ServletFileUpload
ServletFileUpload upload = new ServletFileUpload(factory);
//监听文件上传进度
upload.setProgressListener(new ProgressListener() {
@Override
public void update(long pBytesRead, long lpContentLenght, int i) {
//pBytesRead:已读取到的文件大小
//pContentLenght:文件大小
System.out.println("总大小:" + lpContentLenght + "已上传:" + pBytesRead);
}
});
//处理乱码问题
upload.setHeaderEncoding("UTF-8");
//设置单个文件的最大值
upload.setFileSizeMax(1024 * 1024 * 10);
//设置总共能够上传文件的大小
//1024 = 1kb * 1024 = 1M * 10 = 10M
upload.setSizeMax(1024 * 1024 * 10);
return upload;
}
//3.处理上传文件
public static String uploadParseRequest(ServletFileUpload upload, HttpServletRequest req, String uploadPath) throws IOException {
//把前端请求解析, 封装成一个FileItem对象, 需要从ServletFileUpload对象中获取
List<FileItem> fileItems = null;
String msg=null;
try {
fileItems = upload.parseRequest(req);//获取表单提交的所有东西
} catch (FileUploadException e) {
e.printStackTrace();
}
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 uploadFieldName = fileItem.getFieldName();
System.out.println("上传的文件名: " + uploadFieldName);
//trim()去掉收尾空格
if (uploadFieldName.trim().equals("") || uploadFieldName == null) {
continue;//说明文件有问题不能上传,直接跳到下一个
}
//获取上传的文件名 /image/girl/piaolinag.pang
String fileName = uploadFieldName.substring(uploadFieldName.lastIndexOf("/") + 1);
//获取文件后缀名
String fileExtName = uploadFieldName.substring(uploadFieldName.lastIndexOf(".") + 1);
/*
* 如果文件的后缀名 fileExtName不是我们所需要的
* 就直接return, 不处理, 告诉客户文件类型不对。
* */
System.out.println("文件信息 文件名: " + fileName + "---文件类型" + fileExtName);
//可以使用UUID(唯一识别的通用码), 保证文件名唯一;
//UUID.randomUUID(), 随机生成一个唯一识别的通用码
String uuidPath = UUID.randomUUID().toString();
//网络传输中的东西, 都需要序列化
//POJO, 实体类, 如果想要在多个电脑上运行, 传输===>需要把对象序列化
// implements Serializable : 标记接口, JVM---> Java栈 本地方法栈(调用C++)
//----------------处理文件完毕---------------------
//存到哪? uploadPath
//文件的真实存在的路径 realPath
String realPath = uuidPath + "/" + uuidPath;
//给每个文件创建一个对应的文件夹
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;
//如果>0说明还存在数据
while ((len = inputStream.read(buffer)) > 0) {
fos.write(buffer, 0, len);
}
//关闭流
fos.close();
inputStream.close();
msg = "文件上传成功!";
fileItem.delete();//上传这个删除临时文件
}
}
return msg;
}
}