配置

httpClient是提供的http相关帮助类(v1.9.0+)


主要方法

方法 返回值 描述 示例
cookieStore() cookieStore 获取cookie管理器 httpClient.cookieStore()
request() request 创建request httpClient.request()
delete() request 创建request,并设置methodDELETE httpClient.delete()
delete(str) request 创建request,并设置methodDELETE、设置url httpClient.delete("http://www.easyyapi.com")
get() request 创建request,并设置methodGET httpClient.get()
get(str) request 创建request,并设置methodGET、设置url httpClient.get("http://www.easyyapi.com")
options() request 创建request,并设置methodOPTIONS httpClient.options()
options(str) request 创建request,并设置methodOPTIONS、设置url httpClient.options("http://www.easyyapi.com")
post() request 创建request,并设置methodPOST httpClient.post()
post(str) request 创建request,并设置methodPOST、设置url httpClient.post("http://www.easyyapi.com")
put() request 创建request,并设置methodPUT httpClient.put()
put(str) request 创建request,并设置methodPUT、设置url httpClient.put("http://www.easyyapi.com")
trace() request 创建request,并设置methodTRACE httpClient.trace()
trace(str) request 创建request,并设置methodTRACE、设置url httpClient.trace("http://www.easyyapi.com")

request

  • 可以由httpClient创建

主要方法有:

方法 返回值 描述 示例
call() response 发起http请求 request.call()
method() string 获取当前请求的method request.method()
method(string) request 设置当前请求的method request.method("POST")
url() string 获取当前请求的url request.url()
url(string) request 设置当前请求的url request.url("http://www.easyyapi.com")
body() object 获取当前请求体 request.body()
body(object) request 设置当前请求体 request.body({"name":"admin"})
contentType() string 获取当前请求的Content-type request.contentType()
contentType(string) string 设置当前请求的Content-type request.contentType("application/json")
querys() request 获取所有的query参数 request.querys()
query(string, string) request 设置query(请求时将被追加在url后) request.query("name","Tom")
params() array<param> 获取所有参数 request.params()
params(string) array<param> 获取指定参数名的所有参数 request.params("name")
containsParam(string) bool 判断当前请求是否有指定请求参数 request.containsParam("name")
fileParam(string, string) request 设置一个文件参数 request.fileParam("file","/xxx/xxx/xxxx.xxx")
firstParam(string) param 获取第一个请求参数(注意返回值是param,包含参数名/参数值/参数类型[text/file]) request.firstParam("name")
firstParamValue(string) param 获取第一个请求参数值 request.firstParamValue("name")
lastParam(string) param 获取最后一个请求参数(注意返回值是param,包含参数名/参数值/参数类型[text/file]) request.lastParam("name")
lastParamValue(string) param 获取最后一个请求参数值 request.lastParamValue("name")
param(string, string) request 设置param request.param("name","Tom")
paramValues(string) array<string> 获取指定参数所有值 request.paramValues("name")
header(string, string) request 设置header request.header("Content-type","application/json")
headers() array<header> 获取所有的header request.headers()
headers(string) array<string> 获取指定header所有值 request.headers("Content-type")
containsHeader(string) bool 判断当前请求是否有指定header request.containsHeader("token")
firstHeader(string) string 获取第一个header参数 request.firstHeader("Content-type")
lastHeader(string) string 获取最后一个header参数 request.lastHeader("Content-type")
setHeader(string, string) request 移除当前header名称的所有值,并设置header request.setHeader("Content-type","application/json")
removeHeader(string, string) request 移除指定header名称的指定值 request.removeHeader("Content-type","application/json")
removeHeaders(string) request 移除当前header名称的所有值 request.removeHeaders("Content-type")

response

  • 可以由request.call()得到

主要方法有:

方法 返回值 描述 示例
discard() void 丢弃这次请求的结果, 重新发起此请求 response.discard()
code() int 响应code response.code()
string() string 响应内容 response.string()
contentType() string 响应的contentType response.contentType()
headers() array<header> 获取所有的header response.headers()
headers(string) array<string> 获取指定header所有值 response.headers("Content-type")
containsHeader(string) bool 判断当前响应是否有指定header response.containsHeader("token")
firstHeader(string) string 获取第一个header参数 response.firstHeader("Content-type")
lastHeader(string) string 获取第一个header参数 response.lastHeader("Content-type")
request() request 获取得到此响应的request response.request()

cookieStore

  • 可以由httpClient.cookieStore()获得

主要方法有:

方法 返回值 描述 示例
addCookie(cookie) void 添加一个cookie httpClient.cookieStore().addCookie(cookie)
addCookies(cookies) void 添加多个cookie httpClient.cookieStore().addCookies(cookies)
clear() void 清除cookie httpClient.cookieStore().clear()
cookies() array<cookie> 获得当前的cookies httpClient.cookieStore().cookies()
newCookie() cookie 创建一个cookie,注意:并不会自动添加到cookieStore中, 需要手动调用addCookie加入 httpClient.cookieStore().newCookie()