1. 准备工作
对于文件上传,浏览器在上传的过程中是将文件以流的形式提交到服务器端的。
—般选择采用apache的开源工具common-fileupload这个文件上传组件。
common-fileupload是依赖于common-io这个包的,所以还需要下载这个包。
前往Maven仓库去下载:
common-io-2.4:https://mvnrepository.com/artifact/commons-io/commons-io/2.4
commons-fileupload-1.3.1:https://mvnrepository.com/artifact/commons-fileupload/commons-fileupload/1.3.1
2. 导包
- 新建一个Web项目,在WEB-INF文件下创建lib文件,再将这两个jar包复制进去
- 然后右键lib文件,选择
Add as Libray...
3. 使用类介绍
【文件上传的注意事项】
- 为保证服务器安全,上传文件应该放在外界无法直接访问的目录下,比如放于WEB-INF目录下。
- 为防止文件覆盖的现象发生,要为上传文件产生一个唯一的文件名(时间戳、uuid、MD5、位运算算法)
- 要限制上传文件的最大值。
- 可以限制上传文件的类型,在收到上传文件名时,判断后缀名是否合法。
【需要用到的类详解】
ServletilelUpload负责处理上传的文件数据,并将表单中每个输入项封装成一个Fileltem对象,在使用ServletFileUpload对象解析请求时需要DiskFileltemFactory对象。所以,我们需要在进行解析工作前构造好DiskFileltemFactory对象,通过ServletFileUpload对象的构造方法或setFileltemFactory()方法设置ServletFileUpload对象的fileltemFactory属性。
Fileltem类
在HTML页面input
必须有name
,例如:<input type="file" name="filename">
表单如果包含一个文件上传输入项的话,这个表单的enctype
属性就必须设置为multipart/form-data
<%--记得前面说的写路径把其子项目的根目录加上。同时JSTL表达式字符串拼接--%>
<%--post无大小限制,文件上传用post--%>
<form action="${pageContext.request.contextPath}/upload.do" method="post" enctype="multipart/form-data">
<p>上传用户:<input type="text" name="username"></p>
<p>上传文件1:<input type="file" name="filename1"></p>
<p>上传文件2:<input type="file" name="filename2"></p>
<input type="submit" value="提 交"> | <input type="reset" value="重 置">
</form>
浏览器表单的类型如果为multipart/form-data ,在服务器端想获取数据就要通过流。
【常用方法介绍】
//isFormField方法用攻判断FileItem类对象封装的数据是一个普通文本表单
//还是一个文件表单,如果是普通表单字段(没文件)则返回true,否则返回false
boolean isFormField();
//getFieldName方法用于返回表单标签name属性的值。
String getFieldName();
//getstring方法用于将FileItem对象中保存的数据流内容以一个字符串返回
String getstring();
//getName方法用于获得文件上传字段中的文件名。
String getName( );
//以流的形式返回上传文件的数据内容。
Inputstream getInputStream()
//delete方法用来清空FileItem类对象中存放的主体内容
//如果主体内容被保存在临时文件中,delete方法将删除该临时文件。
void delete();
ServletFileUpload类
ServletFileUpload负责处理上传的文件数据,并将表单中每个输入项封装成—个Fileltem对象中,使用其parseRequest(HttpServletRequest)方法可以将通过表单中每一个HTML标签提交的数据封装成—个Fileltem对象,然后以List列表的形式返回。使用该方法处理上传文件简单易用。
4. 代码编写
前台form表单 upload.jsp
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>文件上传</title>
</head>
<body>
<form action="${pageContext.request.contextPath}/upload.do" method="post" enctype="multipart/form-data">
<p>上传用户:<input type="text" name="username"></p>
<p>上传文件1:<input type="file" name="filename1"></p>
<p>上传文件2:<input type="file" name="filename2"></p>
<input type="submit" value="提 交"> | <input type="reset" value="重 置">
</form>
</body>
</html>
msg.jsp
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>Title</title>
</head>
<body>
${msg}
</body>
</html>
后台FileServlet代码
package com.yue.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.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.util.List;
import java.util.UUID;
public class FileServlet extends HttpServlet {
@Override
protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
// 判断上传的文件是普通表单还是带文件的表单
if (!ServletFileUpload.isMultipartContent(req)){
return; // 终止方法运行,说明这是一个普通的表单,直接返回
}// 如果通过if判断,说明上传的表单是带文件上传的
// 创建上传文件的保存路径,建议在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(); // 创建临时目录
}
//1.创建DiskFileItemFactory对象,处理文件上传路径或者大小限制的;
DiskFileItemFactory diskFileItemFactory = getDiskFileItemFactory(tmpfile);
//2.获取ServletFileUpload
ServletFileUpload upload = getServletFileUpload(diskFileItemFactory);
//3.处理上传的文件
String msg = uploadParseRequest(upload, req, uploadPath);
req.setAttribute("msg",msg);
//req.getRequestDispatcher(req.getContextPath() + "/msg.jsp").forward(req,resp);
req.getRequestDispatcher("/msg.jsp").forward(req,resp);
//这个转发不需要加子项目路径,否则重复,因为转发肯定在当前子项目下
}
}
上面的FileServlet封装了三个方法,后续需要将这三个方法放到FileServlet里;
第一个封装的方法 getDiskFileItemFactory(File tempFile)
方法,其作用是创建DiskFileItemFactory对象,处理文件上传路径或者大小限制的。
// 封装一个磁盘文件工厂的方法,处理文件上传路径和大小限制
private DiskFileItemFactory getDiskFileItemFactory(File tempFile) {
DiskFileItemFactory factory = new DiskFileItemFactory();
//通过这个工厂设置一个缓冲区,当上传的文件大于这个缓冲区的时候,将他放到临时文件中;调优三
factory.setSizeThreshold(1024 * 1024);//缓存区大小为1M
factory.setRepository(tempFile);//临时目录的保存目录
return factory;
}
第二个封装的方法getServletFileUpload(DiskFileItemFactory 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;
}
第三封装的方法uploadParseRequest(upload, req, uploadPath)
方法,其作用是处理上传的文件;
- 把前端请求解析,封装成一个FileItem对象;
- 判断表单是否带有文件;
- 处理文件:获得文件名、文件具体名以及后缀打印,使用UUID生成唯一识别的通用码,保证文件唯一;
- 存放文件:将
uploadPath
与UUID生成的uuidPath
拼接成新的存放地址,再给每个上传的文件创建对应文件夹; - 文件传输。
// 处理上传文件
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().equals("")) {
continue;
}
//获得上传的文件名 /images/girl/paojie.png
String fileName = uploadFileName.substring(uploadFileName.lastIndexOf("/") + 1);
//获得文件的后缀名
String fileExtName = uploadFileName.substring(uploadFileName.lastIndexOf(".") + 1);
/*
如果文件后缀名 fileExtName 不是我们所需要的
就直接return,不处理,告诉用户文件类型不对。
*/
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.mkdir();
}
//====================存放地址完毕====================//
//获得文件上传的流
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;
}
在web.xml将FileServlet进行注册和绑定
<?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.yue.servlet.FileServlet</servlet-class>
</servlet>
<servlet-mapping>
<servlet-name>FileServlet</servlet-name>
<url-pattern>/upload.do</url-pattern>
</servlet-mapping>
</web-app>
文件保存到哪里了?
如果已按照上面的步骤进行文件上传,文件应该保存在这个项目的IDEA下的web/WEB-INF里。
也可以参考这个思路去查找。
标签:文件,String,upload,表单,import,上传,下载 From: https://www.cnblogs.com/magicYue/p/18195894