README.md
ContiNew Admin 中后台管理框架
简介
ContiNew Admin （Continue New Admin）中后台管理框架/脚手架，持续以最新流行技术栈构建，拥抱变化，迭代优化。在社区贡献者的支持和参与下，持续发展并源源不断地为企业级项目开发提供助力。当前采用的技术栈：Vue3、Spring Boot3、TypeScript、Arco Design Vue、Undertow、Sa-Token、JWT、MariaDB、MyBatis Plus、Redis、Redisson、Easy Excel、Hutool 等。
项目源码
| 开源平台 | 源码地址 |
|---|---|
| GitHub | https://github.com/Charles7c/continew-admin |
| Gitee（码云） | https://gitee.com/Charles7c/continew-admin |
反馈交流
cnadmin，拉你进群，探讨技术、提提需求~
加入交流群后，你将会：
- 第一时间收到框架动态
- 第一时间收到框架更新通知
- 第一时间收到框架 Bug 通知
- 和众多大佬互相 (huá shuǐ) 交流 (mō yú)
主要特性
- 精选技术栈：使用综合考虑成熟度、流行性、发展潜力较佳的技术栈，包括 Spring Boot、MyBatis Plus、Sa-Token、Hutool 等
- 高效率开发：后端提供了 CRUD 组件，在 Controller 中只需添加一个注解，即可自动生成增、删、改、查、分页、列表、树列表等 API
- 提供代码生成功能，根据用户提供的项目信息和配置，自动生成前后端项目结构、代码文件和部分逻辑代码，提高开发效率
- 一个注解解决一个条件查询，基于注解的通用查询方式，降低拼接 MyBatis Plus QueryWrapper 的烦恼
- 提供一套 Base 基类（BaseDO、BaseVO、BaseController、BaseService、扩展版 BaseMapper 等），方便复用和扩展
- 编写或基于 Hutool 扩展部分工具类，提供校验工具和实践，提高开发效率（能 PR 到 Hutool 的已尽量 PR）
- 支持 API 级别的功能权限与数据权限，可自定义操作
- 前后端统一异常拦截处理，统一输出异常信息，避免繁琐的异常判断
- 自动初始化数据：通过 Liquibase 管理数据库脚本版本记录，并在系统第一次启动时自动进行数据初始化，无须额外配置导入
- 提供多项实用基础配置，例如：Jackson 针对日期、通用枚举的序列化、反序列化配置，统一线程池配置等
- 良好的代码、配置文件结构和命名，完善的代码注释甚至包括接口文档参数示例，遵循阿里巴巴 《Java开发手册(黄山版)》 的代码规范，保证代码质量和可维护性
- 更多细节及实践，敬请探索与关注
系统功能
Note 更多功能和优化正在赶来
💦 ，最新项目计划和进展请关注 GitHub Project 和 CHANGELOG.md。
- 用户管理：提供用户的相关配置，新增用户后，默认密码为 123456，且支持第三方账号登录
- 部门管理：可配置系统组织架构，树形表格展示
- 角色管理：对权限与菜单进行分配，可根据部门设置角色的数据权限
- 菜单管理：已实现菜单动态路由，后端可配置化，支持多级菜单
- 公告管理：提供公告的发布、查看和删除等功能。管理员可以在后台发布公告，并可以设置公告的生效时间、终止时间，以 markdown-it 为内核渲染 Markdown 格式内容显示
- 字典管理：提供对系统公用数据字典的维护，例如：公告类型，支持字典标签背景色和排序等配置
- 系统配置：提供修改系统标题、Logo、favicon 等基础配置功能，以方便用户系统与其自身品牌形象保持一致（暂未开放高级配置）
- 代码生成：提供根据数据库表自动生成相应的前后端 CRUD 代码的功能
- 在线用户：管理当前登录用户，可一键踢下线
- 日志管理：提供在线用户监控、登录日志监控、操作日志监控和系统日志监控等监控功能
系统截图
Note 受篇幅长度及功能更新频率影响，下方仅为系统 部分 功能 2023年9月23日 截图，更多新增功能及细节请登录演示环境或 clone 代码到本地启动查看。
 |
 |
 |
 |
 |
 |
 |
 |
 |
 |
 |
 |
 |
 |
 |
 |
 |
 |
 |
 |
 |
 |
 |
 |
 |
 |
 |
 |
 |
 |
 |
 |
