org.dromara.hutool.http.client.body

Class UrlEncodedFormBody

java.lang.Object

org.dromara.hutool.http.client.body.FormBody<UrlEncodedFormBody>

org.dromara.hutool.http.client.body.UrlEncodedFormBody

All Implemented Interfaces:

HttpBody

public class UrlEncodedFormBody
extends FormBody<UrlEncodedFormBody>

application/x-www-form-urlencoded 类型请求body封装

Since:

5.7.17

Author:

looly

Field Summary

Fields inherited from class org.dromara.hutool.http.client.body.FormBody

charset, form

Constructor Summary

Constructors

Constructor and Description
UrlEncodedFormBody(Map<String,Object> form, Charset charset) 构造

Method Summary

Modifier and Type	Method and Description
long	contentLength() 获取写出字节长度，未知为-1
String	contentType() 获取Content-Type 根据实现不同，Content-Type可能包含编码信息，也可以不包含
UrlEncodedFormBody	form(String name, Object value) 设置表单数据 如果传入值为null，则移除这个表单项
static UrlEncodedFormBody	of(Map<String,Object> form, Charset charset) 创建 Http request body
void	write(OutputStream out) 写出数据，不关闭流

Methods inherited from class org.dromara.hutool.http.client.body.FormBody

form, form

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.dromara.hutool.http.client.body.HttpBody

contentType, getBytes, getStream, writeClose

Constructor Detail

UrlEncodedFormBody

public UrlEncodedFormBody(Map<String,Object> form,
                          Charset charset)

构造

Parameters:

form - 表单

charset - 编码

Method Detail

of

public static UrlEncodedFormBody of(Map<String,Object> form,
                                    Charset charset)

创建 Http request body

Parameters:

form - 表单

charset - 编码

Returns:

FormUrlEncodedBody

form

public UrlEncodedFormBody form(String name,
                               Object value)

Description copied from class: FormBody

设置表单数据
如果传入值为null，则移除这个表单项

Overrides:

form in class FormBody<UrlEncodedFormBody>

Parameters:

name - 名，blank则忽略之

value - 值为null，则移除这个表单项

Returns:

this

write

public void write(OutputStream out)

Description copied from interface: HttpBody

写出数据，不关闭流

Parameters:

out - out流

contentType

public String contentType()

Description copied from interface: HttpBody

获取Content-Type
根据实现不同，Content-Type可能包含编码信息，也可以不包含

Returns:

Content-Type值

contentLength

public long contentLength()

Description copied from interface: HttpBody

获取写出字节长度，未知为-1

Returns:

长度