# scaffold 项目

# 简介

自用的项目骨架

有任何问题，或者想要的功能，可以在博客首页联系作者

• 管理后台的电脑端：Vue3 提供 element-plus
• 后端采用 Spring Boot 多模块架构、MySQL + MyBatis Plus、Redis + Redisson
• 数据库可使用 MySQL、Oracle、PostgreSQL、SQL Server、MariaDB、国产达梦 DM、TiDB 等
• 权限认证使用 Spring Security & Token & Redis，支持多终端、多种用户的认证系统，支持 SSO 单点登录
• 支持加载动态权限菜单，按钮级别权限控制，本地缓存提升性能
• 支持 SaaS 多租户，可自定义每个租户的权限，提供透明化的多租户底层封装
• 工作流使用 Flowable，支持动态表单、在线设计流程、会签 / 或签、多种任务分配方式
• 高效率开发，使用代码生成器可以一键生成前后端代码 + 单元测试 + Swagger 接口文档 + Validator 参数校验
• 集成微信小程序、微信公众号、企业微信、钉钉等三方登陆，集成支付宝、微信等支付与退款
• 集成阿里云、腾讯云等短信渠道，集成 MinIO、阿里云、腾讯云、七牛云等云存储服务
• 集成报表设计器、大屏设计器，通过拖拽即可生成酷炫的报表与大屏
• 集成 liquibase 实现数据库版本控制

# 项目关系

# 后端项目

# 前端项目

# 内置功能

系统内置多种多种业务功能，可以用于快速你的业务系统：

• 通用模块（必选）：系统功能、基础设施
• 通用模块（可选）：工作流程、支付系统、数据报表、会员中心
• 业务系统（按需）：ERP 系统、CRM 系统、商城系统、微信公众号、AI 大模型

友情提示：本项目基于 RuoYi-Vue-Pro 修改，重构优化后端的代码，美化前端的界面。

• 额外新增的功能，我们使用 🚀 标记。
• 重新实现的功能，我们使用 ⭐️ 标记。

🙂 所有功能，都通过 单元测试 保证高质量。

# 系统功能

# 工作流程

历经头部企业生产验证，工作流引擎须标配仿钉钉 / 飞书 + BPMN 双设计器！！！

前者支持轻量配置简单流程，后者实现复杂场景深度编排

# 支付系统

# 基础设施

# 数据报表

# 微信公众号

# 商城系统

# 会员中心

# ERP 系统

# CRM 系统

# AI 大模型

# 技术栈

# 模块

# 框架

# 项目讲解

# 项目结构和表结构规范

1. 项目结构

   a

2. 表结构

   对应的模块对应表前缀， 如系统相关的表，前缀为：system_

   基础设施服务就是： infra_

# 功能权限

基于 RBAC 权限模型（Role-Based Access Control）的角色访问控制

具体说明查看文档：scaffold 项目之功能权限

# 数据权限

# 用户体系

# 三方登陆

# 部署流程

# 后端项目

docker:

dockerfile 方式启动， 如果访问不到国外镜像，可以看这里使用 github 配合阿里云仓库拉取国外镜像

## AdoptOpenJDK 停止发布 OpenJDK 二进制，而 Eclipse Temurin 是它的延伸，提供更好的稳定性

FROM registry.cn-guangzhou.aliyuncs.com/tzting/eclipse-temurin:21-jre

## 创建目录，并使用它作为工作目录

RUN mkdir -p /scaffold-server

WORKDIR /scaffold-server

## 将后端项目的 Jar 文件，复制到镜像中

COPY scaffold-server.jar app.jar

## 设置 TZ 时区

ENV TZ=Asia/Shanghai

## 设置 JAVA_OPTS 环境变量，可通过 docker run -e "JAVA_OPTS=" 进行覆盖

ENV JAVA_OPTS="-Xms512m -Xmx512m -Djava.security.egd=file:/dev/./urandom"

## 应用参数

ENV ARGS=""

## 暴露后端项目的 48080 端口

EXPOSE 48080

## 启动后端项目

CMD java ${JAVA_OPTS} -jar app.jar $ARGS

目录结构：

-rw-r--r-- 1 root root       676 Jul 26 20:45 application.yml

drwxrwxrwx 2 root root      4096 May  5 21:49 backup

drwxrwxrwx 2 root root      4096 May  5 21:46 build

-rwxrwxrwx 1 root root       548 May  5 23:13 deploy.sh

