com.luckyframework.httpclient.core

接口 RequestParameter

所有已知子接口:

Request

所有已知实现类:

DefaultRequest, DefaultRequestParameter

public interface RequestParameter

请求参数

• Url Parameter:
  该类型参数使用(Map)进行封装，最终会以字符串的形式拼接到URL中.
  eg:
  URL : http://localhost:8864/lucky
  Url Parameter: [name=Jack,id=123]
  ==>
  http://localhost:8864/lucky?name=Jack&id=123
• Rest Parameter:
  该类型参数使用(Map)进行封装，主要用来填充URL中的Rest占位符.
  eg:
  URL : http://localhost:8864/lucky/{name}?id={id}
  Url Parameter: [name=Jack,id=123]
  ==>
  http://localhost:8864/lucky/Jack?id=123
• Request Parameter:
  该类型参数使用(Map)进行封装，用来添加一些表单参数，支持的数据类型有如下几种：
  1.File表示的单个文件
  2.File[]表示的多个文件
  3.MultipartFile表示的单个文件
  4.MultipartFile[]表示的多个文件
  5.HttpFile表示的单个文件
  6.HttpFile[]表示的多个文件
  5.Resource表示的单个文件
  6.Resource[]表示的多个文件
  5.其他类型的Value都将会被当作字符串来处理
• Body Parameter:
  该类型参数使用(BodyObject)进行封装,该参数最终会被放入请求体中。

版本:

1.0.0

作者:

fk7075

方法概要

限定符和类型	方法和说明
default RequestParameter	addFiles(String name, File... files) 添加一组文件参数
default RequestParameter	addFiles(String name, String... filePaths) 添加一组文件参数
default RequestParameter	addFormParameter(String name, Object value) 添加一个表单参数
default RequestParameter	addHttpFiles(String name, HttpFile... httpFiles) 添加一个组Http文件参数
default RequestParameter	addInputStream(String name, String fileName, InputStream inputStream) 添加一个流式参数
default RequestParameter	addMultipartFiles(String name, com.luckyframework.io.MultipartFile... multipartFiles) 添加一组MultipartFile参数
RequestParameter	addPathParameter(String name, Object value) 添加一个Rest参数
RequestParameter	addQueryParameter(String name, Object value) 添加一个URL参数
RequestParameter	addRequestParameter(String name, Object value) 添加一个请求参数
default RequestParameter	addResources(String name, org.springframework.core.io.Resource... resources) 添加一组资源参数
default RequestParameter	addResources(String name, String... resourcePaths) 添加一组资源参数
BodyObject	getBody() 返回请求体参数
Map<String,Object>	getPathParameters() rest风格参数，在URL中以占位符形式的存在的参数
Map<String,List<Object>>	getQueryParameters() URL参数，这些参数将以字符串的形式拼接到URL中
Map<String,Object>	getRequestParameters() 请求的参数
RequestParameter	removerPathParameter(String name) 移除一个Rest参数
RequestParameter	removerQueryParameter(String name) 移除一个URL参数
RequestParameter	removerQueryParameter(String name, int index) 移除指定位置处的URL参数
RequestParameter	removerRequestParameter(String name) 移除一个请求参数
RequestParameter	setBody(BodyObject body) 设置请求体参数
default RequestParameter	setJsonBody(Object jsonBody) 设置一个JSON类型的Body参数
default RequestParameter	setJsonBody(String jsonBodyString) 设置一个JSON类型的Body参数
RequestParameter	setPathParameter(Map<String,Object> pathParamMap) 设置请求参数
RequestParameter	setQueryParameter(String name, Object value) 设置一个URL参数
RequestParameter	setQueryParameters(Map<String,List<Object>> queryParameters)
RequestParameter	setRequestParameter(Map<String,Object> requestParamMap) 设置请求参数
default RequestParameter	setXmlBody(Object xmlBody) 设置一个XML类型的Body参数
default RequestParameter	setXmlBody(String xmlBodyString) 设置一个JSON类型的Body参数

