基于若依搭建微服务nacos版本（ruoyi-Cloud前后端分离）

说明：本文介绍基于Ruoyi-Cloud前后端分离nacos版本的微服务从0到1的搭建过程，同时新增一个新的微服务模块。是基于官方文档的补充说明，需要结合Ruoyi-Cloud的官方文档 https://doc.ruoyi.vip/ruoyi-cloud/

如果直接查看官方文档便可成功部署，推荐直接看官方文档。

以下，我将从自己搭建安装过程中，遇到的坑和bug做详细补充说明，主要涵盖以下几个方面：

1、前置环境搭建（重要）：主要包含nacos、redis。

2、运行系统：主要包含前后端运行，以及运行过程中的关键确认点。

1 环境准备

建议下列组件安装在自己的本机上，或者安装在可以和你的主机相互访问的另一台服务器上，这样初次部署可以规避很多网络访问的坑。

JDK >= 1.8 (推荐1.8版本) # 独自安装即可

Mysql >= 5.7.0 (推荐5.7版本) # 独自安装即可

Redis >= 3.0 # 可以docker安装，参看 https://blog.csdn.net/MoastAll/article/details/129221742

Maven >= 3.0 # 独自安装接口

Node >= 12 # 独自安装即可

nacos >= 2.0.4 (ruoyi-cloud < 3.0 需要下载nacos >= 1.4.x版本) # docker安装

nacos的安装，可以参考我的另一个文章：docker安装nacos

2 运行系统

安装官方的操作进行代码下载和数据库配置

