add 06.md

Author: litongjava

docs/.vuepress/config/sidebar-zh.json

@@ -18,7 +18,7 @@
   {
     "title": "03_配置",
     "collapsable": false,
-    "children": ["03_配置/01.md", "03_配置/02.md", "03_配置/03.md", "03_配置/04.md", "03_配置/05.md"]
+    "children": ["03_配置/01.md", "03_配置/02.md", "03_配置/03.md", "03_配置/04.md", "03_配置/05.md", "03_配置/06.md"]
   },
   {
     "title": "04_架构",

docs/zh/02_部署/04.md

@@ -38,6 +38,20 @@ export MVN_HOME=~/program/apache-maven-3.8.8/
 export PATH=$MVN_HOME/bin:$PATH
 ```
 
+3. 验证配置
+
+```
+mvn -version
+```
+
+```
+Apache Maven 3.8.8 (4c87b05d9aedce574290d1acc98575ed5eb6cd39)
+Maven home: /root/program/apache-maven-3.8.8
+Java version: 21.0.1, vendor: Oracle Corporation, runtime: /root/program/graalvm-jdk-21.0.1+12.1
+Default locale: en_US, platform encoding: UTF-8
+OS name: "linux", version: "5.15.0-92-generic", arch: "amd64", family: "unix"
+```
+
 #### 打包成二进制文件
 
 ```

docs/zh/03_配置/06.md

@@ -0,0 +1,160 @@
+# Json 转换
+
+## 概述
+
+tio-boot 的 json 模块以抽象类 Json 为核心，方便扩展第三方实现，tio-boot 官方给出了 4 个 Json 实现，分别是 TioJson、FastJson、Jackson，Gson 这 4 个实现继承自抽象类 Json。
+
+抽象类 Json 的核心抽象如下：
+
+```
+public abstract class Json {
+    public abstract String toJson(Object object);
+    public abstract <T> T parse(String jsonString, Class <T> type);
+}
+```
+
+如上代码可以看出 Json 抽象就是 Object 与 json string 互转的两个方法，toJson(...)将任意 java 类型转成 json string，而 parse 将 json string 再反向转成范型指定的对象。
+
+## Json 配置
+
+tio-boot 官方提供了 Json 抽象类的三个实现：TioJson、FastJson、Jackson，如果不进行配置，那么默认使用 TioJson 实现，指定为其它实现需要在 configConstant 进行如下配置：
+
+```
+JsonManager.me().setDefaultJsonFactory(new FastJsonFactory());
+```
+
+上面配置将系统默认使用的 TioJson 切换到了 FastJson。还可以通过扩展 Json 抽象类以及 JsonFactory 来实现定制的 Json 实现。
+
+假定用户扩展出了一个 MyJson 与 MyJsonFactory ，那么可以通过如下的方式切换到自己的实现上去：
+
+```
+JsonManager.me().setJsonFactory(new MyJsonFactory());
+```
+
+此外，tio-boot 官方还提供了 MixedJson、MixedJsonFactory 实现，这个实现让转 json string 时使用 TioJson，反向转成对象则使用 FastJson。
+如果希望在非 web 下进行配置，需要使用 JsonManager，例如：
+
+```
+JsonManager.me().setJsonFactory(new MixedJsonFactory());
+```
+
+还可以配置 Date 类型转 json 后的格式：
+
+```
+JsonManager.me().setJsonDatePattern("yyyy-MM-dd");
+```
+
+注意，在使用 MixedJsonFactory、FastJsonFactory、JacksonFactory 时需要添加其依赖，具体依赖参考下一小节内容。
+
+## Json 的实现
+
+官方默认给出了 5 种 json 实现：TioJson、FastJson、Jackson、MixedJson，Gson 可以满足绝大多数需求。
+
+### 1、TioJson
+
+TioJson 是 tio-boot 官方最早的一个实现，目前已经没有什么用
+
+### 2、FastJson
+
+FastJson 是对第三方的 fastjson2 进行的二次封装，该实现最重要的一点就是转换依赖于 Model、java bean 的 getter 方法。使用 fastjson 可以按照其官方文档去配置 fastjson 的各种转换参数。
+
+使用 FastJson 封装时，需要添加其依赖：
+
+```
+      <!-- https://mvnrepository.com/artifact/com.alibaba.fastjson2/fastjson2 -->
+      <dependency>
+        <groupId>com.alibaba.fastjson2</groupId>
+        <artifactId>fastjson2</artifactId>
+        <version>${fastjson.version}</version>
+      </dependency>
+```
+
+### 3、Jackson
+
+该实现与 FastJson 类似，是对第三方的 jackson 的二次封装
+
+使用 Jackson 封装时，需要添加其依赖：
+
+```
+<dependency>
+    <groupId>com.fasterxml.jackson.core</groupId>
+    <artifactId>jackson-databind</artifactId>
+    <version>2.11.0</version>
+</dependency>
+```
+
+### 4、Gson
+
+该实现与 FastJson 类似，是对第三方的 Gson 的二次封装
+
+使用 Gson 封装时，需要添加其依赖：
+
+```
+      <dependency>
+        <groupId>com.google.code.gson</groupId>
+        <artifactId>gson</artifactId>
+        <version>2.10.1</version>
+      </dependency>
+```
+
+### 5、MixedJson
+
+MixedJson 是对 TioJson、FastJson 的再一次封装，Object 转 json string 时使用 TioJson 的实现，而反向 json string 转 Object 使用 FastJson。
+
+这个实现结合了 TioJson 与 FastJson 两者的优势。 前者不支持 json string 到 Object 的转换，后者不支持关联表 sql 查询动态字段的转换。
+
+使用 MixedJson 封装时需要添加 FastJson 封装的依赖：
+
+```
+      <!-- https://mvnrepository.com/artifact/com.alibaba.fastjson2/fastjson2 -->
+      <dependency>
+        <groupId>com.alibaba.fastjson2</groupId>
+        <artifactId>fastjson2</artifactId>
+        <version>${fastjson.version}</version>
+      </dependency>
+```
+
+## 12.4 Json 转换用法
+
+json 转换在 tio-boot 中的使用分为两类用法，第一类是使用配置的 json 转换，第二类是指定某个实现进行 json 转换。
+
+### 1、使用配置的 json 实现转换
+
+如下代码将使用前面章节中介绍的配置的 json 实现进行转的换：
+
+1. 使用 Json 类进行 json 转换
+
+```
+Json.getJson().toJson(object)
+Json.getJson().parse(jsonString, type);
+```
+
+2. 使用 JsonUtils 工具类进行转换
+
+```
+import com.litongjava.tio.utils.json.JsonUtils
+
+JsonUtils.toJson(object)
+JsonUtils.parse(jsonString, type);
+```
+
+3、使用指定的 json 实现转换
+
+如果下代码将使用指定的 json 实现去转换：
+
+```
+// 临时指定使用 FastJson 实现
+FastJson.getJson().toJson(...);
+FastJson.getJson().parse(...);
+
+```
+
+4. Action 直接返回对象今后转换
+
+```
+public Student get(){
+  return new Studnet();
+}
+```
+
+上面这种用法可以临时摆脱配置的 json 实现，从而使用指定的 json 实现。

docs/zh/06_内置组件/01.md

@@ -32,28 +32,34 @@
 
 添加一个在服务器关闭时执行的方法。这允许开发者注册自定义的资源清理逻辑。
 
-## 获取和设置配置
+## 常用类解释
 
-- `getTioServer()` / `getWsServerConfig()` / `getHttpConfig()`: 获取当前的服务器，WebSocket，HTTP 配置。
+1. **`tioServer`**: 这可能是 T-io 服务器的一个实例。它作为服务器的中心运行点，处理进来的连接、数据以及管理资源。
 
-- `setServerInteceptorConfigure(ServerInteceptorConfigure)`: 设置服务器拦截器配置。
-- `setTioBootHttpRoutes(TioBootHttpRoutes)`: 设置 Tio Boot 的 HTTP 路由。
-- `setHttpRoutes(HttpRoutes)`: 设置 HTTP 路由。
-- `setServerTcpHandler(ServerTcpHandler)`: 设置 TCP 处理器。
-- `setServerAioListener(ServerAioListener)`: 设置服务器监听器。
+2. **`wsServerConfig`**: 这代表 WebSocket 服务配置。它包含与 WebSocket 协议相关的设置，如连接超时时间、消息缓冲区大小等。
 
-- `getServerInteceptorConfigure`
-- `getTioBootHttpRoutes`
-- `getHttpRoutes`
-- `getServerTcpHandler`
-- `getServerAioListener`
-- `getServerListener`
+3. **`httpConfig`**: 类似于`wsServerConfig` 代表 HTTP 服务配置。包括最大头部大小、会话超时时间等设置。
 
-## 常用类解释
+4. **`defaultHttpRequestHandlerDispather`**: 这是处理 HTTP 请求的默认分发器。它定义了如何处理和路由进来的 HTTP 请求。tio-boot 启动时会设置为 com.litongjava.tio.boot.http.handler.DefaultHttpRequestHandlerDispather
+
+5. **`defaultHttpServerInterceptorDispatcher`**: 这代表 HTTP 拦截器的分发器，可以拦截并处理 HTTP 请求和响应，tio-boot 启动时会设置为 com.litongjava.tio.boot.http.interceptor.DefaultHttpServerInterceptorDispatcher
+
+6. **`defaultWebSocketHandlerDispather`**: 这代表 websocket 的分发器，它定义了如何处理进来的 WebSocket 消息。tio-boot 启动时会设置为 com.litongjava.tio.boot.websocket.handler.DefaultWebSocketHandlerDispather
+
+7. **`serverInteceptorConfigure`**: 这是服务器拦截器的配置设置，允许你为所有进来的请求或消息定义全局规则或行为。需要配合 DefaultHttpRequestHandlerDispather 使用
+
+8. **`webSocketRoutes`**: 定义 WebSocket 连接的路由，每个路由都与不同的行为或处理逻辑相关联。需要配合 DefaultWebSocketHandlerDispather 使用
+
+9. **`tioBootServerListener`**: 这个监听器可能处理与服务器生命周期相关的事件，比如服务器启动、停止或遇到错误时。
+
+10. **`tioBootHttpRoutes`**: 管理 tio-boot http controller 的路由。每个路由指定了不同 HTTP 路径应该如何处理。
+
+11. **`httpRoutes`**: 管理 tio http server hanlder 的路由
+
+12. **`serverTcpHandler`**: 处理 TCP 连接。它负责处理通过 TCP 连接接收到的数据，并可能发送响应。
+
+13. **`serverAioListener`**: 请求 的监听器。这如接受连接、断开连接等.
+
+## 设置和获取配置
 
-- `ServerInteceptorConfigure` 管理拦截器
-- `TioBootHttpRoutes` 管理 tio-boot controller
-- `HttpRoutes` 管理 tio-http-server handler
-- `ServerTcpHandler` 管理 tcpHnalder
-- `ServerAioListener` tcp 请求监听器
-- `ServerListener` tio-boot server 监听器
+上面这些熟悉都提供了静态的 get 和 set 方法,你可以在需要的时候获取配置或者设置自定义的配置

docs/zh/06_内置组件/04.md

@@ -146,7 +146,7 @@ public class IntecpetorConfiguration {
 
   @AInitialization
   public void serverInteceptorRoutes() {
-    ServerInteceptorConfigure config = new ServerInteceptorConfigure();
+
     // add global
     HttpServerInterceptorModel global = new HttpServerInterceptorModel();
     global.setName("global");
@@ -158,6 +158,7 @@ public class IntecpetorConfiguration {
     hello.addblockeUrl("/hello");
     hello.setInterceptor(new HelloInteceptor());
 
+    ServerInteceptorConfigure config = new ServerInteceptorConfigure();
     config.add(global);
     config.add(hello);
 
@@ -179,4 +180,4 @@ public class IntecpetorConfiguration {
    - `doBeforeHandler` 方法在处理 HTTP 请求之前执行。对于 `GlobalInteceptor`，它返回 `responseFromCache`，而 `HelloInteceptor` 返回 `null`。
    - `doAfterHandler` 方法在请求处理后执行，记录请求信息。
 
-3. DefaultHttpServerInterceptor 用于执行拦截器,拦截器的执行顺序是 config.add 添加的顺序
+3. DefaultHttpServerInterceptor 用于执行拦截器,拦截器的执行顺序是 config.add 添加的顺序