[pull] master from crossoverJie:master

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,28 +1,28 @@
 ---
 name: Bug report
 about: Create a report to help us improve
-title: '提交之前请查看是否有相关 issue，谢谢。'
+title: 'Please check if there are similar issues before submitting'
 labels: ''
 assignees: ''
 
 ---
 
-**Bug 描述**
+**Bug Description**
 A clear and concise description of what the bug is.
 
-**复现**
-复现步骤:
+**Reproduce**
+step:
 1. Go to '...'
 2. Click on '....'
 3. Scroll down to '....'
 4. See error
 
-**预期结果**
+**Expected results**
 A clear and concise description of what you expected to happen.
 
-**截图**
+**Screenshot**
 If applicable, add screenshots to help explain your problem.
 
 
-**附加信息**
+**Additional Information**
 Add any other context about the problem here.

.github/workflows/maven.yml

@@ -0,0 +1,21 @@
+# This workflow will build a Java project with Maven, and cache/restore any dependencies to improve the workflow execution time
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-java-with-maven
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: Java CI with Maven
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+
+jobs:
+  build:
+    uses: ./.github/workflows/reusable_run_tests.yml
+    secrets:
+      codecov_token: ${{ secrets.CODECOV_TOKEN }}

.github/workflows/reusable_run_tests.yml

@@ -0,0 +1,29 @@
+name: A reusable workflow to build and run the unit test suite
+
+on:
+  workflow_call:
+    secrets:
+      codecov_token:
+        required: true
+  workflow_dispatch:
+
+jobs:
+  build_and_test:
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up JDK 17
+        uses: actions/setup-java@v4
+        with:
+          java-version: '17'
+          distribution: 'temurin'
+          cache: maven
+      - name: Build with Maven
+        run: mvn -B package --file pom.xml
+      - name: Upload coverage reports to Codecov
+        uses: codecov/codecov-action@v4
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          verbose: true

README.md

@@ -5,6 +5,7 @@
 <img src="https://i.loli.net/2020/02/21/rfOGvKlTcHCmM92.png"  /> 
 <br/>
 
