请求参数

Net中关于请求的类只有两个类和他们共同的抽象父类

BaseRequest
    |- UrlRequest
    |- BodyRequest

根据请求方法不同使用的Request也不同

GET, HEAD, OPTIONS, TRACE, // Url request
POST, DELETE, PUT, PATCH // Body request

代码示例

scopeNetLife {
    Get<String>("api") {
        // this 即为 UrlRequest
    }.await()

    Post<String>("api") {
        // this 即为 BodyRequest
    }.await()
}

请求参数¶

scopeNetLife { // 创建作用域
    // 这个大括号内就属于作用域内部
    val data = Get<String>("http://www.baidu.com/"){
        param("u_name", "drake")
        param("pwd", "123456")
    }.await() // 发起GET请求并返回`String`类型数据
}

请求函数	描述
`param`	支持基础类型/文件/RequestBody/Part
`json`	请求参数为JSONObject/JsonArray/String
`setQuery`	Url参数, 如果当前请求为Url请求则该函数等效于`param`函数

如果没有添加文件/流那么就是通过BodyRequest内部的FormBody发起请求. 反之就是通过MultipartBody发起请求.

当然你可以完全自定义Body来请求, 譬如以下的Json请求

Json请求¶

这里提供三种创建Json请求的示例代码. 酌情选用

JSON键值对(推荐)

val name = "金城武"
val age = 29
val measurements = listOf(100, 100, 100)

scopeNetLife {
    tvFragment.text = Post<String>("api") {
        // 只支持基础类型的值, 如果值为对象或者包含对象的List会导致其值为null
        json("name" to name, "age" to age, "measurements" to measurements)
    }.await()
}

JSONObject

val name = "金城武"
val age = 29
val measurements = listOf(100, 100, 100)

scopeNetLife {
    tvFragment.text = Post<String>("api") {
        json(JSONObject().run {
            put("name", name)
            put("age", age)
            put("measurements", JSONArray(measurements))
        })
    }.await()
}

自定义的body

val name = "金城武"
val age = 29
val measurements = listOf(100, 100, 100)

scopeNetLife {
    tvFragment.text = Post<String>("api") {
        body = MyJsonBody(name, age, measurements)
    }.await()
}

对于某些可能JSON请求参数存在固定值:

可以考虑继承RequestBody来扩展出自己的新的Body对象, 然后赋值给body字段
添加请求拦截器RequestInterceptor

自定义请求函数¶

前面提到json(Pair<String, Any?>)函数不支持对象值, 因为框架内部使用的org.json.JSONObject其不支持映射对象字段

这里可以创建扩展函数来支持你想要的Json解析框架, 比如以下常用的Json解析框架示例

Gson

fun BodyRequest.gson(vararg body: Pair<String, Any?>) {
    this.body = Gson().toJson(body.toMap()).toRequestBody(MediaConst.JSON)
}

FastJson

fun BodyRequest.fastJson(vararg body: Pair<String, Any?>) {
    this.body = JSON.toJSON(body.toMap()).toRequestBody(MediaConst.JSON)
}

使用

scopeNetLife {
    tvFragment.text = Post<String>("api") {
        gson("name" to name, "model" to Model() // 参数支持Gson可解析的对象
        // fastJson("name" to name, "model" to Model() // 使用FastJson
    }.await()
}

举一反三可以创建其他功能自定义的请求函数
扩展函数要求为顶层函数, 即直接在文件中 (kotlin基础语法)

请求函数¶

关于全部的请求配置选项推荐阅读函数文档或者阅读源码. Net提供清晰的函数结构浏览方便直接阅读源码