微服务架构模式的切换

README.md

@@ -55,3 +55,7 @@ com.ruoyi
 15. 服务监控：监视当前系统CPU、内存、磁盘、堆栈等相关信息。
 16. 在线构建器：拖动表单元素生成相应的HTML代码。
 17. 连接池监视：监视当前系统数据库连接池状态，可进行分析SQL找出系统性能瓶颈。
+
+# 微服务架构模式的切换
+
+详见[微服务架构在不同模式下的切换](./STRUCTURE_MODE.md)

STRUCTURE_MODE.md

@@ -0,0 +1,28 @@
+# 微服务架构模式的切换
+
+- 常规微服务架构模式 
+- all-in-one架构模式（将大部分模块集成到ruoyi-system模块里）
+
+### 常规微服务架构
+
+1. 确保ruoyi-system模块的maven依赖里，**没有**引入其他模块的依赖，需要检查的依赖如下：
+    - ruoyi-auth（鉴权模块）
+    - ruoyi-file（文件模块）
+    - ruoyi-job（定时任务模块）
+    - 其他后续追加的业务模块...
+2. nacos配置使用**GROUP_ALL_IN_1**分组
+3. ruoyi-system模块的入口启动类使用`com.ruoyi.system.RuoYiSystemApplication`
+4. 注解掉ruoyi-system模块里其他模式的入口启动类
+5. 【可选】ruoyi-system模块的`bootstrap.yml`里，关闭配置项：`spring.main.allow-bean-definition-overriding: false`
+
+### all-in-one架构模式
+
+1. 确保ruoyi-system模块的maven依赖里，**引入了**其他模块的依赖，需要检查的依赖如下：
+    - ruoyi-auth（鉴权模块）
+    - ruoyi-file（文件模块）
+    - ruoyi-job（定时任务模块）
+    - 其他后续追加的业务模块...
+2. nacos配置使用**DEFAULT_GROUP**分组
+3. ruoyi-system模块的入口启动类使用`com.ruoyi.SystemAllApplication`
+4. 注解掉ruoyi-system模块里其他模式的入口启动类
+5. ruoyi-system模块的`bootstrap.yml`里，确保开启配置项：`spring.main.allow-bean-definition-overriding: true`

pom.xml

@@ -219,6 +219,27 @@
                 <version>${ruoyi.version}</version>
             </dependency>
 
+            <!-- 鉴权模块 -->
+            <dependency>
+                <groupId>com.ruoyi</groupId>
+                <artifactId>ruoyi-auth</artifactId>
+                <version>${ruoyi.version}</version>
+            </dependency>
+
+            <!-- 文件模块 -->
+            <dependency>
+                <groupId>com.ruoyi</groupId>
+                <artifactId>ruoyi-modules-file</artifactId>
+                <version>${ruoyi.version}</version>
+            </dependency>
+
+            <!-- 定时任务模块 -->
+            <dependency>
+                <groupId>com.ruoyi</groupId>
+                <artifactId>ruoyi-modules-job</artifactId>
+                <version>${ruoyi.version}</version>
+            </dependency>
+
         </dependencies>
     </dependencyManagement>
 

ruoyi-api/ruoyi-api-system/src/main/java/com/ruoyi/system/api/RemoteLogService.java

@@ -17,25 +17,24 @@ import com.ruoyi.system.api.factory.RemoteLogFallbackFactory;
  * @author ruoyi
  */
 @FeignClient(contextId = "remoteLogService", value = ServiceNameConstants.SYSTEM_SERVICE, fallbackFactory = RemoteLogFallbackFactory.class)
