Servlet实现文件上传

一、 文件传输原理及介绍

 

 

浏览器通过流的形式将本地文件上传至服务器

在实现浏览器上传的过程中,由于传统流的结构冗杂且慢,故采用apache的开源工具common-fileupload组件(依赖于common-io)进行上传

//maven中导入依赖
  <!-- https://mvnrepository.com/artifact/commons-io/commons-io -->
    <dependency>
      <groupId>commons-io</groupId>
      <artifactId>commons-io</artifactId>
      <version>2.16.1</version>
    </dependency>

    <!-- https://mvnrepository.com/artifact/commons-fileupload/commons-fileupload -->
    <dependency>
      <groupId>commons-fileupload</groupId>
      <artifactId>commons-fileupload</artifactId>
      <version>1.2.2</version>
    </dependency>

  

二、 文件上传注意事项

1.为保证服务器安全,上传文件应该放在外界无法直接访问的目录下(WEB-INF)

2.为防止文件覆盖的现象发生,要为上传文件产生一个唯一的文件名(加时间戳法、UUID(产生随机不重复数字)、MD5加密、位运算算法)

3.要限制上传文件的最大值

4.可以限制上传文件的类型,在收到上传的文件名时,判断后缀名是否合法

 

三、一些细节

常用方法介绍

 

//isFormFileld方法 用于判断FileItem类对象封装的数据是一个普通文本表单。此外也是一个文件表单,如果是普通表单字段则返回true 负责false

boolean isFormFieldName()

//getFileldName方法用于返回表单标签name属性的值

String getString();

//getString方法用于将FileItem对象中保存的数据流内容以一个字符串返回

String getString();

//getName方法用于获得文件上传字段中的文件名

String getName();

//以流的形式返回上传文件的数据

InputStream getInputStream()

//delete方法用了清空FileItem类对象中存放的主体内容

//如果主体内容被保存在临时文件中,delete方法将删除该临时文件

void delete();

 

ServletFileUpload类

ServletFileUpload负责处理上传的文件数据,并将表单中每个输入项封装成一个FileItem对象中,使用其ParseRequest(HttpServletRequest)方法可以将通过表单中每一个HTML标签提交的数据封窗成一个FileItem对象,然后以List列表的形式返回。使用该方法处理上传文件 好!

 

使用到的相关的类

ServletFileUpload 负责处理上传的文件数据,并将表单中每一个输入项封装成一个FileItem对象,在使用ServletFileUpload对象解析请求时需要DiskFileItemFactory对象。所以,我们需要在进行解析工作前构造好DiskFileItemFactory对象,通过ServletFileUpload对象的构造方法或setFileItemFactory方法设置ServletFileUpload对象的FileItemFactory属性

 

FileItem类

在HTML页面中必须加入 name <input type="file" name="filename">

表单如果包含一个文件上传输入选项的话,这个表单的enctype属性就必须设置为multipart/form-data

<html>
<body>
<h2>Hello World!</h2>
<form action="${pageContext.request.contextPath}/upload.do" enctype="multipart/form-data"  method="post">
<%--    通过表单实现上传  post:文件上传大小无限制  get有限制 务必选择post--%>

    上传用户:<input type="text" name="username"><br/>
    <p><input type="file" name="file1"><br></p>
    <p><input type="file" name="file1"></p>
   <p> <input type="submit"> | <input type="reset"></p>
</form>

</body>
</html>

  

