docs(xtream-codec-core): xtream-codec 适配器相关文档

Closes 93

Author: hylexus

README.md

@@ -53,6 +53,8 @@ Jt-808协议服务端。
 - Github : https://github.com/hylexus/xtream-codec
 - Gitee : https://gitee.com/hylexus/xtream-codec
 
+> 从 **3.0.0-rc.1** 开始，**jt-framework** 内置了 [xtream-codec-core](https://github.com/hylexus/xtream-codec) 的适配器。
+
 ## Compatibility / 兼容性
 
 支持 **spring-boot-2.x** [![spring-boot-2.x](https://img.shields.io/maven-central/v/io.github.hylexus.jt/jt-808-server-spring-boot-starter-boot2.svg?label=spring-boot-2.x)](https://search.maven.org/search?q=g:%22io.github.hylexus.jt%22%20AND%20a:%22jt-808-server-spring-boot-starter-boot2%22)
@@ -148,16 +150,16 @@ Jt-808协议服务端。
 ### 2. 添加依赖
 
 - **spring-boot-3.x**
-    - `jt-808-server-spring-boot-starter-2.3.0.jar`
+    - `jt-808-server-spring-boot-starter-3.0.0-rc.1.jar`
 - **spring-boot-2.x**
-    - `jt-808-server-spring-boot-starter-boot2-2.3.0.jar`
+    - `jt-808-server-spring-boot-starter-boot2-3.0.0-rc.1.jar`
 
 按需求引入为 `808协议` 提供的 `spring-boot-starter`：
 
 - gradle
 
 ```groovy
-implementation group: 'io.github.hylexus.jt', name: 'jt-808-server-spring-boot-starter-boot2', version: "2.3.0"
+implementation group: 'io.github.hylexus.jt', name: 'jt-808-server-spring-boot-starter-boot2', version: "3.0.0-rc.1"
 ```
 
 - maven
@@ -167,7 +169,7 @@ implementation group: 'io.github.hylexus.jt', name: 'jt-808-server-spring-boot-s
 <dependency>
     <groupId>io.github.hylexus.jt</groupId>
     <artifactId>jt-808-server-spring-boot-starter-boot2</artifactId>
-    <version>2.3.0</version>
+    <version>3.0.0-rc.1</version>
 </dependency>
 ```
 

build-script/maven/publish-to-maven-repository-local.sh

@@ -13,6 +13,6 @@ rm -rf /tmp/jt-framework/temp-artifacts
 -P jt-framework.maven.repo.central-portal.enabled=false \
 -P jt-framework.maven.repo.private.enabled=false \
 -P jt-framework.maven.repo.github.enabled=false \
--P jt-framework.maven.publications.signing=on \
+-P jt-framework.maven.publications.signing=off \
 -P jt-framework.backend.build.checkstyle.enabled=true \
 -P jt-framework.backend.build.debug-module-fatjar.enabled=false

buildSrc/src/main/kotlin/JtFrameworkVersions.kt

@@ -117,6 +117,9 @@ object JtFrameworkVersions {
         "jt-808-server-spring-boot-autoconfigure",
         "jt-808-server-spring-boot-starter-boot2",
         "jt-808-server-spring-boot-starter",
+        "jt-808-server-xtream-codec-adapter",
+        "jt-808-server-xtream-codec-adapter-spring-boot-starter",
+        "jt-808-server-xtream-codec-adapter-spring-boot-starter-boot2",
     )
 
     // 不需要 Lombok 的模块

docs/src/.vuepress/sidebar/zh.ts

@@ -61,6 +61,15 @@ export const zhSidebar = sidebar({
                     '/v2/jt-808/guide/annotation-based-dev/notices-for-builtin-msg.md',
                 ]
             },
+            {
+                text:"xtream-codec 适配器",
+                icon: 'extend',
+                collapsible: true,
+                children: [
+                    '/v2/jt-808/guide/xtream-codec-adapter/intro.md',
+                    '/v2/jt-808/guide/xtream-codec-adapter/quick-start.md',
+                ]
+            },
             {
                 text: "定制化",
                 collapsible: true,
@@ -105,6 +114,7 @@ export const zhSidebar = sidebar({
         ],
         '/v2/release-notes': [
             '/v2/release-notes/latest.md',
+            '/v2/release-notes/2.3.x.md',
             '/v2/release-notes/2.1.x.md',
             '/v2/release-notes/2.0.x.md',
             '/v2/release-notes/1.x.md',
@@ -119,6 +129,7 @@ export const zhSidebar = sidebar({
             "/v2/jt-808/config/sub-package.md",
             "/v2/jt-808/config/others.md",
             "/v2/jt-808/config/extension-jiangsu.md",
+            "/v2/jt-808/config/xtream-codec.md",
         ],
         '/v1/jt-808/config/': ["/v1/jt-808/config/"],
         '/v1/jt-808/guide/': [

docs/src/v2/jt-808/config/xtream-codec.md

@@ -0,0 +1,17 @@
+---
+icon: extend
+---
+
+# xtream-codec(v3.0.0)
+
+## 配置项
+
+```yaml
+# xtream-codec 适配器配置
+xtream:
+  codec:
+    # 表达式类型
+    expression:
+      # 取值 spel | mvel | aviator | custom
+      type: spel
+```

docs/src/v2/jt-808/guide/quick-start/compatibility.md

@@ -87,7 +87,7 @@ icon: plugin
     <dependency>
         <groupId>io.github.hylexus.jt</groupId>
         <artifactId>jt-808-server-spring-boot-starter-boot2</artifactId>
-        <version>2.3.0</version>
+        <version>3.0.0-rc.1</version>
         <!-- 1. 排除 jt-framework 自带的 spring-boot-starter(2.7.18) -->
         <exclusions>
             <exclusion>
@@ -120,7 +120,7 @@ icon: plugin
     <dependency>
         <groupId>io.github.hylexus.jt</groupId>
         <artifactId>jt-808-server-spring-boot-starter</artifactId>
-        <version>2.3.0</version>
+        <version>3.0.0-rc.1</version>
         <exclusions>
             <!-- 1. 排除 jt-framework 自带的 spring-boot-starter(3.3.0) -->
             <exclusion>

docs/src/v2/jt-808/guide/quick-start/quick-start.md

@@ -37,14 +37,14 @@ icon: launch
 <dependency>
     <groupId>io.github.hylexus.jt</groupId>
     <artifactId>jt-808-server-spring-boot-starter-boot2</artifactId>
-    <version>2.3.0</version>
+    <version>3.0.0-rc.1</version>
 </dependency>
 ```
 
 @tab:active gradle
 
 ```groovy
-implementation 'io.github.hylexus.jt:jt-808-server-spring-boot-starter-boot2:2.3.0'
+implementation 'io.github.hylexus.jt:jt-808-server-spring-boot-starter-boot2:3.0.0-rc.1'
 ```
 
 :::
@@ -62,14 +62,14 @@ implementation 'io.github.hylexus.jt:jt-808-server-spring-boot-starter-boot2:2.3
 <dependency>
     <groupId>io.github.hylexus.jt</groupId>
     <artifactId>jt-808-server-spring-boot-starter</artifactId>
-    <version>2.3.0</version>
+    <version>3.0.0-rc.1</version>
 </dependency>
 ```
 
 @tab:active gradle
 
 ```groovy
-implementation 'io.github.hylexus.jt:jt-808-server-spring-boot-starter:2.3.0'
+implementation 'io.github.hylexus.jt:jt-808-server-spring-boot-starter:3.0.0-rc.1'
 ```
 
 :::

docs/src/v2/jt-808/guide/xtream-codec-adapter/index.md

@@ -0,0 +1 @@
+# xtream-codec 适配器

docs/src/v2/jt-808/guide/xtream-codec-adapter/intro.md

@@ -0,0 +1,58 @@
+---
+icon: proposal
+---
+
+# 请先读我
+
+## 介绍 <Badge text="3.0.0" type="tip" vertical="top"/>
+
+从 <Badge text="3.0.0" type="tip" vertical="middle"/> 开始，**jt-framework** 适配了 [xtream-codec-core](https://hylexus.github.io/xtream-codec/guide/core/annotation-driven/builtin-annotations.html) 的注解。
+
+## 前置条件
+
+- <span style="color:red;">JDK21+</span>
+- spring-boot-2.x 或 spring-boot-3.x
+
+::: tip 提示
+
+[xtream-codec](https://github.com/hylexus/xtream-codec) 是基于 <span style="color:red;">JDK21+</span> 的，
+因此在 jt-framework 中使用 **xtream-codec** 的编解码库，必须要 <span style="color:red;">JDK21+</span>。
+
+:::
+
+## xtream-codec 注解 VS jt-framework 注解
+
+### 数据处理维度
+
+**jt-framework** 注解对请求和响应分开处理了：
+
+- `@RequestField`
+- `@ResponseField`
+- 另外提供了两种内置别名注解
+    - `@RequestFieldAlias`
+    - `@ResponseFieldAlias`
+
+**xtream-codec** 注解不区分请求和响应：
+
+- 底层统一使用 `@XtreamField` 这一个注解
+- 另外提供了两种内置别名注解
+    - `@Preset.RustStyle.XXX()`: **rust** 风格的别名注解
+    - `@Preset.JtStyle.XXX()`: **JT** 风格的别名注解
+
+### 数据类型维度
+
+- **xtream-codec** 注解支持的数据类型更加丰富
+- **xtream-codec** 自定义编解码器更加灵活
+- **xtream-codec** 注解支持 `Record`
+
+具体参考: [xtream-codec-core 内置类型对比](https://hylexus.github.io/xtream-codec/guide/core/annotation-driven/builtin-annotations.html#%E5%86%85%E7%BD%AE%E7%B1%BB%E5%9E%8B%E5%AF%B9%E6%AF%94)
+
+### 混合版本
+
+- **xtream-codec** 注解支持在同一个实体类上处理不同版本的协议字段
+
+### 调试埋点
+
+**xtream-codec** 支持调试埋点。
+
+具体参考: [xtream-codec-core 调试埋点](https://hylexus.github.io/xtream-codec/guide/core/annotation-driven/entity-codec-tracker.html)