Browse Source

doc: 文档更新

drake 1 year ago
parent
commit
d942da595c
5 changed files with 22 additions and 14 deletions
  1. 9 4
      docs/cache.md
  2. 2 0
      docs/converter.md
  3. 1 1
      docs/default-response.md
  4. 2 1
      docs/repeat-request.md
  5. 8 8
      mkdocs.yml

+ 9 - 4
docs/cache.md

@@ -1,10 +1,16 @@
+**网络请求中缓存至关重要, 而Net是最好的**
+
+1. 页面秒开
+2. 减少服务器压力
+3. 无网络可用
+
+### Net缓存特点
 
 1. 缓存任何请求方式, POST/GET/PUT/HEAD...
 2. 缓存任何数据类型, File/图片/JSON/ProtoBuf/...
 3. 限制最大缓存体积, 缓存遵守磁盘LRU缓存算法, 当缓存达到限制时, 将会删除最近最少使用的缓存
 4. 高性能DiskLruCache来实现统一缓存
 
-
 ## 配置缓存
 
 不配置缓存设置是不会触发缓存的
@@ -67,10 +73,9 @@ scopeNetLife {
 
 > 如果`response.cacheResponse`不为null的时候即代表response来自于本地缓存, 强制缓存或Http缓存协议都如此
 
-
 ## 自定缓存Key
 
-缓存Key默认是`请求方式+URL`后产生的sha1值, 所以并不会使用请求参数判断(综合考虑都不适用)
+缓存Key默认是`请求方式+URL`后产生的sha1值(仅强制缓存模式有效), 并不会默认使用请求参数判断
 
 如果你要实现区别请求参数的缓存请自定义缓存key, 如下
 
@@ -99,7 +104,7 @@ scopeNetLife {
 }
 ```
 
-## 缓存+网络
+## 预览(缓存+网络)
 
 这里可以用到Net的预览模式(preview)来实现, 其实不仅仅是预览缓存也可以用于回退请求
 

+ 2 - 0
docs/converter.md

@@ -116,6 +116,7 @@ scopeNetLife {
     
         override fun <R> onConvert(succeed: Type, response: Response): R? {
             try {
+            	// 此处是为了继承默认转换器支持的返回类型
                 return NetConverter.onConvert<R>(succeed, response)
             } catch (e: ConvertException) {
                 val code = response.code
@@ -222,6 +223,7 @@ scopeNetLife {
 
         override fun <R> onConvert(succeed: Type, response: Response): R? {
             try {
+    			// 此处是为了继承默认转换器支持的返回类型
                 return NetConverter.onConvert<R>(succeed, response)
             } catch (e: ConvertException) {
                 val code = response.code

+ 1 - 1
docs/default-converter.md → docs/default-response.md

@@ -2,7 +2,7 @@ Net支持请求返回的数据类型取决于你自己的转换器实现(即理
 
 # Get<任何对象>("path").await()
 
-默认情况下支持返回以下数据类型
+如果不自定义转换器默认支持返回以下数据类型
 
 | 函数 | 描述 |
 |-|-|

+ 2 - 1
docs/unique.md → docs/repeat-request.md

@@ -21,4 +21,5 @@ btn_request.setOnClickListener {
 
 当`scope`不为空时即表示存在上个请求, 我们无论上个请求是否完成都调用`cancel`函数保证取消即可
 
-> 详细的关于取消网络请求的操作查看: [取消请求](cancel.md)
+> 详细的关于取消网络请求的操作查看: [取消请求](cancel.md) <br>
+> 可以限制部分重复请求一定时间内读取缓存: [缓存有效期](/cache/#_3)

+ 8 - 8
mkdocs.yml

@@ -41,11 +41,11 @@ nav:
   - 请求参数: request.md
   - 全局配置: config.md
   - 请求结果:
-      - 默认转换器: default-converter.md
+      - 默认结果: default-response.md
       - 自定义转换器: converter.md
-      - 特殊结构解析: convert-special.md
-      - kotlin-serialization: kotlin-serialization.md
-      - 数据模型生成插件: model-generate.md
+      - 自定义结构解析: convert-special.md
+      - Kotlin-Serialization: kotlin-serialization.md
+      - 数据生成插件: model-generate.md
   - 自动化:
       - 自动加载框: auto-dialog.md
       - 自动缺省页: auto-state.md
@@ -59,19 +59,19 @@ nav:
       - 单例错误捕获: error-single.md
       - 全局错误捕获: error-global.md
       - 自定义错误提示: error-tip.md
-      - 自定义异常: error-exception.md
+      - 自定义异常抛出: error-exception.md
   - OkHttpClient: okhttp-client.md
   - 拦截器: interceptor.md
   - Https证书: https.md
-  - Cookie管理: cookie.md
+  - Cookie: cookie.md
   - 缓存: cache.md
   - 标签/额外数据: tag.md
   - 上传文件: upload-file.md
   - 下载文件: download-file.md
   - 进度监听: progress.md
   - 取消请求: cancel.md
-  - 重复请求: unique.md
-  - 自动搜索/筛选: debounce.md
+  - 重复请求: repeat-request.md
+  - 自动搜索: debounce.md
   - 最快请求结果: fastest.md
   - 日志插件: log-recorder.md
   - 通知栏日志: log-notice.md