一、文件上传概述
1、文件上传的作用
例如网络硬盘!就是用来上传下载文件的。
在智联招聘上填写一个完整的简历还需要上传照片呢。
2、文件上传对页面的要求
上传文件时的要求比较多,需要记一下:
- 必须使用表单,而且不能是超链接;
- 表单的method必须是PSOT,而不能使GET;
- 表单的enctype必须是multipart/form-data;
- 在表单中添加file表单字段,即<input type=" file " ... />;
<form action="${pageContext.request.contextPath}/FileUploadServlet" method="POST" enctype="multipart/form-data">
用户名:<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>
3、比对文件上传表单和普通文本表单的区别
通过httpWatch查看 " 文件上传表单 " 与 " 普通文本表单 " 的区别:
- 文件上传表单的enctype="multipart/form-data",表示多部件表单数据;
<form action="${pageContext.request.contextPath }/FileUploadServlet" method="post" enctype="multipart/form-data">
用户名:<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>
通过httpWatch测试,查看表单的请求数据正文部分,发现正文部分是由多个部件组成,每个部件对应一个表单字段,每个部件都有自己的头信息。头信息下面是空行,空行下面是字段的正文部分。多个部件之间使用随机生成的分割线隔开。
文本字段的头信息中只包含一条头信息,即Content-Disposition,这个头信息的值有两个部分,第一部分是固定的,即form-data,第二部分为字段的名称。在空行后面就是正文部分了,正文部分就是文本框中填写的内容。
文件字段的头信息中包含两个头信息,Content-Disposition和Content-Type。Content-Disposition中多出一个filename,它指定的是上传的文件名称。而Content-Type指定的是上传的文件类型。文件字段的正文部分就是文件的内容。
请注意,因为我们上传的文件都是普通文件,即txt文件,所以在httpWatch中可以正常显示的,如果上传的是exe、mp3文件,那么在httpWatch中看到的就是乱码。
- 普通文本表单可以不设置enctype属性
> 当method=" post "时,enctype的默认值为application/x-www-form-urlencoded,表示使用url编码正文;
>当method=" get "时,enctype的默认值为null,没有正文,所以不需要enctype了;
<form action="${pageContext.request.contextPath }/FileUploadServlet" 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>
4、文件上传对Servlet的要求
当提交的表单是文件上传表单时,那么对Servlet也是有要求的。
首先我们要肯定一点,文件上传表单的数据也是封装到request对象中的。
request.getParameter(String str) 方法获取指定的表单字段字符内容,单文件上传表单已经不再是字符内容,而是字节内容,所以失败。
这时,可以使用request的getInputStream() 方法获取ServletInputStream对象,它是InputStream的子类,这个ServletInputStream对象对应整个表单的正文部分(从第一个分割线开始,到最后),这说明我们需要的解析流中的数据。当然解析它是很麻烦的一件事,而Apache已经帮我们提供了解析它的工具:commons-fileupload。
可以尝试把request.getInputStream() 这个流中的内容打印出来,再对比httpWatch中的请求数据。
public void doPost(HttpServletRequest request,HttpServletResponse response)throws ServletException,IOException{
InputStream in = request.getInputStream();
String s = IOUtils.toString(in);
System.out.println(s);
}
-----------------------------7ddd3370ab2
Content-Disposition: form-data; name="username"
hello
-----------------------------7ddd3370ab2
Content-Disposition: form-data; name="file1"; filename="a.txt"
Content-Type: text/plain
aaa
-----------------------------7ddd3370ab2
Content-Disposition: form-data; name="file2"; filename="b.txt"
Content-Type: text/plain
bbb
-----------------------------7ddd3370ab2--
二、commons-fileupload
1、fileupload概述
fileupload是由apache 的 commons组件提供的上传组件,它最主要的工作就是帮我们解析request.getInputStream() 。
fileupload 组件需要的jar包有:
- commons-fileupload.jar,核心包;
- xommons-io.jar,依赖包;
2、fileupload的简单应用
fileupload的核心类有:DiskFileItemFactory,ServletFileUpload,FileItem。
使用fileupload组件的步骤如下:
> 创建工厂类DiskFileItemFactory对象:DiskFileItemUpload factory = new DiskFileItemUpload();
> 使用工厂创建解析器对象:ServletFileUpload fileUpload = new ServletFileUpload(factory);
> 使用解析器来解析request对象:List<FileItem> list = fileUpload.parseRequest();
隆重介绍FileItem类,它才是我们最终要的结果。一个FileItem对象第一营一个表单项(表单字段)。一个表单中存在文件字段和普通字段,可以使用FileItem类的isFormField()方法来判断表单字段是否为普通字段,如果不是普通字段,那么就是文件字段了。
- String getName():获取文件字段的文件名称;
- String getString():获取字段的内容,如果是文件字段,那么获取的是文件内容,当然上传的文件必须是文本文件;
- String getFieldName():获取字段名称,例如<input type="text" name=“"username"/>,返回的是username;
- String getContextType():获取上传的文件类型,例如text/plain;
- int getSize():获取上传文件的大小;
- boolean isFormField():判断当前表单字段是否为普通文本字段,如果返回false,说明是文件字段;
- InputStream getInputStream():获取上传文件的输入流;
- void write(File file):把上传的文件保存到指定文件中;
3、简单上传示例
写一个简单的上传示例:
> 表单包含一个用户名字段,以及一个文件字段;
> Servlet保存上传的文件到uploads目录,显示用户名、文件名、文件大小、文件类型。
第一步:完成index.jsp,只需要一个表单。注意表单必须是post的,而且enctype必须是multipart/form-data的。
<form action="${pageContext.request.contetPath}/FileUploadServlet" method="post" enctype="multipart/form-data">
用户名:<input type="text" name="username"/><br/>
文件:<input type="file" name="file"><br/>
<input type="submit" value="提交">
</form>
第二步:完成FileUploadServlet
public void doPost(HttpServletRequest request,HttpServletResopnse response)throws ServletException,IOException{
response.setContextType("text/html;charset=utf-8");
//创建工厂
DiskFileItemFactory factory = new DiskFileItemFactory();
//使用工厂创建解析器对象
ServletFileUpload fileUpload = new ServletFileUpload(factory);
try{
List<FileItem> list = fileUpload.parseRequest(request);
for(FileItem fileItem : list){
if(fileItem.isFormField()){
String fieldName = fileItem.getFieldName();
if(fieldname.equals("username")){
response.getWriter().print("用户名"+fileItem.getString()+"<br/>");
}else{
String name = fileItem.getNmae();
if(name==null || name.isEmpty()){
continue;
}
String savePath = this.getServletContext().getRealPath("/uploads");
File file = new File(savePath,name);
fileItem.write(file);
response.getWriter().print("上传文件名:"+name+"<br/>");<pre name="code" class="html">
response.getWriter().print("上传文件大小:"+fileItem.getSize()+"<br/>");
response.getWriter().print("上传文件类型:"+fileItem.getContextType()+"<br/>");
}
}
}
}catch(Exception e){
throws new ServletException(e);
}
}
三、文件上传之细节
1、把上传的文件放到WEB-INF目录下
如果没有把用户上传的文件存放到WEB-INF目录中,那么用户就可以通过浏览器直接访问上传的文件,这是非常危险的。
假如说用户上传了一个a.jsp文件,然后用户再通过浏览器去访问这个a.jsp文件,那么就会执行a.jsp中的内容,如果在a.jsp中有如下语句:RuntimegetRuntime().exec("shutdown -s -t 1");,那么你就会....
通常我们会在WEB-INF目录下创建一个uploads目录来存放上传的文件,而在Servlet中找到这个目录需要使用ServletContext的getRealPath()方法,例如在我的upload项目中有如下语句:
> ServletContext servletContext = this.getServletContext();
> String savepath = servletContet.getRealPath("/WEB-INF/uploads");
其中savepath为:F:\tomcat6_1\webapps\upload\WEB-INF\uploads
2、文件名称(完整路径和文件名称)
IE6获取的上传文件名称是完整的,而其他浏览器获取的上传文件名称只是文件名称而已。浏览器差异的问题让我还需要处理一下。
String name = fileFileItem.getName();
response.getWriter().print(name);
使用不同浏览器测试,其中IE6会返回上传文件的完整路径,不知道IE在搞什么,这给我们带来很大的麻烦,就需要处理这个问题。
处理这一问题也很简单,无论是否为完整路径,我们都去截取最后一个" \\ " 后面的内容就可以了。
String name = fileFileItem.getName();
int lastIndex = name.lastIndexOf(" \\ ");
if(lastIndex != -1){
name = name.subString();
}
response.getWriter().print(name);
3、中文乱码问题
【1】上传文件名称中包含中文
当上传的名称中包含中文时,需要设置编码,commons-fileupload组件为我们提供了两种设置编码的方式:
- request.setCharactorEncoding(String ):这种方式使我们最熟悉的方式了;
- fileUpload.setHeaderEncoding(String ):这种方式优先级高于上一种方式;
【2】上传的文件内容包含中文
通常我们不需要关心上传文件的内容,因为我们会把上传文件保存到硬盘上!也就是说文件原来是什么样子,到服务器这边还是什么样子。
但是如果你有这样的需求,非要在控制台显示上传的内容,那么可以使用fileItem.getString(" utf-8 ") 来处理编码。
文本文件内容和普通表单项内容使用FileItem类的getString(" utf-8 ") 来处理编码。
4、上传文件同名问题(文件重命名)
通常我们会把用户上传的文件保存到uploads目录下,但如果用户上传了同名文件呢?这会出现覆盖的现象。处理这一问题的手段是使用UUID生成唯一名称,然后使用 " _ " 链接文件上传的原始名称。
例如用户上传的文件是" 我的一寸照片.jpg ",在通过处理后,文件名称为" 91b3881395f4175b969256a3f7b6e10_我的一寸照片.jpg " ,这种手段不会使文件丢失扩展名,并且因为UUID的唯一性,上传的文件同名,但在服务器端是不会出现同名问题的。
public void doPost(HttpServletRequest request, HttpServletResponse response)
throws ServletException, IOException {
request.setCharacterEncoding("utf-8");
DiskFileItemFactory dfif = new DiskFileItemFactory();
ServletFileUpload fileUpload = new ServletFileUpload(dfif);
try {
List<FileItem> list = fileUpload.parseRequest(request);
//获取第二个表单项,因为第一个表单项是username,第二个才是file表单项
FileItem fileItem = list.get(1);
String name = fileItem.getName();//获取文件名称
// 如果客户端使用的是IE6,那么需要从完整路径中获取文件名称
int lastIndex = name.lastIndexOf("\\");
if(lastIndex != -1) {
name = name.substring(lastIndex + 1);
}
// 获取上传文件的保存目录
String savepath = this.getServletContext().getRealPath("/WEB-INF/uploads");
String uuid = CommonUtils.uuid();//生成uuid
String filename = uuid + "_" + name;//新的文件名称为uuid + 下划线 + 原始名称
//创建file对象,下面会把上传文件保存到这个file指定的路径
//savepath,即上传文件的保存目录
//filename,文件名称
File file = new File(savepath, filename);
// 保存文件
fileItem.write(file);
} catch (Exception e) {
throw new ServletException(e);
}
}
5、一个项目不能存放过多的文件(存放目录打散)
一个目录下不应该存放过多的文件,一般一个目录存放1000个文件就是上限了,如果再多,那么打开目录时就会很卡。
也就是说,我们需要把上传的文件存放到不同的目录中,但是也不能每个上传的文件一个目录,这种方式会导致目录过多。所以我们应该采用某种算法来打散。
打散的方法有很多,例如使用日期来打散,每天生产一个目录;也可以使用文件名的首字母来生产目录,相同首字母的文件放到一个目录。
日期打散算法:如果某一天上传的文件过多,那么也会出现一个目录文件过多的情况;
首字母打散算法:如果文件名是中文的,因为中文过多,所以导致目录过多的现象;
Hash打散算法:
> 获取文件名称的HashCode,int hCode = name.hashCode();
> 获取hCode的低4位,然后转换成16进制字符;
> 获取hCode的5~8位,然后转换成16进制字符;
> 使用这两个16进制的字符生成目录链。例如低4位字符为" 5 "
这种算法的好处是,在uploads目录下最多生成16个目录,而每个目录下最多再生成16个目录,即256个目录,所有上传的文件都放到这256个目录下。
例如上传文件名称为:新建文本文档.txt,那么把" 新建文本文档.txt " 的哈希码获取到,再获取哈希码的低四位。加入低四位为:9,5~8位为:1,那么文件的保存路径为:uploads/9/1/。
int hCode = name.hashCode();//获取文件名的HashCode
//获取hCode的低四位,并转换成十六进制字符串
String dir1 = Integer.toHexString(hCode & 0xF);
//获取hCode的5-8位,并转换成十六进制字符串
String dir2 = Integer.toHexString(hCode>>>4 & 0xF);
//与文件保存目录链接成完整路径
savepath = savepath + "/" + dir1 +"/"+dir2;
//因为这个路径可能不存在,所以创建File对象,再创建目录链,确保目录在保存文件之前已经存在
new File(savepath).mkdirs();
6、上传单个文件的大小限制
限制上传文件的大小很简单,ServletFileUpload类的setFileSizeMax(long)就可以了。参数就是上传文件的上限字节数,例如servletFileUpload.setFileSizeMax(1024*10)表示上限为10KB。
一旦上传的文件超出了上限,那么就会抛出FileUploadBase.FileSizeLimitException异常。我们可以在Servlet中获取该异常,然后想页面输出“上传的文件超出限制”。
public void doPost(HttpServletRequest request,HttpServletResponse response)throws ServletException,IOException{
request.setCharactorEncoding("utf-8");
DiskFileItemFactory factory = new DiskFileItemFactory();
ServletFileUpload fileUpload = new ServletFileUpload(factory);
fileUpload.setFileSizeMax(1024 * 10);
try{
List<FileItem> list = fileUpload.parseRequest(request);
FileItem fileItem = list.get(1);//获取第二个表单项
String name = fileItem.getName();//获取文件名称
//如果客户端使用的是IE6,那么从完整路径中截取文件名称
int lastIndex = name.lastIndexOf("\\");
if(lastIndex != -1){
name = name.subString(lastIndex + 1);
}
//获取上传文件的保存目录
String savepath = this.getServletContext().getRealPath("/WEB-INF/uploads");
String uuid = CommonUtils.uuid();//生成uuid
String filename = uuid + "_" + name;//新文件名为uuid+_+原始名称
int hCode = name.hashCode();
<pre name="code" class="html"> String dir1 = Integer.toHexString(hCode & 0xF);
String dir2 = Integer.toHexString(hCode>>>4 & 0xF);
savepath = savepath + "/" + dir1 +"/"+dir2;
new File(savepath).mkdirs();
//创建文件路径
File file = new File(savepath,filename);
fileItem.write(file);
}catch(Exception e){
if(e instanceof FileUploadBase.FileSizeLimitException){
request.setAttribute("msg","上传文件超出10KB!");//在request中保存错误信息
request.getRequestDispacher("/index.jsp").forward(request,response);//转发到index.jsp页面
return;
}
throw new ServletException(e);
}
}
7、上传文件的总大小限制
上传文件的表单中允许上传多个文件,例如:
有时我们需要限制一个请求的大小,也就是说这个请求的最大字节数(所有表单项之和)!实现这一功能也很简单,只需要调用ServletFileUpload类的setSizeMax(long)方法即可。
例如fileUpload.setSizeMax(1024*10),表示整个请求的上限为10KB。当请求大小超出10KB时,servletUpload类的parseRequest()方法会抛出FileUploadBase.SizeLimitExceededException异常。
8、缓存大小与临时目录
大家想一想,如果我上传一个蓝光电影先把电影保存到内存中,然后通过内存 copy 到服务器硬盘上,那么你的硬盘能吃得消吗?
所以fileUpload组件不可能把文件都保存到内存中,fileUpload会判断文件大小是否超出10KB,如果是那么就把文件保存到硬盘上,如果没有超出,那么就保存到内存中。
10KB是fileUpload的默认值,我们可以来设置它。
当文件保存到硬盘时,fileUpload是把文件保存到系统临时目录,当然你也可以设置临时目录。
<p><span style="color:#7f055;">public</span><span style="color:#000000;"> </span><span style="color:#7f055;">void</span><span style="color:#000000;"> doPost(HttpServletRequest request, HttpServletResponse response)</span></p><p><span style="color:#7f055;">throws</span><span style="color:#000000;"> ServletException, IOException {</span></p><p><span style="color:#000000;">request.setCharacterEncoding(</span><span style="color:#2a0ff;">"utf-8"</span><span style="color:#000000;">);</span></p><p><span style="color:#000000;">DiskFileItemFactory dfif = </span><span style="color:#7f055;">new</span><span style="color:#000000;"> DiskFileItemFactory(1024*20, </span><span style="color:#7f055;">new</span><span style="color:#000000;"> File(</span><span style="color:#2a0ff;">"F:\\temp"</span><span style="color:#000000;">));</span></p><p><span style="color:#000000;">ServletFileUpload fileUpload = </span><span style="color:#7f055;">new</span><span style="color:#000000;"> ServletFileUpload(dfif);</span></p><p><span style="color:#7f055;">try</span><span style="color:#000000;"> {</span></p><p><span style="color:#000000;">List<FileItem> list = fileUpload.parseRequest(request);</span></p><p><span style="color:#000000;">FileItem fileItem = list.get(1);</span></p><p><span style="color:#000000;">String name = fileItem.getName();</span></p><p><span style="color:#000000;">String savepath = </span><span style="color:#7f055;">this</span><span style="color:#000000;">.getServletContext().getRealPath(</span><span style="color:#2a0ff;">"/WEB-INF/uploads"</span><span style="color:#000000;">);</span></p><p><span style="color:#3f7f5f;">// <span style="font-family:宋体;">保存文件</span></span></p><p><span style="color:#000000;">fileItem.write(path(savepath, name));</span></p><p><span style="color:#000000;">} </span><span style="color:#7f055;">catch</span><span style="color:#000000;"> (Exception e) {</span></p><p><span style="color:#7f055;">throw</span><span style="color:#000000;"> </span><span style="color:#7f055;">new</span><span style="color:#000000;"> ServletException(e);</span></p><p><span style="color:#000000;">} </span></p><p><span style="color:#000000;">}</span></p><p><span style="color:#7f055;">private</span><span style="color:#000000;"> File path</span><span style="color:#000000;">(String savepath, String filename) {</span></p><p><span style="color:#3f7f5f;">// <span style="font-family:宋体;">从完整路径中获取文件名称</span></span></p><p><span style="color:#7f055;">int</span><span style="color:#000000;"> lastIndex = filename.lastIndexOf(</span><span style="color:#2a0ff;">"\\"</span><span style="color:#000000;">);</span></p><p><span style="color:#7f055;">if</span><span style="color:#000000;">(lastIndex != -1) {</span></p><p><span style="color:#000000;">filename = filename.substring(lastIndex + 1);</span></p><p><span style="color:#000000;">}</span></p><p><span style="color:#3f7f5f;">// <span style="font-family:宋体;">通过文件名称生成一级、二级目录</span></span></p><p><span style="color:#7f055;">int</span><span style="color:#000000;"> hCode = filename.hashCode();</span></p><p><span style="color:#000000;">String dir1 = Integer.</span><span style="color:#000000;">toHexString</span><span style="color:#000000;">(hCode & 0xF);</span></p><p><span style="color:#000000;">String dir2 = Integer.</span><span style="color:#000000;">toHexString</span><span style="color:#000000;">(hCode >>> 4 & 0xF);</span></p><p><span style="color:#000000;">savepath = savepath + </span><span style="color:#2a0ff;">"/"</span><span style="color:#000000;"> + dir1 + </span><span style="color:#2a0ff;">"/"</span><span style="color:#000000;"> + dir2;</span></p><p><span style="color:#3f7f5f;">// <span style="font-family:宋体;">创建目录</span></span></p><p><span style="color:#7f055;">new</span><span style="color:#000000;"> File(savepath).mkdirs();</span></p><p><span style="color:#3f7f5f;">// <span style="font-family:宋体;">给文件名称添加</span><span style="font-family:Courier New;">uuid</span><span style="font-family:宋体;">前缀</span></span></p><p><span style="color:#000000;">String uuid = CommonUtils.</span><span style="color:#000000;">uuid</span><span style="color:#000000;">();</span></p><p><span style="color:#000000;">filename = uuid + </span><span style="color:#2a0ff;">"_"</span><span style="color:#000000;"> + filename;</span></p><p><span style="color:#3f7f5f;">// <span style="font-family:宋体;">创建文件完成路径</span></span></p><p><span style="color:#7f055;">return</span><span style="color:#000000;"> </span><span style="color:#7f055;">new</span><span style="color:#000000;"> File(savepath, filename);</span></p><p><span style="color:#000000;">}</span></p>
二、文件下载
1、通过Servlet下载(第一步)
被下载的资源必须放在WEB-INF目录下(只要用户不能通过浏览器直接访问即可),然后通过Servlet完成下载。
在JSP页面中给出超链接,连接到DownloadServlet,并提供要下载的文件名称。然后DownloadServlet获取文件的真是路径,然后把文件写入到response.getOutputStream()流中。
download.jsp
<body>
<a ref="<c:url value='/DownloadServlet?path=a.avi'>">a.avi</a><br/>
<pre name="code" class="html"> <a ref="<c:url value='/DownloadServlet?path=a.jpg'>">a.jpg</a><br/>
<a ref="<c:url value='/DownloadServlet?path=a.txt'>">a.txt</a><br/>
</body>
DownloadServlet.java
public void doGet(HttpServletRequest request,HttpServletResponse response)throws ServletException,IOException{
String filename = request.getParameter("path");
String filepath = this.getServletContext().getRealPath("/WEB-INF/uploads/"+filename);
File file = new File(filepath);
if(!file.exists()){
response.getWriter().print("您要下载的文件不存在!");
return;
}
IOUtils.copy(new FileInputStream(file),response.getOutputStream());
}
上传代码有如下问题:
- 可以下载a.avi,但在下载框中的文件名称是DownloadServlet;
- 不能下载a.jpg和a.txt,而是在页面中显示他们。
2、通过Servlet下载(第二步)
下面来处理上一例中的问题,让下载框中可以显示正确的文件名称,以及可以下载a.jpg和a.txt文件。
通过添加content-disposition头来处理上面的问题,当设置了content-disposition头后,浏览器就会弹出下载框。
而且还可以通过content-disposition头来指定下载文件的名称。
String filename = request.getParameter("path");
String filepath = this.getServletContext().getRealPath("/WEB-INF/uploads/"+filename);
File file = new File(filepath);
if(!file.exists()){
response.getWriter().print("您下载的文件不存在!");
return;
}
response.addHeader("content-disposition","attachment;filename="+filename);
IOUtils.copy(new FileInputStream(file),response.getOutputStream());
虽然上边的代码已经可以处理a.jpg和a.txt文件的下载问题,并且也处理了在下载框中显示文件名称的问题,但是如果下载的文件名称为中文的,那么还是不行的。
3、通过Servlet下载三
下面处理在下载框中出现中文的问题。
其实这一问题很简单,只需要通过URL来编码中文即可。
download.jsp
<body>
<a ref="<c:url value='/DownloadServlet?path=这个杀手不太冷.avi'>">这个杀手不太冷.avi</a><br/>
<pre name="code" class="html"> <a ref="<c:url value='/DownloadServlet?path=白冰.jpg'>">白冰.jpg</a><br/>
<a ref="<c:url value='/DownloadServlet?path=说明文档.txt'>">说明文档.txt</a><br/>
</body>
DownloadServlet.java
String filename = request.getParameter("path");
filename = new String(filename.getBytes("ISO-8859-1"),"UTF-8");
String filepath = this.getServletContext().getRealPath("/WEB-INF/uploads/"+filename);
File file = new File(filepath);
if(!file.exists()){
response.getWriter().print("您下载的文件不存在!");
return;
}
filename = new String(filename.getBytes("GBK"),"ISO-8859-1");
<pre name="code" class="html">response.addHeader("content-disposition","attachment;filename="+filename);
IOUtils.copy(new FileInputStream(file),response.getOutputStream());