org.dromara.hutool.http.client.body

Class MultipartOutputStream

java.lang.Object

java.io.OutputStream

org.dromara.hutool.http.client.body.MultipartOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class MultipartOutputStream
extends OutputStream

Multipart/form-data输出流封装
遵循RFC2387规范，见：https://www.rfc-editor.org/rfc/rfc2387

Since:

5.7.17

Author:

looly

Constructor Summary

Constructors

Constructor and Description
MultipartOutputStream(OutputStream out, Charset charset) 构造，使用全局默认的边界字符串
MultipartOutputStream(OutputStream out, Charset charset, String boundary) 构造

Method Summary

Modifier and Type	Method and Description
void	close()
void	finish() 上传表单结束
void	write(int b)
MultipartOutputStream	write(String formFieldName, Object value) 添加Multipart表单的数据项 --分隔符(boundary)[换行] Content-Disposition: form-data; name="参数名"[换行] [换行] 参数值[换行] 或者： --分隔符(boundary)[换行] Content-Disposition: form-data; name="表单名"; filename="文件名"[换行] Content-Type: MIME类型[换行] [换行] 文件的二进制内容[换行]

Methods inherited from class java.io.OutputStream

flush, write, write

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MultipartOutputStream

public MultipartOutputStream(OutputStream out,
                             Charset charset)

构造，使用全局默认的边界字符串

Parameters:

out - HTTP写出流

charset - 编码

MultipartOutputStream

public MultipartOutputStream(OutputStream out,
                             Charset charset,
                             String boundary)

构造

Parameters:

out - HTTP写出流

charset - 编码

boundary - 边界符

Since:

5.7.17

Method Detail

write

public MultipartOutputStream write(String formFieldName,
                                   Object value)
                            throws IORuntimeException

添加Multipart表单的数据项

     --分隔符(boundary)[换行]
     Content-Disposition: form-data; name="参数名"[换行]
     [换行]
     参数值[换行]
 

或者：

     --分隔符(boundary)[换行]
     Content-Disposition: form-data; name="表单名"; filename="文件名"[换行]
     Content-Type: MIME类型[换行]
     [换行]
     文件的二进制内容[换行]
 

Parameters:

formFieldName - 表单名

value - 值，可以是普通值、资源（如文件等）

Returns:

this

Throws:

IORuntimeException - IO异常

write

public void write(int b)
           throws IOException

Specified by:

write in class OutputStream

Throws:

IOException

finish

public void finish()
            throws IORuntimeException

上传表单结束

Throws:

IORuntimeException - IO异常

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class OutputStream