♻️ refactor(im): 重命名 IM 模块中的多个类和文件以简化结构

YunaiV
1 parent 8b908afe
Showing 93 changed files with 76 additions and 151 deletions
yudao-module-im/pom.xml
yudao-module-im/yudao-module-im-api/src/main/java/cn/iocoder/yudao/module/im/api/package-info.java → yudao-module-im/src/main/java/cn/iocoder/yudao/module/im/api/package-info.java
yudao-module-im/src/main/java/cn/iocoder/yudao/module/im/controller/app/package-info.java
yudao-module-im/src/main/java/cn/iocoder/yudao/module/im/controller/package-info.java
yudao-module-im/yudao-module-im-api/src/main/java/cn/iocoder/yudao/module/im/enums/ErrorCodeConstants.java → yudao-module-im/src/main/java/cn/iocoder/yudao/module/im/enums/ErrorCodeConstants.java
yudao-module-im/yudao-module-im-api/src/main/java/cn/iocoder/yudao/module/im/enums/ImCommonConstants.java → yudao-module-im/src/main/java/cn/iocoder/yudao/module/im/enums/ImCommonConstants.java
yudao-module-im/yudao-module-im-biz/src/main/java/cn/iocoder/yudao/module/im/framework/package-info.java → yudao-module-im/src/main/java/cn/iocoder/yudao/module/im/framework/package-info.java
yudao-module-im/src/main/java/cn/iocoder/yudao/module/im/package-info.java
yudao-module-im/yudao-module-im-biz/src/test/resources/application-unit-test.yaml → yudao-module-im/src/test/resources/application-unit-test.yaml
yudao-module-im/yudao-module-im-biz/src/test/resources/sql/clean.sql → yudao-module-im/src/test/resources/sql/clean.sql
yudao-module-im/yudao-module-im-biz/src/test/resources/sql/create_tables.sql → yudao-module-im/src/test/resources/sql/create_tables.sql
yudao-module-im/yudao-module-im-api/pom.xml
yudao-module-im/yudao-module-im-api/src/main/java/cn/iocoder/yudao/module/im/enums/message/ImMessageSceneEnum.java
yudao-module-im/yudao-module-im-biz/pom.xml
yudao-server/pom.xml
@@ -7,24 +7,67 @@
         <artifactId>yudao</artifactId>
         <version>${revision}</version>
     </parent>
-    <modules>
-        <module>yudao-module-im-api</module>
-        <module>yudao-module-im-biz</module>
-    </modules>
     <modelVersion>4.0.0</modelVersion>
     <artifactId>yudao-module-im</artifactId>
-    <packaging>pom</packaging>
+    <packaging>jar</packaging>
     <name>${project.artifactId}</name>
     <description>
-        <!-- TODO 芋艿：这块后面再调整下 -->
-        im 模块，主要提供能力：
-        1. 通讯能力，例如：消息发送、消息接收、消息撤回、消息已读等。
-        2. 通讯会话，例如：单聊、群聊、聊天室等。
-        3. 通讯消息，例如：文本、图片、语音、视频、文件等。
-        4. 通讯消息的存储，例如：消息存储、消息索引、消息搜索等。
-        5. 通讯消息的推送，例如：消息推送、消息通知等。
-        6. 通讯消息的安全，例如：消息加密、消息签名等。
+        im 模块，我们放即时通讯业务。
+        例如说：单聊、群聊、消息收发、消息撤回、消息已读等等
     </description>
-</project>
 \ No newline at end of file
+    <dependencies>
+        <dependency>
+            <groupId>cn.iocoder.boot</groupId>
+            <artifactId>yudao-module-system</artifactId>
+            <version>${revision}</version>
+        </dependency>
+
+        <dependency>
+            <groupId>cn.iocoder.boot</groupId>
+            <artifactId>yudao-common</artifactId>
+        </dependency>
+
+        <!-- Web 相关 -->
+        <dependency>
+            <groupId>cn.iocoder.boot</groupId>
+            <artifactId>yudao-spring-boot-starter-web</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>cn.iocoder.boot</groupId>
+            <artifactId>yudao-spring-boot-starter-security</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>cn.iocoder.boot</groupId>
+            <artifactId>yudao-spring-boot-starter-websocket</artifactId>
+        </dependency>
+
+        <!-- DB 相关 -->
+        <dependency>
+            <groupId>cn.iocoder.boot</groupId>
+            <artifactId>yudao-spring-boot-starter-mybatis</artifactId>
+        </dependency>
+
+        <dependency>
+            <groupId>cn.iocoder.boot</groupId>
+            <artifactId>yudao-spring-boot-starter-redis</artifactId>
+        </dependency>
+
+        <!-- 工具类相关 -->
+        <dependency>
+            <groupId>cn.iocoder.boot</groupId>
+            <artifactId>yudao-spring-boot-starter-excel</artifactId>
+        </dependency>
+
+        <!-- Test 测试相关 -->
+        <dependency>
+            <groupId>cn.iocoder.boot</groupId>
+            <artifactId>yudao-spring-boot-starter-test</artifactId>
+        </dependency>
+
+    </dependencies>
+
+</project>
+/**
+ * 占位
+ */
+package cn.iocoder.yudao.module.im.controller.app;
+/**
+ * 提供 RESTful API 给前端：
+ * 1. admin 包：提供给管理后台 yudao-ui-admin 前端项目
+ * 2. app 包：提供给用户 APP yudao-ui-app 前端项目，它的 Controller 和 VO 都要添加 App 前缀，用于和管理后台进行区分
+ */
+package cn.iocoder.yudao.module.im.controller;
+/**
+ * im 模块，我们放即时通讯业务。
+ * 例如说：单聊、群聊、消息收发、消息撤回、消息已读等等
+ *
+ * 1. Controller URL：以 /im/ 开头，避免和其它 Module 冲突
+ * 2. DataObject 表名：以 im_ 开头，方便在数据库中区分
+ */
+package cn.iocoder.yudao.module.im;
-<?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">
-    <parent>
-        <groupId>cn.iocoder.boot</groupId>
-        <artifactId>yudao-module-im</artifactId>
-        <version>${revision}</version>
-    </parent>
-    <modelVersion>4.0.0</modelVersion>
-    <artifactId>yudao-module-im-api</artifactId>
-    <packaging>jar</packaging>
-
-    <name>${project.artifactId}</name>
-    <description>
-        im 模块 API，暴露给其它模块调用
-    </description>
-
-    <dependencies>
-        <dependency>
-            <groupId>cn.iocoder.boot</groupId>
-            <artifactId>yudao-common</artifactId>
-        </dependency>
-    </dependencies>
-
-</project>
 \ No newline at end of file
