sdk/com.m8test.script.core.api.http.client/HttpClient

HttpClient

interface HttpClient : ScriptCloseable, ScriptContextual

用于执行 HTTP 和 WebSocket 请求的异步客户端。

这是进行网络通信的核心接口。它提供了 get、post 等便捷方法，以及一个高度可定制的 request 方法来满足各种复杂请求的需求。所有网络操作都是 非阻塞的，并返回一个 Deferred 对象，代表未来的计算结果。

Author

M8Test, [email protected], https://m8test.com

Functions

abstract override fun close()

关闭当前对象, 如果没有调用本方法则会报错, 当然本方法由系统调用, 不需要手动调用.

get

abstract fun get(scope: CoroutineScope, urlString: String, queryParametersJson: Map<String, String>?, requestBuilder: HttpClientRequest.() -> Unit?): Deferred<HttpClientResponse>

异步发起一个 HTTP GET 请求。

getContext

abstract fun getContext(): ScriptContext

获取脚本上下文对象 ScriptContext.

getCookies

abstract fun getCookies(scope: CoroutineScope, url: String): Deferred<List<HttpCookie>>

异步获取指定 URL 的 Cookie 存储。

isClosed

abstract fun isClosed(): Boolean

判断当前对象是否已经调用了 close 方法.

post

abstract fun post(scope: CoroutineScope, url: String, urlencodedBodyJson: Map<String, String>?, requestBuilder: HttpClientRequest.() -> Unit?): Deferred<HttpClientResponse>

异步发起一个 HTTP POST 请求，发送 application/x-www-form-urlencoded 类型的数据。这常用于提交网页表单。

postJson

abstract fun postJson(scope: CoroutineScope, url: String, json: String?, requestBuilder: HttpClientRequest.() -> Unit?): Deferred<HttpClientResponse>

异步发起一个 HTTP POST 请求，发送 JSON 格式的数据。 Content-Type 头将自动设置为 application/json。

postMultipart

abstract fun postMultipart(scope: CoroutineScope, url: String, multipartBuilder: HttpClientMultipart.() -> Unit, requestBuilder: HttpClientRequest.() -> Unit?): Deferred<HttpClientResponse>

异步发起一个 HTTP POST 请求，发送 multipart/form-data 类型的数据。这通常用于文件上传或包含混合内容的表单。

prepareGet

abstract fun prepareGet(scope: CoroutineScope, urlString: String, queryParametersJson: Map<String, String>?, requestBuilder: HttpClientRequest.() -> Unit?): Deferred<HttpStatement>

准备一个 HTTP GET 请求以供后续执行，但不立即发送。

preparePost

abstract fun preparePost(scope: CoroutineScope, url: String, urlencodedBodyJson: Map<String, String>?, requestBuilder: HttpClientRequest.() -> Unit?): Deferred<HttpStatement>

准备一个 application/x-www-form-urlencoded 类型的 HTTP POST 请求以供后续执行。

preparePostJson

abstract fun preparePostJson(scope: CoroutineScope, url: String, json: String?, requestBuilder: HttpClientRequest.() -> Unit?): Deferred<HttpStatement>

准备一个发送 JSON 数据的 HTTP POST 请求以供后续执行。 Content-Type 头将自动设置为 application/json。

preparePostMultipart

abstract fun preparePostMultipart(scope: CoroutineScope, url: String, multipartBuilder: HttpClientMultipart.() -> Unit, requestBuilder: HttpClientRequest.() -> Unit?): Deferred<HttpStatement>

准备一个 multipart/form-data 类型的 HTTP POST 请求以供后续执行。

prepareRequest

abstract fun prepareRequest(scope: CoroutineScope, urlString: String, requestBuilder: HttpClientRequest.() -> Unit?): Deferred<HttpStatement>

准备一个高度可定制的 HTTP 请求以供后续执行。

request

abstract fun request(scope: CoroutineScope, urlString: String, requestBuilder: HttpClientRequest.() -> Unit?): Deferred<HttpClientResponse>

异步发起一个高度可定制的 HTTP 请求。

webSocket

abstract fun webSocket(scope: CoroutineScope, url: String, request: HttpClientRequest.() -> Unit?, webSocketSessionBuilder: WebSocketSession.() -> Unit): Job

建立一个 WebSocket 连接。