From 18f9da53e0a0b4ced589b399b9af60e39fe29492 Mon Sep 17 00:00:00 2001
From: sh1yu <41428433@qq.com>
Date: Wed, 13 Mar 2024 09:23:39 +0800
Subject: [PATCH] add Spring docs

---
 .../03-connect/12-spring-connector.md         | 77 +++++++++++++++++++
 .../03-connect/12-spring-connector.md         | 77 +++++++++++++++++++
 2 files changed, 154 insertions(+)
 create mode 100644 docs/design-document/03-connect/12-spring-connector.md
 create mode 100644 i18n/zh/docusaurus-plugin-content-docs/current/design-document/03-connect/12-spring-connector.md

diff --git a/docs/design-document/03-connect/12-spring-connector.md b/docs/design-document/03-connect/12-spring-connector.md
new file mode 100644
index 0000000000..3c01a64e96
--- /dev/null
+++ b/docs/design-document/03-connect/12-spring-connector.md
@@ -0,0 +1,77 @@
+# Spring
+
+## SpringSinkConnector：From EventMesh to Spring BlockingQueue
+
+1. Start your EventMesh Runtime.
+2. Enable sinkConnector and check `sink-config.yml`.
+3. Start your SpringBoot project that depends on the [Eventmesh-Connector-Spring] project, It will subscribe to the topic defined in `pubSubConfig.subject` in the EventMesh Runtime. And will receive the data of rice into the org/apache/eventmesh/connector/spring/sink/connector/SpringSinkConnector. In Java ` queue ` attribute, the usage is as follows.
+
+```java
+@Component
+class MySinkApp{
+    
+    @Resource
+    SpringSinkConnector connector;
+    
+    void letsUseEventMeshSpring(){
+        //This queue can be fetched for use
+        BlockingQueue<ConnectRecord> queue = connector.getQueue();
+    }
+}
+```
+
+4. Using the Topic specified in `pubSubConfig.subject`, send a message to the EventMesh, which you will then see in the above queue.
+
+```yaml
+# Common configuration
+pubSubConfig:
+  meshAddress: 127.0.0.1:10000
+  subject: TEST-TOPIC-SPRING
+  idc: FT
+  env: PRD
+  group: springSink
+  appId: 5033
+  userName: springSinkUser
+  passWord: springPassWord
+connectorConfig:
+  connectorName: springSink
+```
+
+## SpringSourceConnector：From Spring BlockingQueue to EventMesh
+
+1. Start your EventMesh Runtime.
+2. Enable sinkConnector and check  `source-config.yml`.
+3. Start your SpringBoot project that depends on the [Eventmesh-Connector-Spring] project,And send the data you send using [SpringSourceConnector] to `pubSubConfig.subject` in the EventMesh Runtime, as follows.
+
+```java
+@Component
+class MySourceApp{
+    
+    @Resource
+    SpringSourceConnector connector;
+    
+    void letsUseEventMeshSpring(){
+        //Send a message here
+        connector.send(new Object());
+    }
+}
+```
+
+4. Send a message to the [SpringSourceConnector], and you will receive it in EventMesh.
+
+```yaml
+# 公共配置
+pubSubConfig:
+  meshAddress: 127.0.0.1:10000
+  subject: TEST-TOPIC-SPRING
+  idc: FT
+  env: PRD
+  group: springSource
+  appId: 5033
+  userName: springSourceUser
+  passWord: springPassWord
+connectorConfig:
+  connectorName: springSource
+```
+
+>Note: This Connector project cannot run independently. It is a Springboot-starter, and the SpringBoot application needs to rely on this project.
\ No newline at end of file
diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/design-document/03-connect/12-spring-connector.md b/i18n/zh/docusaurus-plugin-content-docs/current/design-document/03-connect/12-spring-connector.md
new file mode 100644
index 0000000000..aef05e91d4
--- /dev/null
+++ b/i18n/zh/docusaurus-plugin-content-docs/current/design-document/03-connect/12-spring-connector.md
@@ -0,0 +1,77 @@
+# Spring
+
+## SpringSinkConnector：从 EventMesh 到 Spring 的 BlockingQueue
+
+1. 启动你的 EventMesh Runtime。
+2. 启用 sinkConnector 并检查 `sink-config.yml`。
+3. 启动你依赖了 [eventmesh-connector-spring] 工程的 SpringBoot 项目 ，它将订阅到 EventMesh Runtime 中 `pubSubConfig.subject` 中定义的主题，并将收到的数据饭入到 org/apache/eventmesh/connector/spring/sink/connector/SpringSinkConnector.java 中的 `queue` 属性，用法如下。
+
+```java
+@Component
+class MySinkApp{
+    
+    @Resource
+    SpringSinkConnector connector;
+    
+    void letsUseEventMeshSpring(){
+        //这个queue可以获取出来以供使用
+        BlockingQueue<ConnectRecord> queue = connector.getQueue();
+    }
+}
+```
+
+4. 使用在 `pubSubConfig.subject` 中指定的 Topic，向 EventMesh 发送消息，然后你将在 上述队列中 看到该消息。
+
+```yaml
+# 公共配置
+pubSubConfig:
+  meshAddress: 127.0.0.1:10000
+  subject: TEST-TOPIC-SPRING
+  idc: FT
+  env: PRD
+  group: springSink
+  appId: 5033
+  userName: springSinkUser
+  passWord: springPassWord
+connectorConfig:
+  connectorName: springSink
+```
+
+## SpringSourceConnector：从 Spring 的 BlockingQueue 到 EventMesh
+
+1. 启动你的 EventMesh Runtime。
+2. 启用 sourceConnector 并检查 `source-config.yml`。 
+3. 启动你依赖了 [eventmesh-connector-spring] 工程的 SpringBoot 项目，并将你使用 [SpringSourceConnector] 发送的数据发送到 EventMesh Runtime 中的 `pubSubConfig.subject`，用法如下。 
+
+```java
+@Component
+class MySourceApp{
+    
+    @Resource
+    SpringSourceConnector connector;
+    
+    void letsUseEventMeshSpring(){
+        //这里发送消息
+        connector.send(new Object());
+    }
+}
+```
+
+4. 向 connector 发送一个消息，然后你将在 EventMesh 中接收到该消息。
+
+```yaml
+# 公共配置
+pubSubConfig:
+  meshAddress: 127.0.0.1:10000
+  subject: TEST-TOPIC-SPRING
+  idc: FT
+  env: PRD
+  group: springSource
+  appId: 5033
+  userName: springSourceUser
+  passWord: springPassWord
+connectorConfig:
+  connectorName: springSource
+```
+
+>注意事项: 本Connector工程不能独立运行，其实是SpringBoot-Starter，需要SpringBoot应用依赖此工程。
\ No newline at end of file