servlet实现上传附件

红太狼 2021-12-05 00:45 276阅读 0赞

一、简单介绍

使用 Servlet上传附件 原理上还是蛮简单的，首先获取上传的附件对象，然后做一些简单处理 后写入到指定路径的磁盘中。

二、准备条件

common-io.jar ，下载地址：[http://commons.apache.org/io/download\_io.cgi][http_commons.apache.org_io_download_io.cgi]  
common-upload.jar ，下载地址：[http://jakarta.apache.org/commons/fileupload/][http_jakarta.apache.org_commons_fileupload]

三、实现流程

首先在新建好的项目中 加入上述的两个必须jar包，然后根据需求创建好upload.jsp页面选择附件，代码如下：

<%@page import="java.io.File"%>
    <%@ page language="java" contentType="text/html; charset=UTF-8"
        pageEncoding="UTF-8"%>
    <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
    <html>
    <head>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
    <title>Use servlet upload file</title>
    </head>
    <body>
    <form name="uploadForm" method="post" action="servlet/uploadFileServlet" enctype="multipart/form-data">
        附件名称：<input type="text" name="uploadName" value=""/><br/>
        选择附件：<input type="file" name="uploadFile"/><br/>
        <input type="submit" value="上传"/>
    </form>
    </body>
    </html>

其中，enctype=“multipart/form-data” 是必须加入的，因为原先没有加入的普通表单是以字符提交到后台的，但是加了之后所有参数全部会以二进制流格式传入后台，所以后台处理代码 request.getParameter(“paramName”) 将返回空字符串。

基本显示如下图：  
![在这里插入图片描述][20190717175538451.png]  
页面定义好了，接下来创建上面提交的servlet ，代码如下：

package com.chenghui.servlet;
     
    import java.io.File;
    import java.io.IOException;
    import java.io.PrintWriter;
    import java.util.Iterator;
    import java.util.List;
     
    import javax.servlet.ServletConfig;
    import javax.servlet.ServletException;
    import javax.servlet.http.HttpServlet;
    import javax.servlet.http.HttpServletRequest;
    import javax.servlet.http.HttpServletResponse;
     
    import org.apache.commons.fileupload.FileItem;
    import org.apache.commons.fileupload.FileUploadException;
    import org.apache.commons.fileupload.disk.DiskFileItemFactory;
    import org.apache.commons.fileupload.servlet.ServletFileUpload;
     
    /**
     * Servlet implementation class UploadFileServlet
     */
    public class UploadFileServlet extends HttpServlet {
        private static final long serialVersionUID = 1L;
           
        private static final String UPLOAD_PATH = "d:\\attach\\";
        
        /**
         * @see HttpServlet#HttpServlet()
         */
        public UploadFileServlet() {
            super();
            // TODO Auto-generated constructor stub
        }
     
        /**
         * @see Servlet#init(ServletConfig)
         */
        public void init(ServletConfig config) throws ServletException {
            // TODO Auto-generated method stub
        }
     
        /**
         * @see Servlet#destroy()
         */
        public void destroy() {
            // TODO Auto-generated method stub
        }
     
        /**
         * 
         * 偶然发现一个现象，当我定义的servlet 中重写了 service方法，那么每次调用的是service方法，除非注释掉该方法才会根据请求挑战到对象的doPost/doGet中
         * @see HttpServlet#service(HttpServletRequest request, HttpServletResponse response)
         *//*
        protected void service(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
            System.out.println("service");
        }*/
     
        /**
         * @see HttpServlet#doGet(HttpServletRequest request, HttpServletResponse response)
         */
        protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {        
            //创建一个磁盘文件的工厂，然后将它 传递到servletFileUplaod的实例中
            DiskFileItemFactory diskFileItemFactory = new DiskFileItemFactory();
            ServletFileUpload servletFileUpload = new ServletFileUpload(diskFileItemFactory);
            
            try {
                //根据request对象获取所有的文件集合，这里包括input标签输入的值也属于FileInput
                List<FileItem> fileItemList = servletFileUpload.parseRequest(request);
                Iterator iterator = fileItemList.iterator();
                String showFileName = "";
                while(iterator.hasNext()){
                    FileItem fileItem = (FileItem)iterator.next();
                    if(fileItem.isFormField()){ //是否是表单提交域，可以分区是否上传的附件
                        String name = fileItem.getFieldName();  //input标签的name
                        String value = fileItem.getString();    //input表单的value
                        if("uploadName".equals(name)){
                            showFileName = value;
                        }
                    }else{
                        String fieldName = fileItem.getFieldName();  //表单提交过来的file input标签中name的属性值
                        String fileName = fileItem.getName();  //file input上传的文件名
                        String contentType = fileItem.getContentType();  //获得上传文件的类型
                        long size = fileItem.getSize();      //上传文件的大小
                        
                        String filePath = UPLOAD_PATH + showFileName + fileName.substring(fileName.lastIndexOf("."));
                        File saveFile = new File(filePath);
                        
                        fileItem.write(saveFile); //将文件写入磁盘中
                        //成功之后 简单输出一下
                        PrintWriter out = response.getWriter();
                        out.print("上传成功！上传文件为:"+fileName+"<br/>保存的地址为"+filePath+ "！！");
                        out.close();
                    }
                }
            } catch (FileUploadException e) {
                e.printStackTrace();
            } catch (Exception e) {
                e.printStackTrace();
            }
        }
     
        /**
         * @see HttpServlet#doPost(HttpServletRequest request, HttpServletResponse response)
         */
        protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
            doGet(request, response);
        }
    }

在web.xml中对应的配置：

<servlet>
      	<servlet-name>uploadFileServlet</servlet-name>
      	<servlet-class>com.chenghui.servlet.UploadFileServlet</servlet-class>
      </servlet>
      <servlet-mapping>
      	<servlet-name>uploadFileServlet</servlet-name>
      	<url-pattern>/servlet/uploadFileServlet</url-pattern>
      </servlet-mapping>

好了基本上可以走一下流程了，在upload.jsp页面选择附件后点击“上传”按钮，效果显示如下：  
![在这里插入图片描述][20190717175714800.png]然后去d:attach 目录下找上传的附件，找到了，ok上传成功！但是显示的文字有乱码，这是因为response对象在输出的时候没有指定具体的编码，所以按照默认的iso-8859-1输出 就乱码了。

解决方案：在 PrintWriter out = response.getWriter(); 的上面加上

response.setContentType("text/html;charset=UTF-8");

就好了。

正确显示效果如下：  
![在这里插入图片描述][20190717175823422.png]  
另外，将上传的附件是使用org.apache.commons.fileupload.FileItem 提供write方法写入磁盘中的，这也可以用字节流完成该操作。

/**
    	 * @see HttpServlet#doGet(HttpServletRequest request, HttpServletResponse response)
    	 */
    	protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {		
    		//创建一个磁盘文件的工厂，然后将它 传递到servletFileUplaod的实例中
    		DiskFileItemFactory diskFileItemFactory = new DiskFileItemFactory();
    		ServletFileUpload servletFileUpload = new ServletFileUpload(diskFileItemFactory);
    		
    		try {
    			//根据request对象获取所有的文件集合，这里包括input标签输入的值也属于FileInput
    			List<FileItem> fileItemList = servletFileUpload.parseRequest(request);
    			Iterator iterator = fileItemList.iterator();
    			String showFileName = "";
    			//如果附件地址不存在 就创建一下
    			File uploadPath = new File(UPLOAD_PATH);
    			if(!uploadPath.exists()){
    				uploadPath.mkdir();
    			}
    			while(iterator.hasNext()){
    				FileItem fileItem = (FileItem)iterator.next();
    				if(fileItem.isFormField()){ //是否是表单提交域，可以分区是否上传的附件
    					String name = fileItem.getFieldName();  //input标签的name
    					String value = fileItem.getString();    //input表单的value
    					if("uploadName".equals(name)){
    						showFileName = value;
    					}
    				}else{
    					String fieldName = fileItem.getFieldName();  //表单提交过来的file input标签中name的属性值
    					String fileName = fileItem.getName();  //file input上传的文件名
    					String contentType = fileItem.getContentType();  //获得上传文件的类型
    					long size = fileItem.getSize();      //上传文件的笑答
    					
    					String filePath = UPLOAD_PATH + showFileName + fileName.substring(fileName.lastIndexOf("."));
    					//org.apache.commons.fileupload.FileItem 提供write方法写入磁盘中
    					//fileItem.write(new File(filePath));
    					//使用字节流读取二进制格式的附件传给文件流  然后 写入磁盘
    					OutputStream outputStream = new FileOutputStream(new File(UPLOAD_PATH,showFileName + fileName.substring(fileName.lastIndexOf("."))));//这里传递父亲的文件夹路径和当前文件的名称
    					InputStream inputStream = fileItem.getInputStream();
    					int length = 0;
    					
    					byte[] buf = new byte[1024];
    					while((length = inputStream.read(buf)) != -1){  //首先根据传递的字节数组将读取的字节的数量返回，在判断是否读取的空
    						System.out.println(buf);
    						outputStream.write(buf, 0, length);
    					}
    					inputStream.close();
    					outputStream.close();
    					//成功之后 简单输出一下
    					response.setContentType("text/html;charset=UTF-8");
    					PrintWriter out = response.getWriter();
                        out.print("上传成功！上传文件为:"+fileName+"<br/>保存的地址为"+filePath+ "！！");
                        out.close();
    				}
    			}
    		} catch (FileUploadException e) {
    			e.printStackTrace();
    		} catch (Exception e) {
    			e.printStackTrace();
    		}
    	}

上传的效果是一样的。输出每次读取的byte数组。  
基本上，使用servlet 上传附件的功能就已经完成了。

四、多附件上传

如果有需求需要上传多个附件，那么现在这个demo同样有效果，只需要稍作修改就好了。

upload.jsp需要增加一个选择附件的控件，代码 如下：

<%@page import="java.io.File"%>
    <%@ page language="java" contentType="text/html; charset=UTF-8"
        pageEncoding="UTF-8"%>
    <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
    <html>
    <head>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
    <title>Use servlet upload file</title>
    </head>
    <body>
    <form name="uploadForm" method="post" action="servlet/uploadFileServlet" enctype="multipart/form-data">
    	附件名称：<input type="text" name="uploadName" value=""/><br/>
    	选择附件：<input type="file" name="uploadFile"/><br/>
    	
    	附件名称：<input type="text" name="uploadName1" value=""/><br/>
    	选择附件：<input type="file" name="uploadFile2"/><br/>
    	
    	<input type="submit" value="上传"/>
    </form>
    </body>
    </html>

servlet.java 逻辑其实不用改，因为我们是迭代所有FileItem对象的集合，所以所有的附件和附件信息全都保存在这个集合中，简单提炼了下代码，具体如下：

/**
    	 * @see HttpServlet#doGet(HttpServletRequest request, HttpServletResponse response)
    	 */
    	protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {		
    		response.setContentType("text/html;charset=UTF-8");
    		PrintWriter out = response.getWriter();
     
    		//创建一个磁盘文件的工厂，然后将它 传递到servletFileUplaod的实例中
    		DiskFileItemFactory diskFileItemFactory = new DiskFileItemFactory();
    		ServletFileUpload servletFileUpload = new ServletFileUpload(diskFileItemFactory);
    		try {
    			//根据request对象获取所有的文件集合，这里包括input标签输入的值也属于FileInput
    			List<FileItem> fileItemList = servletFileUpload.parseRequest(request);
    			Iterator iterator = fileItemList.iterator();
    			String showFileName = "";
    			String showFileName1 = "";
    			//如果附件地址不存在 就创建一下
    			File uploadPath = new File(UPLOAD_PATH);
    			if(!uploadPath.exists()){
    				uploadPath.mkdir();
    			}
    			while(iterator.hasNext()){
    				FileItem fileItem = (FileItem)iterator.next();
    				if(fileItem.isFormField()){ //是否是表单提交域，可以分区是否上传的附件
    					String name = fileItem.getFieldName();  //input标签的name
    					String value = fileItem.getString();    //input表单的value
    					showFileName = value;  //这里注意好出场顺序，不然就乱套了
    				}else{
    					String fieldName = fileItem.getFieldName();  //表单提交过来的file input标签中name的属性值
    					String fileName = fileItem.getName();  //file input上传的文件名
    					String contentType = fileItem.getContentType();  //获得上传文件的类型
    					long size = fileItem.getSize();      //上传文件的笑答
    					
    					String filePath = UPLOAD_PATH + showFileName + fileName.substring(fileName.lastIndexOf("."));
    					//org.apache.commons.fileupload.FileItem 提供write方法写入磁盘中
    					//fileItem.write(new File(filePath));
    					//使用字节流读取二进制格式的附件传给文件流  然后 写入磁盘
    					OutputStream outputStream = new FileOutputStream(new File(UPLOAD_PATH,showFileName + fileName.substring(fileName.lastIndexOf("."))));//这里传递父亲的文件夹路径和当前文件的名称
    					InputStream inputStream = fileItem.getInputStream();
    					int length = 0;
    					
    					byte[] buf = new byte[1024];
    					while((length = inputStream.read(buf)) != -1){  //首先根据传递的字节数组将读取的字节的数量返回，在判断是否读取的空
    						System.out.println(buf);
    						outputStream.write(buf, 0, length);
    					}
    					inputStream.close();
    					outputStream.close();
    					//成功之后 简单输出一下
                        out.print("上传成功！上传文件为:"+fileName+"<br/>保存的地址为"+filePath+ "！！");
    				}
    			}
    		} catch (FileUploadException e) {
    			e.printStackTrace();
    		} catch (Exception e) {
    			e.printStackTrace();
    		}finally{
    			out.close();
    		}
    	}

五、实现下载功能

上传功能实现完了 之后再来说说下载功能的具体实现。

如果我们把附件放在当前项目下，可以直接通过超链接 进行下载，但是假如附件放在我们上面例子的d:\\attach 下那怎么办，tomcat 是不可能访问项目以外的资源的。

所以接下来有两种解决方案：

1、创建一个虚拟目录

我们发布项目的时候，也是通过在server.xml配置 实现将一个虚拟目录发布到tomcat服务器上，不一定这个虚拟目录上非得有什么WEB-INF，[web.ml][] 等等之类的文件，这个目录专门存放一些附件之类的同样可以访问。

那么同理 在server.xml 中加上如下例子：

访问的话可以使用 localhost:8080/img/imgName 就好了。  
2、采用输入流读取附件，然后输出流写入 即可完成下载功能

具体代码如下：

/**
    	 * @see HttpServlet#doGet(HttpServletRequest request, HttpServletResponse response)
    	 */
    	protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
    		//获取需要下载的附件的地址，然后采用输入流InputStream读取附件信息
    		String filePath = request.getParameter("filePath");
    		if(filePath!=null){
    			try{
    				File file = new File(filePath);
    				//创建输入流
    				InputStream inputStream = new BufferedInputStream(new FileInputStream(file));
    				byte[] buffer = new byte[inputStream.available()];
    				//传递available() 有效的字节数，可以一次性读取完毕
    				inputStream.read(buffer);
    				inputStream.close();
    				//清空response，设置response的Header
    				response.reset();           
    				response.addHeader("Content-Disposition", "attachment;filename=" + new String(file.getName().getBytes("utf-8"),"ISO-8859-1"));
    	            response.addHeader("Content-Length", "" + file.length());
    	            
    				OutputStream outputStream = new BufferedOutputStream(response.getOutputStream());
    				response.setContentType("application/octet-stream");
    				outputStream.write(buffer);
    				outputStream.flush();
    				outputStream.close();
    			} catch (IOException ex) {
    	            ex.printStackTrace();
    	        }
    		}
    	}

