JavaWeb的文件上传和下载功能
对于文件上传，浏览器在上传的过程中是将文件以流的形式提交到服务器端的，如果直接使用Servlet获取上传文件的输入流然后再解析里面的请求参数是比较麻烦，所以一般选择采用apache的开源工具commons-fileupload这个文件上传组件。
这个commons-fileupload上传组件的jar包可以去apache官网上面下载。
commons-fileupload是依赖于commons-io这个包的，所以还需要下载这个包。
地址：
https://commons.apache.org/proper/commons-fileupload/download_fileupload.cgi
https://commons.apache.org/proper/commons-io/download_io.cgi
一、项目搭建
创建或打开一个已有的JavaWeb项目，将commons-fileupload-1.4.jar和commons-io-2.11.0.jar复制到WebContent → WEB-INF下的lib文件夹中。
然后，选中这两个jar包，右键，Build Path → Add to Build Path。
这样，项目的编译环境中就引入了这两个jar包。
jar导入之后，在后面的编程过程中就可以使用这个包中的类了，Ctrl + Shift + O时能见到这个包。
二、文件上传
1、文件上传页面
新建一个JSP文件：fileuploaddownload.jsp
<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%> <!DOCTYPE html> <html> <head> <meta charset="UTF-8"> <title>文件上传与下载</title> <link href="css/style.css" rel="stylesheet" type="text/css" /> </head> <body> <table width="100%" border="0" cellspacing="0" cellpadding="0" align="center"> <tr> <td height="30"> <table width="100%" border="0" cellspacing="0" cellpadding="0"> <tr> <td height="62" background="images/nav04.gif"> </td> </tr> </table> </td> </tr> <tr> <td height="10"><font color="red">${message}</font></td> </tr> <tr> <td class="CPanel"> <fieldset> <legend>文件上传</legend> <form action="${pageContext.request.contextPath}/UploadServlet" enctype="multipart/form-data" method="post"> 上传用户：<input type="text" name="username" /><br /> 上传文件1：<input type="file" name="file1" /><br /> 上传文件2：<input type="file" name="file2" /><br /> <input type="submit" value="提交" /> </form> </fieldset> </td> </tr> </table> </body> </html>
2、文件上传Servlet
新建一个Servlet类：UploadServlet.java
import java.io.File; import java.io.FileOutputStream; import java.io.IOException; import java.io.InputStream; import java.util.List; import javax.servlet.ServletException; import javax.servlet.annotation.WebServlet; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; import org.apache.commons.fileupload.FileItem; import org.apache.commons.fileupload.disk.DiskFileItemFactory; import org.apache.commons.fileupload.servlet.ServletFileUpload; /** * @ClassName:UploadServlet * @Author lihuawei * @Date 2022-04-09 v1.0 */ @WebServlet("/UploadServlet") public class UploadServlet extends BaseServlet { protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException { // 得到上传文件的保存目录，将上传的文件存放于WEB-INF目录下，不允许外界直接访问，保证上传文件的安全 String savePath = this.getServletContext().getRealPath("/WEB-INF/upload"); File file = new File(savePath); // 判断上传文件的保存目录是否存在 if (!file.exists() && !file.isDirectory()) { System.out.println(savePath + "目录不存在，需要创建。"); // 创建目录 file.mkdirs(); // File中有mkdir方法和mkdirs方法。 // 两者都是创建文件夹的方法，都会有返回值。创建成功返回true，创建失败返回false。 // mkdir方法是用于创建最后一个/后面的文件夹，最后一个/前面的文件夹必须都存在。这是才会创建成功。否则会创建失败。 // mkdirs方法是无论父文件夹是否存在都会创建。 } // 消息提示 String message = ""; try { // 使用Apache文件上传组件处理文件上传步骤： // 1、创建一个DiskFileItemFactory工厂 DiskFileItemFactory factory = new DiskFileItemFactory(); // 2、创建一个文件上传解析器 ServletFileUpload upload = new ServletFileUpload(factory); // 设置编码，解决上传文件名的中文乱码 upload.setHeaderEncoding("UTF-8"); // 3、判断是普通表单，还是带文件上传的表单。若返回值为true则是带文件上传的表单；返回值为false则是普通表单 if (!ServletFileUpload.isMultipartContent(request)) { // 普通表单，按照传统方式获取数据 return null; } // 4、使用ServletFileUpload解析器解析上传数据，解析结果返回的是一个List<FileItem>集合，每一个FileItem对应一个Form表单的输入项 List<FileItem> list = upload.parseRequest(request); for (FileItem item : list) { if (item.isFormField()) { // 如果fileitem中封装的是普通输入项的数据 String name = item.getFieldName(); // 解决普通输入项的数据的中文乱码问题 String value = item.getString("UTF-8"); // value = new String(value.getBytes("iso8859-1"),"UTF-8"); System.out.println(name + "=" + value); } else { // 如果fileitem中封装的是上传文件 String filename = item.getName(); // 得到上传的文件名称 System.out.println(filename); if (filename == null || filename.trim().equals("")) { continue; } // 注意：不同的浏览器提交的文件名是不一样的，有些浏览器提交上来的文件名是带有路径的， // 如： c:\a\b\1.txt，而有些只是单纯的文件名，如：1.txt // 处理获取到的上传文件的文件名的路径部分，只保留文件名部分 filename = filename.substring(filename.lastIndexOf("\\") + 1); // 获取item中的上传文件的输入流 InputStream in = item.getInputStream(); // 创建一个文件输出流 FileOutputStream out = new FileOutputStream(savePath + "\\" + filename); // 创建一个缓冲区 byte[] buffer = new byte[1024]; // 判断输入流中的数据是否已经读完的标识 int len = 0; // 循环将输入流读入到缓冲区当中，(len=in.read(buffer))>0就表示in里面还有数据 while ((len = in.read(buffer)) > 0) { // 使用FileOutputStream输出流将缓冲区的数据写入到指定的目录(savePath + "\\" + filename)当中 out.write(buffer, 0, len); } // 关闭输入流 in.close(); // 关闭输出流 out.close(); // 删除处理文件上传时生成的临时文件 item.delete(); message = "文件上传成功！"; } } } catch (Exception e) { message = "文件上传失败！"; e.printStackTrace(); } request.setAttribute("message", message); request.getRequestDispatcher("/fileuploaddownload.jsp").forward(request, response); } protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException { doGet(request, response); } }
运行，选择文件上传。
3、文件上传的细节
上述的代码虽然可以成功将文件上传到服务器上面的指定目录当中，但是文件上传功能有许多需要注意的小细节问题，以下列出的几点需要特别注意的：
（1）为保证服务器安全，上传文件应该放在外界无法直接访问的目录下，比如放于WEB-INF目录下。
（2）为防止文件覆盖的现象发生，要为上传文件产生一个唯一的文件名。
（3）为防止一个目录下面出现太多文件，要使用hash算法打散存储。
（4）要限制上传文件的最大值。
（5）要限制上传文件的类型，在收到上传文件名时，判断后缀名是否合法。
针对上述提出的5点细节问题，我们来改进一下UploadServlet，改进后的代码如下：
import java.io.File; import java.io.FileOutputStream; import java.io.IOException; import java.io.InputStream; import java.util.List; import java.util.UUID; import javax.servlet.ServletException; import javax.servlet.annotation.WebServlet; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; import org.apache.commons.fileupload.FileItem; import org.apache.commons.fileupload.FileUploadBase; import org.apache.commons.fileupload.ProgressListener; import org.apache.commons.fileupload.disk.DiskFileItemFactory; import org.apache.commons.fileupload.servlet.ServletFileUpload; /** * @ClassName:UploadServlet * @Author lihuawei * @Date 2022-04-09 v2.0 */ @WebServlet("/UploadServlet") public class UploadServlet extends BaseServlet { protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {// 得到上传文件的保存目录，将上传的文件存放于WEB-INF目录下，不允许外界直接访问，保证上传文件的安全 String savePath = this.getServletContext().getRealPath("/WEB-INF/upload"); // 2022-04-10 v2.0增加 // 上传时生成的临时文件保存目录 String tempPath = this.getServletContext().getRealPath("/WEB-INF/temp"); File tmpFile = new File(tempPath); if (!tmpFile.exists()) { // 创建临时目录 tmpFile.mkdirs(); } // 2022-04-10 v2.0去掉 // File file = new File(savePath); // 判断上传文件的保存目录是否存在 // if (!file.exists() && !file.isDirectory()) { // System.out.println(savePath + "目录不存在，需要创建。"); // 创建目录 file.mkdirs(); // // File中有mkdir方法和mkdirs方法。 // // 两者都是创建文件夹的方法，都会有返回值。创建成功返回true，创建失败返回false。 // // mkdir方法是用于创建最后一个/后面的文件夹，最后一个/前面的文件夹必须都存在。这是才会创建成功。否则会创建失败。 // // mkdirs方法是无论父文件夹是否存在都会创建。 // } // 消息提示 String message = ""; try { // 使用Apache文件上传组件处理文件上传步骤： // 1、创建一个DiskFileItemFactory工厂 DiskFileItemFactory factory = new DiskFileItemFactory(); // 2022-04-10 v2.0增加 // 设置工厂的缓冲区的大小，当上传的文件大小超过缓冲区的大小时，就会生成一个临时文件存放到指定的临时目录当中。 factory.setSizeThreshold(1024 * 100);// 设置缓冲区的大小为100KB，如果不指定，那么缓冲区的大小默认是10KB // 2022-04-10 v2.0增加 // 设置上传时生成的临时文件的保存目录 factory.setRepository(tmpFile); // 2、创建一个文件上传解析器 ServletFileUpload upload = new ServletFileUpload(factory); // 2022-04-10 v2.0增加 // 监听文件上传进度 upload.setProgressListener(new ProgressListener() { public void update(long pBytesRead, long pContentLength, int pItems) { System.out.println("文件大小为：" + pContentLength + "，当前已处理：" + pBytesRead); } }); // 设置编码，解决上传文件名的中文乱码 upload.setHeaderEncoding("UTF-8"); // 3、判断是普通表单，还是带文件上传的表单，若返回值为true则是带文件上传的表单；返回值为false则是普通表单 if (!ServletFileUpload.isMultipartContent(request)) { // 普通表单，按照传统方式获取数据 return null; } // 2022-04-10 v2.0增加 // 设置上传单个文件的大小的最大值，目前是设置为1024*1024*10字节，也就是10MB upload.setFileSizeMax(1024 * 1024 * 10); // 设置上传文件总量的最大值，最大值=同时上传的多个文件的大小的最大值的和，目前设置为100MB upload.setSizeMax(1024 * 1024 * 100); // 4、使用ServletFileUpload解析器解析上传数据，解析结果返回的是一个List<FileItem>集合，每一个FileItem对应一个Form表单的输入项 List<FileItem> list = upload.parseRequest(request); for (FileItem item : list) { if (item.isFormField()) { // 如果fileitem中封装的是普通输入项的数据 String name = item.getFieldName(); // 解决普通输入项的数据的中文乱码问题 String value = item.getString("UTF-8"); // value = new String(value.getBytes("iso8859-1"),"UTF-8"); System.out.println(name + "=" + value); } else { // 如果fileitem中封装的是上传文件 String filename = item.getName(); // 得到上传的文件名称 System.out.println(filename); if (filename == null || filename.trim().equals("")) { continue; } // 注意：不同的浏览器提交的文件名是不一样的，有些浏览器提交上来的文件名是带有路径的， // 如： c:\a\b\1.txt，而有些只是单纯的文件名，如：1.txt // 处理获取到的上传文件的文件名的路径部分，只保留文件名部分 filename = filename.substring(filename.lastIndexOf("\\") + 1); // 2022-04-10 v2.0增加 // 得到上传文件的扩展名 String fileExtName = filename.substring(filename.lastIndexOf(".") + 1); // 如果需要限制上传的文件类型，那么可以通过文件的扩展名来判断上传的文件类型是否合法 System.out.println("上传的文件的扩展名是：" + fileExtName); // 获取item中的上传文件的输入流 InputStream in = item.getInputStream(); // 2022-04-10 v2.0增加 // 得到文件保存的名称 String saveFilename = makeFileName(filename); // 2022-04-10 v2.0增加 // 得到文件的保存目录 String realSavePath = makePath(saveFilename, savePath); // 创建一个文件输出流 // 2022-04-10 v2.0修改 // FileOutputStream out = new FileOutputStream(savePath + "\\" + filename); FileOutputStream out = new FileOutputStream(realSavePath + "\\" + filename); // 创建一个缓冲区 byte[] buffer = new byte[1024]; // 判断输入流中的数据是否已经读完的标识 int len = 0; // 循环将输入流读入到缓冲区当中，(len=in.read(buffer))>0就表示in里面还有数据 while ((len = in.read(buffer)) > 0) { // 使用FileOutputStream输出流将缓冲区的数据写入到指定的目录(savePath + "\\" + filename)当中 out.write(buffer, 0, len); } // 关闭输入流 in.close(); // 关闭输出流 out.close(); // 删除处理文件上传时生成的临时文件 item.delete(); message = "文件上传成功！"; } } } catch (FileUploadBase.FileSizeLimitExceededException e) { e.printStackTrace(); request.setAttribute("message", "单个文件超出最大值！！！"); request.getRequestDispatcher("/fileuploaddownload.jsp").forward(request, response); return; } catch (FileUploadBase.SizeLimitExceededException e) { e.printStackTrace(); request.setAttribute("message", "上传文件的总的大小超出限制的最大值！！！"); request.getRequestDispatcher("/fileuploaddownload.jsp").forward(request, response); return; } catch (Exception e) { message = "文件上传失败！"; e.printStackTrace(); } request.setAttribute("message", message); request.getRequestDispatcher("/fileuploaddownload.jsp").forward(request, response); } protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException { doGet(request, response); } /** * @Method: makeFileName * @Description: 生成上传文件的文件名，文件名以：uuid+"_"+文件的原始名称 * @Author:lihuawei 2022-04-10 v2.0 * @Param filename 文件的原始名称 * @Return uuid+"_"+文件的原始名称 */ private String makeFileName(String filename) { // 2.jpg // 为防止文件覆盖的现象发生，要为上传文件产生一个唯一的文件名 return UUID.randomUUID().toString() + "_" + filename; } /** * @Method: makePath * @Description:为防止一个目录下面出现太多文件，要使用hash算法打散存储 * @Anthor:lihuawei 2022-04-10 v2.0 * @Param filename 文件名，要根据文件名生成存储目录 * @Param savePath 文件存储路径 * @Return 新的存储目录 */ private String makePath(String filename, String savePath) { // 得到文件名的hashCode的值，得到的就是filename这个字符串对象在内存中的地址 int hashcode = filename.hashCode(); int dir1 = hashcode & 0xf; // 0--15 int dir2 = (hashcode & 0xf0) >> 4; // 0-15 // 构造新的保存目录 String dir = savePath + "\\" + dir1 + "\\" + dir2; // upload\2\3 upload\3\5 // File既可以代表文件也可以代表目录 File file = new File(dir); // 如果目录不存在 if (!file.exists()) { // 创建目录 file.mkdirs(); } return dir; } }
效果：
三、文件下载
1、文件下载页面
要将Web应用系统中的文件资源提供给用户进行下载，首先我们要有一个页面列出要下载文件目录下的所有文件，当用户点击文件下载超链接时就进行下载操作。
（1）编写一个ListFileServlet类，用于列出Web应用系统中指定目录下的所有下载文件。
import java.io.File; import java.io.IOException; import java.util.HashMap; import java.util.Map; import javax.servlet.ServletException; import javax.servlet.annotation.WebServlet; import javax.servlet.http.HttpServlet; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; /** * @ClassName:ListFileServlet * @Author lihuawei * @Date 2022-04-14 v1.0 */ @WebServlet("/ListFileServlet") public class ListFileServlet extends HttpServlet { public void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException { request.setCharacterEncoding("utf-8"); response.setContentType("text/html;charset=utf-8"); // 获取下载文件的目录 String downloadPath = "D:\\downloads"; // 存储要下载的文件名，LinkedHashMap是有序的（插入的顺序） Map<String, String> fileNameMap = new LinkedHashMap<String, String>(); // 递归遍历filepath目录下的所有文件和目录，将文件的文件名存储到map集合中 listfile(new File(downloadPath), fileNameMap);// File既可以代表一个文件也可以代表一个目录 // 将Map集合发送到listfile.jsp页面进行显示 request.setAttribute("fileNameMap", fileNameMap); request.getRequestDispatcher("/fileuploaddownload.jsp").forward(request, response); } /** * @Method: listfile * @Description: 递归遍历指定目录下的所有文件 * @Anthor:lihuawei * @Date 2022-04-14 v1.0 * @param file 即代表一个文件，也代表一个文件目录 * @param map 存储文件名的Map集合 */ public void listfile(File file, Map<String, String> map) { // 如果file代表的不是一个文件，而是一个目录 if (!file.isFile()) { // 列出该目录下的所有文件和目录 File files[] = file.listFiles(); // 遍历files[]数组 for (File f : files) { // 递归 listfile(f, map); } } else { String absoluteName = file.getAbsolutePath(); String fileName = file.getName(); System.out.println("ListFileServlet.listfile()...fileName = " + fileName + ";absoluteName = " + absoluteName); // absoluteName是文件的绝对路径的文件名称，这个名称是唯一的，因此可以作为key；fileName是文件名，在不同的路径下有可能会重复 map.put(absoluteName, fileName); } } public void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException { doGet(request, response); } }
注意：ListFileServlet中listfile()方法，listfile()方法是用来列出目录下的所有文件的，listfile()方法内部采用了递归，罗列出下载目录下的所有文件，包括子目录下的文件。
在实际开发当中，我们还可能会在数据库创建一张表，里面会存储要下载的文件名以及文件的具体存放目录，我们通过查询表就可以知道文件的具体存放目录，这样是不需要用到递归操作的，我们就可以修改listfile()方法即可。
这个例子是因为没有使用数据库存储要下载的文件名和文件的具体存放位置，而指定一个服务器上存放下载文件的位置，所以需要用到递归。在递归时，将获取到的文件名存放到从外面传递到listfile方法里面的Map集合当中，这样就可以保证所有的文件都存放在同一个Map集合当中。
（2）修改fileuploaddownload.jsp，增加文件下载模块。
<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%> <%@taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %> <!DOCTYPE html> <html> <head> <meta charset="UTF-8"> <title>文件上传与下载</title> <link href="css/style.css" rel="stylesheet" type="text/css" /> </head> <body> <table width="100%" border="0" cellspacing="0" cellpadding="0" align="center"> <tr> <td height="30"> <table width="100%" border="0" cellspacing="0" cellpadding="0"> <tr> <td height="62" background="images/nav04.gif"> </td> </tr> </table> </td> </tr> <tr> <td height="10"><font color="red">${message}</font></td> </tr> <tr> <td class="CPanel"> <fieldset> <legend>文件上传</legend> <form action="${pageContext.request.contextPath}/UploadServlet" enctype="multipart/form-data" method="post"> 上传用户：<input type="text" name="username" /><br /> 上传文件1：<input type="file" name="file1" /><font color="red">单个文件不得超过10M！</font><br /> 上传文件2：<input type="file" name="file2" /><font color="red">单个文件不得超过10M！</font><br /> <input type="submit" value="提交" /> </form> </fieldset> </td> </tr> <tr> <td class="CPanel"> <fieldset> <legend>文件下载</legend> <!-- 遍历Map集合 --> <c:forEach var="me" items="${fileNameMap}"> <c:url value="/DownloadServlet" var="downurl"> <c:param name="filename" value="${me.key}"></c:param> </c:url><a href="${downurl}">${me.value}</a> <br /> </c:forEach> </fieldset> </td> </tr> </table> </body> </html>
效果：
当鼠标指向下载文件的超链接时，能够看到，我们可以通过请求参数filename获取该文件在服务器上的真实绝对路径，可以用于下载。
点击超链接，请求服务器的DownLoadServlet，传给它filename。
2、实现文件下载
编写一个用于处理文件下载的DownLoadServlet类。
import java.io.File; import java.io.FileInputStream; import java.io.IOException; import java.io.OutputStream; import java.net.URLEncoder; import javax.servlet.ServletException; import javax.servlet.annotation.WebServlet; import javax.servlet.http.HttpServlet; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; import javax.swing.Box.Filler; /** * @ClassName:DownloadServlet * @Author lihuawei * @Date 2022-04-16 v1.0 */ @WebServlet("/DownloadServlet") public class DownloadServlet extends HttpServlet { protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException { request.setCharacterEncoding("utf-8"); response.setContentType("text/html;charset=utf-8"); // 得到要下载文件的绝对路径文件名称 String absoluteName = request.getParameter("filename"); // D:\downloads\2\第07周线上上课情况.docx System.out.println("DownLoadServlet.doGet()...absoluteName = " + absoluteName); // 得到要下载的文件 File file = new File(absoluteName); // 如果文件不存在 if (!file.exists()) { request.setAttribute("message", "您要下载的资源不存在！"); request.getRequestDispatcher("/fileuploaddownload.jsp").forward(request, response); return; } // 获取文件名，不包含路径 String fileName = file.getName(); // 设置响应头，控制浏览器下载该文件 response.setHeader("content-disposition", "attachment;filename=" + URLEncoder.encode(fileName, "UTF-8")); // 读取要下载的文件，保存到文件输入流 FileInputStream in = new FileInputStream(absoluteName); // 创建输出流 OutputStream out = response.getOutputStream(); // 创建缓冲区 byte buffer[] = new byte[1024]; int len = 0; // 循环将输入流中的内容读取到缓冲区当中 while ((len = in.read(buffer)) > 0) { // 输出缓冲区的内容到浏览器，实现文件下载 out.write(buffer, 0, len); } // 关闭文件输入流 in.close(); // 关闭输出流 out.close(); } protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException { doGet(request, response); } }
点击超链接，就可以下载文件了。