四、代码编写

  1 package com.kuang.servlet;
  2 
  3 import org.apache.commons.fileupload.FileItem;
  4 import org.apache.commons.fileupload.FileUploadException;
  5 import org.apache.commons.fileupload.ProgressListener;
  6 import org.apache.commons.fileupload.disk.DiskFileItemFactory;
  7 import org.apache.commons.fileupload.servlet.ServletFileUpload;
  8 
  9 import javax.servlet.ServletException;
 10 import javax.servlet.http.HttpServlet;
 11 import javax.servlet.http.HttpServletRequest;
 12 import javax.servlet.http.HttpServletResponse;
 13 import java.io.File;
 14 import java.io.FileOutputStream;
 15 import java.io.IOException;
 16 import java.io.InputStream;
 17 import java.util.List;
 18 import java.util.UUID;
 19 
 20 public class fileServlet extends HttpServlet {
 21     @Override
 22     protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
 23 
 24     }
 25 
 26     @Override
 27     protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
 28 
 29         //判断用户上传的文件是普通表单还是带文件的表单,如果是普通文件直接返回
 30         if (!ServletFileUpload.isMultipartContent(req)) {
 31             return;
 32         }
 33         //创建文件上传保存的路路径,在WEB-INF路径下是安全的,用户无法直接访问上传,仅可通过重定向等方式进行访问
 34         //小:上传文件
 35         String uploadPath = this.getServletContext().getRealPath("/WEB-INF/upload");
 36         System.out.println(uploadPath);
 37         File uploadFile = new File(uploadPath);
 38         if (!uploadFile.exists()){
 39             uploadFile.mkdir();//若目录不存在就进行创建
 40         }
 41         //设置缓存: 临时路径,如果文件好过了预期大小,就把他放到一个临时文件中,过几天自动删除,或者提醒用户转存为永久
 42         //大:临时上传文件---qq
 43         String tmpPath = this.getServletContext().getRealPath("WEB-INF/tmp");
 44         File file = new File(tmpPath);
 45         if (!file.exists()){
 46             file.mkdir();
 47         }
 48         //处理上传的文件,一般通过流来获取,可以使用request.getInputStream(),原生态的文件上传流获取,十分麻烦
 49         //建议使用 Apache的文件上传组件来实现,common-fileupload,它需要依赖于 commons-io组件;
 50         //1、创建DiskFileItemFactory对象,处理文件上传路径或大小的限制——》   重要 •  1. 创建DiskFileItemFactory对象,处理文件上传路径或者大小限制
 51         DiskFileItemFactory factory = getDiskFileItemFactory(uploadFile);
 52         /*
 53          * 通过工厂设置一个缓冲区,当上传的文件大于这个缓冲区的时候,将他放到临时文件中,
 54          * factory.setSizeThreshold(1024*1024);//缓存区大小为1M
 55          * factory.setRespository(file);//临时文件的保存目录,需要一个File
 56          *
 57          * */
 58         // 重要 • 2、获取ServletFileUpload
 59         ServletFileUpload upload = getServletFileUpload(factory);
 60 
 61         //3、处理上传的文件
 62         try {
 63             String msg = uploadParseRequest(upload,req,uploadPath);
 64             //将数据发给前端
 65             req.setAttribute("msg",msg);
 66             req.getRequestDispatcher("msg.jsp").forward(req,resp);
 67         } catch (FileUploadException e) {
 68             e.printStackTrace();
 69         }
 70     }
 71 
 72 
 73     public static DiskFileItemFactory getDiskFileItemFactory(File file){
 74         DiskFileItemFactory factory = new DiskFileItemFactory();
 75         //通过这个工厂设置一个缓冲区,当上传的文件大于这个缓冲区的时候,将他放到临时文件中
 76         factory.setSizeThreshold(1024*1024); //缓冲区大小为1M
 77         factory.setRepository(file);//临时文件保存的目录,需要一个File
 78         return factory;
 79     }
 80 
 81     public static ServletFileUpload getServletFileUpload(DiskFileItemFactory factory){
 82         ServletFileUpload upload = new ServletFileUpload(factory);
 83         //监听文件上传进度
 84         upload.setProgressListener(new ProgressListener() {
 85             @Override
 86             //pBytesRead:已经读取到的文件大小
 87             //pContentLength : 文件大小
 88             /*
 89              * 监听文件上传进度
 90              * upload.setProgressListener(new ProgressListener()){
 91              * @Override
 92              * //pBytentLength:文件大小
 93              * public void update(Long pBytesRead,Long pContentLength, int pItems){
 94              * System.out.println("总大小:"+pContentLength+ "已上传:" + pBytesRead);}
 95              * }
 96              * */
 97             public void update(long pBytesRead, long pContentLength, int pItems) {
 98                 System.out.println("总大小:"+pContentLength+"已上传"+pBytesRead);
 99             }
100         });
101         //处理乱码问题
102         upload.setHeaderEncoding("utf-8");
103         //设置单个文件的最大值
104         upload.setFileSizeMax(1024*1024*10);
105         //设置总共能够上传文件的大小
106         upload.setSizeMax(1024 * 1024 * 10);
107         return upload;
108     }
109 
110     public static String uploadParseRequest(ServletFileUpload upload, HttpServletRequest request, String uploadPath) throws FileUploadException, IOException {
111         String msg = "";
112         //把前端请求解析,封装成一个FileItem对象(表单中的输入项)
113         List<FileItem> fileItems = upload.parseRequest(request);
114         for (FileItem fileItem : fileItems) {
115             if (fileItem.isFormField()){
116                 String name = fileItem.getFieldName();
117                 String value = fileItem.getString("UTF-8");
118                 System.out.println(name+":"+value);
119             }else {
120                 //****************************处理文件****************************
121                 //拿到文件名字
122                 String uploadFileName = fileItem.getName();
123                 System.out.println("上传的文件名:"+uploadFileName);
124                 if (uploadFileName.trim().equals("") || uploadFileName==null){
125                     continue;
126                 }
127                 //获得上传的文件名
128                 String fileName = uploadFileName.substring(uploadFileName.lastIndexOf("/")+1);
129                 //获得文件的后缀名
130                 String fileExName = uploadFileName.substring(uploadFileName.lastIndexOf(".")+1);
131                 /*
132                  * 如果文件后缀名fileExName不是所需的直接return,不进行处理,告诉用户文件类型不对
133                  * */
134                 System.out.println("文件信息 [文件名:"+fileName+"---文件类型"+fileExName+"]");
135                 //可以使用UUID(唯一识别通用码)保证文件名唯一
136                 String uuidPath = UUID.randomUUID().toString();
137                 //****************************处理文件完毕****************************
138                 //真实存在的路径
139                 String realPath = uploadPath+"/"+uuidPath;
140                 //给每个文件创建一个对应的文件夹
141                 File realPathFile = new File(realPath);
142                 if (!realPathFile.exists()){
143                     realPathFile.mkdir();
144                 }
145                 //****************************存放地址完毕*****************************
146                 //获得文件上传的流
147                 InputStream inputStream = fileItem.getInputStream();
148                 //创建一个文件输出流
149                 //realPath是真实的文件夹
150                 FileOutputStream fos = new FileOutputStream(realPath + "/"+fileName);
151                 //创建一个缓冲区
152                 byte[] buffer = new byte[1024 * 1024];
153                 //判断是否读取完毕
154                 int len = 0;
155                 while ((len=inputStream.read(buffer))>0){
156                     fos.write(buffer,0,len);
157                 }
158                 //关闭流
159                 fos.close();
160                 inputStream.close();
161                 msg = "文件上传成功";
162                 fileItem.delete();//上传成功,清除临时文件
163                 //*************************文件传输完毕**************************
164             }
165         }
166         return msg;
167     }
168 }
View Code

 

五、运行效果

 

posted @ 2025-04-27 14:35  逃逸线LinesOfFlight  阅读(32)  评论(0)    收藏  举报