然后把上传的输出字符串改一下，加一个超链接，代码如下：

//成功之后 简单输出一下
    out.println("上传成功！上传文件为:"+fileName+"<br/>保存的地址为"+filePath+ "！！<a href='downloadFileServlet?filePath="+filePath+"'>下载</a><br/>");

接下来 重新部署下项目，看看结果。效果如下图所示：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM3MTMxMTEx_size_16_color_FFFFFF_t_70]ok，下载附件功能也完成了！

六、上传附件中遇到问题的解决方案

1、中文乱码

在上面的例子中 附件显示名称和 附件的名称都是使用的英文名称，如果改为中文呢？ 所以果断尝试了一下，结果都乱码了，当时第一时间想到的是 使用request.setCharacterEncoding(“UTF-8”); 但是没有效果呀，这种设置字符编码 方式只适合普通表单的post请求。  
后来发现 可以这样，在创建ServletFileUpload对象之后设置一下头部编码，代码如下：

ServletFileUpload servletFileUpload = new ServletFileUpload(diskFileItemFactory);
    servletFileUpload.setHeaderEncoding("UTF-8");

再试一下，发现 附件的实际名称没变乱码，但是 附件的显示名称还是乱码，这需要单独设置encoding，原先取参数都是

String value = fileItem.getString();    //input表单的value

