Yumin/Net @ dbc174e4db0fcdd794643621235e19427d3f1a43

本框架使用OkHttp作为请求内核, 使用Kotlin语言扩展OkHttp的函数设计

非常欢迎共同贡献代码

Net支持使用协程发起网络, 当然即使不会协程也可以使用该框架.

建议

禁止写一个函数封装一个请求函数, 如果公司工资不是按行数算钱, 禁止俄罗斯套娃.
Post/Get等函数本身就是高扩展性的请求动作. 你有特殊请求可以在拦截器/转换器处理, 或者使用TAG标签区分请求.
如果想快速改变项目全局的请求URL可以声明为全局常量

使用

这里演示发起网络请求百度网站内容的三个步骤

创建作用域
发起请求
接收数据

=== "单个请求"

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

=== "串行请求"

```kotlin
scopeNetLife {
    val data = Get<String>("http://0000www.baidu.com/").await() // 请求A 发起GET请求并返回数据
    val data = Get<String>("http://www.baidu.com/").await() // 请求B 将等待A请求完毕后发起GET请求并返回数据
}
```

=== "并发请求"

```kotlin
scopeNetLife {
    // 以下两个网络请求属于同时进行中
    val aDeferred = Get<String>("http://www.baidu.com/") // 发起GET请求并返回一个对象(Deferred)表示"任务A"
    val bDeferred = Get<String>("http://www.baidu.com/") // 发起请求并返回"任务B"

    // 随任务同时进行, 但是数据依然可以按序返回
    val aData = aDeferred.await() // 等待任务A返回数据
    val bData = bDeferred.await() // 等待任务B返回数据
}
```

多个网络请求放在同一个作用域内就可以统一控制, 如果你的多个网络请求毫无关联, 你可以创建多个作用域.

当Get或Post等函数调用就会开始发起网络请求, await只是等待其请求成功返回结果, 所以如果你在await后执行的网络请求,这不属于并发(属于串行)

并发的错误示例

scopeNetLife {
    // 请求A
    val aDeferred = Get<String>("http://www.baidu.com/").await()
    // 请求B, 由于上面使用`await()`函数, 所以必须等待A请求返回结果后才会执行B
    val bDeferred = Get<String>("http://www.baidu.com/")

    val bData = bDeferred.await() // 等待任务B返回数据
}

关于JSON解析以及全局URL等初始化配置后面讲解

请求参数

关于请求参数参数

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

JSON请求体

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

=== "JSON键值对(推荐)"

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

scopeNetLife {
    tv_fragment.text = Post<String>("api") {
        json("name" to name, "age" to age, "measurements" to measurements) // 同时也支持Map集合
    }.await()
}
```

=== "JSONObject"

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

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

=== "自定义的body"

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

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

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

可以考虑继承RequestBody来扩展出自己的新的Body(), 然后使用param函数传入请求中.
定义拦截器

RESTFUL

Net支持RestFul设计风格

private fun GET() {
    scopeNetLife {
        tv_fragment.text = Get<String>("http://www.baidu.com/").await()
    }
}

private fun POST() {
    scopeNetLife {
        tv_fragment.text = Post<String>("http://www.baidu.com/").await()
    }
}

private fun HEAD() {
    scopeNetLife {
        tv_fragment.text = Head<String>("http://www.baidu.com/").await()
    }
}

private fun PUT() {
    scopeNetLife {
        tv_fragment.text = Put<String>("http://www.baidu.com/").await()
    }
}

private fun PATCH() {
    scopeNetLife {
        tv_fragment.text = Patch<String>("http://www.baidu.com/").await()
    }
}

private fun DELETE() {
    scopeNetLife {
        tv_fragment.text = Delete<String>("http://www.baidu.com/").await()
    }
}

private fun TRACE() {
    scopeNetLife {
        tv_fragment.text = Trace<String>("http://www.baidu.com/").await()
    }
}

private fun OPTIONS() {
    scopeNetLife {
        tv_fragment.text = Options<String>("http://www.baidu.com/").await()
    }
}

函数

默认在IO线程执行网络请求(通过作用域参数可以控制Dispatch调度器), 要求在协程作用域内执行.

index.md 6.4 KB Historique Raw

建议

使用

请求参数

JSON请求体

RESTFUL

函数

index.md 6.4 KB

Historique Raw