快速开始
Note 下方步骤有重叠部分，无需重复执行。
后端
# 1.克隆本项目
git clone https://github.com/Charles7c/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.启动程序
# 4.1 启动成功：访问 http://localhost:8000/，页面输出：Xxx started successfully.
# 4.2 接口文档：http://localhost:8000/doc.html
# 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/continew-admin 目录下
# 5.1.3 将 docker 目录上传到服务器 / 目录下，并授权（chmod -R 777 /docker）
# 5.1.4 修改 docker-compose.yml 中的 MariaDB 配置、Redis 配置、continew-admin-server 配置、Nginx 配置
# 5.1.5 执行 docker-compose up -d 创建并后台运行所有容器
# 5.2 其他方式部署前端
# 1.克隆本项目
git clone https://github.com/Charles7c/continew-admin.git
# 2.在 IDE（Visual Studio Code/WebStorm）中打开前端项目 continew-admin-ui
# 3.安装 pnpm，配置淘宝源
npm install -g pnpm
pnpm config set registry https://registry.npm.taobao.org
# 4.安装依赖
pnpm i
# 5.启动程序
# 5.1 启动成功：访问 http://localhost:5173/
pnpm dev
# 6.部署
# 6.1 Docker 部署
# 6.1.1 服务器安装好 docker 及 docker-compose（参考：https://blog.charles7c.top/categories/fragments/2022/10/31/CentOS%E5%AE%89%E8%A3%85Docker）
# 6.1.2 执行 pnpm build 进行项目打包，将 dist 目录下的所有文件放到 /docker/continew-admin/web 目录下
# 6.1.3 将 docker 目录上传到服务器 / 目录下，并授权（chmod -R 777 /docker）
# 6.1.4 修改 docker-compose.yml 中的 MariaDB 配置、Redis 配置、continew-admin-server 配置、Nginx 配置
# 6.1.5 执行 docker-compose up -d 创建并后台运行所有容器
# 6.2 其他方式部署核心技术栈
| 名称 | 版本 | 简介 |
|---|---|---|
| Vue | 3.3.4 | 渐进式 JavaScript 框架，易学易用，性能出色，适用场景丰富的 Web 前端框架。 |
| TypeScript | 4.9.5 | TypeScript 是微软开发的一个开源的编程语言，通过在 JavaScript 的基础上添加静态类型定义构建而成。 |
| Arco Design Vue | 2.52.0 | 字节跳动推出的前端 UI 框架，样式美观，组件丰富。 |
| Spring Boot | 2.7.16 | 简化新 Spring 应用的初始搭建以及开发过程。 |
| Undertow | 2.2.26.Final | 采用 Java 开发的灵活的高性能 Web 服务器，提供包括阻塞和基于 NIO 的非堵塞机制。 |
| Sa-Token + JWT | 1.36.0 | 轻量级 Java 权限认证框架，让鉴权变得简单、优雅。 |
| MariaDB | 10.10.2 | MySQL 的一个分支，主要由开源社区在维护，完全兼容 MySQL，包括 API 和命令行，能轻松成为 MySQL 的代替品。 |
| MyBatis Plus | 3.5.3.2 | MyBatis 的增强工具，在 MyBatis 的基础上只做增强不做改变，简化开发、提高效率。 |
| dynamic-datasource-spring-boot-starter | 3.6.1 | 基于 Spring Boot 的快速集成多数据源的启动器。 |
| Hikari | 4.0.3 | JDBC 连接池，号称 “史上最快连接池”，SpringBoot 在 2.0 之后，采用的默认数据库连接池就是 Hikari。 |
| mysql-connector-j | 8.0.33 | MySQL Java 驱动。 |
| P6Spy | 3.9.1 | SQL 性能分析组件。 |
| Liquibase | 4.9.1 | 用于管理数据库版本，跟踪、管理和应用数据库变化。 |
| Redis | 6.2.7 | 高性能的 key-value 数据库。 |
| Redisson | 3.20.1 | 不仅仅是一个 Redis Java 客户端，同其他 Redis Java 客户端有着很大的区别，相比之下其他客户端提供的功能还仅仅停留在作为数据库驱动层面上，比如仅针对 Redis 提供连接方式，发送命令和处理返回结果等。而 Redisson 充分的利用了 Redis 键值数据库提供的一系列优势，基于 Java 实用工具包中常用接口，为使用者提供了一系列具有分布式特性的常用工具类。使得原本作为协调单机多线程并发程序的工具包获得了协调分布式多机多线程并发系统的能力，大大降低了设计和研发大规模分布式系统的难度。同时结合各富特色的分布式服务，更进一步简化了分布式环境中程序相互之间的协作。 |
| Just Auth | 1.16.5 | 开箱即用的整合第三方登录的开源组件，脱离繁琐的第三方登录 SDK，让登录变得 So easy！ |
| Easy Excel | 3.3.2 | 一个基于 Java 的、快速、简洁、解决大文件内存溢出的 Excel 处理工具。 |
| Easy Captcha | 1.6.2 | Java 图形验证码，支持 gif、中文、算术等类型，可用于 Java Web、JavaSE 等项目。 |
| Knife4j | 4.3.0 | 前身是 swagger-bootstrap-ui，集 Swagger2 和 OpenAPI3 为一体的增强解决方案。本项目使用的是 knife4j-openapi3-spring-boot-starter 基于 OpenAPI3 规范，在 Spring Boot < 3.0.0-M1 的单体架构下可以直接引用此 starter，该模块包含了 UI 部分，底层基于 springdoc-openapi 项目。 |
| Hutool | 5.8.22 | 小而全的 Java 工具类库，通过静态方法封装，降低相关 API 的学习成本，提高工作效率，使 Java 拥有函数式语言般的优雅，让 Java 语言也可以“甜甜的”。 |
| Lombok | 1.18.30 | 在 Java 开发过程中用注解的方式，简化了 JavaBean 的编写，避免了冗余和样板式代码，让编写的类更加简洁。 |
项目结构
后端
采用按功能拆分模块的开发方式，项目目录结构如下：
Note 下方项目目录结构是按照模块的层次顺序进行介绍的，实际 IDE 中
continew-admin-common模块会因为字母排序原因排在上方。
continew-admin # 全局通用项目配置及依赖版本管理
├─ continew-admin-webapi # API 模块（存放 Controller 层代码，打包部署的模块）
│ └─ src
│ └─ main
│ ├─ java # 工程源文件代码目录
│ │ └─ top
│ │ └─ charles7c
│ │ └─ cnadmin
│ │ ├─ webapi
│ │ │ └─ controller
│ │ │ ├─ auth # 认证相关 API
│ │ │ ├─ common # 公共相关 API（例如：验证码 API 等）
│ │ │ ├─ monitor # 系统监控相关 API
│ │ │ ├─ system # 系统管理相关 API
│ │ │ └─ tool # 系统工具相关 API
│ │ └─ ContinewAdminApplication.java # 启动入口
│ └─ resources # 工程配置目录
│ ├─ db.changelog # 数据库脚本文件
│ │ ├─ v1.0.0 # v1.0.0 版本数据库脚本文件
│ │ └─ v1.1.0 # v1.1.0 版本数据库脚本文件
│ └─ templates # 模板文件
│ └─ mail # 邮件模板
├─ continew-admin-monitor # 系统监控模块（存放系统监控模块相关功能，例如：日志管理、服务监控等）
│ └─ src
│ └─ main
│ ├─ java # 工程源文件代码目录
│ │ └─ top
│ │ └─ charles7c
│ │ └─ cnadmin
│ │ └─ monitor
│ │ ├─ annotation # 系统监控相关注解
│ │ ├─ config # 系统监控相关配置
│ │ │ └─ properties # 系统监控相关配置属性
│ │ ├─ enums # 系统监控相关枚举
│ │ ├─ filter # 系统监控相关过滤器
│ │ ├─ interceptor # 系统监控相关拦截器
│ │ ├─ mapper # 系统监控相关 Mapper
│ │ ├─ model # 系统监控相关模型
│ │ │ ├─ entity # 系统监控相关实体对象
│ │ │ ├─ query # 系统监控相关查询条件
│ │ │ └─ vo # 系统监控相关 VO（View Object）
│ │ └─ service # 系统监控相关业务接口及实现类
│ │ └─ impl # 系统监控相关业务实现类
│ └─ resources # 工程配置目录
│ └─ mapper # MyBatis Mapper XML 文件目录
├─ continew-admin-system # 系统管理模块（存放系统管理模块相关功能，例如：部门管理、角色管理、用户管理等）
│ └─ src
│ └─ main
│ ├─ java # 工程源文件代码目录
│ │ └─ top
│ │ └─ charles7c
│ │ └─ cnadmin
│ │ ├─ auth # 系统认证相关业务及配置
│ │ │ ├─ config # 系统认证相关配置
│ │ │ │ └─ satoken # Sa-Token 配置
│ │ │ ├─ model # 系统认证相关模型
│ │ │ │ ├─ query # 系统认证相关查询条件
│ │ │ │ ├─ request # 系统认证相关请求对象
│ │ │ │ └─ vo # 系统认证相关 VO（View Object）
│ │ │ └─ service # 系统认证相关业务接口及实现类
│ │ │ └─ impl # 系统认证相关业务实现类
│ │ └─ system # 系统管理相关业务及配置
│ │ ├─ enums # 系统管理相关枚举
│ │ ├─ mapper # 系统管理相关 Mapper
│ │ ├─ model # 系统管理相关模型
│ │ │ ├─ entity # 系统管理相关实体对象
│ │ │ ├─ query # 系统管理相关查询条件
│ │ │ ├─ request # 系统管理相关请求对象
│ │ │ └─ vo # 系统管理相关 VO（View Object）
│ │ └─ service # 系统管理相关业务接口及实现类
│ │ └─ impl # 系统管理相关业务实现类
│ └─ resources # 工程配置目录
│ └─ mapper # MyBatis Mapper XML 文件目录
├─ continew-admin-tool # 系统工具模块（存放系统工具模块相关功能，例如：代码生成、文件管理等）
│ └─ src
│ └─ main
│ ├─ java # 工程源文件代码目录
│ │ └─ top
│ │ └─ charles7c
│ │ └─ cnadmin
│ │ └─ tool
│ │ ├─ config # 系统工具相关配置
│ │ │ └─ properties # 系统工具相关配置属性
│ │ ├─ enums # 系统工具相关枚举
│ │ ├─ mapper # 系统工具相关 Mapper
│ │ ├─ model # 系统工具相关模型
│ │ │ ├─ entity # 系统工具相关实体对象
│ │ │ ├─ query # 系统工具相关查询条件
│ │ │ ├─ request # 系统工具相关请求对象
│ │ │ └─ vo # 系统工具相关 VO（View Object）
│ │ ├─ service # 系统工具相关业务接口及实现类
│ │ │ └─ impl # 系统工具相关业务实现类
│ │ └─ util # 系统工具相关工具类
│ └─ resources # 工程配置目录
│ ├─ mapper # MyBatis Mapper XML 文件目录
│ └─ templates # 模板文件
│ └─ generator # 代码生成器模板
├─ continew-admin-common # 公共模块（存放公共工具类，公共配置等）
│ └─ src
│ └─ main
│ └─ java # 工程源文件代码目录
│ └─ top
│ └─ charles7c
│ └─ cnadmin
│ └─ common
│ ├─ annotation # 公共注解
│ ├─ base # 公共基类
│ ├─ config # 公共配置
│ │ ├─ easyexcel # Easy Excel 配置
│ │ ├─ jackson # Jackson 配置
│ │ ├─ mybatis # MyBatis Plus 配置
│ │ ├─ threadpool # 线程池配置
│ │ └─ properties # 公共配置属性
│ ├─ constant # 公共常量
│ ├─ enums # 公共枚举
│ ├─ exception # 公共异常
│ ├─ handler # 公共处理器
│ ├─ model # 公共模型
│ │ ├─ dto # 公共 DTO（Data Transfer Object）
│ │ ├─ query # 公共查询条件
│ │ ├─ request # 公共请求对象
│ │ └─ vo # 公共 VO（View Object）
│ ├─ service # 公共业务接口
│ └─ util # 公共工具类
│ ├─ helper # 公共 Helper（助手）
│ ├─ holder # 公共 Holder（持有者）
│ └─ validate # 公共校验器（参数校验，业务校验）前端
continew-admin
└─ continew-admin-ui # 前端项目
├─ config # 全局 Vite 配置
├─ public # 公共静态资源（favicon.ico、logo.svg）
├─ src
│ ├─ api # 请求接口
│ │ ├─ demo # 示例模块
│ │ ├─ auth # 认证模块
│ │ ├─ common # 公共模块
│ │ ├─ monitor # 系统监控模块
│ │ ├─ system # 系统管理模块
│ │ └─ tool # 系统工具模块
│ ├─ assets # 静态资源
│ │ ├─ icons # 图标资源
│ │ ├─ images # 图片资源
│ │ └─ style # 样式资源
│ ├─ components # 通用业务组件
│ ├─ config # 全局配置（包含 echarts 主题）
│ │ └─ settings.json # 配置文件
│ ├─ directives # 指令集（如需，可自行补充）
│ ├─ hooks # 全局 hooks
│ ├─ layout # 布局
│ ├─ locale # 国际化语言包
│ ├─ mock # 模拟数据
│ ├─ router # 路由配置
│ ├─ store # 状态管理中心
│ ├─ types # TypeScript 类型
│ ├─ utils # 工具库
│ ├─ views # 页面模板
│ │ ├─ demo # Arco Design 相关示例模块
│ │ ├─ dashboard # 仪表盘模块
│ │ ├─ login # 登录模块
│ │ ├─ monitor # 系统监控模块
│ │ │ ├─ log # 日志管理
│ │ │ │ ├─ login # 登录日志
│ │ │ │ ├─ operation # 操作日志
│ │ │ │ └─ system # 系统日志
│ │ │ └─ online # 在线用户
│ │ └─ system # 系统管理模块
│ │ ├─ announcement # 公告管理
│ │ ├─ config # 系统配置
│ │ ├─ dept # 部门管理
│ │ ├─ dict # 字典管理
│ │ ├─ menu # 菜单管理
│ │ ├─ role # 角色管理
│ │ └─ user # 用户模块
│ │ └─ center # 个人中心
│ ├─ App.vue
│ └─ main.ts # 入口文件
├─ .env.development
├─ .env.production
├─ index.html
├─ package.json
└─ tsconfig.json贡献代码
ContiNew Admin 致力于持续以最新流行技术栈构建，拥抱变化，迭代优化。作为一个开源项目，Creator 的初心是希望 ContiNew Admin 在社区贡献者的支持和参与下，持续发展并源源不断地为企业级项目开发提供助力。我们非常欢迎广大社区用户为 ContiNew Admin 贡献或优化代码。
分支说明
ContiNew Admin 的分支目前分为下个大版本的开发分支和上个大版本的维护分支，PR 前请注意对应分支是否处于维护状态，版本支持情况请查看 更新日志/版本支持。
| 分支 | 说明 |
|---|---|
| dev | 开发分支，默认为下个大版本的 SNAPSHOT 版本，接受新功能或新功能优化 PR |
| x.x.x | 维护分支，在 vx.x.x 版本维护期终止前（一般为下个大版本发布前），用于修复上个版本的 Bug，只接受已有功能修复，不接受新功能 PR |
流程步骤
如果您想提交新功能或优化现有代码，可以按照以下步骤操作：
- 首先，在 Gitee 或 Github 上将项目 fork 到您自己的仓库
- 然后，将 fork 过来的项目（即您的项目）克隆到本地
- 切换到当前仍在维护的分支（请务必充分了解分支使用说明，可进群联系维护者确认）
- 开始修改代码，修改完成后，将代码 commit 并 push 到您的远程仓库
- 在 Gitee 或 Github 上新建 pull request（pr），选择好源和目标，按模板要求填写说明信息后提交即可（多多参考 已批准合并的 pr 记录，会大大增加批准合并率）
- 最后，耐心等待维护者合并您的请求即可
请记住，如果您有任何疑问或需要帮助，我们将随时提供支持。
Note 欢迎大家为 ContiNew Admin 贡献代码，我们非常感谢您的支持！为了更好地管理项目，维护者有一些要求：
- 请确保代码、配置文件的结构和命名规范良好，完善的代码注释甚至包括接口文档参数示例，并遵循阿里巴巴的 《Java开发手册(黄山版)》 中的代码规范，保证代码质量和可维护性
- 在提交代码前，请按照 Angular 提交规范 编写 commit 的 message（建议在 IntelliJ IDEA 中下载并安装 Git Commit Template 插件，以便按照规范进行 commit）
- 提交代码之前，请关闭所有代码窗口，执行 mvn compile 命令（项目已配置代码格式化插件，编译通过的同时也会自动进行代码格式化），编译通过后，不要再打开查看任何代码窗口，直接提交即可，以免不同的 IDE 配置会自动进行代码格式化
鸣谢
鸣谢
感谢参与贡献的每一位小伙伴！（以下排名不分先后）
特别鸣谢
- 感谢 JetBrains 提供的 非商业开源软件开发授权
- 感谢 Arco Design Pro 开箱即用的中后台前端解决方案
- 感谢 MyBatis Plus、Sa-Token 、Easy Excel、Knife4j、Hutool 等国产开源组件作者为国内开源世界作出的贡献
- 感谢 ELADMIN、RuoYi-Vue-Plus、RuoYi-Vue3 提供的诸多成熟方案，致敬各位作者为开源脚手架领域作出的贡献
- 感谢项目使用或未使用到的每一款开源组件，致敬各位开源先驱
🔥
License
- 遵循 Apache-2.0 开源许可协议
- Copyright © 2022-present Charles7c
GitHub Star 趋势
