五、文件上传
1.准备工作
idea建立空项目,选择jdk和对应版本,新建module
**创建web项目:**普通Java项目添加web应用;maven通过模板创建,通过maven创建普通;再去增加一个web框架支持
Javaweb之前在HttpServletResponse处讲了下载文件,此处上传文件相反操作
对于文件上传,浏览器在上传的过程中是将文件以流的形式提交到服务器端的。
一般选择采用apache的开源工具common-fileupload这个文件上传组件
common.fileupload是依赖于common.io这个包的,所以还需要下载这个包
https://mvnrepository.com/artifact/commons-io/commons-io/2.8.0
https://mvnrepository.com/artifact/commons-fileupload/commons-fileupload/1.4
把jar包导入项目目录
【知识点】2020版IDEA创建项目javaEE没有web选项的解决办法
1.正常创建Java项目
然后点击弹出来的Java EE下的 web applocation 就可以了。
【知识点】把jar包导入项目目录
方法一:
1.创建lib包
2.把jar包复制进这个lib下
方法二:
第五步选择你需要的文件下的lib目录
第六步:
2.使用类介绍
【文件上传注意事项】
1.为了保证服务器安全,上传文件应该放在外界无法直接访问的目录下,比如放在WEB-INF目录下
2.为了防止文件覆盖的现象发生,要上传的文件需要产生一个唯一的文件名(使用UUID、时间戳、MD5、加密算法)
3.要限制上传文件的在最大值
4.可以限制上传文件的类型,在收到上传文件名时,判断后缀名是否合法
【需要使用到的类详解】
- ”ServletFileUpload“负责处理上传的文件数据,并将表单中每个输入项封装成一个FileItem对象
- 使用ServletFileUpload对象解析请求是需要”DiskFileItemFactory对象“,先构造DiskFileItemFactory对象
- 通过ServletFileUpload对象的构造方法 或者setFileItemFactory()方法,设置”servletFileUpload对象“的fileItemFactory属性
【前端页面】
在HTML页面input必须有name<input type="file"name=“filename”>
表单如果包含一个文件上传输入项的话,这个表单的enctype属性就必须设置为multipart/form-data
<form action="${pageContext.request.contextPath}/upload.do" enctype="multipart/form-data" method="post">
<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">|<input type="reset"></p>
</form>
浏览器表单的类型如果为multipart/form-data,在服务器端想获取数据就要通过流。
【常用方法介绍】
//isFormFiled方法用于判断FileItem类对象封装的数据是一个普通文本表单
//还是一个文件表单,如果是普通表单字段则返回true,否则返回false
boolean isFormField();
//getFieldName方法用于返回表单标签name属性的值
String getFiledName();
//getString方法用于将FileItem对象保存的数据流内容以一个字符串返回
String getName();
//getName方法用于获得文件上传字段中的文件名
String getName();
//以流的形式返回上传文件的数据内容
InputStream getInputStream();
//delete方法用来清空FileItem类对象中存放的主体内容
//如果主体内容保存在临时文件中,delete方法将删除该临时文件
void delete();
ServletFileUpload类
ServletFileUpload负责处理上传的文件数据,并将表单中每个输入项封装成为一个FileItem对象中,
使用其parseRequest(HttpServletRequest)方法,可以将通过表单中每个HTML标签<input>
提交的数据封装成一个FileItem对象,
然后以List列表的形式返回。使用该方法处理上传文件简单易用。
【易错】普通javaweb项目新建servlet需要导入servlet-api的包,再右击new servlet
在一个方法中书写文件上传
package com.kuang.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.*;
import javax.servlet.http.*;
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 Servlet extends HttpServlet {
@Override
protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
//************************准备工作****************************************
//判断表单:普通表单还是带文件的表单
if (!ServletFileUpload.isMultipartContent(request)){
return;//终止方法运行,说明这是一个普通的表单,直接返回
}
/*<----本“文件上传”设计中,为用户上传的每一个文件新建一个文件夹,防止用户上传文件名字有冲突---->
创建上传文件的保存路径,建议在WEB-INF路径下,安全,用户无法直接访问上传的文件*/
//创建文件保存总路径
String uploadPath = this.getServletContext().getRealPath("/WEB-INF/upload");
File uploadFile = new File(uploadPath);
if (!uploadFile.exists()){
uploadFile.mkdir();//创建这个目录
}
/*创建文件保存缓存路径,存放临时文件;
假如文件超过了预期的大小,我们就将其放到这个临时文件中,过几天自动删除,或者提醒用户转存为永久*/
//创建文件保存临时文件路径
String tmpPath = this.getServletContext().getRealPath("/WEB-INF/tmp");
File tmpFile= new File( tmpPath );
if (!tmpFile.exists()){
tmpFile.mkdir();//创建这个临时目录
}
//************************文件上传****************************************
/*
处理上传的文件,一般需要通过流来获取,我们可以使用request。getInputStream(),原生态的文件上传流获取,十分麻烦
但是我们都建议使用Apache的文件上传组件来实现,它需要依赖于commons-io组件
*/
/*思路:
1.”ServletFileUpload“负责处理上传的文件数据,并将表单中每个输入项封装成一个FileItem对象
2.使用ServletFileUpload对象解析请求是需要”DiskFileItemFactory对象“,先构造DiskFileItemFactory对象
3.通过ServletFileUpload对象的构造方法 或者setFileItemFactory()方法,设置”servletFileUpload对象“的fileItemFactory属性
*/
try {
//*****************************************************************
//1.创建DiskFileItemFactory对象,用于处理文件上传路径或者大小限制
DiskFileItemFactory factory=new DiskFileItemFactory();
//通过工厂设置一个缓冲区,当上传的文件大于这个缓冲区的时候,将他放到临时文件中
factory.setSizeThreshold(1024*1024);//缓冲区大小为1M
factory.setRepository(tmpFile);//临时目录的保存目录,需要一个File
//*****************************************************************
//2.获取ServletFileUpload
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");
//设置单个文件的最大值
upload.setFileSizeMax(1024*1024*10);
//设置总共能够上传的文件的大小
//1024 = 1kb * 1024 = 1M * 10 = 10M
upload.setSizeMax(1024*1024*10);
//*****************************************************************
//3.处理上传文件
//把前端请求解析,封装成一个FileItem对象,需要ServletFileUpload对象中获取
List<FileItem> fileItems = upload.parseRequest(request);
//fileItem 每一个表单对象
for(FileItem fileItem:fileItems){
//判断上传的input是普通项还是文件上传项
if(fileItem.isFormField()){ //普通input
//getFiledName指的是前端表单控制件的name;
String name = fileItem.getFieldName();
String value = fileItem.getString("UTF-8");//处理乱码
System.out.println(name+":"+value);
}else{ //文件上传input
//文件
//======处理文件=======
//=========1)拿到上传的文件路径 如:/images/girl/paojie.png==========
String uploadFileName = fileItem.getName();
//存在路径不合法的情况
if (uploadFileName.trim().equals("")||uploadFileName==null){
continue;
}
//获得上传的文件名
String fileName=uploadFileName.substring(uploadFileName.lastIndexOf("/")+1);
//获得文件的后缀名
String fileExtName=uploadFileName.substring(uploadFileName.lastIndexOf(".")+1);
/*
如果文件后缀名fileExtName不是我们所需要的,
就直接return,不处理,告诉用户文件类型不对
*/
//========2)使用UUID(唯一识别的通用码),办证文件名唯一========
//UUID.randomUUID(),随机生成一个唯一识别的通用码,本设计中用其为每个上传的文件生成一个包(文件夹)
String uuidPath= UUID.randomUUID().toString();
//========3)生成文件存放路径========
String realPath=uploadPath+"/"+uuidPath;
//给每个文件都创造一个对应的文件夹
File realPathFile=new File(realPath);
if (!realPathFile.exists()){
realPathFile.mkdir();
}
//========4)文件传输========
//1.获取文件上传的流
InputStream inputStream=fileItem.getInputStream();
//2.创建一个文件输出流
//realPath=真实的文件夹
//差了一个文件:加上输出文件的名字
FileOutputStream fileOutputStream=new FileOutputStream(realPath+"/"+fileName);
//3.创建一个缓冲区
byte[] buffer=new byte[1024*1024];
//4.读取,判断是否读取完毕
int len=0;
//如果大于0说明还存在数据
while((len=inputStream.read(buffer))>0){
fileOutputStream.write(buffer,0,len);
}
//5.关闭流
fileOutputStream.close();
inputStream.close();
String msg="文件上传成功"; //向前端输出信息
fileItem.delete(); //上传成功,清除缓存
}
}
} catch (FileUploadException e) {
e.printStackTrace();
}
}
@Override
protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
doGet(request,response);
}
}
将各个步骤封装成函数,简化主函数,完整代码【重点】
package com.kuang.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.*;
import javax.servlet.http.*;
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 Servlet2 extends HttpServlet {
@Override
protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
//************************准备工作****************************************
//判断表单:普通表单还是带文件的表单
if (!ServletFileUpload.isMultipartContent(request)){
return;//终止方法运行,说明这是一个普通的表单,直接返回
}
/*<----本“文件上传”设计中,为用户上传的每一个文件新建一个文件夹,防止用户上传文件名字有冲突---->
创建上传文件的保存路径,建议在WEB-INF路径下,安全,用户无法直接访问上传的文件*/
//创建文件保存总路径
String uploadPath = this.getServletContext().getRealPath("/WEB-INF/upload");
File uploadFile = new File(uploadPath);
if (!uploadFile.exists()){
uploadFile.mkdir();//创建这个目录
}
/*创建文件保存缓存路径,存放临时文件;
假如文件超过了预期的大小,我们就将其放到这个临时文件中,过几天自动删除,或者提醒用户转存为永久*/
//创建文件保存临时文件路径
String tmpPath = this.getServletContext().getRealPath("/WEB-INF/tmp");
File tmpFile= new File( tmpPath );
if (!tmpFile.exists()){
tmpFile.mkdir();//创建这个临时目录
}
//************************处理文件上传****************************************
/*
处理上传的文件,一般需要通过流来获取,我们可以使用request。getInputStream(),原生态的文件上传流获取,十分麻烦
但是我们都建议使用Apache的文件上传组件来实现,它需要依赖于commons-io组件
*/
/*思路:
1.”ServletFileUpload“负责处理上传的文件数据,并将表单中每个输入项封装成一个FileItem对象
2.使用ServletFileUpload对象解析请求是需要”DiskFileItemFactory对象“,先构造DiskFileItemFactory对象
3.通过ServletFileUpload对象的构造方法 或者setFileItemFactory()方法,设置”servletFileUpload对象“的fileItemFactory属性
*/
try {
//1.创建DiskFileItemFactory对象,用于处理文件上传路径或者大小限制
DiskFileItemFactory factory = getDiskFileItemFactory(tmpFile);
//2.获取ServletFileUpload
ServletFileUpload upload = getServletFileUpload(factory);
//3.处理上传文件
//把前端请求解析,封装成一个FileItem对象,需要ServletFileUpload对象中获取
String msg = uploadParseRequest(upload, request, uploadPath);
//4.Servlet请求转发消息
System.out.println(msg);
if(msg.equals( "文件上传成功!")) {
// Servlet请求转发消息
request.setAttribute("msg",msg);
request.getRequestDispatcher("info.jsp").forward(request, response);
}else {
msg ="请上传文件";
request.setAttribute("msg",msg);
request.getRequestDispatcher("info.jsp").forward(request, response);
}
}catch (FileUploadException e) {
e.printStackTrace();
}
}
@Override
protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
doGet(request,response);
}
/**
* 1.创建DiskFileItemFactory对象,用于处理文件上传路径或者大小限制
* @param tmpFile
* @return
*/
public static DiskFileItemFactory getDiskFileItemFactory(File tmpFile){
DiskFileItemFactory factory=new DiskFileItemFactory();
//通过工厂设置一个缓冲区,当上传的文件大于这个缓冲区的时候,将他放到临时文件中
factory.setSizeThreshold(1024*1024);//缓冲区大小为1M
factory.setRepository(tmpFile);//临时目录的保存目录,需要一个File
return factory;
}
/**
* 2.获取ServletFileUpload
* @param factory
* @return
*/
public static 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");
//设置单个文件的最大值
upload.setFileSizeMax(1024*1024*10);
//设置总共能够上传的文件的大小
//1024 = 1kb * 1024 = 1M * 10 = 10M
upload.setSizeMax(1024*1024*10);
return upload;
}
/**
* 3.处理上传文件
* @param upload
* @param uploadPath
* @return
*/
public static String uploadParseRequest(ServletFileUpload upload,HttpServletRequest request,String uploadPath) throws IOException, FileUploadException {
String msg=""; //结果信息
//把前端请求解析,封装成一个FileItem对象,需要ServletFileUpload对象中获取
List<FileItem> fileItems = upload.parseRequest(request);
//fileItem 每一个表单对象
for(FileItem fileItem:fileItems){
//判断上传的input是普通项还是文件上传项
if(fileItem.isFormField()){ //普通input
//getFiledName指的是前端表单控制件的name;
String name = fileItem.getFieldName();
String value = fileItem.getString("UTF-8");//处理乱码
System.out.println(name+":"+value);
}else{ //文件上传input
//文件
//======处理文件=======
//=========1)拿到上传的文件路径 如:/images/girl/paojie.png==========
String uploadFileName = fileItem.getName();
//存在路径不合法的情况
if (uploadFileName.trim().equals("")||uploadFileName==null){
continue;
}
//获得上传的文件名
String fileName=uploadFileName.substring(uploadFileName.lastIndexOf("/")+1);
//获得文件的后缀名
String fileExtName=uploadFileName.substring(uploadFileName.lastIndexOf(".")+1);
/*
如果文件后缀名fileExtName不是我们所需要的,
就直接return,不处理,告诉用户文件类型不对
*/
//========2)使用UUID(唯一识别的通用码),办证文件名唯一========
//UUID.randomUUID(),随机生成一个唯一识别的通用码,本设计中用其为每个上传的文件生成一个包(文件夹)
String uuidPath= UUID.randomUUID().toString();
//========3)生成文件存放路径========
String realPath=uploadPath+"/"+uuidPath;
//给每个文件都创造一个对应的文件夹
File realPathFile=new File(realPath);
if (!realPathFile.exists()){
realPathFile.mkdir();
}
//========4)文件传输========
//1.获取文件上传的流
InputStream inputStream=fileItem.getInputStream();
//2.创建一个文件输出流
//realPath=真实的文件夹
//差了一个文件:加上输出文件的名字
FileOutputStream fileOutputStream=new FileOutputStream(realPath+"/"+fileName);
//3.创建一个缓冲区
byte[] buffer=new byte[1024*1024];
//4.读取,判断是否读取完毕
int len=0;
//如果大于0说明还存在数据
while((len=inputStream.read(buffer))>0){
fileOutputStream.write(buffer,0,len);
}
//5.关闭流
fileOutputStream.close();
inputStream.close();
msg="文件上传成功!"; //向前端输出信息
fileItem.delete(); //上传成功,清除缓存
}
}
return msg;
}
}