1、前往Gitee下载页面(https://gitee.com/y_project/RuoYi-Cloud (opens new window))下载解压到工作目录

2、导入到Eclipse，菜单 File -> Import，然后选择 Maven -> Existing Maven Projects，点击 Next> 按钮，选择工作目录，然后点击 Finish 按钮，即可成功导入。

Eclipse会自动加载Maven依赖包，初次加载会比较慢（根据自身网络情况而定）

3、创建数据库ry-cloud并导入数据脚本ry_2021xxxx.sql（必须），quartz.sql（可选）

4、创建数据库ry-config并导入数据脚本ry_config_2021xxxx.sql（必须）

5、配置nacos持久化，修改conf/application.properties文件，增加支持mysql数据源配置 # 在上文的docker安装nacos中，进行数据库配置。

需要注意的是，当我们吧ry-config数据导入完成后，请重启nacos，并登录nacos控制台，理论上是可以看到该界面的 ：

如果没有看到该界面，请查看你的

nacos是否有问题，有没有同时打开8848 9848 9849这三个端口
是否存在网络问题：确保你的nacos所在服务器能够访问你在nacos配置文件中配置的数据库
数据库配置是否错误 ：确保在ry-cloud.config_info表中配置的content数据连接内容（mysql、redis等），是可以被你的微服务直接访问的

2.1 后端运行

打开运行基础模块（启动没有先后顺序）

RuoYiGatewayApplication （网关模块必须）

RuoYiAuthApplication （认证模块必须）

RuoYiSystemApplication （系统模块必须）

RuoYiMonitorApplication （监控中心可选）

RuoYiGenApplication （代码生成可选）

RuoYiJobApplication （定时任务可选）

RuoYFileApplication （文件服务可选）

2.2 前端运行

进入项目目录

cd ruoyi-ui

强烈建议不要用直接使用 cnpm 安装，会有各种诡异的 bug，可以通过重新指定 registry 来解决 npm 安装速度慢的问题。

npm install --registry=https://registry.npmmirror.com

本地开发启动项目

npm run dev

4、打开浏览器，输入：(http://localhost:80 (opens new window)) 默认账户/密码 admin/admin123）

若能正确展示登录页面，并能成功登录，菜单及页面展示正常，则表明环境搭建成功

3 新建一个微服务module：ruoyi-jxbd

通过前两步骤，我们已经完成ruoyi-Cloud的启动，接下来我们需要做的基于该框架额外搭建一个微服务module，module名称就叫做：jxbd（不用问我为什么叫这个，随便起的）。

3.1 使用postman调用接口

做开发的第一步是模仿ruoyi的接口实现方式，首先我们要能使用postman调用若依的接口。

登录进ruoyi控制台，打开F12，然后刷新页面。可以看到一些请求接口，这里我们选择getInfo接口，如下图：

我们需要的三个信息：

请求url：http://localhost/dev-api/system/user/getInfo
请求方式：GET
鉴权：Authorization

打开postman，并配置上述信息，发送请求即可，如下：

3.2 模仿ruoyi-system模块，新建一个ruoyi-jxbd模块

先放截图：

基于ruoyi搭建一个新的module需要做的事情有如下几个方面：

1、新增上图所述的目录结构和代码
2、修改主pom文件，增加新模块
3、在ry-cloud.config_info表中，新增一条记录，该记录用于新服务注册到nacos。
4、启动新模块

3.2.1 新建ruoyi-jxbd模块

这个模块的创建，我是参考ruoyi-modules ruoyi-system进行创建的。学习的第一步，像素级复刻，开始！

完整的目录树，见上上图。需要重点关注的文件有：
pom.xml文件：该文件是参考system下面的pom修改的，需要修改的已在下文标注

xml 复制代码

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xmlns="http://maven.apache.org/POM/4.0.0"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <parent>
        <groupId>com.ruoyi</groupId>
        <artifactId>ruoyi</artifactId>
        <version>3.6.3</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>
    
	<!-- 修改为自己的名字 -->
    <artifactId>ruoyi-jxbd</artifactId>

    <description>
    	<!-- 修改为自己的名字 -->
        ruoyi-jxbd系统模块
    </description>

    <dependencies>

        <!-- SpringCloud Alibaba Nacos -->
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
        </dependency>

        <!-- SpringCloud Alibaba Nacos Config -->
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
        </dependency>

        <!-- SpringCloud Alibaba Sentinel -->
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-sentinel</artifactId>
        </dependency>

        <!-- SpringBoot Actuator -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
        </dependency>

        <!-- Swagger UI -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>${swagger.fox.version}</version>
        </dependency>

        <!-- Mysql Connector -->
        <dependency>
            <groupId>com.mysql</groupId>
            <artifactId>mysql-connector-j</artifactId>
        </dependency>

        <!-- RuoYi Common DataSource -->
        <dependency>
            <groupId>com.ruoyi</groupId>
            <artifactId>ruoyi-common-datasource</artifactId>
        </dependency>

        <!-- RuoYi Common DataScope -->
        <dependency>
            <groupId>com.ruoyi</groupId>
            <artifactId>ruoyi-common-datascope</artifactId>
        </dependency>

        <!-- RuoYi Common Log -->
        <dependency>
            <groupId>com.ruoyi</groupId>
            <artifactId>ruoyi-common-log</artifactId>
        </dependency>

        <!-- RuoYi Common Swagger -->
        <dependency>
            <groupId>com.ruoyi</groupId>
            <artifactId>ruoyi-common-swagger</artifactId>
        </dependency>

    </dependencies>

    <build>
        <finalName>${project.artifactId}</finalName>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <executions>
                    <execution>
                        <goals>
                            <goal>repackage</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>

</project>

bootstrap.yml文件，需要注意的点：

1、port，要注意不要和系统已占用的端口、若依的其他模块端口冲突，可以在ReadMe.md中查看ruoyi配置的默认端口。
2、应用名称，修改为ruoyi-jxbd

xml 复制代码

# Tomcat
server:
  port: 9888

# Spring
spring: 
  application:
    # 应用名称
    name: ruoyi-jxbd
  profiles:
    # 环境配置
    active: dev
  cloud:
    nacos:
      discovery:
        # 服务注册地址
        server-addr: 127.0.0.1:8848
      config:
        # 配置中心地址
        server-addr: 127.0.0.1:8848
        # 配置文件格式
        file-extension: yml
        # 共享配置
        shared-configs:
          - application-${spring.profiles.active}.${spring.cloud.nacos.config.file-extension}

其余代码，像素级复刻SysConfigController的具体实现逻辑即可。

3.2.2 修改主pom文件

添加ruoyi-jxbd模块

3.2.3 新增nacos配置

在ry-cloud.config_info表中，新增一条记录：

该记录也是借鉴system模块修改的，主要关注的点：

1、redis和mysql配置
2、mybatis的包名称

sql 复制代码

INSERT INTO `ry-config`.config_info (id, data_id, group_id, content, md5, gmt_create, gmt_modified, src_user, src_ip, app_name, tenant_id, c_desc, c_use, effect, type, c_schema, encrypted_data_key) VALUES (10, 'ruoyi-jxbd-dev.yml', 'DEFAULT_GROUP', '# spring配置
spring:
  redis:
    host: 192.168.10.15
    port: 6379
    password:
  datasource:
    druid:
      stat-view-servlet:
        enabled: true
        loginUsername: admin
        loginPassword: 123456
    dynamic:
      druid:
        initial-size: 5
        min-idle: 5
        maxActive: 20
        maxWait: 60000
        connectTimeout: 30000
        socketTimeout: 60000
        timeBetweenEvictionRunsMillis: 60000
        minEvictableIdleTimeMillis: 300000
        validationQuery: SELECT 1 FROM DUAL
        testWhileIdle: true
        testOnBorrow: false
        testOnReturn: false
        poolPreparedStatements: true
        maxPoolPreparedStatementPerConnectionSize: 20
        filters: stat,slf4j
        connectionProperties: druid.stat.mergeSql\\=true;druid.stat.slowSqlMillis\\=5000
      datasource:
          # 主库数据源
          master:
            driver-class-name: com.mysql.cj.jdbc.Driver
            url: jdbc:mysql://xxxx:3306/database?useUnicode=true&characterEncoding=utf8&zeroDateTimeBehavior=convertToNull&useSSL=true&serverTimezone=GMT%2B8
            username: root
            password: xxxx
          # 从库数据源
          # slave:
            # username: 
            # password: 
            # url: 
            # driver-class-name: 

# mybatis配置
mybatis:
    # 搜索指定包别名
    typeAliasesPackage: com.ruoyi.jxbd
    # 配置mapper的扫描，找到所有的mapper.xml映射文件
    mapperLocations: classpath:mapper/**/*.xml

# swagger配置
swagger:
  title: 系统模块接口文档
  license: Powered By ruoyi
  licenseUrl: https://ruoyi.vip', '00678c89684ec0b825cb9b71e032db65', '2020-11-20 00:00:00', '2023-12-04 07:51:28', 'nacos', '0:0:0:0:0:0:0:1', '', '', '数据模块', 'null', 'null', 'yaml', '', '');

3.2.3 启动新的微服务模块

1、重新编译整个代码工程
2、重启nacos，确保nacos中有ruoyi-jxbd的配置
3、启动gateway、auth、system、jxbd模块
postman调用接口，即可，至此完工。

参考资料：

RuoYi-Cloud介绍：https://doc.ruoyi.vip/ruoyi-cloud/

Ruoyi-Cloud讨论：https://gitee.com/y_project/RuoYi-Cloud/issues/I4956F