-package cn.iocoder.yudao.module.im.enums.message;
-
-import cn.iocoder.yudao.framework.common.core.ArrayValuable;
-import lombok.Getter;
-import lombok.RequiredArgsConstructor;
-
-import java.util.Arrays;
-
-/**
- * IM 消息场景枚举
- *
- * @author 芋道源码
- */
-@RequiredArgsConstructor
-@Getter
-public enum ImMessageSceneEnum implements ArrayValuable<Integer> {
-
-    PRIVATE(1, "私聊"),
-    GROUP(2, "群聊");
-
-    public static final Integer[] ARRAYS = Arrays.stream(values()).map(ImMessageSceneEnum::getScene).toArray(Integer[]::new);
-
-    /**
-     * 场景
-     */
-    private final Integer scene;
-    /**
-     * 名字
-     */
-    private final String name;
-
-    @Override
-    public Integer[] array() {
-        return ARRAYS;
-    }
-
-}
-<?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">
-    <parent>
-        <artifactId>yudao-module-im</artifactId>
-        <groupId>cn.iocoder.boot</groupId>
-        <version>${revision}</version>
-    </parent>
-    <modelVersion>4.0.0</modelVersion>
-    <packaging>jar</packaging>
-
-    <artifactId>yudao-module-im-biz</artifactId>
-
-    <name>${project.artifactId}</name>
-    <description>
-        im 模块，主要实现 im 模块的业务逻辑。
-    </description>
-
-    <dependencies>
-        <dependency>
-            <groupId>cn.iocoder.boot</groupId>
-            <artifactId>yudao-module-im-api</artifactId>
-            <version>${revision}</version>
-        </dependency>
-        <dependency>
-            <groupId>cn.iocoder.boot</groupId>
-            <artifactId>yudao-module-system</artifactId>
-            <version>${revision}</version>
-        </dependency>
-
-        <!-- Web 相关 -->
-        <dependency>
-            <groupId>cn.iocoder.boot</groupId>
-            <artifactId>yudao-spring-boot-starter-web</artifactId>
-        </dependency>
-
-        <dependency>
-            <groupId>cn.iocoder.boot</groupId>
-            <artifactId>yudao-spring-boot-starter-security</artifactId>
-        </dependency>
-
-        <dependency>
-            <groupId>cn.iocoder.boot</groupId>
-            <artifactId>yudao-spring-boot-starter-websocket</artifactId>
-        </dependency>
-
-        <!-- DB 相关 -->
-        <dependency>
-            <groupId>cn.iocoder.boot</groupId>
-            <artifactId>yudao-spring-boot-starter-mybatis</artifactId>
-        </dependency>
-
-        <dependency>
-            <groupId>cn.iocoder.boot</groupId>
-            <artifactId>yudao-spring-boot-starter-redis</artifactId>
-        </dependency>
-
-        <!-- 工具类相关 -->
-        <dependency>
-            <groupId>cn.iocoder.boot</groupId>
-            <artifactId>yudao-spring-boot-starter-excel</artifactId>
-        </dependency>
-
-        <!-- Test 测试相关 -->
-        <dependency>
-            <groupId>cn.iocoder.boot</groupId>
-            <artifactId>yudao-spring-boot-starter-test</artifactId>
-        </dependency>
-
-    </dependencies>
-
-</project>
 \ No newline at end of file
@@ -125,7 +125,7 @@
         <!-- IM 相关模块。默认注释，保证编译速度 -->
         <dependency>
             <groupId>cn.iocoder.boot</groupId>
-            <artifactId>yudao-module-im-biz</artifactId>
+            <artifactId>yudao-module-im</artifactId>
             <version>${revision}</version>
         </dependency>