Browse Source

修订文档

drake 3 years ago
parent
commit
d9040fb740
7 changed files with 33 additions and 24 deletions
  1. 1 1
      docs/config.md
  2. 8 8
      docs/css/extra.css
  3. 1 1
      docs/error-handle.md
  4. 1 1
      docs/exception-track.md
  5. 9 8
      docs/request.md
  6. 12 4
      docs/tag.md
  7. 1 1
      mkdocs.yml

+ 1 - 1
docs/config.md

@@ -54,5 +54,5 @@
 
 例如Retrofit的动态`BaseURL`功能就可以直接修改`NetConfig.host`
 
-<img src="https://i.imgur.com/ueqcNYw.png" width="500"/>
+<img src="https://i.imgur.com/gOhMDUZ.png" width="480"/>
 

+ 8 - 8
docs/css/extra.css

@@ -36,13 +36,13 @@
 }
 
 /*字体渲染*/
-@font-face{
-    font-family: 'JetBrains Mono';
-    src: local('JetBrains Mono'),
-         url('https://raw.githubusercontent.com/JetBrains/JetBrainsMono/master/fonts/webfonts/JetBrainsMono-Regular.woff2') format('woff2'),
-         url('https://raw.githubusercontent.com/JetBrains/JetBrainsMono/master/fonts/ttf/JetBrainsMono-Regular.ttf') format('truetype');
-    font-weight: normal;
-    font-style: normal;
+@font-face {
+	font-family: 'Iosevka SS05';
+	src: local('Iosevka SS05 Medium'),
+	     url('https://raw.githubusercontent.com/liangjingkanji/liangjingkanji/master/font/iosevka/iosevka-ss05-medium.woff2') format('woff2');
+	font-display: swap;
+	font-weight: normal;
+	font-style: normal;
 }
 @font-face{
     font-family: 'HYZhengYuan';
@@ -55,7 +55,7 @@
     -webkit-font-feature-settings: "liga" on, "calt" on;
     -webkit-font-smoothing: subpixel-antialiased;
     text-rendering: optimizeLegibility;
-    font-family: 'JetBrains Mono', "HYZhengYuan" !important;
+    font-family: 'Iosevka SS05', "HYZhengYuan" !important;
 }
 
 /*布局*/

+ 1 - 1
docs/error-handle.md

@@ -80,7 +80,7 @@ catch里面的`it`属于异常对象, 这里列举可能存在的异常
 
 源码位于: `NetConfig`
 
-<img src="https://i.imgur.com/3Zf9CwT.png" width="550"/>
+<img src="https://i.imgur.com/NZFlRoN.png" width="400"/>
 
 缺省页的错误处理是单独的: `onStateError`
 

+ 1 - 1
docs/exception-track.md

@@ -13,7 +13,7 @@ scopeNetLife {
 
 查看LogCat可以看到异常堆栈信息
 
-<img src="https://i.imgur.com/4PjbIwH.png" width="800"/>
+<img src="https://i.imgur.com/Vlbnrog.png" width="650"/>
 
 这属于请求参数错误404, 将会打印出错误码以及请求的URL.
 

+ 9 - 8
docs/request-params.md → docs/request.md

@@ -1,6 +1,4 @@
-在Net中都是使用的其框架内部创建的`Request`创建请求
-
-涉及到请求参数的类只有两个类和一个抽象父类
+Net中关于请求的类只有两个类和他们共同的抽象父类
 
 ```kotlin
 BaseRequest
@@ -30,8 +28,8 @@ scopeNetLife {
 }
 ```
 
-## 表单请求
-关于请求参数参数
+## 请求参数
+
 ```kotlin
 scopeNetLife { // 创建作用域
     // 这个大括号内就属于作用域内部
@@ -46,8 +44,11 @@ scopeNetLife { // 创建作用域
 |-|-|
 |`param`|支持基础类型/文件/RequestBody/Part|
 |`json`|请求参数为JSONObject/JsonArray/String|
-|`setQuery`|Url参数, 如果当前请求的Url请求则该函数等效于`param`函数|
+|`setQuery`|Url参数, 如果当前请求为Url请求则该函数等效于`param`函数|
+
+如果没有添加文件/流那么就是通过BodyRequest内部的`FormBody`发起请求. 反之就是通过`MultipartBody`发起请求.
 
+> 当然你可以完全自定义Body来请求, 譬如以下的Json请求
 
 
 ## JSON请求
@@ -105,7 +106,7 @@ scopeNetLife { // 创建作用域
 
 ## 请求函数
 
-关于具体函数希望阅读源码. Net源码全部有文档注释, 以及函数结构分组
+关于全部的请求配置选项推荐阅读函数文档或者阅读源码. Net提供清晰的函数结构浏览方便直接阅读源码
 
-<img src="https://i.imgur.com/oZp9WYZ.png" width="420"/>
+<img src="https://i.imgur.com/j9H4c1y.png" width="400"/>
 

+ 12 - 4
docs/tag.md

@@ -1,15 +1,20 @@
-Net的标签完美的扩展的OkHttp的标签功能
 
-<br>
-在拦截器(Interceptor)或者转换器(NetConvert)中都可以通过`request.tag(name)`获取到标签对象
+Q: 什么是标签?
+
+A: 标签就是一个存储在Request对象中的Map集合, 便于Request请求对象携带指定的数据. 该数据可以通过Request在拦截器/转换器/响应体中被获取到, 用于构建区分请求的业务逻辑
 
+<br>
+Net中的标签同时支持使用字符串或者Class字节码作为标签的键名. 根据传入类型决定
 
 ## 标签使用
 
 ### 1) 设置标签
+
 ```kotlin hl_lines="2"
 scopeNetLife {
-    tv_fragment.text = Get<String>("api", "我是一个标签").await()
+    tv_fragment.text = Get<String>("api", "标签A"){ // 使用Any::class.java作为键名
+        setTag("tagName", "标签B") // 使用字符串作为键名
+    }.await()
 }
 ```
 
@@ -21,6 +26,9 @@ class MyInterceptor : Interceptor {
         request.tag()?.let {
             // 获取标签做任何事
         }
+        request.tag("tagName")?.let {
+           // 获取标签做任何事
+        }
         return chain.proceed(request)
     }
 }

+ 1 - 1
mkdocs.yml

@@ -40,7 +40,7 @@ nav:
   - 同步请求: sync-request.md
   - 队列请求: enqueue-request.md
   - ViewModel: view-model.md
-  - 请求参数: request-params.md
+  - 请求对象: request.md
   - 创建作用域: scope.md
   - 全局配置: config.md
   - OkHttpClient: okhttp-client.md