This commit is contained in:
zc
2026-02-27 10:50:07 +08:00
parent 0ee56404c2
commit 86527b9c21
611 changed files with 2741 additions and 2752 deletions

110
README.md
View File

@@ -1,44 +1,44 @@
# ContiNew Admin 中后台管理框架
<a href="https://github.com/ysoft-org/ysoft-admin" title="Release" target="_blank">
<a href="https://github.com/wms-org/wms-admin" title="Release" target="_blank">
<img src="https://img.shields.io/badge/SNAPSHOT-v3.6.0-%23ff3f59.svg" alt="Release" />
</a>
<a href="https://github.com/ysoft-org/ysoft-starter" title="ContiNew Starter" target="_blank">
<a href="https://github.com/wms-org/wms-starter" title="ContiNew Starter" target="_blank">
<img src="https://img.shields.io/badge/ContiNew Starter-2.9.0-%236CB52D.svg" alt="ContiNew Starter" />
</a>
<a href="https://spring.io/projects/spring-boot" title="Spring Boot" target="_blank">
<img src="https://img.shields.io/badge/Spring Boot-3.2.12-%236CB52D.svg?logo=Spring-Boot" alt="Spring Boot" />
</a>
<a href="https://github.com/ysoft-org/ysoft-admin" title="Open JDK" target="_blank">
<a href="https://github.com/wms-org/wms-admin" title="Open JDK" target="_blank">
<img src="https://img.shields.io/badge/Open JDK-17-%236CB52D.svg?logo=OpenJDK&logoColor=FFF" alt="Open JDK" />
</a>
<a href="https://app.codacy.com/gh/ysoft-org/ysoft-admin/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade" title="Codacy" target="_blank">
<a href="https://app.codacy.com/gh/wms-org/wms-admin/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade" title="Codacy" target="_blank">
<img src="https://app.codacy.com/project/badge/Grade/19e3e2395d554efe902c3822e65db30e" alt="Codacy" />
</a>
<a href="https://sonarcloud.io/summary/new_code?id=Charles7c_ysoft-admin" title="Sonar" target="_blank">
<img src="https://sonarcloud.io/api/project_badges/measure?project=Charles7c_ysoft-admin&metric=alert_status" alt="Sonar" />
<a href="https://sonarcloud.io/summary/new_code?id=Charles7c_wms-admin" title="Sonar" target="_blank">
<img src="https://sonarcloud.io/api/project_badges/measure?project=Charles7c_wms-admin&metric=alert_status" alt="Sonar" />
</a>
<br />
<a href="https://github.com/ysoft-org/ysoft-admin/blob/dev/LICENSE" title="License" target="_blank">
<a href="https://github.com/wms-org/wms-admin/blob/dev/LICENSE" title="License" target="_blank">
<img src="https://img.shields.io/badge/License-Apache--2.0-blue.svg" alt="License" />
</a>
<a href="https://github.com/ysoft-org/ysoft-admin" title="GitHub Stars" target="_blank">
<img src="https://img.shields.io/github/stars/ysoft-org/ysoft-admin?style=social" alt="GitHub Stars" />
<a href="https://github.com/wms-org/wms-admin" title="GitHub Stars" target="_blank">
<img src="https://img.shields.io/github/stars/wms-org/wms-admin?style=social" alt="GitHub Stars" />
</a>
<a href="https://github.com/ysoft-org/ysoft-admin" title="GitHub Forks" target="_blank">
<img src="https://img.shields.io/github/forks/ysoft-org/ysoft-admin?style=social" alt="GitHub Forks" />
<a href="https://github.com/wms-org/wms-admin" title="GitHub Forks" target="_blank">
<img src="https://img.shields.io/github/forks/wms-org/wms-admin?style=social" alt="GitHub Forks" />
</a>
<a href="https://gitee.com/ysoft/ysoft-admin" title="Gitee Stars" target="_blank">
<img src="https://gitee.com/ysoft/ysoft-admin/badge/star.svg?theme=dark" alt="Gitee Stars" />
<a href="https://gitee.com/wms/wms-admin" title="Gitee Stars" target="_blank">
<img src="https://gitee.com/wms/wms-admin/badge/star.svg?theme=dark" alt="Gitee Stars" />
</a>
<a href="https://gitee.com/ysoft/ysoft-admin" title="Gitee Forks" target="_blank">
<img src="https://gitee.com/ysoft/ysoft-admin/badge/fork.svg?theme=dark" alt="Gitee Forks" />
<a href="https://gitee.com/wms/wms-admin" title="Gitee Forks" target="_blank">
<img src="https://gitee.com/wms/wms-admin/badge/fork.svg?theme=dark" alt="Gitee Forks" />
</a>
<a href="https://gitcode.com/ysoft/ysoft-admin" title="GitCode Stars" target="_blank">
<img src="https://gitcode.com/ysoft/ysoft-admin/star/badge.svg" alt="GitCode Stars" />
<a href="https://gitcode.com/wms/wms-admin" title="GitCode Stars" target="_blank">
<img src="https://gitcode.com/wms/wms-admin/star/badge.svg" alt="GitCode Stars" />
</a>
📚 [在线文档](https://ysoft.top) | 🚀 [演示地址](https://admin.ysoft.top)(账号/密码admin/admin123
📚 [在线文档](https://wms.top) | 🚀 [演示地址](https://admin.wms.top)(账号/密码admin/admin123
## 简介
@@ -50,9 +50,9 @@ ContiNew AdminContinue New Admin持续迭代优化的前后端分离中后
| | 后端 | 前端 |
| :------ | :----------------------------------------------------------- | :----------------------------------------------------------- |
| Gitee | [ysoft/ysoft-admin](https://gitee.com/ysoft/ysoft-admin) | [ysoft/ysoft-admin-ui](https://gitee.com/ysoft/ysoft-admin-ui) |
| GitCode | [ysoft/ysoft-admin](https://gitcode.com/ysoft/ysoft-admin) | [ysoft/ysoft-admin-ui](https://gitcode.com/ysoft/ysoft-admin-ui) |
| GitHub | [ysoft-org/ysoft-admin](https://github.com/ysoft-org/ysoft-admin) | [ysoft-org/ysoft-admin-ui](https://github.com/ysoft-org/ysoft-admin-ui) |
| Gitee | [wms/wms-admin](https://gitee.com/wms/wms-admin) | [wms/wms-admin-ui](https://gitee.com/wms/wms-admin-ui) |
| GitCode | [wms/wms-admin](https://gitcode.com/wms/wms-admin) | [wms/wms-admin-ui](https://gitcode.com/wms/wms-admin-ui) |
| GitHub | [wms-org/wms-admin](https://github.com/wms-org/wms-admin) | [wms-org/wms-admin-ui](https://github.com/wms-org/wms-admin-ui) |
## 项目起源
@@ -74,11 +74,11 @@ ContiNew AdminContinue New Admin持续迭代优化的前后端分离中后
## 为什么选我们?
> [!TIP]
> 更为完整的图文描述请查阅[《在线文档》](https://ysoft.top/admin/intro/why.html)。
> 更为完整的图文描述请查阅[《在线文档》](https://wms.top/admin/intro/why.html)。
1.**甄选技术栈:** ContiNewContinue New 项目致力于持续迭代优化,让技术不掉队。在技术选型时,进行深度广泛地调研,从流行度、成熟度和发展潜力等多方面甄选技术栈。
2.**Starter 组件:** 从 v2.1.0 版本开始,抽取并封装后端基础组件及各框架集成配置到 ContiNew Starter 项目,且 **[已发布至 Maven 中央仓库](https://central.sonatype.com/search?q=ysoft-starter&namespace=top.ysoft)**,可在你的任意项目中直接引入所需依赖使用。即使你不用脚手架项目,难道能让你搭项目框架更快、更爽、更省力的 Starter 也要 Say No 吗?
2.**Starter 组件:** 从 v2.1.0 版本开始,抽取并封装后端基础组件及各框架集成配置到 ContiNew Starter 项目,且 **[已发布至 Maven 中央仓库](https://central.sonatype.com/search?q=wms-starter&namespace=top.wms)**,可在你的任意项目中直接引入所需依赖使用。即使你不用脚手架项目,难道能让你搭项目框架更快、更爽、更省力的 Starter 也要 Say No 吗?
3.**CRUD 套件:** 封装通用增删改查套件,适配后端各分层,几分钟即可提供一套 CRUD API包括新增、修改、批量删除、查询详情、分页列表查询、全部列表查询、树型列表查询、导出到 Excel且 API 支持按实际所需开放或扩展。
@@ -116,7 +116,7 @@ public class DeptController extends BaseController<DeptService, DeptResp, DeptDe
## 系统功能
> [!TIP]
> 更多功能和优化正在赶来💦,最新项目计划、进展请进群或关注 [需求墙](https://ysoft.top/require.html) 和 [更新日志](https://ysoft.top/admin/other/changelog.html)。
> 更多功能和优化正在赶来💦,最新项目计划、进展请进群或关注 [需求墙](https://wms.top/require.html) 和 [更新日志](https://wms.top/admin/other/changelog.html)。
- 仪表盘:提供工作台、分析页,工作台提供功能快捷导航入口、最新公告、动态;分析页提供全面数据可视化能力
- 个人中心:支持基础信息修改、密码修改、邮箱绑定、手机号绑定(并提供行为验证码、短信限流等安全处理)、第三方账号绑定/解绑、头像裁剪上传
@@ -231,7 +231,7 @@ public class DeptController extends BaseController<DeptService, DeptResp, DeptDe
| <a href="https://arco.design/vue/docs/start" target="_blank">Arco Design</a> | 2.56.0 | 字节跳动推出的前端 UI 框架,年轻化的色彩和组件设计。 |
| <a href="https://www.typescriptlang.org/zh/" target="_blank">TypeScript</a> | 5.0.4 | TypeScript 是微软开发的一个开源的编程语言,通过在 JavaScript 的基础上添加静态类型定义构建而成。 |
| <a href="https://vite.dev/" target="_blank">Vite</a> | 5.1.5 | 下一代的前端工具链,为开发提供极速响应。 |
| [ContiNew Starter](https://github.com/ysoft-org/ysoft-starter) | 2.9.0 | ContiNew Starter 包含了一系列经过企业实践优化的依赖包(如 MyBatis-Plus、SaToken可轻松集成到应用中为开发人员减少手动引入依赖及配置的麻烦为 Spring Boot Web 项目的灵活快速构建提供支持。 |
| [ContiNew Starter](https://github.com/wms-org/wms-starter) | 2.9.0 | ContiNew Starter 包含了一系列经过企业实践优化的依赖包(如 MyBatis-Plus、SaToken可轻松集成到应用中为开发人员减少手动引入依赖及配置的麻烦为 Spring Boot Web 项目的灵活快速构建提供支持。 |
| <a href="https://spring.io/projects/spring-boot" target="_blank">Spring Boot</a> | 3.2.12 | 简化 Spring 应用的初始搭建和开发过程基于“约定优于配置”的理念使开发人员不再需要定义样板化的配置。Spring Boot 3.0 开始,要求 Java 17 作为最低版本) |
| <a href="https://undertow.io/" target="_blank">Undertow</a> | 2.3.17.Final | 采用 Java 开发的灵活的高性能 Web 服务器,提供包括阻塞和基于 NIO 的非堵塞机制。 |
| <a href="https://sa-token.dev33.cn/" target="_blank">Sa-Token + JWT</a> | 1.39.0 | 轻量级 Java 权限认证框架,让鉴权变得简单、优雅。 |
@@ -262,11 +262,11 @@ public class DeptController extends BaseController<DeptService, DeptResp, DeptDe
## 快速开始
> [!TIP]
> 更详细的流程,请查看在线文档[《快速开始》](https://ysoft.top/admin/intro/quick-start.html)。
> 更详细的流程,请查看在线文档[《快速开始》](https://wms.top/admin/intro/quick-start.html)。
```bash
# 1.克隆本项目
git clone https://github.com/ysoft-org/ysoft-admin.git
git clone https://github.com/wms-org/wms-admin.git
# 2.在 IDEIntelliJ IDEA/Eclipse中打开本项目
@@ -280,9 +280,9 @@ git clone https://github.com/ysoft-org/ysoft-admin.git
# 5.部署
# 5.1 Docker 部署
# 5.1.1 服务器安装好 docker 及 docker-compose参考https://blog.charles7c.top/categories/fragments/2022/10/31/CentOS%E5%AE%89%E8%A3%85Docker
# 5.1.2 执行 mvn package 进行项目打包,将 target/app 目录下的所有内容放到 /docker/ysoft-admin 目录下
# 5.1.2 执行 mvn package 进行项目打包,将 target/app 目录下的所有内容放到 /docker/wms-admin 目录下
# 5.1.3 将 docker 目录上传到服务器 / 目录下并授权chmod -R 777 /docker
# 5.1.4 修改 docker-compose.yml 中的 MySQL 配置、Redis 配置、ysoft-admin-server 配置、Nginx 配置
# 5.1.4 修改 docker-compose.yml 中的 MySQL 配置、Redis 配置、wms-admin-server 配置、Nginx 配置
# 5.1.5 执行 docker-compose up -d 创建并后台运行所有容器
# 5.2 其他方式部署
```
@@ -290,14 +290,14 @@ git clone https://github.com/ysoft-org/ysoft-admin.git
## 项目结构
> [!TIP]
> 后端采用按功能拆分模块的开发方式,下方项目目录结构是按照模块的层次顺序进行介绍的,实际 IDE 中 `ysoft-admin-common` 模块会因为字母排序原因排在上方。
> 后端采用按功能拆分模块的开发方式,下方项目目录结构是按照模块的层次顺序进行介绍的,实际 IDE 中 `wms-admin-common` 模块会因为字母排序原因排在上方。
```
ysoft-admin
├─ ysoft-webapiAPI 及打包部署模块)
wms-admin
├─ wms-webapiAPI 及打包部署模块)
│ ├─ src
│ │ ├─ main
│ │ │ ├─ java/top/ysoft/admin
│ │ │ ├─ java/top/wms/admin
│ │ │ │ ├─ config (配置)
│ │ │ │ ├─ controller
│ │ │ │ │ ├─ auth系统认证相关 API
@@ -320,10 +320,10 @@ ysoft-admin
│ │ │ └─ logback-spring.xml日志配置文件
│ │ └─ test测试相关代码目录
│ └─ pom.xml包含打包相关配置
├─ ysoft-module-system系统管理模块存放系统管理相关业务功能例如部门管理、角色管理、用户管理等
├─ wms-module-system系统管理模块存放系统管理相关业务功能例如部门管理、角色管理、用户管理等
│ ├─ src
│ │ ├─ main
│ │ │ ├─ java/top/ysoft/admin
│ │ │ ├─ java/top/wms/admin
│ │ │ │ ├─ auth系统认证相关业务
│ │ │ │ │ ├─ model系统认证相关模型
│ │ │ │ │ │ ├─ query系统认证相关查询条件
@@ -345,10 +345,10 @@ ysoft-admin
│ │ │ └─ mapper系统管理相关 Mapper XML 文件目录)
│ │ └─ test测试相关代码目录
│ └─ pom.xml
├─ ysoft-plugin插件模块存放代码生成、任务调度等扩展模块后续会进行插件化改造
│ ├─ ysoft-plugin-schedule任务调度插件模块
├─ wms-plugin插件模块存放代码生成、任务调度等扩展模块后续会进行插件化改造
│ ├─ wms-plugin-schedule任务调度插件模块
│ │ ├─ src
│ │ │ ├─ main/java/top/ysoft/admin/schedule
│ │ │ ├─ main/java/top/wms/admin/schedule
│ │ │ │ ├─ api任务调度中心相关 API
│ │ │ │ ├─ config任务调度相关配置
│ │ │ │ ├─ constant任务调度相关常量
@@ -360,9 +360,9 @@ ysoft-admin
│ │ │ │ └─ service代码生成器相关业务接口及实现类
│ │ │ └─ test测试相关代码目录
│ │ └─ pom.xml
│ ├─ ysoft-plugin-open能力开放插件模块
│ ├─ wms-plugin-open能力开放插件模块
│ │ ├─ src
│ │ │ ├─ main/java/top/ysoft/admin/open
│ │ │ ├─ main/java/top/wms/admin/open
│ │ │ │ ├─ mapper代码生成器相关 Mapper
│ │ │ │ ├─ model能力开放相关模型
│ │ │ │ │ ├─ entity能力开放相关实体对象
@@ -372,10 +372,10 @@ ysoft-admin
│ │ │ │ └─ service能力开放相关业务接口及实现类
│ │ │ └─ test测试相关代码目录
│ │ └─ pom.xml
│ ├─ ysoft-plugin-generator代码生成器插件模块
│ ├─ wms-plugin-generator代码生成器插件模块
│ │ ├─ src
│ │ │ ├─ main
│ │ │ │ ├─ java/top/ysoft/admin/generator
│ │ │ │ ├─ java/top/wms/admin/generator
│ │ │ │ │ ├─ config代码生成器相关配置
│ │ │ │ │ ├─ enums代码生成器相关枚举
│ │ │ │ │ ├─ mapper代码生成器相关 Mapper
@@ -392,9 +392,9 @@ ysoft-admin
│ │ │ └─ test测试相关代码目录
│ │ └─ pom.xml
│ └─ pom.xml
├─ ysoft-common公共模块存放公共工具类公共配置等
├─ wms-common公共模块存放公共工具类公共配置等
│ ├─ src
│ │ ├─ main/java/top/ysoft/admin/common
│ │ ├─ main/java/top/wms/admin/common
│ │ │ ├─ config公共配置
│ │ │ ├─ constant公共常量
│ │ │ ├─ enums公共枚举
@@ -405,11 +405,11 @@ ysoft-admin
│ │ │ └─ util公共工具类
│ │ └─ test测试相关代码目录
│ └─ pom.xml
├─ ysoft-extension扩展模块
│ ├─ ysoft-extension-schedule-server任务调度服务端模块实际开发时如果是公司统一提供环境可直接删除本模块
├─ wms-extension扩展模块
│ ├─ wms-extension-schedule-server任务调度服务端模块实际开发时如果是公司统一提供环境可直接删除本模块
│ │ ├─ src
│ │ │ ├─ main
│ │ │ │ ├─ java/top/ysoft/admin/extension/schedule
│ │ │ │ ├─ java/top/wms/admin/extension/schedule
│ │ │ │ │ └─ ScheduleServerApplication.java任务调度服务端启动程序
│ │ │ │ └─ resources
│ │ │ │ ├─ config核心配置目录
@@ -442,11 +442,11 @@ ysoft-admin
ContiNew Admin 致力于提供开箱即用持续舒适的开发体验。作为一个开源项目Creator 的初心是希望 ContiNew Admin 依托开源协作模式,提升技术透明度、放大集体智慧、共创优秀实践,源源不断地为企业级项目开发提供助力。
我们非常欢迎广大社区用户为 ContiNew Admin **贡献(开发,测试、文档、答疑等)** 或优化代码,欢迎各位感兴趣的小伙伴儿,[添加微信](https://ysoft.top/support.html) 讨论或认领任务。
我们非常欢迎广大社区用户为 ContiNew Admin **贡献(开发,测试、文档、答疑等)** 或优化代码,欢迎各位感兴趣的小伙伴儿,[添加微信](https://wms.top/support.html) 讨论或认领任务。
### 分支说明
ContiNew Admin 的分支目前分为下个大版本的开发分支和上个大版本的维护分支PR 前请注意对应分支是否处于维护状态,版本支持情况请查看 [更新日志/版本支持](https://ysoft.top/admin/other/changelog.html#%E7%89%88%E6%9C%AC%E6%94%AF%E6%8C%81)。
ContiNew Admin 的分支目前分为下个大版本的开发分支和上个大版本的维护分支PR 前请注意对应分支是否处于维护状态,版本支持情况请查看 [更新日志/版本支持](https://wms.top/admin/other/changelog.html#%E7%89%88%E6%9C%AC%E6%94%AF%E6%8C%81)。
| 分支 | 说明 |
| ----- | ------------------------------------------------------------ |
@@ -461,7 +461,7 @@ ContiNew Admin 的分支目前分为下个大版本的开发分支和上个大
2. 然后,将 fork 过来的项目(即您的项目)克隆到本地
3. 切换到当前仍在维护的分支(请务必充分了解分支使用说明,可进群联系维护者确认)
4. 开始修改代码,修改完成后,将代码 commit 并 push 到您的远程仓库
5. 在 Gitee 或 Github 上新建 pull requestpr选择好源和目标按模板要求填写说明信息后提交即可多多参考 [已批准合并的 pr 记录](https://github.com/ysoft-org/ysoft-admin/pulls?q=is%3Apr+is%3Amerged),会大大增加批准合并率)
5. 在 Gitee 或 Github 上新建 pull requestpr选择好源和目标按模板要求填写说明信息后提交即可多多参考 [已批准合并的 pr 记录](https://github.com/wms-org/wms-admin/pulls?q=is%3Apr+is%3Amerged),会大大增加批准合并率)
6. 最后,耐心等待维护者合并您的请求即可
请记住,如果您有任何疑问或需要帮助,我们将随时提供支持。
@@ -469,7 +469,7 @@ ContiNew Admin 的分支目前分为下个大版本的开发分支和上个大
> [!IMPORTANT]
> 欢迎大家为 ContiNew Admin 贡献代码,我们非常感谢您的支持!为了更好地管理项目,维护者有一些要求:
>
> 1. 请确保代码、配置文件的结构和命名规范良好,完善的代码注释甚至包括接口文档参数示例,并遵循阿里巴巴的 <a href="https://github.com/ysoft-org/ysoft-admin/blob/dev/.style/Java%E5%BC%80%E5%8F%91%E6%89%8B%E5%86%8C(%E9%BB%84%E5%B1%B1%E7%89%88).pdf" target="_blank">《Java开发手册(黄山版)》</a> 中的代码规范,保证代码质量和可维护性
> 1. 请确保代码、配置文件的结构和命名规范良好,完善的代码注释甚至包括接口文档参数示例,并遵循阿里巴巴的 <a href="https://github.com/wms-org/wms-admin/blob/dev/.style/Java%E5%BC%80%E5%8F%91%E6%89%8B%E5%86%8C(%E9%BB%84%E5%B1%B1%E7%89%88).pdf" target="_blank">《Java开发手册(黄山版)》</a> 中的代码规范,保证代码质量和可维护性
> 2. 在提交代码前,请按照 [Angular 提交规范](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular) 编写 commit 的 message建议在 IntelliJ IDEA 中下载并安装 Git Commit Template 插件,以便按照规范进行 commit
> 3. 提交代码之前,请关闭所有代码窗口,执行 `mvn compile` 命令(代码格式化插件会在项目编译时对全局代码进行格式修正),编译通过后,不要再打开查看任何代码窗口,直接提交即可,以免不同的 IDE 配置会自动进行代码格式化
@@ -487,8 +487,8 @@ ContiNew Admin 的分支目前分为下个大版本的开发分支和上个大
感谢参与贡献的每一位小伙伴🥰
<a href="https://github.com/ysoft-org/ysoft-admin/graphs/contributors">
<img src="https://opencollective.com/ysoft-admin/contributors.svg?width=890&button=false" alt="contributors" />
<a href="https://github.com/wms-org/wms-admin/graphs/contributors">
<img src="https://opencollective.com/wms-admin/contributors.svg?width=890&button=false" alt="contributors" />
</a>
### 特别鸣谢
@@ -499,9 +499,9 @@ ContiNew Admin 的分支目前分为下个大版本的开发分支和上个大
## License
- 遵循 <a href="https://github.com/ysoft-org/ysoft-admin/blob/dev/LICENSE" target="_blank">Apache-2.0</a> 开源许可协议
- 遵循 <a href="https://github.com/wms-org/wms-admin/blob/dev/LICENSE" target="_blank">Apache-2.0</a> 开源许可协议
- Copyright © 2022-present <a href="https://blog.charles7c.top" target="_blank">Charles7c</a>
## GitHub Star 趋势
![GitHub Star 趋势](https://starchart.cc/charles7c/ysoft-admin.svg)
![GitHub Star 趋势](https://starchart.cc/charles7c/wms-admin.svg)