文件上传
文件上传
1、搭建项目
2、导包
文件在网络上都是使用IO的方式,即流的方式进行的传输,而我们要实现的文件上传功能可以直接使用apache的组件commons-fileupload(针对文件上传的工具类包),这个jar包又依赖commons-io包(封装了大量的IO操作的工具类),所以在实现文件上传功能的时候我们需要导入这两个依赖
<dependency>
<groupId>commons-io</groupId>
<artifactId>commons-io</artifactId>
<version>2.9.0</version>
</dependency>
<dependency>
<groupId>commons-fileupload</groupId>
<artifactId>commons-fileupload</artifactId>
<version>1.4</version>
</dependency>
3、使用类介绍
【文件上传的注意事项】
- .为保证服务器安全,上传文件应该放在外界无法直接访问的目录下,比如放于 WEB-INF目录下。
- 为防止文件覆盖的现象发生,要为上传文件产生一个唯一的文件名:使用时间戳/UUID/MD5等手段实现
- 限制上传文件的最大值:因为服务器上硬盘资源很贵,不能让用户随意的使用
- 限制文件上传类型,在收到上传文件名时,判断后缀名是否合法。比如这个文件夹只用来存储图片,那你就不能上传一个.mp4的文件
文件上传在我们生活中很常见,所以一定要掌握
【需要用到的类详解】
- ServletFileUpload:在后端获取文件上传的文件数据,并将上传文件数据的表单中的每个输入项都封装为一个FileItem对象
- FileItem
- DiskFileItemFactory:使用ServletFileUpload解析前端表单传过来的文件数据时需要使用到DiskFileItemFactory对象,所以在获取ServletFileUpload对象之前我们需要先获取DiskFileItemFactory对
- fileItemFactory属性:ServletFileUpload对象的一个属性
ServletFileUpload负责处理上传的文件数据,并将表单中每个输入项封装成一个FileItem对象, 在使用ServletFileUpload对象解析请求时需要DiskFileItemFactory对象。所以,我们需要在进行解析工作前构造好DiskFileItemFactory对象,通过ServletFileUpload对象的构造方法或setFileItemFactory()方法设置ServletFileUpload对象的fileItemFactory属性。
FileItem类
【常用方法介绍】
//isFormField方法用于判断FileItem类对象封装的数据是一个普通文本表单
//还是一个文件表单,如果是普通表单字段则返回true,否则返回false
boolean isFormField();//即:只要是上传的文件,返回的就是false
//getFieldName方法用于返回表单标签name属性的值。
String getFieldName();//获取这个input的name属性值
//getString方法用于将FileItem对象中保存的数据流内容以一个字符串返回
String getString();//用字符串存储文件的数据流
//getName方法用于获得文件上传字段中的文件名
String getName();
//以流的形式返回上传文件的数据内容。
InputStream getInputStream()
//delete方法用来清空FileItem类对象中存放的主体内容
//如果主体内容被保存在临时文件中,delete方法将删除该临时文件。
void delete();
ServletFileUpload 类
ServletFileUpload负责处理上传的文件数据,并将表单中每个输入项封装成一个FileItem对象中 . 使用其parseRequest(HttpServletRequest) 方法可以将通过表单中每一个HTML标签提交的数据封装成一个FileItem对象,然后以List列表的形式返回,使用该方法处理上传文件简单易用
编写servlet
文件上传JSP
<%@ page contentType="text/html; charset=UTF-8" pageEncoding="UTF-8" %>
<!DOCTYPE html>
<html>
<head>
<title>JSP - Hello World</title>
</head>
<body>
<h1>文件上传</h1>
<br/>
<%--通过表单上传文件--%>
<%--注意:文件一般比较大,所以上传文件都是使用post方式提交
get方式只能提交4-5kb的数据,而post没有限制
${pageContext.request.contextPath}:获取到webapp路径--%>
<form action="FileUploadServlet" method="post" enctype="multipart/form-data">
<p>上传用户:<input type="text" name="username"></p>
<p><input type="file" name="file1"></p>
<p><input type="file" name="file2"></p>
<p><input type="submit" value="点击上传"> | <input type="reset" value="重置"></p>
</form>
</body>
</html>
显示文件上传成功的跳转JSP页面
<%--
Created by IntelliJ IDEA.
User: yt
Date: 2021/7/14
Time: 14:04
To change this template use File | Settings | File Templates.
--%>
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>Title</title>
</head>
<body>
${msg}
</body>
</html>
servlet编写
package com.yt.servlet; /**
* ClassName:${NAME}
* Package:${PACKAGE_NAME}
* Description:
*
* @date:2021/7/14 13:16
* @author:yt
*/
import org.apache.commons.fileupload.FileItem;
import org.apache.commons.fileupload.FileUploadException;
import org.apache.commons.fileupload.disk.DiskFileItemFactory;
import org.apache.commons.fileupload.servlet.ServletFileUpload;
import javax.servlet.*;
import javax.servlet.http.*;
import javax.servlet.annotation.*;
import java.io.*;
import java.util.List;
import java.util.UUID;
@WebServlet(name = "FileUploadServlet", value = "/FileUploadServlet")
public class FileUploadServlet extends HttpServlet {
@Override
protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
doPost(request,response);
}
@Override
protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
//1、判断提交的表单是普通表单还是带上传文件的表单
if(!ServletFileUpload.isMultipartContent(request)){
//ServletFileUpload.isMultipartContent(req)用于判断这份表单提交的数据是不是包含文件
//结束方法调用,说明这是一个普通的表单,没有包含文件的<input>,直接返回
return;
}
//2、文件存储空间创建:创建上传文件的路径,建议在WEB-INF路径下,安全,用户无法直接访问上传的文件
//获取/WEB-INF下的/upload路径
String uploadPath = this.getServletContext().getRealPath("/WEB-INF/upload");
//创建一个文件对象
File uploadFile = new File(uploadPath);
if (!uploadFile.exists()){
//如果这个路径不存在,就创建这份路径
uploadFile.mkdir();
}
//3、缓存空间创建:临时路径,假如文件超过了预期的大小,我们就把他放在一个临时文件中,过几天自动删除,或者提醒用户转为永久
String tmpPath = this.getServletContext().getRealPath("WEB-INF/tmp");
File tmpFile = new File(tmpPath);
if (!tmpFile.exists()) {
tmpFile.mkdir();
}
DiskFileItemFactory factory = getDiskFileItemFactory(tmpFile);
ServletFileUpload upload = getServletFileUpload(factory);
String msg = uploadParasRequest(upload, request, uploadPath);
System.out.println("===============uploadParasRequest================");
request.setAttribute("msg",msg);
request.getRequestDispatcher("info.jsp").forward(request,response);
}
public DiskFileItemFactory getDiskFileItemFactory(File file){
//直接使用我们所学的流的概念来上传文件很低效,且我们的开发成倍很高,所以我们可以直接使用开源的包,比如Apache的文件上传组件来实现
// ,common-fileupload,他需要依赖于commons-io组件
/*使用规则:
①ServletFileUpload负责处理上传的文件数据,并将表单中每个输入项封装成一个FileItem对象, 在使用ServletFileUpload
对象解析请求时需要DiskFileItemFactory对象。
②我们需要在进行解析工作前构造好DiskFileItemFactory对象,通过ServletFileUpload对象的构造方法或setFileItemFactory()
方法设置ServletFileUpload对象的fileItemFactory属性。*/
//1、创建DiskFileItemFactory对象,获取磁盘对象
DiskFileItemFactory factory = new DiskFileItemFactory(1024*1024,file);
return factory;
}
public ServletFileUpload getServletFileUpload(DiskFileItemFactory factory){
//2、创建ServletFileUpload对象,获取上传文件的解析对象
//DiskFileItemFactory对象作为参数传入ServletFileUpload的构造中
ServletFileUpload upload = new ServletFileUpload(factory);
upload.setHeaderEncoding("UTF-8");
upload.setFileSizeMax(1024*1024*10);
upload.setSizeMax(1024*1024*10);
return upload;
}
public String uploadParasRequest(ServletFileUpload upload,HttpServletRequest req,String uploadPath) throws UnsupportedEncodingException {
String msg = null;
//3、正式解析表单中上传的文件,并将其存储在服务器上指定的位置
try {
List<FileItem> fileItems = upload.parseRequest(req);
//使用文件解析对象的parseRequest()(解析request),这个方法就会将req中的表单项按照一个<input>一个FileItem对象来进行封装
//parseRequest(HttpServletRequest) 方法可以将通过表单中每一个HTML标签提交的数据封装成一个FileItem对象,然后以List列表的形式返回
for (FileItem fileItem : fileItems) {//遍历,找到表单中每一个文件对应的<input>上传的文件数据
if (fileItem.isFormField()) { //这个<input>中的数据不是文件
String name = fileItem.getFieldName();//获取非文件<input>的name属性
String value = fileItem.getString("utf-8");//获取非文件<input>的value属性
System.out.println(name + ":" + value);//输出显示
}else { //这个<input>中的数据是文件
//===============1、处理文件:获取文上传的文件的文件名+文件类型===============
String uploadFileName = fileItem.getName();//获取这个文件的名称
System.out.println("上传的文件名:" + uploadFileName);
if (uploadFileName.trim().equals("") || uploadFileName == null) {//如果文件上传的名字为空
continue;//跳过本次循环继续下一个List元素的遍历
}
//精妙点:获取文件的名称
//获得上传的文件名 /images/girl/paojie.jpg
String fileName = uploadFileName.substring(uploadFileName.lastIndexOf("/") + 1);//获取最后一个/后面的所有字符串,获取结果 = 文件名.文件类型
String fileExtName = uploadFileName.substring(uploadFileName.lastIndexOf(".") + 1);//最后一个"."后面的字符串,获取结果 = 文件类型
System.out.println("文件信息[文件名:" + fileName + "----文件类型" + fileExtName+"]");//打印输出对文件进行查看
//=====================2、处理文件存放地址:/WEB-INF/upload + 文件上传时生成的唯一的UUID===============
//可以使用UUID(可以唯一识别的通用码),保证文件名唯一;UUID.randomUUID(),随机生成一个唯一的识别通用码;
String uuidPath = UUID.randomUUID().toString() ;
//存到哪?uploadPath
//文件真正要存储在服务器上的存在的路径realPath = /WEB-INF/upload + 文件上传时生成的唯一的UUID
String realPath = uploadPath + "/" + uuidPath;
//给每个文件创建一个对应的文件夹
File realPathFile = new File(realPath);
if (!realPathFile.exists()) {
realPathFile.mkdir(); //一般这个文件存储的文件夹都是不存在的,所以一定会为我们的上传文件创建一个新的文件夹来存储它
}
//============================3、文件传输:配合工具类fileName+文件IO操作就可以实现文件存储在服务器上============================
InputStream in = null;//每次遍历到的都是一个独立的、完整的文件对应的fileItem对象,所以我们只需要从它里面获取数据流再存储下来即可
try {
in = fileItem.getInputStream();
} catch (IOException e) {
e.printStackTrace();
}
//创建一个文件输入流
FileOutputStream fos = new FileOutputStream(realPath + "/" + fileName);//获取文件输入流
//文件名还是和原来保持不变,只是文件存储的上一级文件夹的名称是我们通过/WEB-INF/upload + 文件上传时生成的唯一的UUID生成的不重复的
byte[] buffer = new byte[1024];//创建一个缓冲区
int len = 0;//定义一个变量存储一次读到的实际数据量
while ((len = in.read(buffer)) > 0) {//通过判断实际读取的数据量是不是>0就可以判断文件是不是读完了
fos.write(buffer, 0, len);//将文件流写到这个文件中 ——“realPath + "/" + fileName”
}
//关闭流
in.close();
fos.close();
msg="文件上传成功!";
fileItem.delete();//上传成功,清除临时文件
}
}
} catch (FileUploadException e) {
e.printStackTrace();
} catch (FileNotFoundException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
}
return msg;
}
}