需要传递encoding ，让FileItem知道你想得到什么格式的value，代码如下：

String value = fileItem.getString("UTF-8");    //input表单的value

再重新部署一下，具体效果如下：  
![在这里插入图片描述][20190717180705762.png]  
2、String类型的变量索引越界

String 类型的变量索引越界了，具体如下：

java.lang.StringIndexOutOfBoundsException: String index out of range: -1

仔细排查 发现如果上传的附件框如果不选择图片，那么Servlet还是会去按照常规获取附件写入磁盘，所以这里

String filePath = UPLOAD_PATH + showFileName + fileName.substring(fileName.lastIndexOf("."));

在它上面过滤掉就好了，具体如下：

if(fileName.length()==0){
       	continue;
       }

[http_commons.apache.org_io_download_io.cgi]: http://commons.apache.org/io/download_io.cgi
[http_jakarta.apache.org_commons_fileupload]: http://jakarta.apache.org/commons/fileupload/
[20190717175538451.png]: /images/20211205/8a4cd4f02dbc4b3f887eb42fd5bd1e53.png
[20190717175714800.png]: /images/20211205/052e5951d7934caeab96d0c840c00d4c.png
[20190717175823422.png]: /images/20211205/67c1d887fa2f4fc3908471ccd1a8d573.png
[web.ml]: http://web.ml
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM3MTMxMTEx_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20190717180454797.jpg?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM3MTMxMTEx,size_16,color_FFFFFF,t_70
[20190717180705762.png]: https://img-blog.csdnimg.cn/20190717180705762.png