Java精选笔记_文件上传与下载

文件上传与下载

如何实现文件上传

在Web应用中，由于大多数文件的上传都是通过表单的形式提交给服务器的，因此，要想在程序中实现文件上传的功能，首先得创建一个用于提交上传文件的表单页面。

为了使Servlet程序可以获取到上传文件的数据，需要将表单页面的method属性设置为post方式，enctype属性设置为“multipart/form-data”类型，添加文件的input标签类型设置为file类型。

上传

客户端

form的enctype属性设置为multipart/form-data

<input type="file" name="xxx" multiple/>

服务器

@MultipartConfig

maxFileSize

maxRequestSize

location

fileSizeThreshold

HttpServletRequest

getPart(String)

getParts()

Part

getName()

getContentType()

write(String)

delete()

getInputStream()

文件上传的相关API

FileItem接口

FileItme接口用于封装单个表单字段元素的数据，一个表单字段元素对应一个FileItem对象，在FileItem类中定义了许多获取表单字段元素的方法。

boolean isFormField()
isFormField()方法用于判断FileItem类对象封装的数据是一个普通文本表单字段，还是一个文件表单字段，如果是普通表单字段则返回true，否则返回false。

String getName()
getName()方法用于获得文件上传字段中的文件名。如果FileItem类对象对应的是普通表单字段，getName()方法将返回null，否则，只要浏览器将文件的字段信息传递给服务器，getName()方法就会返回一个字符串类型的结果，如：“C:\Sunset.jpg”。

String getFieldName()
getFieldName()方法用于获得表单字段元素描述头的name属性值，也是表单标签name属性的值。例如“name=file1”中的“file1”。

void write(File file)
write()方法用于将FileItem对象中保存的主体内容保存到某个指定的文件中。如果FileItem对象中的主体内容是保存在某个临时文件中，那么该方法顺利完成后，临时文件有可能会被清除。另外，该方法也可将普通表单字段内容写入到一个文件中，但它主要用于将上传的文件内容保存到本地文件系统中。

String getString()
getString()方法用于将FileItem对象中保存的数据流内容以一个字符串返回，它有两个重载的定义形式：

public String getString()

public String getString(java.lang.String encoding)

String getContentType()
getContentType()方法用于获得上传文件的类型，即表单字段元素描述头属性“Content-Type”的值，如“image/jpeg”。如果FileItem类对象对应的是普通表单字段，该方法将返回null。

boolean isInMemory()
isInMemory()方法用来判断FileItem对象封装的数据内容是存储在内存中，还是存储在临时文件中，如果存储在内存中则返回true，否则返回false。

void delete()
delete()方法用来清空FileItem类对象中存放的主体内容，如果主体内容被保存在临时文件中，delete()方法将删除该临时文件。需要注意的是，尽管FileItem对象被垃圾收集器收集时会自动清除临时文件，但应该及时调用delete()方法清除临时文件，从而释放系统存储资源，以防系统出现异常，导致临时文件被永久的保存在硬盘中。

InputStream getInputStream()
getInputStream()方法以流的形式返回上传文件的数据内容。

long getSize()
getSize()方法返回该上传文件的大小（以字节为单位）。

DiskFileItemFactory类

用于将请求消息实体中的每一个文件封装成单独的FileItem对象。如果上传的文件比较小，将直接保存在内存中，如果上传的文件比较大，则会以临时文件的形式，保存在磁盘的临时文件夹中。默认情况下，文件保存在内存还是硬盘临时文件夹的临界值是10240，即10kb。





两个构造方法

DiskFileItemFactory() 采用默认临界值和系统临时文件夹构造文件项工厂对象

DiskFileItemFactory(int sizeThreshold, File repository ) 采用参数指定临界值和系统临时文件夹构造文件项工厂对象





常用方法

FileItem createItem()方法

该方法用于将请求消息实体创建成FileItem类型的实例对象，该方法是FileUpload组件在解析请求时内部自动调用，无需我们管理。

setSizeThreshold(int sizeThreshold) 和getSizeThreshold()方法

setSizeThreshold(int sizeThreshold)方法用于设置是否将上传文件以临时文件的形式保存在磁盘的临界值。getSizeThreshold()方法用来获取此临界值。

setRepository(File repository)和getRespository()方法

如果上传文件的大小大于setSizeThreshold()方法设置的临界值，这时，可以采用setRepository()方法，将上传的文件以临时文件的形式保存在指定的目录下。

ServletFileUpload类

ServletFileUpload类是Apache组件处理文件上传的核心高级类，通过使用parseRequest(HttpServletRequest) 方法可以将HTML中每个表单提交的数据封装成一个FileItem对象，然后以List列表的形式返回。





两个构造方法

ServletFileUpload() 构造一个未初始化的ServletFileUpload实例对象

ServletFileUpload(FileItemFactory fileItemFactory)  根据参数指定的FileItemFactory对象创建一个ServletFileUpload对象

常用方法

setSizeMax(long sizeMax)和getSizeMax()
setSizeMax()方法继承自FileUploadBase类，用于设置请求消息实体内容（即所有上传数据）的最大尺寸限制，以防止客户端恶意上传超大文件来浪费服务器端的存储空间。其中，参数sizeMax是以字节为单位。对应的getSizeMax()方法用于读取请求消息实体内容所允许的最大值

setFileSizeMax(long fileSizeMax)
setFileSizeMax()方法继承自FileUploadBase类，用于设置单个上传文件的最大尺寸限制，以防止客户端恶意上传超大文件来浪费服务器端的存储空间。其中，参数fileSizeMax是以字节为单位。对应的geFileSizeMax()方法用于获取单个上传文件所允许的最大值。

parseRequest(javax.servlet.http.

HttpServletRequest req)
parseRequest()方法是ServletFileUpload类的重要方法，它是对HTTP请求消息体内容进行解析的入口。它解析出FORM表单中的每个字段的数据，并将它们分别包装成独立的FileItem对象，然后将这些FileItem对象加入进一个List类型的集合对象中返回。

getItemIterator(HttpServletRequest request)
getItemIterator()方法和parseRequest()方法基本相同。但是getItemIterator()方法返回的是一个迭代器，该迭代器中保存的不是FileItem对象，而是FileItemStream对象，如果你希望进一步提高性能，你可以采用getItemIterator()方法，直接获得每一个文件项的数据输入流，做底层处理；如果性能不是问题，你希望代码简单，则采用parseRequest()方法即可。

isMultipartContent(HttpServletRequest req)
isMultipartContent()方法用于判断请求消息中的内容是否是“multipart/form-data”类型，如果是，则返回true，否则返回false。需要注意的是，isMultipartContent()方法是一个静态方法，不用创建ServletFileUpload类的实例对象即可被调用。

getFileItemFactory()和

setFileItemFactory(FileItemFactory factory)
这两个方法继承自FileUpload类，分别用于读取和设置fileItemFactory属性。

setHeaderEncoding(String encoding)和getHeaderEncoding()
这两个方法继承自FileUploadBase类，用于设置和读取字符编码。需要注意的是，如果没有使用setHeaderEncoding()设置字符编码，则getHeaderEncoding()方法返回null，上传组件会采用HttpServletRequest设置的字符编码。但是，如果HttpServletRequest的字符编码也为null，这时，上传组件将采用系统默认的字符编码。获取系统默认字符编码的方式如：System.getProperty("file.encoding"));