根据狂神老师课堂整理
需要用到的流
common-fileupload
common-io
从maven仓库中下载直接放到项目下和src属于同一类,放入后右键把jar添加到库
***错误提示:要在maven上也导入这个两个jar包否则运行会报500错误提示无法实例化
文件传输注意事项
- 为保证服务器安全,上传文件应放在无法访问的目录下,比如WEB-INF目录下
- 为防止文件颠覆的现象,要为上传文件产生一个唯一的文件名 (用时间戳,uuid解决)
- 要限制上传文件的最大值
- 可以限制上传文件
需要用到的类详解
ServletFileUpload责处理上传的文件数据,并将表单中每个输入项封装成一个FileItem对象,在使用servletFileUpload对象解析请求时需要DiskFileltemFactory对象。所以我们需要在进行解析工作前构造好DiskEileltemFactory对象,通过ServletFileUpload对象的构造方法或setFileltem
Factory()方法设置ServletFileUpload对象的fileltemFactory属性。
Fileltem类
在HTML页面input必须有name<input type="file" name="filename">
<form action="" enctype="multipart/form-data" method="post">
上传用户:<input type="text" name="username"><br/>
<p><input type="file"name="file1"></p>
<p><input type="file"name="file1"></p>
<p><input type="submit"> | <input type="reset"></p>
</form>
表单如果包含一个文件上传输入项的话,这个表单的enctype属性就必须设置为multipart/form-data
浏览器表单类型如果为multipart/form-date,在服务器端想获取数据就要通过流
- 常用方法介绍
//isFormFile方法用于判断FileItem类对象封装的数据是一个普通文本表单还是一个文件表单,如果是普通表单字段则返回true,否则返回false
booleanisField();
//getFieldName方法用于返回表单标签name属性的值
String getFieldName();
//getString方法用于将FileItem对象中保存的数据流内容以一个字符串返回
String getString();
//getName方法用于获得文件上传字段中的文件名。
String getName();
//以流的形式返回上传文件的数据内容。
InputStream getInputStream();
//delete方法用来清空FileItem类对象中存放的主体内容//如果主体内容被保存在临时文件中,delete方法将删除该临时文件
void delete();
- ServletFileUpload类
ServletFileUpload负责处理上传的文件数据,并将表单中的每个输入项封装成一个FileItem对象中,使用其parseRequest(HttpServletRequest)方法可以将通过表单中每一个HTML标签提交的数据封装成一个FileItem对象,然后以List列表的形式返回。使用该方法处理上传文件简单易用。
代码编写
FileServlet
package com.jiuqi.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;
//extends接Javax.servlet.http.HttpServlet导包,导入后可以改成HttpServlet
public class FileServlet extends HttpServlet {
@Override
protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
/*ServletFileUpload判断上传的文件是普通表单还是带文件的表单
isMultipartContent() 判断是否包含文件
*/
if (!ServletFileUpload.isMultipartContent(req)) {
return;//终止方法运行,说明这是一个普通表单,直接返回
}
//通过if表明是带文件的表单
/*创建上传文件的保存路径,为了安全应放在WEB-INF路径下
getServletContext() 获得全局的上下文
getRealPath() 获得真实的地址
*/
String uploadPath = this.getServletContext().getRealPath("/WEB-INF/upload");
File uploadFile = new File(uploadPath);
//.exists()判断文件是否存在
if (!uploadFile.exists()) {
uploadFile.mkdir();//创建这个目录
}
/*缓存,临时文件
临时路径,如果上传的文件超过预期的大小,我们将它存放到一个临时目录中,过几天自动删除,或者提醒用户转存为永久
*/
String tmpPath = this.getServletContext().getRealPath("/WEB-INF/upload");
File file = new File(tmpPath);
if (!file.exists()) {
file.mkdir();//创建这个临时目录
}
/*处理上传的文件一般需要通过流来获取,我们可以通过request.getInputstream(),原生态文件上传流获取,十分麻烦
但是我们都建议使用Apache的文件上传组件来实现,common-fileupload,它需要依赖于common-io组件;
*/
try {
//1、创建DiskFileItemFactory对象,处理文件上传路径或限制文件大小
DiskFileItemFactory factory = getDiskFileItemFactory(file);
//2、获取ServletFileUpload
ServletFileUpload upload = getServletFileUpload(factory);
//3、处理上传的文件
String msg = uploadParseReq(upload, req, uploadPath);
//servlet请求转发信息
req.setAttribute("msg", msg);
req.getRequestDispatcher("info.jsp").forward(req, resp);
} catch (FileUploadException e) {
e.printStackTrace();
}
}
public static DiskFileItemFactory getDiskFileItemFactory(File file) {
//1.创建DiskFileItemFactory对象,处理文件上传路径或限制文件大小
DiskFileItemFactory factory = new DiskFileItemFactory();
//通过这个工厂设置一个缓冲区,当上传的文件大小大于缓冲区的时候,将它放到临时文件中;
factory.setSizeThreshold(1024 * 1024);//缓冲区大小为1M
factory.setRepository(file);//临时文件的保存路径,需要一个File
return factory;
}
public static ServletFileUpload getServletFileUpload(DiskFileItemFactory factory) {
/*
ServletFileUpload负责处理上传的文件数据,并将表单中的每个输入项封装成一个FileItem对象中,
使用其parseRequest(HttpServletRequest)方法可以将通过表单中每一个HTML标签提交的数据封装成一个FileItem对象,
然后以List列表的形式返回。使用该方法处理上传文件简单易用
*/
//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);
return upload;
}
public static String uploadParseReq(ServletFileUpload upload, HttpServletRequest request, String uploadPath)
throws FileUploadException, IOException {
String msg = "";
//3、处理上传文件
//把前端的请求解析,封装成一个FileItem对象
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;
}
//获得文件的上传名 /img/girl/ooa.jpg
String fileName = uploadFileName.substring(uploadFileName.lastIndexOf("/") + 1);
//获得文件的后缀名
String fileExtName = uploadFileName.substring(uploadFileName.lastIndexOf(".") + 1);
/*
如果后缀名 fileExtName 不是我们需要的就直接return,不处理告诉用户类型不对
*/
System.out.println("文件信息[件名:"+fileName+"---文件类型"+fileExtName+"]");
//可以使用UUID(唯一通用识别码)来保证文件名的统一
/*
网络上传输的东西都要序列化
POJO实体类,如果想在多个电脑上与运行,传输需要把对象都序列化
implements Serializable : 标记接口, JVM--->Java栈 本地方法栈 native-->C++
JNI(Java本地化接口) = Java Native Interface
*/
String uuidPath = UUID.randomUUID().toString();
//======================存放地址=======================
//存在uploadPath,文件真实存在的路径realPath
String realPath = uploadPath+"/"+uuidPath;
//给每个文件创建一个对应的文件夹
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;
//如果大于0,说明还存在数据
while ((len = inputStream.read(buffer)) > 0) {
fos.write(buffer, 0, len);
}
//关闭流
fos.close();
inputStream.close();
msg = "文件上传成功!";
fileItem.delete();//上传成功,清除临时文件
//======================文件传输完毕=======================
}
}
return msg;
}
}
配置文件web.xml
<?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"
metadata-complete="true">
<servlet>
<servlet-name>FileServlet</servlet-name>
<servlet-class>com.jiuqi.servlet.FileServlet</servlet-class>
</servlet>
<servlet-mapping>
<servlet-name>FileServlet</servlet-name>
<url-pattern>/upload.do</url-pattern>
</servlet-mapping>
</web-app>
info.jsp
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>Title</title>
</head>
<body>
${msg}
</body>
</html>
index.jsp
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title></title>
</head>
<body>
<%--通过表单上传文件
get:上传的文件大小有限制
post:上传的文件大小没有限制
--%>
<%--${pageContext.request.contextPath}获取服务器路径--%>
<form action="${pageContext.request.contextPath}/upload.do" enctype="multipart/form-data" method="post">
上传用户:<input type="text" name="username"><br/>
<p><input type="file"name="file1"></p>
<p><input type="file"name="file1"></p>
<p><input type="submit"> | <input type="reset"></p>
</form>
</body>
</html>
我出现的错误
- 没有在maven导入那两个jar包运行会报500错误提示无法实例化(狂神老师应该事先导好了)
- 把文件写在了doget上,应该写在dopost会出现405错误
- if (!ServletFileUpload.isMultipartContent(req)) {
return;//终止方法运行,说明这是一个普通表单,直接返回
}
没有写!走另一个路径导致直接终止方法运行出现空白页面
- 在编写代码时一定要注意不要打错任何一个字符,要做到心平气和不要急躁更不要急功近利,在快速打字时一定要检查避免出错,尽量复制代码以免出错。