-rw-r--r-- 1 root root       951 Jul 26 20:37 Dockerfile

-rwxrwxrwx 1 root root       758 May  5 21:34 Dockerfile_bak_20240726

-rw-r--r-- 1 root root 239261495 May 20 21:01 scaffold-server.jar

构建镜像：

docker build -t scaffold-server .

新建 Shell 脚本 deploy.sh ，使用 Docker 启动后端项目

#!/bin/bash

set -e

## 第一步：删除可能启动的老 scaffold-server 容器

echo "开始删除 scaffold-server 容器"

docker stop scaffold-server || true

docker rm scaffold-server || true

echo "完成删除 scaffold-server 容器"

## 第二步：启动新的 scaffold-server 容器 \

echo "开始启动 scaffold-server 容器"

docker run -d \

--name scaffold-server \

-p 48080:48080 \

-e "SPRING_PROFILES_ACTIVE=dev" \

-v /home/software/scaffold-server:/root/logs/ \

scaffold-server

echo "正在启动 scaffold-server 容器中，需要等待 60 秒左右"

构建进行运维命令

docker restart scaffold-server

docker start scaffold-server

docker stop scaffold-server

# 前端项目

npm run build:prod ## 打包 prod 生产环境

npm run build:stage ## 打包 stage 预发布环境

# 商城部署

# 发布为 Web 网站

① 修改项目根目录的 .env 配置文件，修改 SHOPRO_BASE_URL 、 SHOPRO_STATIC_URL 、 SHOPRO_H5_URL 为你的域名地址。

② 阅读 HBuilder 的官方文档 https://zh.uniapp.dcloud.io/quickstart-hx.html 的「发布为 Web 网站」小节。

③ 打包按成后，它其实就是一个静态网站，可以通过 Nginx 进行转发。具体的转发配置，参考 https://juejin.cn/post/7310980511453839375 文章

# 发布为微信小程序

① 修改项目根目录的 .env 配置文件，修改 SHOPRO_BASE_URL 、 SHOPRO_STATIC_URL 、 SHOPRO_H5_URL 为你的域名地址。

② 阅读 HBuilder 的官方文档 https://zh.uniapp.dcloud.io/quickstart-hx.html 的「发布为微信小程序」小节。

注意，微信有各种白名单要配置，可参考 https://blog.csdn.net/weixin_45966674/article/details/133280890 文章

# 仪表盘设计器

下载项目 scaffold-ui-go-view

执行下面的命令

# 安装 pnpm，提升依赖的安装速度

npm config set registry https://registry.npmmirror.com

npm install -g pnpm

# 安装依赖

pnpm install

# 启动服务

npm run dev

打包好将 dist 放到 nginx 的 html 目录下

# nginx 配置

server { ## 后端项目

    listen       80;

    server_name  scaffold.tzzfj.cn; ## 重要！！！修改成你的外网 IP / 域名

    ## 不要使用 location / 转发到后端项目，因为 druid、admin 等监控，不需要外网可访问。或者增加 Nginx IP 白名单限制也可以。

    location /admin-api/ { ## 后端项目 - 管理后台

        proxy_pass http://127.0.0.1:48080/admin-api/; ## 重要！！！proxy_pass 需要设置为后端项目所在服务器的 IP

        proxy_set_header Host $http_host;

        proxy_set_header X-Real-IP $remote_addr;

        proxy_set_header REMOTE-HOST $remote_addr;

        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;

    }

    location /app-api/ { ## 后端项目 - 用户 App

        proxy_pass http://127.0.0.1:48080/app-api/; ## 重要！！！proxy_pass 需要设置为后端项目所在服务器的 IP

        proxy_set_header Host $http_host;

        proxy_set_header X-Real-IP $remote_addr;

        proxy_set_header REMOTE-HOST $remote_addr;

        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;

    }

    location / { ## 前端项目

        root   /home/software/nginx-1.25.5/html/scaffold-ui-admin;

        index  index.html index.htm;

        try_files $uri $uri/ /index.html;

    }

}

推荐使用 nginxWebUi 工具管理， 直接将上面的 nginx 导入， 在将域名改成自己的

# S3 文件服务

# 七牛云

只需要注册，添加一个桶，然后在获取对应的 key 就好， 如果需要自定义域名上传访问文件则可以参考这篇文章： https://blog.csdn.net/weixin_44955793/article/details/130313810

# minio

# 总结

# 参考资料