Java上传文件API汇总

心已赠人 2023-10-07 22:38 31阅读 0赞

**一、FileItem接口**

Fileltem接口用于封装单个表单字段元素的数据，一个表单字段元素对应一个Fileltem对象。为了便于讲解，在此将Fileltem的实现类称为Fileltem类，Fileltem类实现了Serializable接口，因此，支持序列化操作。在FiIeItem类中人素的方法，具体如下。

**1. boolean isFormField()方法**

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

**2.String getName()方法**

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

需要注意的是，通过不同浏览器上传的文件，获取到的完整路径和名称都是不一样的。例如，用户使用IE浏览器上传文件，获取到的就是完整的路径“C:\\Sunset.jpg”，如果使用其他浏览器，比如火狐，获取到的仅仅是文件名，没有路径，如“Sunset.jpg”。

**3.String getFieldName()方法**

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

**4. void write(File file)方法**

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

**5.String getString()方法**

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

(1) public String getString(）

(2) public String getString(java.lang.String encoding)

在上面重载的两个方法中，前者使用默认的字符集编码将主体内容转换成字符串，后者使用参数指足的子付集编码将主体内容转换成字符串。需要注意的是，如果在读取普通表单字段无系内谷时出现中文乱码现象，请调用第二个getString)方法，并为之传递正确的字符集编码名称。

倘名外Rssicod.sayThelos oninte .emelblait pait2 )moilelssto molleli

**6. String getContentType()方法**

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

**7.boolean islnMemory()方法**

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

**8. void delete()方法**

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

**9. InputStream getlnputStream()方法**

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

**10. long getSize()方法**

getSize()方法返回该上传文件的大小(以子节为单)。

**二、DiskFileltemFactory类**

DiskFileltemFactory类用于将请求消息实体中的每一个文件封装成单独的Fileltem对象。如果卜传的文件比较小。将直接保存在内存中，如果上传的文件比较大，则会以临时文件的形式，保存在磁盘的临时文件夹中。默认情况下，文件保存在内存还是硬盘临时文件夹的临界值是10240，即10KB。接下来，首先了解一下DiskFileItemFactory类的两个构造方法:

DiskFileItemFactory()

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

DiskFileItemFactory(int sizeThreshold，Filerepository)

采用参数指定临界值和系统临时文件夹构造文件项工厂对象

上面DiskFileltemFactory类的两个构造方法，其中，第二个构造方法需要传递两个参数，参数sizeThreshold代表文件保存在内还是磁盘临时文件夹的临界值，参数repository表示临时文件的存储路径。

接下来，针对DiskFileItemFactory类的常用方法进行详细讲解，具体如下所示。

**1. Fileltem createltem(String fieldName， String contentType，boolean isFormField，String fileName)方法**

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

**2. setSizeThreshold(int sizeThreshold)和getSizeThreshold()方法**

setSizeThreshold(int sizeThreshold)方法用于设置是否将上传文件以临时文件的形式保存在磁盘的临界值。当Apache文件上传组件解析上传的数据时，需要将解析后的数据临时保存，以便后续对数据进一步处理。由于Java虚拟机可使用的内存空间是有限的，因此，需要根据上传文件的大小决定文件的保存位置。例如，一个800MB的文件，是无法在内存中临时保存的，这时，Apache文件上传组件可以采用临时文件的方式来保存这些数据。但是，如果上传的文件很小，只有600KB，显然将其保存在内存中是比较好的选择。另外，对应的getSizeThreshold()方法用来获取此临界值。

**3. setRepository(File repository)和getRepository()方法**

如果上传文件的大小大于setSizeThreshold()方法设置的临界值，这时，可以采用setRepository()方法，将上传的文件以临时文件的形式保存在指定的目录下。在默认情况下，采用的是系统默认的临时文件路径，可以通过以下方式获取。

System.getProperty("java.io.tmpdir")

另外，对应的getRepository()方法用于获取临时文件。

**三、ServletFileUpload类**

ServletFileUpload类是Apache组件处理文件上传的核心高级类，通过使用parseRequest(HttpServletRequest)方法可以将HTML中每个表单提交的数据封装成个Fileltem对象，然后以List列表的形式返回。接下来，首先看一下ServletFileUpload类的构造方法如下所示：

**ServletFileUpload()**

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

**ServletFileUpload(FileItemFactory fileItemFactory)**

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

由于在文件上传过程中，FileltemFactory类必须设置，因此，在使用第一个构造方法创建ServletFileUpload对象时，首先需要在解析请求之前调用setFileltemFactory()方法设置fileltemFactory属性。

了解了ServletFileUpload对象的创建，接下来，学习一下ServletFileUpload类的方法，具体如下。

**1. setSizeMax(long sizeMax)和getSizeMax()方法**

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

另外，对应的getSizeMax()方法用于读取请求消息实体内容所允许的最大值。

**2.setFileSizeMax(long fileSizeMax)方法**

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

另外，对应的getFileSizeMax()方法用于获取单个上传文件所允许的最大值。

**3. parseRequest(javax.servlet.http.HttpServletRequest req)**

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

**4. getltemlterator(HttpServletRequest request)**

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

**5. isMultipartContent(HttpServletRequest req)**

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

**6. getFileltemFactory()和setFileltemFactory(FileltemFactory factory)**

这两个方法继承自FileUpload类，分别用于读取和设置fileltemFactory属性。

**7. setHeaderEncoding(String encoding)方法和getHeaderEncoding()方法**

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

System.getProperty("file.encoding")

**Java最新课程：**

[**Java零基础视频教程(2022最新Java入门，含斯坦福大学练习题+力扣算法题**][Java_2022_Java]

**Java基础入门：**

[**java零基础自学首Java入门教程（含Java项目和Java真题）**][java_Java_Java_Java]

**Javaweb核心基础**

[**JavaWeb基础教程，Java web从入门到企业实战完整版**][JavaWeb_Java web]

**Spring Cloud最全微服务架构**：

[**史上最全面的springcloud微服务技术栈**][springcloud]

**SSM框架教程：**

[**SSM框架教程\_Spring+SpringMVC+Maven高级+Spring**][SSM_Spring_SpringMVC_Maven_Spring]

**SpringBoot2全套视频教程：**

[**SpringBoot2全套视频教程，springboot零基础到项目实战**][SpringBoot2_springboot]

[Java_2022_Java]: https://www.bilibili.com/video/BV17F411T7Ao?spm_id_from=333.999.0.0
[java_Java_Java_Java]: https://www.bilibili.com/video/BV1Cv411372m?spm_id_from=333.999.0.0
[JavaWeb_Java web]: https://www.bilibili.com/video/BV1Qf4y1T7Hx?spm_id_from=333.999.0.0
[springcloud]: https://www.bilibili.com/video/BV1LQ4y127n4?spm_id_from=333.999.0.0
[SSM_Spring_SpringMVC_Maven_Spring]: https://www.bilibili.com/video/BV1Fi4y1S7ix?spm_id_from=333.999.0.0
[SpringBoot2_springboot]: https://www.bilibili.com/video/BV15b4y1a7yG