# ContiNew Admin 多租户中后台管理框架
📚 [在线文档](https://continew.top) | 🚀 [演示地址](https://continew.top/admin/guide/demo.html) ## 简介 **AI 编程纪元已经开启，基于 ContiNew 项目开发，让 AI 助手“学习”更优雅的代码规范，“写出”更优质的代码。** ContiNew Admin（Continue New Admin）：持续迭代优化的，前后端分离，多租户中后台管理系统框架。开箱即用，重视每一处代码规范，重视每一种解决方案细节，持续提供舒适的前、后端开发体验。 当前采用的技术栈：Spring Boot3（Java17）、Vue3 & Arco Design & TS & Vite、Sa-Token、MyBatis Plus、FastExcel、Redisson、JetCache、JustAuth、Crane4j、Hutool、Liquibase 等。 ## 项目源码 | | 后端 | 前端 | | :------ | :----------------------------------------------------------- | :----------------------------------------------------------- | | Gitee | [continew/continew-admin](https://gitee.com/continew/continew-admin) | [continew/continew-admin-ui](https://gitee.com/continew/continew-admin-ui) | | GitCode | [continew/continew-admin](https://gitcode.com/continew/continew-admin) | [continew/continew-admin-ui](https://gitcode.com/continew/continew-admin-ui) | | GitHub | [continew-org/continew-admin](https://github.com/continew-org/continew-admin) | [continew-org/continew-admin-ui](https://github.com/continew-org/continew-admin-ui) | ## 项目起源 我热衷于做数据归档，归档后的数据可以提高学习/工作效率，为记忆“减负”，在持续的数据归档中，优质的“沉淀”会带来非匀速、跨越式的学习/工作体验。**数据归档是一件需要持续去做的事情**。 从接触程序代码的第一天，我的程序数据归档也随之开始了，刷过的算法题、笔记、对接各种组件的配置文件，甚至于一些亮眼的样式设计、“如诗”的代码片段。这些数据的沉淀丰富了我的解决方案，提高了我的编程效率，逐渐为各种场景落实成了一个个雏形程序。再后来，我意识到，我归档的这些雏形程序，有一个更为妥贴的名称：**程序框架/脚手架**。 技术的发展，导致这些雏形程序的生命周期很是短暂，它们有别于我归档的其他数据，有时由于工作的原因，没有时间很好的去沉淀它们，在使用时变得越来越不顺手。所以，某段时间，我放弃了维护，而是去采用一些更为成熟的框架。 不过，在陆续几年使用了一些成熟框架后，我前后遇到了一些困难： 1. 代码洁癖想要找到一个**扩展性佳，代码规范良好，开发体验舒适**的框架很不容易，总是差些什么 2. 项目上手困难或是基础版功能不全，需要的全在专业版，亦或者代码阅读性差，文档收费 3. 部分解决方案缺失，已有解决方案也过于偏向样板化，无法形成良好的逻辑闭环 4. 好不容易找到一些相较合适的，没过多久，部分作者可能暂时没法对外发“电”了，随着了解深入，很多 Bug 或新技术趋势还是需要自己研究解决 在工作中，很多想法/设计受限于客户需求、开发工期，必须优先以交付为导向，但一些优秀的实践需要花时间持续进行沉淀，只要我没跳出这个圈子，我还是需要一直去做好程序归档。“种一棵树最好的时间是十年前，其次是现在”，最终，我选择在业余时间更加正视这件事，从头归档沉淀，从添加每一个依赖开始，我希望它能持续的迭代优化、演进，所以我把它命名为 **ContiNew（Continue New）**。并且这次我选择了开源，我希望它不仅仅能吸收我的需求和沉淀，而是依托开源协作模式，及时发现更多的问题，接受更多的可能性，沉淀更优秀的思考，设计。 ## 为什么选我们？ > [!TIP] > 更为完整的图文描述请查阅[《在线文档》](https://continew.top/admin/guide/why-choose-us.html)。 **AI 编程纪元已经开启，基于 ContiNew 项目开发，让 AI 助手“学习”更优雅的代码规范，“写出”更优质的代码。** 1.**甄选技术栈：** ContiNew（Continue New） 项目致力于持续迭代优化，让技术不掉队。在技术选型时，进行深度广泛地调研，从流行度、成熟度和发展潜力等多方面甄选技术栈。 2.**Starter 组件：** 从 v2.1.0 版本开始，抽取并封装后端基础组件及各框架集成配置到 ContiNew Starter 项目，且 **[已发布至 Maven 中央仓库](https://central.sonatype.com/search?q=continew-starter&namespace=top.continew)**，可在你的任意项目中直接引入所需依赖使用。即使你不用脚手架项目，难道能让你搭项目框架更快、更爽、更省力的 Starter 也要 Say No 吗？ 3.**CRUD 套件：** 封装通用增删改查套件，适配后端各分层，几分钟即可提供一套 CRUD API，包括新增、修改、批量删除、查询详情、分页列表查询、全部列表查询、树型列表查询、导出到 Excel，且 API 支持按实际所需开放或扩展。 ```java @Tag(name = "部门管理 API") @RestController @CrudRequestMapping(value = "/system/dept", api = {Api.TREE, Api.GET, Api.CREATE, Api.UPDATE, Api.DELETE, Api.EXPORT}) public class DeptController extends BaseController {} ``` 4.**代码生成器：** 提供代码生成器，已配套前、后端代码生成模板，数据表设计完之后，简单配置一下即可生成前、后端 80% 的代码，包含 CRUD API、权限控制、参数校验、接口文档等内容。如果业务不复杂，也可能就是 95% 的代码。 5.**改善开发体验：** 持续优化及适配能改善开发体验的组件。 - 适配 ContiNew Starter 各组件，针对 Spring 基础配置、通用解决方案以及流行框架进行了深度封装的 starter 集合，改善你在开发每个 Spring Boot Web 项目的体验。（时间日期及枚举参数自动转换、默认线程池、跨域、加密、脱敏、限流、幂等、License、日志、异常及响应通用解决方案等等，更多细节可查看 Starter 源码） - 适配 Crane4j 数据填充组件，减少因为一个用户名而产生的联表回填； - 适配 SpEL Validator 基于 SpEL 的 Java 参数校验，使用 SpEL 表达式，强化基础参数校验。例如：当其中一个字段为 xxx 时，另一个字段不能为空等等； - 适配 P6Spy SQL 性能分析组件，开发期间方便监控 SQL 执行； - 适配 TLog 链路追踪组件，方便在杂乱的日志文件中追踪你某次请求的日志记录； - 适配 JetCache 缓存框架（比 Spring Cache 更强大易用），通过注解声明即可快速实现方法级缓存，极大改善编码式缓存体验，且支持灵活的二级缓存配置、分布式自动刷新等能力； - 前端适配 Vue Devtools（Vue 官方提供的调试浏览器插件），极大提高 Vue 开发及调试效率 6.**Almost最佳后端规范：** 后端严格遵循阿里巴巴 Java 编码规范，注释覆盖率 > 45%，接口参数示例 100%，代码分层使用体验佳，变量、方法命名清晰统一，前端代码也使用严格的 ESLint、StyleLint 等检查。良好的设计，代码复用率极高！写代码时，让你有一种无需多写，理应如此的感觉。我是代码洁癖，我实际写的时候很清楚这到底是不是乱吹。 7.**卓越工程：** 后端采用模块化工程结构，并适配了统一项目版本号、编译项目自动代码格式化、代码混淆等插件，提供了自定义打包部署结构配置（配置文件、三方依赖和主程序分离），提供全套环境及应用的 Docker Compose 部署脚本。为了减少您开发新项目时的改造耗时，项目品牌配置持续进行深度聚合，简单的配置和结构修改即可快速开始独属于你的新项目。 8.**业务脚手架：** 有颜有料，不止是说说而已，持续打磨 UI 设计与色彩主题。提供基于 RBAC 的权限控制、通用数据权限，包含丰富的通用业务功能：第三方登录，邮箱、短信（生产级炸弹漏洞处理方案），个人中心、用户管理、角色管理、部门管理、系统配置（基础站点配置、邮件配置、安全配置）、系统日志、消息中心、通知公告等，设计用心，逻辑合理闭环。 > 一个好的脚手架项目，不仅仅是提供一系列组件集成与配置，也不仅仅是封装一堆好用的工具，还更应该提供一系列通用基础业务解决方案及设计，为初创团队项目减负。 9.**质量与安全：** CI 已集成 Sonar、Codacy，Push 即扫描代码质量，定期扫描 CVE 漏洞，及时解决潜在问题。封装数据库字段加密、JSON 脱敏、XSS 过滤等工具，提供诸多安全解决方案。 由于篇幅有限，且项目正处于高速发展期，更多功能正在陆续上线（敬请关注仓库或群内动态）。另外像最基本的统一异常、错误处理，基础线程池等配置就不在此赘述，细节优化详情请 clone 代码查看。 > Talk is cheap, show the code. ## 系统功能 > [!TIP] > 更多功能和优化正在赶来💦，最新项目计划、进展请进群或关注 [需求墙](https://continew.top/admin/other/feature.html) 和 [更新日志](https://continew.top/admin/changelog/)。 - 仪表盘：提供工作台、分析页，工作台提供功能快捷导航入口、最新公告、动态；分析页提供全面数据可视化能力 - 个人中心：支持基础信息修改、密码修改、邮箱绑定、手机号绑定（并提供行为验证码、短信限流等安全处理）、第三方账号绑定/解绑、头像裁剪上传 - 消息中心：提供站内信消息统一查看、标记已读、全部已读、删除等功能（目前仅支持系统通知消息）、提供个人公告查看 - 用户管理：管理系统用户，包含新增、修改、删除、导入、导出、重置密码、分配角色等功能 - 角色管理：管理系统用户的功能权限及数据权限，包含新增、修改、删除、分配角色等功能 - 菜单管理：管理系统菜单及按钮权限，支持多级菜单，动态路由，包含新增、修改、删除等功能 - 部门管理：管理系统组织架构，包含新增、修改、删除、导出等功能，以树形列表进行展示 - 通知公告：管理系统公告，支持通知范围（所有人、指定用户）、通知方式（系统消息、登录弹窗）、定时发送、置顶设置 - 文件管理：管理系统文件及文件夹，支持上传、下载、预览（目前支持图片、音视频、PDF、Word、Excel、PPT）、重命名、切换视图（列表、网格）等功能 - 字典管理：管理系统公用数据字典，例如：消息类型。支持字典标签背景色和排序等配置 - 系统配置： - 网站配置：提供修改系统标题、Logo、favicon、版权信息等基础配置功能，以方便用户系统与其自身品牌形象保持一致 - 安全配置：提供密码策略修改，支持丰富的密码策略设定，包括但不限于 `密码有效期`、`密码重复次数`、`密码错误锁定账号次数、时间` 等 - 登录配置：提供验证码开关等登录相关配置 - 邮件配置：提供系统发件箱配置，也支持通过配置文件指定 - 短信配置：提供系统短信服务配置，也支持通过配置文件指定 - 存储配置：管理文件存储配置，支持本地存储、兼容 S3 协议对象存储 - 客户端配置：多端（PC端、小程序端等）认证管理，可设置不同的 token 有效期 - 在线用户：管理当前登录用户，可一键踢除下线 - 日志管理：管理系统登录日志、操作日志，支持查看日志详情，包含请求头、响应头等报文信息 - 短信日志：管理系统短信发送日志，支持删除、导出 - 应用管理：管理第三方系统应用 AK、SK，包含新增、修改、删除、查看密钥、重置密钥等功能，支持设置密钥有效期 - 租户管理：管理租户信息，包含新增、修改、删除、分配角色等功能 - 租户套餐：管理租户套餐信息，包含新增、修改、删除、查看等功能 - 任务管理：管理系统定时任务，包含新增、修改、删除、执行功能，支持 Cron（可配置式生成 Cron 表达式） 和固定频率 - 任务日志：管理定时任务执行日志，包含停止、重试指定批次，查询集群各节点的详细输出日志等功能 - 代码生成：提供根据数据库表自动生成相应的前后端 CRUD 代码的功能，支持同步最新表结构及代码生成预览 ## 系统截图 > [!TIP] > 受篇幅长度及功能更新频率影响，下方仅为系统 **部分** 功能于 **2024年11月18日** 进行的截图，更多新增功能及细节请登录演示环境或 clone 代码到本地启动查看。 ## 核心技术栈 | 名称 | 版本 | 简介 | | :----------------------------------------------------------- |:-------------| :----------------------------------------------------------- | | Vue | 3.5.4 | 渐进式 JavaScript 框架，易学易用，性能出色，适用场景丰富的 Web 前端框架。 | | Arco Design | 2.57.0 | 字节跳动推出的前端 UI 框架，年轻化的色彩和组件设计。 | | TypeScript | 5.0.4 | TypeScript 是微软开发的一个开源的编程语言，通过在 JavaScript 的基础上添加静态类型定义构建而成。 | | Vite | 5.1.5 | 下一代的前端工具链，为开发提供极速响应。 | | [ContiNew Starter](https://github.com/continew-org/continew-starter) | 2.13.2 | ContiNew Starter 包含了一系列经过企业实践优化的依赖包（如 MyBatis-Plus、SaToken），可轻松集成到应用中，为开发人员减少手动引入依赖及配置的麻烦，为 Spring Boot Web 项目的灵活快速构建提供支持。 | | Spring Boot | 3.3.12 | 简化 Spring 应用的初始搭建和开发过程，基于“约定优于配置”的理念，使开发人员不再需要定义样板化的配置。（Spring Boot 3.0 开始，要求 Java 17 作为最低版本） | | Undertow | 2.3.18.Final | 采用 Java 开发的灵活的高性能 Web 服务器，提供包括阻塞和基于 NIO 的非堵塞机制。 | | Sa-Token + JWT | 1.44.0 | 轻量级 Java 权限认证框架，让鉴权变得简单、优雅。 | | MyBatis Plus | 3.5.12 | MyBatis 的增强工具，在 MyBatis 的基础上只做增强不做改变，简化开发、提高效率。 | | dynamic-datasource-spring-boot-starter | 4.3.1 | 基于 Spring Boot 的快速集成多数据源的启动器。 | | Hikari | 5.1.0 | JDBC 连接池，号称 “史上最快连接池”，SpringBoot 在 2.0 之后，采用的默认数据库连接池就是 Hikari。 | | MySQL | 8.0.42 | 体积小、速度快、总体拥有成本低，是最流行的关系型数据库管理系统之一。 | | mysql-connector-j | 8.3.0 | MySQL Java 驱动。 | | P6Spy | 3.9.1 | SQL 性能分析组件。 | | Liquibase | 4.27.0 | 用于管理数据库版本，跟踪、管理和应用数据库变化。 | | [JetCache](https://github.com/alibaba/jetcache/blob/master/docs/CN/Readme.md) | 2.7.8 | 一个基于 Java 的缓存系统封装，提供统一的 API 和注解来简化缓存的使用。提供了比 SpringCache 更加强大的注解，可以原生的支持 TTL、两级缓存、分布式自动刷新，还提供了 Cache 接口用于手工缓存操作。 | | Redisson | 3.49.0 | 不仅仅是一个 Redis Java 客户端，Redisson 充分的利用了 Redis 键值数据库提供的一系列优势，为使用者提供了一系列具有分布式特性的常用工具：分布式锁、限流器等。 | | Redis | 7.2.8 | 高性能的 key-value 数据库。 | | [Snail Job](https://snailjob.opensnail.com/) | 1.5.0 | 灵活，可靠和快速的分布式任务重试和分布式任务调度平台。 | | [X File Storage](https://x-file-storage.xuyanwu.cn/#/) | 2.2.1 | 一行代码将文件存储到本地、FTP、SFTP、WebDAV、阿里云 OSS、华为云 OBS...等其它兼容 S3 协议的存储平台。 | | SMS4J | 3.3.4 | 短信聚合框架，轻松集成多家短信服务，解决接入多个短信 SDK 的繁琐流程。 | | Just Auth | 1.16.7 | 开箱即用的整合第三方登录的开源组件，脱离繁琐的第三方登录 SDK，让登录变得 So easy！ | | Fast Excel | 1.2.0 | （由原 EasyExcel 作者创建的新项目）一个基于 Java 的、快速、简洁、解决大文件内存溢出的 Excel 处理工具。 | | [AJ-Captcha](https://ajcaptcha.beliefteam.cn/captcha-doc/) | 1.3.0 | Java 行为验证码，包含滑动拼图、文字点选两种方式，UI支持弹出和嵌入两种方式。 | | Easy Captcha | 1.6.2 | Java 图形验证码，支持 gif、中文、算术等类型，可用于 Java Web、JavaSE 等项目。 | | [Crane4j](https://createsequence.gitee.io/crane4j-doc/#/) | 2.9.0 | 一个基于注解的，用于完成一切 “根据 A 的 key 值拿到 B，再把 B 的属性映射到 A” 这类需求的字段填充框架。 | | [SpEL Validator](https://spel-validator.sticki.cn/) | 0.5.1-beta | 基于 SpEL 的 jakarta.validation-api 扩展增强包。 | | [CosID](https://cosid.ahoo.me/guide/getting-started.html) | 2.13.0 | 旨在提供通用、灵活、高性能的分布式 ID 生成器。 | | [Graceful Response](https://doc.feiniaojin.com/graceful-response/home.html) | 5.0.4-boot3 | 一个Spring Boot技术栈下的优雅响应处理组件，可以帮助开发者完成响应数据封装、异常处理、错误码填充等过程，提高开发效率，提高代码质量。 | | Knife4j | 4.5.0 | 前身是 swagger-bootstrap-ui，集 Swagger2 和 OpenAPI3 为一体的增强解决方案。 | | [OpenFeign](https://springdoc.cn/spring-cloud-openfeign/) | 13.5 | Spring Cloud OpenFeign 是一种基于 Spring Cloud 的声明式 REST 客户端，它简化了与 HTTP 服务交互的过程。 | | Hutool | 5.8.38 | 小而全的 Java 工具类库，通过静态方法封装，降低相关 API 的学习成本，提高工作效率，使 Java 拥有函数式语言般的优雅，让 Java 语言也可以“甜甜的”。 | | Lombok | 1.18.36 | 在 Java 开发过程中用注解的方式，简化了 JavaBean 的编写，避免了冗余和样板式代码，让编写的类更加简洁。 | ## 快速开始 > [!TIP] > 更详细的流程，请查看在线文档[《快速开始》](https://continew.top/admin/guide/quick-start.html)。 ```bash # 1.克隆本项目 git clone https://github.com/continew-org/continew-admin.git # 2.在 IDE（IntelliJ IDEA/Eclipse）中打开本项目 # 3.修改配置文件中的数据源配置信息、Redis 配置信息、邮件配置信息等 # [3.也可以在 IntelliJ IDEA 中直接配置程序启动环境变量（DB_HOST、DB_PORT、DB_USER、DB_PWD、DB_NAME；REDIS_HOST、REDIS_PORT、REDIS_PWD、REDIS_DB）] # 4.启动程序 # 启动成功，在控制台末尾会输出 ContiNew Admin service started successfully. # 并输出 API 地址及 API 接口文档地址 ``` ## 项目结构 > [!TIP] > 后端采用按功能拆分模块的开发方式，下方项目目录结构是按照模块的层次顺序进行介绍的，实际 IDE 中 `continew-common` 模块会因为字母排序原因排在上方。 ``` continew-admin ├─ continew-server（打包部署模块） │ ├─ src │ │ ├─ main │ │ │ ├─ java/top/continew/admin │ │ │ │ ├─ config （配置） │ │ │ │ ├─ controller │ │ │ │ │ ├─ common（通用相关 API） │ │ │ │ │ └─ monitor（系统监控相关 API） │ │ │ │ ├─ job （定时任务） │ │ │ │ └─ ContiNewAdminApplication.java（ContiNew Admin 启动程序） │ │ │ └─ resources │ │ │ ├─ config（核心配置目录） │ │ │ │ ├─ application-dev.yml（开发环境配置文件） │ │ │ │ ├─ application-prod.yml（生产环境配置文件） │ │ │ │ └─ application.yml（通用配置文件） │ │ │ ├─ db/changelog（Liquibase 数据脚本配置目录） │ │ │ │ ├─ mysql（MySQL 数据库初始 SQL 脚本目录） │ │ │ │ ├─ postgresql（PostgreSQL 数据库初始 SQL 脚本目录） │ │ │ │ └─ db.changelog-master.yaml（Liquibase 变更记录文件） │ │ │ ├─ templates（模板配置目录，例如：邮件模板） │ │ │ ├─ banner.txt（Banner 配置文件） │ │ │ └─ logback-spring.xml（日志配置文件） │ │ └─ test（测试相关代码目录） │ └─ pom.xml（包含打包相关配置） ├─ continew-system（系统管理模块，存放系统管理相关业务功能，例如：部门管理、角色管理、用户管理等） │ ├─ src │ │ ├─ main │ │ │ ├─ java/top/continew/admin │ │ │ │ ├─ auth（系统认证相关业务） │ │ │ │ │ ├─ controller（系统认证相关 API） │ │ │ │ │ ├─ service（系统认证相关业务接口及实现类） │ │ │ │ │ ├─ model（系统认证相关模型） │ │ │ │ │ │ ├─ query（系统认证相关查询条件） │ │ │ │ │ │ ├─ req（系统认证相关请求参数（Request）） │ │ │ │ │ │ └─ resp（系统认证相关响应参数（Response）） │ │ │ │ │ ├─ enums（系统认证相关枚举） │ │ │ │ │ ├─ handler（系统认证相关处理器） │ │ │ │ │ └─ config（系统认证相关配置） │ │ │ │ └─ system（系统管理相关业务） │ │ │ │ ├─ controller（系统管理相关 API） │ │ │ │ ├─ service（系统管理相关业务接口及实现类） │ │ │ │ ├─ mapper（系统管理相关 Mapper） │ │ │ │ ├─ model（系统管理相关模型） │ │ │ │ │ ├─ entity（系统管理相关实体） │ │ │ │ │ ├─ query（系统管理相关查询条件） │ │ │ │ │ ├─ req（系统管理相关请求参数（Request）） │ │ │ │ │ └─ resp（系统管理相关响应参数（Response）） │ │ │ │ ├─ enums（系统管理相关枚举） │ │ │ │ ├─ util（系统管理相关工具类） │ │ │ │ ├─ validation（系统管理相关参数校验工具类） │ │ │ │ └─ config（系统管理相关配置） │ │ │ └─ resources │ │ │ └─ mapper（系统管理相关 Mapper XML 文件目录） │ │ └─ test（测试相关代码目录） │ └─ pom.xml ├─ continew-plugin（插件模块，存放能力开放、租户等扩展模块，后续会进行插件化改造） │ ├─ continew-plugin-open（能力开放插件模块） │ │ ├─ src │ │ │ ├─ main/java/top/continew/admin/open │ │ │ │ ├─ controller（能力开放相关 API） │ │ │ │ ├─ service（能力开放相关业务接口及实现类） │ │ │ │ ├─ mapper（能力开放相关 Mapper） │ │ │ │ ├─ model（能力开放相关模型） │ │ │ │ │ ├─ entity（能力开放相关实体） │ │ │ │ │ ├─ query（能力开放相关查询条件） │ │ │ │ │ ├─ req（能力开放相关请求参数（Request）） │ │ │ │ │ └─ resp（能力开放相关响应参数（Response）） │ │ │ │ ├─ util（能力开放相关工具类） │ │ │ │ └─ config（能力开放相关配置） │ │ │ └─ test（测试相关代码目录） │ │ └─ pom.xml │ ├─ continew-plugin-tenant（租户插件模块） │ │ ├─ src │ │ │ ├─ main/java/top/continew/admin/tenant │ │ │ │ ├─ controller（租户相关 API） │ │ │ │ ├─ service（租户相关业务接口及实现类） │ │ │ │ ├─ mapper（租户相关 Mapper） │ │ │ │ ├─ model（租户相关模型） │ │ │ │ │ ├─ enums（租户相关枚举） │ │ │ │ │ ├─ entity（租户相关实体） │ │ │ │ │ ├─ query（租户相关查询条件） │ │ │ │ │ ├─ req（租户相关请求参数（Request）） │ │ │ │ │ └─ resp（租户相关响应参数（Response）） │ │ │ │ ├─ util（租户相关工具类） │ │ │ │ ├─ constant（租户相关常量类） │ │ │ │ └─ config（租户相关配置） │ │ │ └─ test（测试相关代码目录） │ │ └─ pom.xml │ ├─ continew-plugin-schedule（任务调度插件模块） │ │ ├─ src │ │ │ ├─ main/java/top/continew/admin/schedule │ │ │ │ ├─ controller（任务调度相关 API） │ │ │ │ ├─ service（代码生成器相关业务接口及实现类） │ │ │ │ ├─ api（任务调度中心相关 API） │ │ │ │ ├─ model（任务调度相关模型） │ │ │ │ │ ├─ query（任务调度相关查询条件） │ │ │ │ │ ├─ req（任务调度相关请求参数（Request）） │ │ │ │ │ └─ resp（任务调度相关响应参数（Response）） │ │ │ │ ├─ constant（任务调度相关常量类） │ │ │ │ ├─ enums（任务调度相关枚举） │ │ │ │ ├─ exception（任务调度相关异常） │ │ │ │ └─ config（任务调度相关配置） │ │ │ └─ test（测试相关代码目录） │ │ └─ pom.xml │ ├─ continew-plugin-generator（代码生成器插件模块） │ │ ├─ src │ │ │ ├─ main │ │ │ │ ├─ java/top/continew/admin/generator │ │ │ │ │ ├─ controller（代码生成器相关 API） │ │ │ │ │ ├─ service（代码生成器相关业务接口及实现类） │ │ │ │ │ ├─ mapper（代码生成器相关 Mapper） │ │ │ │ │ ├─ model（代码生成器相关模型） │ │ │ │ │ │ ├─ entity（代码生成器相关实体） │ │ │ │ │ │ ├─ query（代码生成器相关查询条件） │ │ │ │ │ │ ├─ req（代码生成器相关请求参数（Request）） │ │ │ │ │ │ └─ resp（代码生成器相关响应参数（Response）） │ │ │ │ │ ├─ enums（代码生成器相关枚举） │ │ │ │ │ └─ config（代码生成器相关配置） │ │ │ │ └─ resources │ │ │ │ └─ templates（代码生成相关模板目录） │ │ │ │ ├─ backend（后端模板目录） │ │ │ │ └─ frontend（前端模板目录） │ │ │ └─ test（测试相关代码目录） │ │ └─ pom.xml │ └─ pom.xml ├─ continew-common（公共模块，存放公共工具类，公共配置等） │ ├─ src │ │ ├─ main/java/top/continew/admin/common │ │ │ ├─ base（公共基类） │ │ │ │ ├─ controller（控制器基类） │ │ │ │ ├─ mapper（Mapper 接口基类） │ │ │ │ ├─ model（公共模型） │ │ │ │ │ ├─ entity（实体基类） │ │ │ │ │ └─ resp（列表、详情响应基类） │ │ │ │ └─ service（业务接口及实现基类） │ │ │ ├─ service（公共服务接口） │ │ │ ├─ model（公共模型） │ │ │ │ └─ req（公共请求参数（Request）） │ │ │ ├─ context（公共上下文） │ │ │ ├─ constant（公共常量类） │ │ │ ├─ enums（公共枚举） │ │ │ ├─ util（公共工具类） │ │ │ └─ config（公共配置） │ │ │ ├─ mybatis（MyBatis Plus 配置） │ │ │ ├─ websocket（Websocket 配置） │ │ │ ├─ doc（接口文档配置） │ │ │ ├─ excel（Excel 配置） │ │ │ └─ exception（全局异常处理） │ │ └─ test（测试相关代码目录） │ └─ pom.xml ├─ continew-extension（扩展模块） │ ├─ continew-extension-schedule-server（任务调度服务端模块，实际开发时如果是公司统一提供环境，可直接删除本模块） │ │ ├─ src │ │ │ ├─ main │ │ │ │ ├─ java/top/continew/admin/extension/schedule │ │ │ │ │ └─ ScheduleServerApplication.java（任务调度服务端启动程序） │ │ │ │ └─ resources │ │ │ │ ├─ config（核心配置目录） │ │ │ │ │ ├─ application-dev.yml（开发环境配置文件） │ │ │ │ │ ├─ application-prod.yml（生产环境配置文件） │ │ │ │ │ └─ application.yml（通用配置文件） │ │ │ │ ├─ db/changelog（Liquibase 数据脚本配置目录） │ │ │ │ │ ├─ mysql（MySQL 数据库初始 SQL 脚本目录） │ │ │ │ │ ├─ postgresql（PostgreSQL 数据库初始 SQL 脚本目录） │ │ │ │ │ └─ db.changelog-master.yaml（Liquibase 变更记录文件） │ │ │ │ └─ logback-spring.xml（日志配置文件） │ │ │ └─ test（测试相关代码目录） │ │ └─ pom.xml │ └─ pom.xml ├─ .github（GitHub 相关配置目录，实际开发时直接删除） ├─ .idea │ └─ icon.png（IDEA 项目图标，实际开发时直接删除） ├─ .image（截图目录，实际开发时直接删除） ├─ .style（代码格式、License文件头相关配置目录，实际开发时根据需要取舍，删除时注意删除 /pom.xml 中的 spotless 插件配置） ├─ .gitignore（Git 忽略文件相关配置文件） ├─ docker（项目部署相关配置目录，实际开发时可备份后直接删除） ├─ LICENSE（开源协议文件） ├─ CHANGELOG.md（更新日志文件，实际开发时直接删除） ├─ README.md（项目 README 文件，实际开发时替换为真实内容） ├─ lombok.config（Lombok 全局配置文件） └─ pom.xml（包含版本锁定及全局插件相关配置） ``` ## 贡献指南 ContiNew Admin 致力于提供开箱即用，持续舒适的开发体验。作为一个开源项目，Creator 的初心是希望 ContiNew Admin 依托开源协作模式，提升技术透明度、放大集体智慧、共创优秀实践，源源不断地为企业级项目开发提供助力。 我们非常欢迎广大社区用户为 ContiNew Admin **贡献（开发，测试、文档、答疑等）** 或优化代码，欢迎各位感兴趣的小伙伴儿，[添加微信](https://continew.top/discussion.html) 讨论或认领任务。 ### 分支说明 ContiNew Admin 的分支目前分为下个大版本的开发分支和上个大版本的维护分支，PR 前请注意对应分支是否处于维护状态，版本支持情况请查看 [更新日志/版本支持](https://continew.top/admin/changelog/)。 | 分支 | 说明 | | ----- | ------------------------------------------------------------ | | dev | 开发分支，默认为下个大版本的 SNAPSHOT 版本，接受新功能或新功能优化 PR | | x.x.x | 维护分支，在 vx.x.x 版本维护期终止前（一般为下个大版本发布前），用于修复上个版本的 Bug，只接受已有功能修复，不接受新功能 PR | ### 贡献代码 如果您想提交新功能或优化现有代码，可以按照以下步骤操作： 1. 首先，在 Gitee 或 Github 上将项目 fork 到您自己的仓库 2. 然后，将 fork 过来的项目（即您的项目）克隆到本地 3. 基于当前仍在维护的分支（例如：dev），切出来一个新的分支（例如：feat/tenant）（不要修改源分支，源分支仅做同步 continew 最新代码用） 4. 在新分支开始修改代码，修改完成后，将代码 commit 并 push 到您的远程仓库 5. 在 Gitee 或 Github 上新建 pull request（pr），选择好源和目标，按模板要求填写说明信息后提交即可（多多参考 [已批准合并的 pr 记录](https://github.com/continew-org/continew-admin/pulls?q=is%3Apr+is%3Amerged)，会大大增加批准合并率） 6. 提交后，会提示你需要签署 CLA（Contributor License Agreement，贡献者协议），请确保你的 commit 所用邮箱和对应平台绑定邮箱一致（如果不一致，可以在本地通过 `git reset --soft HEAD~1` 回退，然后使用正确邮箱重新提交，最后 `git push -f` 即可，不需要重新创建 PR），然后使用该邮箱签署即可 7. 最后，耐心等待维护者合并您的请求即可 8. PR 合并后，下次 PR 时请先同步最新代码，然后再次从步骤 3 开始 以下是向 `continew-admin` 项目提交 pull request 为例的简单步骤： ``` 1.continew/continew-admin -> fork -> your/continew-admin 2.git clone your/continew-admin 3.dev -> feat/tenant 4.feat/tenant 本地开发，开发完 push 到 your/continew-admin 5.your/continew-admin:feat/tenant -> continew/continew-admin:dev 6.阅读并签署 CLA 7.PR 合并完成，删除 feat/tenant 分支 8.强制从 continew/continew-admin 覆盖更新 your/continew-admin，然后重复步骤 3... ``` > [!IMPORTANT] > 欢迎大家为 ContiNew Admin 贡献代码，我们非常感谢您的支持！为了更好地管理项目，维护者有一些要求： > > 1. 请确保代码、配置文件的结构和命名规范良好，完善的代码注释甚至包括接口文档参数示例，并遵循阿里巴巴的 《Java开发手册(黄山版)》 中的代码规范，保证代码质量和可维护性 > 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 配置会自动进行代码格式化 ## 反馈交流 欢迎各位小伙伴儿扫描下方二维码加入项目交流群，与项目维护团队及其他大佬用户实时交流讨论。

## 鸣谢 ### 鸣谢 感谢参与贡献的每一位小伙伴🥰 ### 特别鸣谢 - 感谢 JetBrains 提供的 非商业开源软件开发授权 - 感谢 MyBatis Plus、Sa-Token 、JetCache、Crane4j、Knife4j、Hutool 等开源组件作者为国内开源世界作出的贡献 - 感谢项目使用或未使用到的每一款开源组件，致敬各位开源先驱 :fire: ## License - 遵循 Apache-2.0 开源许可协议 - Copyright © 2022-present Charles7c ## GitHub Star 趋势