系统快速上手部署 👍

写在最前

无论您是多年编程的高级工程师,还是刚刚入门的实习生,部署请完全参考本文档操作。

环境说明

软件版本备注
jdk17支持 Java 21
mysql8要求设置数据库大小写不敏感 lower_case_table_names = 1
redis7+
node18/20/22使用偶数版LTS版本 最高 22.9.0
maven3.8+
IDEA2023+需要安装 lombok 插件

项目下载

git clone https://git.pig4cloud.com/pig/pigx.git

一、检查 IDEA 环境

开发环境环境检查,不会的同学点这里!

请使用 IDEA 2023 以上版本

  1. 设置 JAVA17 开发环境
    • 进入 File → Settings → Build, Execution, Deployment → Compiler → Java Compiler
    • Project Bytecode Version 设置为 17
设置 JAVA17 编译环境
  1. 设置全局编译环境
全局编译环境设置
  1. 设置模块的编译环境
    • File → Project Structure → Modules 中,选中需要调整的模块
    • Language Level 设置为 17(对应 Java SE 17)
设置模块编译环境
Maven 配置步骤

如下图所示:① 点击 IDEA 右侧 Maven 面板; ② 勾选 cloud profile; ③ 点击 Maven Reload ;

Maven 配置界面

二、配置数据库

参数说明

版本: mysql5.7.8+
默认字符集: utf8mb4
默认排序规则: utf8mb4_general_ci

# 要求设置数据库大小写不敏感 https://blog.csdn.net/fdipzone/article/details/73692929
lower_case_table_names = 1

数据库脚本说明

-- 建库语句
source db/1schema.sql;
-- 核心数据库
source db/2pigxx.sql;
-- 工作流相关数据库
source db/3pigxx_flow.sql;
-- 定时任务相关数据库
source db/4pigxx_job.sql;
-- 微信公众号相关数据库
source db/5pigxx_mp.sql;
-- 配置中心数据库
source db/6pigxx_config.sql;
-- 支付模块数据库
source db/7pigxx_pay.sql;
-- 代码生成模块数据库
source db/8pigxx_codegen.sql;
-- 报表设计数据库
source db/99pigxx_bi.sql;
-- APP模块数据库
source db/999pigxx_app.sql;
-- 【特别说明】大屏设计器:pigxx_report,自动创建表没有 DML SQL

关于系统账号密码说明

系统作用账号密码
pigx-ui用户登录admin/123456
pigx-registernacos 注册配置中心nacos/nacos
pigx-sentinel-dashboardsentinel 流量保护sentinel/sentinel
pigx-monitor服务监控pigx/pigx
pigx-bi-platform报表设计平台pigx/pigx

三、配置本地 hosts

hosts 配置要求

必须按此步骤配置,禁止修改代码中配置成固定 IP win 配置方法 | mac 配置方法 | 懒人建议: 使用 switchhost 快速切换 host 梯子、VPN 等软件会导致 hosts 配置失效,请关闭!

127.0.0.1 pigx-register
127.0.0.1 pigx-gateway
127.0.0.1 pigx-redis
127.0.0.1 pigx-xxl
127.0.0.1 pigx-mysql
127.0.0.1 pigx-sentinel
127.0.0.1 pigx-monitor
127.0.0.1 pigx-seata

四、配置修改

① nacos 数据源修改

# pigx/pigx-register/src/main/resources/application.properties
# 数据源相关配置修改正确的密码
db.user=用户
db.password=密码

② 启动 PigxNacosApplication

pigx/pigx-register/src/main/java/com/alibaba/nacos/PigxNacosApplication.java

③ 浏览器访问 http://127.0.0.1:18080 (pigx 5.9+) 默认账号密码(nacos/nacos)

④ 编辑 【浏览器 Nacos 中】application-dev.yml 修改 redis 配置

spring:
  data:
    redis:
      password: #有密码就改,没密码删除此属性
Nacos 配置界面

⑤ 编辑【浏览器 Nacos 中】 修改数据库配置

序号配置文件名称备注
1pigx-upms-biz-dev.yml修改数据库链接信息、文件上传本地路径信息
2pigx-codegen-dev.yml修改数据库链接信息
3pigx-pay-platform-dev.yml修改数据库链接信息
4pigx-flow-biz-dev.yml修改数据库链接信息
5pigx-mp-platform-dev.yml修改数据库链接信息
6pigx-daemon-elastic-job-dev.yml修改数据库链接信息
7pigx-daemon-quartz-dev.yml修改数据库链接信息
8pigx-report-platform-dev.yml修改数据库链接信息、文件上传存储路径
spring:
  datasource:
    username: ${MYSQL-USER:root} #只需要修改此处用户名密码 , 冒号后边部分
    password: ${MYSQL-PWD:root} #只需要修改此处用户名密码, 冒号后边部分
    url: jdbc:mysql://${MYSQL-HOST:pigx-mysql}:${MYSQL-PORT:3306}/.... #酌情修改此处端口, 冒号后边部分

五、启动顺序(基础模块)

1.pigx-register/PigxNacosApplication.java
2.pigx-upms-biz/PigxAdminApplication   [注意启动完毕输出路由初始化完毕再去启动其他模块]
3.pigx-auth/PigxAuthApplication
4.pigx-gateway/PigxGatewayApplication
以上服务为核心基础服务,其他服务按需启动。

IDEA Service 面板可能显示不全 SpringBoot 的 Main 启动类,直接按上边模块去根目录找 Main 方法启动即可。

六、启动前端

Node 版本要求

Node 版本必须使用 18,如遇 install 失败,请删除 node_modules 文件夹,尝试重新 npm install

# 查看 node 版本
node -v

# 高版本执行切换至 18
n 18.20.4

# 下载前端源码
git clone https://git.pig4cloud.com/pig/pigx-ui.git

# 安装前端依赖
npm install --registry=https://registry.npmmirror.com

# 启动
npm run dev

常见问题

问题排查建议

工单系统搜索可以解决大部分问题,注意使用关键词搜索。新建工单时请提供日志、截图、复现步骤。

工单系统搜索界面