Browse Source

更新文档

drake 4 years ago
parent
commit
42bb0580bd
2 changed files with 18 additions and 34 deletions
  1. 2 6
      README.md
  2. 16 28
      docs/read-cache.md

+ 2 - 6
README.md

@@ -27,13 +27,9 @@ Android上不是最强网络任务库, 创新式的网络请求库(基于Kalle/O
 
 <br>
 
-
-
 Net 1.x 版本为RxJava实现 <br>
 Net 2.x 版本为协程实现(开发者无需掌握协程也可以使用)
 
-
-
 正在进行的任务
 
 - OkHttp4.8 重构
@@ -108,8 +104,8 @@ allprojects {
 
 ```groovy
 // 协程库(版本自定)
-implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-core:1.3.7'
-implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-android:1.3.7'
+implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-core:1.3.9'
+implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-android:1.3.9'
 
 // 支持自动下拉刷新和缺省页的(可选)
 implementation 'com.github.liangjingkanji:BRV:1.3.14'

+ 16 - 28
docs/read-cache.md

@@ -1,6 +1,7 @@
 Net_v2基于[Kalle](https://github.com/yanzhenjie/Kalle)开发, 支持Kalle的9种缓存模式
 
 缓存模式要求在初始化的时候开启
+
 ```kotlin
 initNet("http://182.92.97.186/") {
     cacheEnabled() // 开启缓存
@@ -16,6 +17,7 @@ initNet("http://182.92.97.186/") {
     }
     ```
 === "读取缓存然后请求网络"
+
     ```kotlin
     scopeNetLife {
         // 然后执行这里(网络请求)
@@ -41,33 +43,19 @@ initNet("http://182.92.97.186/") {
 
 缓存模式属于`CacheMod`枚举, 建议开发者浏览缓存模式的源码和注释,有助于理解和更好的使用缓存模式。
 
-1. `HTTP` Http标准模式;
-<br>发起请求前如果本地已经有缓存,会检查缓存是否过期,如果没过期则返回缓存数据,如果过期则带上缓存头去服务器做校验。如果服务器响应304则返回缓存数据,如果响应其它响应码则读取服务器数据,并根据服务器响应头来决定是否缓存数据到本地。如果请求失败则是正常失败。
-
-1. `HTTP_YES_THEN_WRITE_CACHE` 先Http标准协议再写入缓存;
-<br>发起请求前如果本地已经有缓存则带缓存头,在有缓存的时候,服务器可能响应304,则返回缓存数据,如果服务器响应其它响应码,则读取服务器数据,并把请求成功后的数据缓存到本地。如果请求失败则是正常失败。
-
-1. `NETWORK` 仅仅请求网络;
-<br>发起请求前不管本地是否有缓存,都不会带上缓存头,请求成功后,不论服务器响应头如何,都不会缓存数据到本地。如果请求失败则是正常失败。
-
-1. `NETWORK_YES_THEN_HTTP` 先仅仅网络再按照Http标准协议;
-<br>发起请求前不管本地是否有缓存,都不会带上缓存头,请求成功后根据服务器响应头来决定是否缓存数据到本地。如果请求失败则是正常失败。
-
-1. `NETWORK_YES_THEN_WRITE_CACHE` 先仅仅网络再写入缓存;
-<br>发起请求前不管本地是否有缓存,都不会带上缓存头,请求成功后会把数据缓存到本地。如果请求失败则是正常失败。
-
-1. `NETWORK_NO_THEN_READ_CACHE` 先仅仅网络,失败后读取缓存;
-<br>发起请求前不管本地是否有缓存,都不会带上缓存头,请求成功后正常返回,请求失败后尝试读取缓存,如果缓存不存在则继续按照之前失败的流程走,如果缓存存在则正常返回缓存。
-
-1. `READ_CACHE `仅仅读取缓存;
-<br>只是去读取缓存,如果缓存不存在则会失败,如果缓存存在就返回缓存。
-
-1. `READ_CACHE_NO_THEN_NETWORK` 先读取缓存,缓存不存在再请求网络;
-<br>先尝试读取缓存,如果缓存存在就返回缓存,如果缓存不存在就请求网络,请求成功后不论服务器响应头如何都不存缓存数据。如果请求失败则是正常失败。
-
-1. `READ_CACHE_NO_THEN_HTTP` 先读取缓存,缓存不存在再;
-<br>先尝试读取缓存,如果缓存存在就返回缓存,如果缓存不存在就请求网络,请求成功后根据服务器响应头来决定是否缓存数据到本地。如果请求失败则是正常失败。
+| 常量                           | 作用                             | 描述                                                         |
+| ------------------------------ | -------------------------------- | ------------------------------------------------------------ |
+| `HTTP`                         | Http标准模式                     | 发起请求前如果本地已经有缓存,会检查缓存是否过期,<br />如果没过期则返回缓存数据,如果过期则带上缓存头去服务器做校验。<br />如果服务器响应304则返回缓存数据,如果响应其它响应码则读取服务器数据,并根据服务器响应头来决定是否缓存数据到本地。如果请求失败则是正常失败。 |
+| `HTTP_YES_THEN_WRITE_CACHE`    | 先Http标准协议再写入缓存         | 发起请求前如果本地已经有缓存则带缓存头,在有缓存的时候,服务器可能响应304,则返回缓存数据,如果服务器响应其它响应码,则读取服务器数据,并把请求成功后的数据缓存到本地。如果请求失败则是正常失败。 |
+| `NETWORK`                      | 仅仅请求网络                     | 发起请求前不管本地是否有缓存,都不会带上缓存头,请求成功后,不论服务器响应头如何,都不会缓存数据到本地。如果请求失败则是正常失败 |
+| `NETWORK_YES_THEN_HTTP`        | 先仅仅网络再按照Http标准协议     | 发起请求前不管本地是否有缓存,都不会带上缓存头,请求成功后根据服务器响应头来决定是否缓存数据到本地。如果请求失败则是正常失败 |
+| `NETWORK_YES_THEN_WRITE_CACHE` | 先仅仅网络再写入缓存             | 发起请求前不管本地是否有缓存,都不会带上缓存头,请求成功后会把数据缓存到本地。如果请求失败则是正常失败。 |
+| `NETWORK_NO_THEN_READ_CACHE`   | 先仅仅网络,失败后读取缓存       | 发起请求前不管本地是否有缓存,都不会带上缓存头,请求成功后正常返回,请求失败后尝试读取缓存,如果缓存不存在则继续按照之前失败的流程走,如果缓存存在则正常返回缓存 |
+| `READ_CACHE `                  | 仅仅读取缓存                     | 仅读取缓存                                                   |
+| `READ_CACHE_NO_THEN_NETWORK`   | 先读取缓存,缓存不存在再请求网络 | 先尝试读取缓存,如果缓存存在就返回缓存,如果缓存不存在就请求网络,请求成功后不论服务器响应头如何都不存缓存数据。如果请求失败则是正常失败。 |
+| `READ_CACHE_NO_THEN_HTTP`      | 先读取缓存,缓存不存在再         | 先尝试读取缓存,如果缓存存在就返回缓存,如果缓存不存在就请求网络,请求成功后根据服务器响应头来决定是否缓存数据到本地。如果请求失败则是正常失败。 |
 
 <br>
-便于理解
-<img src="https://i.imgur.com/sHnrzWX.png" width="80%%"/>
+便于理解的思维导图
+
+<img src="https://i.imgur.com/sHnrzWX.png" width="600"/>