方法详细资料

getRequestParameters

Map<String,Object> getRequestParameters()

请求的参数

getPathParameters

Map<String,Object> getPathParameters()

rest风格参数，在URL中以占位符形式的存在的参数

getQueryParameters

Map<String,List<Object>> getQueryParameters()

URL参数，这些参数将以字符串的形式拼接到URL中

setBody

RequestParameter setBody(BodyObject body)

设置请求体参数

getBody

BodyObject getBody()

返回请求体参数

addPathParameter

RequestParameter addPathParameter(String name,
                                  Object value)

添加一个Rest参数

setPathParameter

RequestParameter setPathParameter(Map<String,Object> pathParamMap)

设置请求参数

addRequestParameter

RequestParameter addRequestParameter(String name,
                                     Object value)

添加一个请求参数

setRequestParameter

RequestParameter setRequestParameter(Map<String,Object> requestParamMap)

设置请求参数

addQueryParameter

RequestParameter addQueryParameter(String name,
                                   Object value)

添加一个URL参数

setQueryParameter

RequestParameter setQueryParameter(String name,
                                   Object value)

设置一个URL参数

setQueryParameters

RequestParameter setQueryParameters(Map<String,List<Object>> queryParameters)

removerRequestParameter

RequestParameter removerRequestParameter(String name)

移除一个请求参数

removerPathParameter

RequestParameter removerPathParameter(String name)

移除一个Rest参数

removerQueryParameter

RequestParameter removerQueryParameter(String name)

移除一个URL参数

removerQueryParameter

RequestParameter removerQueryParameter(String name,
                                       int index)

移除指定位置处的URL参数

addFormParameter

default RequestParameter addFormParameter(String name,
                                          Object value)

添加一个表单参数

参数:

name - 参数名

value - 参数值

addHttpFiles

default RequestParameter addHttpFiles(String name,
                                      HttpFile... httpFiles)

添加一个组Http文件参数

参数:

name - 参数名

httpFiles - Http文件列表

addInputStream

default RequestParameter addInputStream(String name,
                                        String fileName,
                                        InputStream inputStream)

添加一个流式参数

参数:

name - 参数名

fileName - 文件名

inputStream - 输入流

addFiles

default RequestParameter addFiles(String name,
                                  File... files)

添加一组文件参数

参数:

name - 参数名

files - 文件列表

addFiles

default RequestParameter addFiles(String name,
                                  String... filePaths)

添加一组文件参数

参数:

name - 参数名

filePaths - 文件路径列表

addResources

default RequestParameter addResources(String name,
                                      org.springframework.core.io.Resource... resources)

添加一组资源参数

参数:

name - 参数名

resources - 资源列表

addResources

default RequestParameter addResources(String name,
                                      String... resourcePaths)

添加一组资源参数

参数:

name - 参数名

resourcePaths - 资源路径列表

addMultipartFiles

default RequestParameter addMultipartFiles(String name,
                                           com.luckyframework.io.MultipartFile... multipartFiles)

添加一组MultipartFile参数

参数:

name - 参数名

multipartFiles - MultipartFile参数列表

setJsonBody

default RequestParameter setJsonBody(Object jsonBody)

设置一个JSON类型的Body参数

参数:

jsonBody - 可序列化为JSON字符的对象

setJsonBody

default RequestParameter setJsonBody(String jsonBodyString)

设置一个JSON类型的Body参数

参数:

jsonBodyString - JSON字符串

setXmlBody

default RequestParameter setXmlBody(Object xmlBody)

设置一个XML类型的Body参数

参数:

xmlBody - 可序列化为XML字符的对象

setXmlBody

default RequestParameter setXmlBody(String xmlBodyString)

设置一个JSON类型的Body参数

参数:

xmlBodyString - XML字符串