Browse Source

doc: README

drake 2 years ago
parent
commit
802e468ea7
4 changed files with 17 additions and 13 deletions
  1. 11 9
      README.md
  2. 1 1
      docs/cancel.md
  3. 3 3
      docs/index.md
  4. 2 0
      docs/scope.md

+ 11 - 9
README.md

@@ -41,6 +41,7 @@ Welcome to international translation of this project's documents/notes, thank yo
 
 - [x] 开发效率No.1
 - [x] 专为Android而生
+- [x] OkHttp最佳实践
 - [x] 使用高性能Okio
 - [x] 支持OkHttp所有功能/组件
 - [x] 随时升级OkHttp版本保证网络安全性
@@ -52,27 +53,28 @@ Welcome to international translation of this project's documents/notes, thank yo
 - [x] 协程并发(不会协程也可上手)
 - [x] 并发/串行/队列/同步请求
 - [x] 快速切换线程
-- [x] 全局错误处理
+- [x] 全局错误处理(减少崩溃率)
 - [x] 协程作用域支持错误和结束回调
 - [x] 解析任何数据(json/protocol...)的转换器
 - [x] 泛型指定网络请求返回任何类型
 - [x] 自动处理下拉刷新和上拉加载
-- [x] 自动处理分页加载
-- [x] 自动缺省页
-- [x] 自动处理生命周期
-- [x] 自动处理加载对话框
-- [x] 自动错误信息吐司
-- [x] 自动异常捕获(定位请求位置)
+- [x] 自动分页加载
+- [x] 自动显示缺省页
+- [x] 自动显示加载对话框
+- [x] 自动取消请求(生命周期)
+- [x] 自动吐司错误信息
+- [x] 自动捕获异常
 - [x] 支持ViewModel
 - [x] Request携带数据(setExtra/tagOf)
 - [x] Request支持Id/Group分组
-- [x] AS日志插件/应用通知栏日志
+- [x] 日志信息输出(AndroidStudio插件/App通知栏)
 - [x] 并发请求返回最快请求结果
 - [x] 全局取消请求
 - [x] Https快速配置
 - [x] Cookie持久化管理
+- [x] 定时/限时请求
 - [x] 强制缓存模式/自定义缓存Key/缓存有效期/LRU缓存算法/缓存任何数据
-- [x] 缓存+网络双重读取(预览模式实现)
+- [x] 先缓存后网络请求(预览模式)
 - [x] 内置超强轮询器(计时器)
 - [x] 监听上传/下载进度(使用时间, 每秒速度, 剩余时间...)
 

+ 1 - 1
docs/cancel.md

@@ -6,7 +6,7 @@ Net取消协程作用域自动取消内部网络请求, 也支持任意位置取
 ```kotlin
 downloadScope = scopeNetLife {
     // 下载文件
-    val file = Get("download").await()
+    val file = Get<File>("download").await()
 }
 
 downloadScope.cancel() // 取消下载

+ 3 - 3
docs/index.md

@@ -1,15 +1,15 @@
 本框架使用Android主流的Http框架OkHttp作为请求内核, 遵守不影响OkHttp原有的函数组件使用原则开发
 
 <br>
-<p align="center"><strong>非常欢迎共同贡献代码/修订文档, 点击文档右上角小铅笔可直接修订文档 ↗</strong></p>
+<p align="center"><strong>STAR/分享可以让更多人参与到本开源项目, 点击文档右上角小铅笔可直接修订文档 ↗</strong></p>
 <br>
 
 
 ## 前言
 
+1. 任何本文档没有提到的功能都可以通过搜索`"OkHttp如何**"`来解决, 因为本框架支持OkHttp所有功能/组件
 1. 建议创建一个Api.kt的`object`单例类存储所有请求路径常量
-1. `Post/Get等`函数属于请求动作. `scope*`等函数属于作用域, 假设你有某个请求需要重复使用建议封装`请求动作`而不是作用域
-1. Net使用目前最先进的协程并发网络, 不会协程也可以使用本框架
+1. `Post/Get等`函数属于请求动作. `scope**`等函数属于作用域, 假设你有某个请求需要重复使用建议封装`请求动作`而不是作用域
 1. 如果你觉得文档看不懂或者有歧义那肯定是作者问题, 请反馈给作者或者自我修订
 
 

+ 2 - 0
docs/scope.md

@@ -2,6 +2,8 @@
 
 本质上Net的请求动作函数返回的是一个Deferred对象. 可以在任何协程作用域内执行. 但是考虑到完整的生命周期和错误处理等推荐使用Net内部定义的作用域.
 
+> 发生在Net作用域内的任何异常都会被捕获, 有效减少应用崩溃率. 如果配合[kotlin-serialization](kotlin-serialization.md)还可以解决因服务器返回null字段导致的崩溃
+
 ## 异步任务的作用域
 
 创建可以捕捉异常的协程作用域, 但是不会触发`NetErrorHandler`(全局错误处理者). 该作用域于一般用于普通的异步任务