Yumin/Net @ b002bacad50dcfaeacddc8fc15904a459d668fdc

本框架使用Android主流的Http框架OkHttp作为请求内核, 遵守不影响OkHttp原有的函数组件使用原则开发

STAR/分享可以让更多人参与到本开源项目, 点击文档右上角小铅笔可直接修订文档 ↗

前言

任何本文档没有提到的功能都可以通过搜索"OkHttp如何**"来解决, 因为本框架支持OkHttp所有功能/组件
建议创建一个Api.kt的object单例类存储所有请求路径常量
Post/Get等函数属于请求动作. scope**等函数属于作用域, 假设你有某个请求需要重复使用建议封装请求动作而不是作用域
如果你觉得文档看不懂或者有歧义那肯定是作者问题, 请反馈给作者或者自我修订

使用

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

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

=== "单个请求"

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

=== "串行请求"

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

=== "并发请求"

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

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

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

多进程或Xposed项目要求初始化

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

并发的错误示例

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

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

返回结果

返回结果支持的数据类型(即Post等函数的泛型)由转换器决定, 默认支持以下类型

非以上类型要求自定义转换器

转换器的返回值决定你的网络请求的返回结果类型, 你甚至可以返回null, 前提是泛型为可空类型

RestFul

Net支持RestFul设计风格

scopeNetLife {
    tvFragment.text = Get<String>("https://github.com/liangjingkanji/Net/").await()
    tvFragment.text = Post<String>("https://github.com/liangjingkanji/Net/").await()
    tvFragment.text = Head<String>("https://github.com/liangjingkanji/Net/").await()
    tvFragment.text = Put<String>("https://github.com/liangjingkanji/Net/").await()
    tvFragment.text = Patch<String>("https://github.com/liangjingkanji/Net/").await()
    tvFragment.text = Delete<String>("https://github.com/liangjingkanji/Net/").await()
    tvFragment.text = Trace<String>("https://github.com/liangjingkanji/Net/").await()
    tvFragment.text = Options<String>("https://github.com/liangjingkanji/Net/").await()
}

函数

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

index.md 4.8 KB Historia Czysty

前言

使用

返回结果

RestFul

函数

index.md 4.8 KB

Historia Czysty