-public interface RemoteLogService
+public interface RemoteLogService {
-{
     /**
      * 保存系统日志
      *
      * @param sysOperLog 日志实体
-     * @param source 请求来源
+     * @param source     请求来源
      * @return 结果
      */
     @PostMapping("/operlog")
-    public R<Boolean> saveLog(@RequestBody SysOperLog sysOperLog, @RequestHeader(SecurityConstants.FROM_SOURCE) String source) throws Exception;
+    R<Boolean> saveLog(@RequestBody SysOperLog sysOperLog, @RequestHeader(SecurityConstants.FROM_SOURCE) String source) throws Exception;
 
     /**
      * 保存访问记录
      *
      * @param sysLogininfor 访问实体
-     * @param source 请求来源
+     * @param source        请求来源
      * @return 结果
      */
     @PostMapping("/logininfor")
-    public R<Boolean> saveLogininfor(@RequestBody SysLogininfor sysLogininfor, @RequestHeader(SecurityConstants.FROM_SOURCE) String source);
+    R<Boolean> saveLogininfor(@RequestBody SysLogininfor sysLogininfor, @RequestHeader(SecurityConstants.FROM_SOURCE) String source);
 }

ruoyi-auth/src/main/java/com/ruoyi/auth/RuoYiAuthApplication.java

@@ -2,6 +2,7 @@ package com.ruoyi.auth;
 
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
 import org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration;
 import com.ruoyi.common.security.annotation.EnableRyFeignClients;
 
@@ -10,6 +11,7 @@ import com.ruoyi.common.security.annotation.EnableRyFeignClients;
  * 
  * @author ruoyi
  */
+@ConditionalOnProperty(name = "spring.cloud.nacos.config.group", havingValue = "DEFAULT_GROUP", matchIfMissing = true)
 @EnableRyFeignClients
 @SpringBootApplication(exclude = {DataSourceAutoConfiguration.class })
 public class RuoYiAuthApplication

ruoyi-auth/src/main/java/com/ruoyi/auth/service/SysLoginService.java

@@ -24,8 +24,7 @@ import com.ruoyi.system.api.model.LoginUser;
  * @author ruoyi
  */
 @Component
-public class SysLoginService
+public class SysLoginService {
-{
     @Autowired
     private RemoteUserService remoteUserService;
 
@@ -41,58 +40,49 @@ public class SysLoginService
     /**
      * 登录
      */
-    public LoginUser login(String username, String password)
+    public LoginUser login(String username, String password) {
-    {
         // 用户名或密码为空 错误
-        if (StringUtils.isAnyBlank(username, password))
+        if (StringUtils.isAnyBlank(username, password)) {
-        {
             recordLogService.recordLogininfor(username, Constants.LOGIN_FAIL, "用户/密码必须填写");
             throw new ServiceException("用户/密码必须填写");
         }
         // 密码如果不在指定范围内 错误
         if (password.length() < UserConstants.PASSWORD_MIN_LENGTH
-                || password.length() > UserConstants.PASSWORD_MAX_LENGTH)
+                || password.length() > UserConstants.PASSWORD_MAX_LENGTH) {
-        {
             recordLogService.recordLogininfor(username, Constants.LOGIN_FAIL, "用户密码不在指定范围");
             throw new ServiceException("用户密码不在指定范围");
         }
         // 用户名不在指定范围内 错误
         if (username.length() < UserConstants.USERNAME_MIN_LENGTH
-                || username.length() > UserConstants.USERNAME_MAX_LENGTH)
+                || username.length() > UserConstants.USERNAME_MAX_LENGTH) {
-        {
             recordLogService.recordLogininfor(username, Constants.LOGIN_FAIL, "用户名不在指定范围");
             throw new ServiceException("用户名不在指定范围");
         }
         // IP黑名单校验
         String blackStr = Convert.toStr(redisService.getCacheObject(CacheConstants.SYS_LOGIN_BLACKIPLIST));
-        if (IpUtils.isMatchedIp(blackStr, IpUtils.getIpAddr()))
+        if (IpUtils.isMatchedIp(blackStr, IpUtils.getIpAddr())) {
-        {
             recordLogService.recordLogininfor(username, Constants.LOGIN_FAIL, "很遗憾，访问IP已被列入系统黑名单");
             throw new ServiceException("很遗憾，访问IP已被列入系统黑名单");
         }
         // 查询用户信息
         R<LoginUser> userResult = remoteUserService.getUserInfo(username, SecurityConstants.INNER);
 
-        if (StringUtils.isNull(userResult) || StringUtils.isNull(userResult.getData()))
+        if (StringUtils.isNull(userResult) || StringUtils.isNull(userResult.getData())) {
-        {
             recordLogService.recordLogininfor(username, Constants.LOGIN_FAIL, "登录用户不存在");
             throw new ServiceException("登录用户：" + username + " 不存在");
         }
 
-        if (R.FAIL == userResult.getCode())
+        if (R.FAIL == userResult.getCode()) {
-        {
             throw new ServiceException(userResult.getMsg());
         }
 
         LoginUser userInfo = userResult.getData();
         SysUser user = userResult.getData().getSysUser();
-        if (UserStatus.DELETED.getCode().equals(user.getDelFlag()))
+        if (UserStatus.DELETED.getCode().equals(user.getDelFlag())) {
-        {
             recordLogService.recordLogininfor(username, Constants.LOGIN_FAIL, "对不起，您的账号已被删除");
             throw new ServiceException("对不起，您的账号：" + username + " 已被删除");
         }
-        if (UserStatus.DISABLE.getCode().equals(user.getStatus()))
+        if (UserStatus.DISABLE.getCode().equals(user.getStatus())) {
-        {
             recordLogService.recordLogininfor(username, Constants.LOGIN_FAIL, "用户已停用，请联系管理员");
             throw new ServiceException("对不起，您的账号：" + username + " 已停用");
         }
@@ -101,29 +91,24 @@ public class SysLoginService
         return userInfo;
     }
 
-    public void logout(String loginName)
+    public void logout(String loginName) {
-    {
         recordLogService.recordLogininfor(loginName, Constants.LOGOUT, "退出成功");
     }
 
     /**
      * 注册
      */
-    public void register(String username, String password)
+    public void register(String username, String password) {
-    {
         // 用户名或密码为空 错误
-        if (StringUtils.isAnyBlank(username, password))
+        if (StringUtils.isAnyBlank(username, password)) {
-        {
             throw new ServiceException("用户/密码必须填写");
         }
         if (username.length() < UserConstants.USERNAME_MIN_LENGTH
-                || username.length() > UserConstants.USERNAME_MAX_LENGTH)
+                || username.length() > UserConstants.USERNAME_MAX_LENGTH) {
-        {
             throw new ServiceException("账户长度必须在2到20个字符之间");
         }
         if (password.length() < UserConstants.PASSWORD_MIN_LENGTH
-                || password.length() > UserConstants.PASSWORD_MAX_LENGTH)
+                || password.length() > UserConstants.PASSWORD_MAX_LENGTH) {
-        {
             throw new ServiceException("密码长度必须在5到20个字符之间");
         }
 
@@ -134,8 +119,7 @@ public class SysLoginService
         sysUser.setPassword(SecurityUtils.encryptPassword(password));
         R<?> registerResult = remoteUserService.registerUserInfo(sysUser, SecurityConstants.INNER);
 
-        if (R.FAIL == registerResult.getCode())
+        if (R.FAIL == registerResult.getCode()) {
-        {
             throw new ServiceException(registerResult.getMsg());
         }
         recordLogService.recordLogininfor(username, Constants.REGISTER, "注册成功");

ruoyi-auth/src/main/java/com/ruoyi/auth/service/SysRecordLogService.java

@@ -15,8 +15,7 @@ import com.ruoyi.system.api.domain.SysLogininfor;
  * @author ruoyi
  */
 @Component
-public class SysRecordLogService
+public class SysRecordLogService {
-{
     @Autowired
     private RemoteLogService remoteLogService;
 
@@ -24,23 +23,18 @@ public class SysRecordLogService
      * 记录登录信息
      *
      * @param username 用户名
-     * @param status 状态
+     * @param status   状态
-     * @param message 消息内容
+     * @param message  消息内容
-     * @return
      */
-    public void recordLogininfor(String username, String status, String message)
+    public void recordLogininfor(String username, String status, String message) {
-    {
         SysLogininfor logininfor = new SysLogininfor();
         logininfor.setUserName(username);
         logininfor.setIpaddr(IpUtils.getIpAddr());
         logininfor.setMsg(message);
         // 日志状态
-        if (StringUtils.equalsAny(status, Constants.LOGIN_SUCCESS, Constants.LOGOUT, Constants.REGISTER))
+        if (StringUtils.equalsAny(status, Constants.LOGIN_SUCCESS, Constants.LOGOUT, Constants.REGISTER)) {
-        {
             logininfor.setStatus(Constants.LOGIN_SUCCESS_STATUS);
-        }
+        } else if (Constants.LOGIN_FAIL.equals(status)) {
-        else if (Constants.LOGIN_FAIL.equals(status))
-        {
             logininfor.setStatus(Constants.LOGIN_FAIL_STATUS);
         }
         remoteLogService.saveLogininfor(logininfor, SecurityConstants.INNER);

ruoyi-auth/src/main/resources/bootstrap.yml

@@ -23,3 +23,5 @@ spring:
         # 共享配置
         shared-configs:
           - application-${spring.profiles.active}.${spring.cloud.nacos.config.file-extension}
+        # 指定分组
+        group: DEFAULT_GROUP #默认微服务组

ruoyi-common/ruoyi-common-core/src/main/java/com/ruoyi/common/core/constant/ServiceNameConstants.java

@@ -5,20 +5,19 @@ package com.ruoyi.common.core.constant;
  *
  * @author ruoyi
  */
-public class ServiceNameConstants
+public class ServiceNameConstants {
-{
     /**
-     * 认证服务的serviceid
+     * 认证服务的serviceId
      */
     public static final String AUTH_SERVICE = "ruoyi-auth";
 
     /**
-     * 系统模块的serviceid
+     * 系统模块的serviceId
      */
     public static final String SYSTEM_SERVICE = "ruoyi-system";
 
     /**
-     * 文件服务的serviceid
+     * 文件服务的serviceId
      */
     public static final String FILE_SERVICE = "ruoyi-file";
 }

ruoyi-gateway/src/main/resources/bootstrap.yml

@@ -23,6 +23,9 @@ spring:
         # 共享配置
         shared-configs:
           - application-${spring.profiles.active}.${spring.cloud.nacos.config.file-extension}
+        # 指定分组
+#        group: DEFAULT_GROUP #默认微服务组
+        group: GROUP_ALL_IN_1 #多模块集成在system模块里的模式
     sentinel:
       # 取消控制台懒加载
       eager: true

ruoyi-modules/ruoyi-file/src/main/java/com/ruoyi/file/RuoYiFileApplication.java

@@ -2,6 +2,7 @@ package com.ruoyi.file;
 
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
 import org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration;
 import com.ruoyi.common.swagger.annotation.EnableCustomSwagger2;
 
@@ -10,6 +11,7 @@ import com.ruoyi.common.swagger.annotation.EnableCustomSwagger2;
  * 
  * @author ruoyi
  */
+@ConditionalOnProperty(name = "spring.cloud.nacos.config.group", havingValue = "DEFAULT_GROUP", matchIfMissing = true)
 @EnableCustomSwagger2
 @SpringBootApplication(exclude = {DataSourceAutoConfiguration.class })
 public class RuoYiFileApplication

ruoyi-modules/ruoyi-file/src/main/resources/bootstrap.yml

@@ -23,3 +23,5 @@ spring:
         # 共享配置
         shared-configs:
           - application-${spring.profiles.active}.${spring.cloud.nacos.config.file-extension}
+        # 指定分组
+        group: DEFAULT_GROUP #默认微服务组

ruoyi-modules/ruoyi-gen/src/main/resources/bootstrap.yml

@@ -23,3 +23,6 @@ spring:
         # 共享配置
         shared-configs:
           - application-${spring.profiles.active}.${spring.cloud.nacos.config.file-extension}
+        # 指定分组
+#        group: DEFAULT_GROUP #默认微服务组
+        group: GROUP_ALL_IN_1 #多模块集成在system模块里的模式

ruoyi-modules/ruoyi-job/src/main/java/com/ruoyi/job/RuoYiJobApplication.java

@@ -5,12 +5,14 @@ import org.springframework.boot.autoconfigure.SpringBootApplication;
 import com.ruoyi.common.security.annotation.EnableCustomConfig;
 import com.ruoyi.common.security.annotation.EnableRyFeignClients;
 import com.ruoyi.common.swagger.annotation.EnableCustomSwagger2;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
 
 /**
  * 定时任务
  * 
  * @author ruoyi
  */
+@ConditionalOnProperty(name = "spring.cloud.nacos.config.group", havingValue = "DEFAULT_GROUP", matchIfMissing = true)
 @EnableCustomConfig
 @EnableCustomSwagger2
 @EnableRyFeignClients   

ruoyi-modules/ruoyi-job/src/main/resources/bootstrap.yml

@@ -23,3 +23,5 @@ spring:
         # 共享配置
         shared-configs:
           - application-${spring.profiles.active}.${spring.cloud.nacos.config.file-extension}
+        # 指定分组
+        group: DEFAULT_GROUP #默认微服务组

ruoyi-modules/ruoyi-system/pom.xml

@@ -88,6 +88,24 @@
             <artifactId>ruoyi-common-swagger</artifactId>
         </dependency>
 
+        <!-- =============================================================================== -->
+
+        <!-- 可选部署：合并鉴权模块 -->
+        <dependency>
+            <groupId>com.ruoyi</groupId>
+            <artifactId>ruoyi-auth</artifactId>
+        </dependency>
+        <!-- 可选部署：合并文件模块 -->
+        <dependency>
+            <groupId>com.ruoyi</groupId>
+            <artifactId>ruoyi-modules-file</artifactId>
+        </dependency>
+        <!-- 可选部署：合并定时任务模块 -->
+        <dependency>
+            <groupId>com.ruoyi</groupId>
+            <artifactId>ruoyi-modules-job</artifactId>
+        </dependency>
+
     </dependencies>
 
     <build>

ruoyi-modules/ruoyi-system/src/main/java/com/ruoyi/SystemAllApplication.java

@@ -0,0 +1,25 @@
+package com.ruoyi;
+
+import com.alibaba.druid.spring.boot3.autoconfigure.DruidDataSourceAutoConfigure;
+import com.ruoyi.common.security.annotation.EnableCustomConfig;
+import com.ruoyi.common.security.annotation.EnableRyFeignClients;
+import com.ruoyi.common.swagger.annotation.EnableCustomSwagger2;
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+
+/**
+ * 多合一启动器
+ *
+ * @author Alan Scipio
+ * created on 2024/1/31
+ */
+@EnableCustomConfig
+@EnableCustomSwagger2
+@EnableRyFeignClients
+@SpringBootApplication(exclude = {DruidDataSourceAutoConfigure.class})
+public class SystemAllApplication {
+    public static void main(String[] args) {
+        SpringApplication.run(SystemAllApplication.class, args);
+        System.out.println("(♥◠‿◠)ﾉﾞ  系统模块(All-in-one模式)启动成功   ლ(´ڡ`ლ)ﾞ");
+    }
+}

ruoyi-modules/ruoyi-system/src/main/java/com/ruoyi/system/RuoYiSystemApplication.java

@@ -12,13 +12,13 @@ import com.ruoyi.common.swagger.annotation.EnableCustomSwagger2;
  *
  * @author ruoyi
  */
-@EnableCustomConfig
+//@EnableCustomConfig
-@EnableCustomSwagger2
+//@EnableCustomSwagger2
-@EnableRyFeignClients
+//@EnableRyFeignClients
-@SpringBootApplication(exclude = {DruidDataSourceAutoConfigure.class})
+//@SpringBootApplication(exclude = {DruidDataSourceAutoConfigure.class})
 public class RuoYiSystemApplication {
     public static void main(String[] args) {
         SpringApplication.run(RuoYiSystemApplication.class, args);
-        System.out.println("(♥◠‿◠)ﾉﾞ  系统模块启动成功   ლ(´ڡ`ლ)ﾞ");
+        System.out.println("(♥◠‿◠)ﾉﾞ  系统模块(常规模式)启动成功   ლ(´ڡ`ლ)ﾞ");
     }
 }

ruoyi-modules/ruoyi-system/src/main/resources/bootstrap.yml

@@ -7,6 +7,8 @@ spring:
   application:
     # 应用名称
     name: ruoyi-system
+  main:
+    allow-bean-definition-overriding: true # All-in-one模式下必须
   profiles:
     # 环境配置
     active: dev
@@ -23,3 +25,6 @@ spring:
         # 共享配置
         shared-configs:
           - application-${spring.profiles.active}.${spring.cloud.nacos.config.file-extension}
+        # 指定分组
+#        group: DEFAULT_GROUP #默认微服务组
+        group: GROUP_ALL_IN_1 #多模块集成在system模块里的模式

ruoyi-visual/ruoyi-monitor/src/main/resources/bootstrap.yml

@@ -23,3 +23,6 @@ spring:
         # 共享配置
         shared-configs:
           - application-${spring.profiles.active}.${spring.cloud.nacos.config.file-extension}
+        # 指定分组
+#        group: DEFAULT_GROUP #默认微服务组
+        group: GROUP_ALL_IN_1 #多模块集成在system模块里的模式