Browse Source

docs: config.md

drake 2 years ago
parent
commit
7667394554
2 changed files with 26 additions and 5 deletions
  1. 25 4
      docs/config.md
  2. 1 1
      docs/scope.md

+ 25 - 4
docs/config.md

@@ -69,18 +69,28 @@ NetConfig.initialize("https://github.com/liangjingkanji/Net/") {
 
 ## 修改配置
 
-单例[NetConfig](api/-net/com.drake.net/-net-config/index.html)存储初始化时的配置, 可随时修改配置
+[NetConfig](api/-net/com.drake.net/-net-config/index.html)的字段即为全局配置, 可随时修改
 
-例如Retrofit的动态`baseURL`功能就可以直接修改`NetConfig.host`
+例如Retrofit的动态`BaseURL`功能就可以直接修改`NetConfig.host`
 
 ```kotlin
 NetConfig.host = "https://github.com/liangjingkanji/Net/"
 ```
 
 
-## 动态域名
+## 动态BaseURL
 
-如果请求时传入的是路径(例如`/api/index`)那么会自动和初始化时的Host拼接. 但是如果传入的是以`http/https`开头的全路径那么则不会与Host进行拼接
+这个概念来源于Retrofit, 因为Retrofit无法动态修改Host, 但是这个Net支持随时修改
+
+1) 直接修改
+
+```kotlin
+NetConfig.host = "新的BaseURL"
+```
+
+
+2) 传入路径
+如传入参数为路径(例如`/api/index`)会自动和`host`拼接组成完成URL, 但如果传入的以`http/https`开头的全路径则会直接作为请求URL
 
 ```kotlin
 scopeNetLife {
@@ -88,4 +98,15 @@ scopeNetLife {
 }
 ```
 
+3) 使用拦截器
+
+或者通过指定`tag`, 然后拦截器(interceptor)中根据tag动态修改host, 因为拦截器能修改一切请求参数
+
+```kotlin
+scopeNetLife {
+    val data = Get<String>("/api/index", "User").await() // User即为tag
+}
+// 拦截器修改请求URL不做介绍
+```
+
 

+ 1 - 1
docs/scope.md

@@ -36,7 +36,7 @@
 <br>
 
 
-> 如果想了解详细的协程使用方式, 可以查看我的一篇文章: [最全面的Kotlin协程: Coroutine/Channel/Flow 以及实际应用](https://juejin.im/post/6844904037586829320)
+> 如果想了解详细的协程使用方式, 可以查看一篇文章: [最全面的Kotlin协程: Coroutine/Channel/Flow 以及实际应用](https://juejin.im/post/6844904037586829320)
 
 有时候可能面临嵌套的`scope*`函数或者作用域内有子作用域情况, 这个时候的生命周期是如何