Net/docs/scope.md

协程请求要求在协程的作用域中调用, 这里介绍如何创建不同的作用域获取不同的功能

本质上Net的请求动作函数返回的是一个Deferred对象. 可以在任何协程作用域内执行. 但是考虑到完整的生命周期和错误处理等推荐使用Net内部定义的作用域.

发生在Net作用域内的任何异常都会被捕获, 有效减少应用崩溃率. 如果配合kotlin-serialization还可以解决因服务器返回null字段导致的崩溃

异步任务的作用域

创建可以捕捉异常的协程作用域, 但是不会触发NetErrorHandler(全局错误处理者). 该作用域于一般用于普通的异步任务

|函数|描述| |-|-| |scope|创建最基础的作用域, 所有作用域都包含异常捕捉| |scopeLife|创建跟随生命周期取消的作用域| |ViewModel.scopeLife|创建跟随ViewModel生命周期的作用域, 如何在ViewModel创建作用域|

网络请求的作用域

网络请求的作用域可以根据生命周期自动取消网络请求, 发生错误也会自动弹出吐司(可以自定义或者取消), 并且具备一些场景的特殊功能(例如加载对话框, 缺省页, 下拉刷新等)

网络请求的作用域比上面提到的异步任务的作用域多的区别就是

1. 发生错误会触发全局错误处理NetErrorHandler
2. 具备一些特殊场景功能, 比如自动下拉刷新, 自动显示加载库等

| 函数 | 描述 | |-|-| |scopeNet|创建自动处理网络错误的作用域| |scopeNetLife|创建自动处理网络错误的作用域, 且包含跟随Activity或者Fragment生命周期| |scopeDialog|创建自动加载对话框的作用域, 生命周期跟随对话框| |ViewModel.scopeNetLife|创建跟随ViewModel生命周期的作用域, 如何在ViewModel创建作用域| |PageRefreshLayout.scope|创建跟随PageRefreshLayout生命周期的作用域| |StateLayout.scope|创建跟随StateLayout生命周期的作用域|

PageRefreshLayout/StateLayout 属于BRV框架中的布局, 用于支持自动化缺省页/下拉刷新

如果想了解详细的协程使用方式, 可以查看一篇文章: 最全面的Kotlin协程: Coroutine/Channel/Flow 以及实际应用

有时候可能面临嵌套的scope*函数或者作用域内有子作用域情况, 这个时候的生命周期是如何

嵌套Scope

scopeNet {
    val task = Post<String>("api0").await()

    scopeNet {
        val task = Post<String>("api0").await() // 此时发生请求错误
    }.catch {
        // A
    }
}.catch {
    // B
}

• 以下嵌套作用域错误将会仅发生在A处, 并被捕获, 同时不影响外部scopeNet的请求和异常捕获
• 两个scopeNet的异常抛出和捕获互不影响
• scopeNet/scopeDialog/scope等函数同理

子作用域

scopeNet {
    val await = Post<String>("api").await()

    launch {
       val task = Post<String>("api0").await()  // 此时发生请求错误
    }.invokeOnCompletion {
        // A
    }
}.catch {
     // B
}

• 这种情况 先执行A然后执行B, 并且都能捕获异常.
• 同时scopeNet发生错误也会导致launch内的请求被取消, launch发生错误也会导致scopeNet发生错误