+[![codecov](https://codecov.io/gh/crossoverJie/cim/graph/badge.svg?token=oW5Gd1oKmf)](https://codecov.io/gh/crossoverJie/cim)
 [![Build Status](https://img.shields.io/badge/cim-cross--im-brightgreen.svg)](https://github.com/crossoverJie/cim)
 [![](https://badge.juejin.im/entry/5c2c000e6fb9a049f5713e26/likes.svg?style=flat-square)](https://juejin.im/post/5c2bffdc51882509181395d7)
 
@@ -16,27 +17,26 @@
 
 # V2.0
 - [x] Upgrade to JDK17 & springboot3.0 
+- [x] Client SDK 
 - [ ] Client use [picocli](https://picocli.info/) instead of springboot.
-- [ ] Supports binary client(build with golang). 
-- [ ] Support integration testing.
+- [x] Support integration testing.
 - [ ] Integrate OpenTelemetry .
 - [ ] Support single node startup(Contains no components).
 - [ ] Third-party components support replacement(Redis/Zookeeper, etc.).
 - [ ] Support web client(websocket).
 - [ ] Support docker container.
 - [ ] Support kubernetes operation.
+- [ ] Supports binary client(build with golang).
 
-## 介绍
+## Introduction
 
-`CIM(CROSS-IM)` 一款面向开发者的 `IM(即时通讯)`系统；同时提供了一些组件帮助开发者构建一款属于自己可水平扩展的 `IM` 。
+`CIM(CROSS-IM)` is an `IM (instant messaging)` system for developers; it also provides some components to help developers build their own scalable `IM`.
+Using `CIM`, you can achieve the following requirements:
+- `IM` instant messaging system.
+- Message push middleware for `APP`.
+- Message middleware for `IOT` massive connection scenarios.
 
-借助 `CIM` 你可以实现以下需求：
-
-- `IM` 即时通讯系统。
-- 适用于 `APP` 的消息推送中间件。
-- `IOT` 海量连接场景中的消息透传中间件。
-
-> 在使用或开发过程中有任何疑问都可[联系我](#联系作者)。
+> If you have any questions during use or development, you can [contact me](#联系作者).
 
 ## 视频演示
 
@@ -47,6 +47,7 @@
 | [群聊](https://youtu.be/_9a4lIkQ5_o) [私聊](https://youtu.be/kfEfQFPLBTQ) | [群聊](https://www.bilibili.com/video/av39405501) [私聊](https://www.bilibili.com/video/av39405821) | 
 | <img src="https://i.loli.net//2019//05//08//5cd1d9e788004.jpg"  height="295px" />  | <img src="https://i.loli.net//2019//05//08//5cd1da2f943c5.jpg" height="295px" />
 
+![demo.gif](pic/demo.gif)
 
 ## TODO LIST
 
@@ -60,60 +61,63 @@
 * [x] 服务端自动剔除离线客户端
 * [x] 客户端自动重连
 * [x] [延时消息](#延时消息)
+* [x] SDK 开发包
 * [ ] 分组群聊
-* [ ] SDK 开发包
 * [ ] 离线消息
-* [ ] 协议支持消息加密
+* [ ] 消息加密
 
 
 
-## 系统架构
+## Architecture
 
-![](https://i.loli.net/2019/05/08/5cd1d45a156f1.jpg)
+![](pic/architecture.png)
 
-- `CIM` 中的各个组件均采用 `SpringBoot` 构建。
--  采用 `Netty` 构建底层通信。
--  `Redis` 存放各个客户端的路由信息、账号信息、在线状态等。
--  `Zookeeper` 用于 `IM-server` 服务的注册与发现。
+- Each component in `CIM` is built using `SpringBoot`
+  - Client build with [cim-client-sdk](https://github.com/crossoverJie/cim/tree/master/cim-client-sdk)
+- Use `Netty` to build the underlying communication.
+- `MetaStore` is used for registration and discovery of `IM-server` services.
 
 
 ### cim-server
+IM server is used to receive client connections, message forwarding, message push, etc.
+Support cluster deployment.
 
-`IM` 服务端；用于接收 `client` 连接、消息透传、消息推送等功能。
-
-**支持集群部署。**
+### cim-route
 
-### cim-forward-route
-
-消息路由服务器；用于处理消息路由、消息转发、用户登录、用户下线以及一些运营工具（获取在线用户数等）。
+Route server; used to process message routing, message forwarding, user login, user offline, and some operation tools (get the number of online users, etc.).
 
 ### cim-client
+IM client terminal, a command can be started and initiated to communicate with others (group chat, private chat).
 
-`IM` 客户端；给用户使用的消息终端，一个命令即可启动并向其他人发起通讯（群聊、私聊）。
-
-## 流程图
+## Flow Chart
 
-![](https://i.loli.net/2019/05/08/5cd1d45b982b3.jpg)
+![](https://s2.loli.net/2024/10/13/8teMn7BSa5VWuvi.png)
 
-- 客户端向 `route` 发起登录。
-- 登录成功从 `Zookeeper` 中选择可用 `IM-server` 返回给客户端，并保存登录、路由信息到 `Redis`。
-- 客户端向 `IM-server` 发起长连接，成功后保持心跳。
-- 客户端下线时通过 `route` 清除状态信息。
+- Server register to `MetaStore`
+- Route subscribe `MetaStore`
+- Client login to Route
+  - Route get Server info from `MetaStore`
+- Client open connection to Server
+- Client1 send message to Route
+- Route select Server and forward message to Server
+- Server push message to Client2
 
 
 ## 快速启动
 
 首先需要安装 `Zookeeper、Redis` 并保证网络通畅。
 
 ```shell
-docker run --name zookeeper -d -p 2181:2181 zookeeper
-docker run --rm --name redis -d -p 6379:6379 redis
+docker run --rm --name zookeeper -d -p 2181:2181 zookeeper:3.9.2
+docker run --rm --name redis -d -p 6379:6379 redis:7.4.0
 ```
 
 ```shell
 git clone https://github.com/crossoverJie/cim.git
 cd cim
-mvn -Dmaven.test.skip=true clean package
+mvn clean package -DskipTests=true
+cd cim-server && cim-client && cim-forward-route
+mvn clean package spring-boot:repackage -DskipTests=true
 ```
 
 ### 部署 IM-server(cim-server)
@@ -272,7 +276,7 @@ java -jar cim-client-1.0.0-SNAPSHOT.jar --server.port=8084 --cim.user.id=上方
 :delay delayMsg 10
 ```
 
-![](https://tva1.sinaimg.cn/large/006y8mN6ly1g7brppmokqg30gn07gafj.gif)
+![](pic/delay.gif)
 
 ## 联系作者
 

cim-client-sdk/README.md

@@ -0,0 +1,25 @@
+
+```java
+    var auth1 = ClientConfigurationData.Auth.builder()
+    .userId(id)
+    .userName(cj)
+    .build();
+
+    Client client1 = Client.builder()
+                    .auth(auth1)
+                    .routeUrl(routeUrl)
+                    .build();
+
+    ClientState.State state = client1.getState();
+    Awaitility.await().atMost(10, TimeUnit.SECONDS)
+    .untilAsserted(() -> Assertions.assertEquals(ClientState.State.Ready, state));
+    Optional<CIMServerResVO> serverInfo = client1.getServerInfo();
+    Assertions.assertTrue(serverInfo.isPresent());
+
+    // send msg
+    String msg = "hello";
+    client1.sendGroup(msg);
+
+    // get oline user
+    Set<CIMUserInfo> onlineUser = client1.getOnlineUser();
+```

cim-client-sdk/pom.xml

@@ -0,0 +1,51 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+  <modelVersion>4.0.0</modelVersion>
+  <parent>
+    <groupId>com.crossoverjie.netty</groupId>
+    <artifactId>cim</artifactId>
+    <version>1.0.0-SNAPSHOT</version>
+  </parent>
+
+  <artifactId>cim-client-sdk</artifactId>
+
+  <properties>
+    <maven.compiler.source>17</maven.compiler.source>
+    <maven.compiler.target>17</maven.compiler.target>
+    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+  </properties>
+
+
+  <dependencies>
+    <dependency>
+      <groupId>com.crossoverjie.netty</groupId>
+      <artifactId>cim-common</artifactId>
+    </dependency>
+
+    <dependency>
+      <groupId>com.crossoverjie.netty</groupId>
+      <artifactId>cim-rout-api</artifactId>
+    </dependency>
+
+    <dependency>
+      <groupId>org.junit.jupiter</groupId>
+      <artifactId>junit-jupiter</artifactId>
+      <scope>test</scope>
+    </dependency>
+
+    <dependency>
+      <groupId>org.junit.vintage</groupId>
+      <artifactId>junit-vintage-engine</artifactId>
+      <scope>test</scope>
+    </dependency>
+    <dependency>
+      <groupId>com.crossoverjie.netty</groupId>
+      <artifactId>cim-integration-test</artifactId>
+      <version>${project.version}</version>
+      <scope>test</scope>
+    </dependency>
+  </dependencies>
+
+</project>

cim-client-sdk/src/main/java/com/crossoverjie/cim/client/sdk/Client.java

@@ -0,0 +1,39 @@
+package com.crossoverjie.cim.client.sdk;
+
+import com.crossoverjie.cim.client.sdk.impl.ClientBuilderImpl;
+import com.crossoverjie.cim.client.sdk.impl.ClientConfigurationData;
+import com.crossoverjie.cim.common.pojo.CIMUserInfo;
+import com.crossoverjie.cim.route.api.vo.req.P2PReqVO;
+import com.crossoverjie.cim.route.api.vo.res.CIMServerResVO;
+import java.io.Closeable;
+import java.util.Optional;
+import java.util.Set;
+import java.util.concurrent.CompletableFuture;
+
+public interface Client extends Closeable {
+
+    static ClientBuilder builder() {
+        return new ClientBuilderImpl();
+    }
+
+    default void sendP2P(P2PReqVO p2PReqVO) throws Exception{
+        sendP2PAsync(p2PReqVO).get();
+    };
+
+    CompletableFuture<Void> sendP2PAsync(P2PReqVO p2PReqVO);
+
+    default void sendGroup(String msg) throws Exception{
+        sendGroupAsync(msg).get();
+    };
+
+    CompletableFuture<Void> sendGroupAsync(String msg);
+
+    ClientState.State getState();
+
+    ClientConfigurationData.Auth getAuth();
+
+    Set<CIMUserInfo> getOnlineUser() throws Exception;
+
+    Optional<CIMServerResVO> getServerInfo();
+
+}

cim-client-sdk/src/main/java/com/crossoverjie/cim/client/sdk/ClientBuilder.java

@@ -0,0 +1,26 @@
+package com.crossoverjie.cim.client.sdk;
+
+import com.crossoverjie.cim.client.sdk.impl.ClientConfigurationData;
+import com.crossoverjie.cim.client.sdk.io.MessageListener;
+import com.crossoverjie.cim.client.sdk.io.ReconnectCheck;
+import java.util.concurrent.ThreadPoolExecutor;
+
+import com.crossoverjie.cim.client.sdk.io.backoff.BackoffStrategy;
+import okhttp3.OkHttpClient;
+
+/**
+ * @author crossoverJie
+ */
+public interface ClientBuilder {
+
+    Client build();
+    ClientBuilder auth(ClientConfigurationData.Auth auth);
+    ClientBuilder routeUrl(String routeUrl);
+    ClientBuilder loginRetryCount(int loginRetryCount);
+    ClientBuilder event(Event event);
+    ClientBuilder reconnectCheck(ReconnectCheck reconnectCheck);
+    ClientBuilder okHttpClient(OkHttpClient okHttpClient);
+    ClientBuilder messageListener(MessageListener messageListener);
+    ClientBuilder callbackThreadPool(ThreadPoolExecutor callbackThreadPool);
+    ClientBuilder backoffStrategy(BackoffStrategy backoffStrategy);
+}