ContiNew/continew-admin
1
1
Fork 0
mirror of https://github.com/continew-org/continew-admin.git synced 2025-10-31 10:57:13 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: 完善 README 文档主要特性，系统功能，项目结构部分内容

Browse Source
This commit is contained in:
Charles7c
2023-08-25 23:54:36 +08:00
parent df77e574cc
commit 85043d829c
1 changed files with 26 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

41
README.md
View File

@@ -34,16 +34,17 @@ ContiNew Admin （Continue New Admin）中后台管理框架/脚手架，持续
## 主要特性 ## 主要特性
- 精选技术栈，综合考虑成熟度、流行性、发展潜力 - 精选技术栈：使用综合考虑成熟度、流行性、发展潜力较佳的技术栈，包括 Spring Boot、MyBatis Plus、Sa-Token、Hutool 等
- 高效率开发，后端提供了 CRUD 组件，在 Controller 添加一个注解，搞定增、删、改、查、分页、列表、树列表 - 高效率开发：后端提供了 CRUD 组件，在 Controller 中只需添加一个注解，即可自动生成增、删、改、查、分页、列表、树列表等 API
- 基于注解的通用查询方式，降低拼接 MyBatis Plus QueryWrapper 的烦恼 - 提供代码生成功能，根据用户提供的项目信息和配置，自动生成前后端项目结构、代码文件和部分逻辑代码，提高开发效率
- 提供一套 Base 基类（BaseDO、BaseVO、BaseController、BaseService、升级版 BaseMapper...，用了你就知道），既方便复用又方便扩展 - 一个注解解决一个条件查询，基于注解的通用查询方式，降低拼接 MyBatis Plus QueryWrapper 的烦恼
- 提供一套校验工具实践，另根据实际需要，基于 Hutool 扩展部分工具类（能 PR 到 Hutool 的已尽量 PR） - 提供一套 Base 基类（BaseDO、BaseVO、BaseController、BaseService、扩展版 BaseMapper 等），方便复用和扩展
- 编写或基于 Hutool 扩展部分工具类，提供校验工具和实践，提高开发效率（能 PR 到 Hutool 的已尽量 PR）
- 支持 API 级别的功能权限与数据权限，可自定义操作 - 支持 API 级别的功能权限与数据权限，可自定义操作
- 前后端统一异常拦截处理，统一输出异常，避免繁琐的判断 - 前后端统一异常拦截处理，统一输出异常信息，避免繁琐的异常判断
- 良好的代码、配置文件结构和命名，完善的代码注释，遵循阿里巴巴 <a href="https://github.com/Charles7c/continew-admin/blob/dev/code-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> 的代码规范 - 自动初始化数据：通过 Liquibase 管理数据库脚本版本记录，并在系统第一次启动时自动进行数据初始化，无须额外配置导入
- 提供多项实用基础配置，例如：Jackson 针对日期、通用枚举的序列化、反序列化配置，统一线程池配置... - 提供多项实用基础配置，例如：Jackson 针对日期、通用枚举的序列化、反序列化配置，统一线程池配置等
- 通过 Liquibase 管理数据库脚本版本记录 - 良好的代码、配置文件结构和命名，完善的代码注释甚至包括接口文档参数示例，遵循阿里巴巴 <a href="https://github.com/Charles7c/continew-admin/blob/dev/code-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> 的代码规范，保证代码质量和可维护性
- 更多细节及实践，敬请探索与关注 - 更多细节及实践，敬请探索与关注
## 系统功能 ## 系统功能
@@ -54,6 +55,8 @@ ContiNew Admin （Continue New Admin）中后台管理框架/脚手架，持续
- 角色管理：对权限与菜单进行分配，可根据部门设置角色的数据权限 - 角色管理：对权限与菜单进行分配，可根据部门设置角色的数据权限
- 菜单管理：已实现菜单动态路由，后端可配置化，支持多级菜单 - 菜单管理：已实现菜单动态路由，后端可配置化，支持多级菜单
- 部门管理：可配置系统组织架构，树形表格展示 - 部门管理：可配置系统组织架构，树形表格展示
- 公告管理：提供公告的发布、查看和删除等功能。管理员可以在后台发布公告，并可以设置公告的生效时间、终止时间，以 markdown-it 为内核渲染 Markdown 格式内容显示
- 代码生成：提供根据数据库表自动生成相应的前后端 CRUD 代码的功能
- 在线用户：管理当前登录用户，可一键踢下线 - 在线用户：管理当前登录用户，可一键踢下线
- 日志管理：提供在线用户监控、登录日志监控、操作日志监控和系统日志监控等监控功能 - 日志管理：提供在线用户监控、登录日志监控、操作日志监控和系统日志监控等监控功能
@@ -79,7 +82,8 @@ continew-admin # 全局通用项目配置及依赖版本管理
│ │ │ ├─ auth # 认证相关 API │ │ │ ├─ auth # 认证相关 API
│ │ │ ├─ common # 公共相关 API（例如：验证码 API 等） │ │ │ ├─ common # 公共相关 API（例如：验证码 API 等）
│ │ │ ├─ monitor # 系统监控相关 API │ │ │ ├─ monitor # 系统监控相关 API
│ │ │ └─ system # 系统管理相关 API │ │ │ ├─ system # 系统管理相关 API
│ │ │ └─ tool # 系统工具相关 API
│ │ └─ ContinewAdminApplication.java # 启动入口 │ │ └─ ContinewAdminApplication.java # 启动入口
│ └─ resources # 工程配置目录 │ └─ resources # 工程配置目录
│ ├─ db.changelog # 数据库脚本文件 │ ├─ db.changelog # 数据库脚本文件
@@ -121,11 +125,13 @@ continew-admin # 全局通用项目配置及依赖版本管理
│ │ │ ├─ config # 系统认证相关配置 │ │ │ ├─ config # 系统认证相关配置
│ │ │ │ └─ satoken # Sa-Token 配置 │ │ │ │ └─ satoken # Sa-Token 配置
│ │ │ ├─ model # 系统认证相关模型 │ │ │ ├─ model # 系统认证相关模型
│ │ │ │ ├─ query # 系统认证相关查询条件
│ │ │ │ ├─ request # 系统认证相关请求对象 │ │ │ │ ├─ request # 系统认证相关请求对象
│ │ │ │ └─ vo # 系统认证相关 VO（View Object） │ │ │ │ └─ vo # 系统认证相关 VO（View Object）
│ │ │ └─ service # 系统认证相关业务接口及实现类 │ │ │ └─ service # 系统认证相关业务接口及实现类
│ │ │ └─ impl # 系统认证相关业务实现类 │ │ │ └─ impl # 系统认证相关业务实现类
│ │ └─ system # 系统管理相关业务及配置 │ │ └─ system # 系统管理相关业务及配置
│ │ ├─ enums # 系统管理相关枚举
│ │ ├─ mapper # 系统管理相关 Mapper │ │ ├─ mapper # 系统管理相关 Mapper
│ │ ├─ model # 系统管理相关模型 │ │ ├─ model # 系统管理相关模型
│ │ │ ├─ entity # 系统管理相关实体对象 │ │ │ ├─ entity # 系统管理相关实体对象
@@ -187,7 +193,7 @@ continew-admin # 全局通用项目配置及依赖版本管理
│ │ └─ vo # 公共 VO（View Object） │ │ └─ vo # 公共 VO（View Object）
│ ├─ service # 公共业务接口 │ ├─ service # 公共业务接口
│ └─ util # 公共工具类 │ └─ util # 公共工具类
│ ├─ helper # 公共 Helper（助手） │ ├─ helper # 公共 Helper（助手）
│ ├─ holder # 公共 Holder（持有者） │ ├─ holder # 公共 Holder（持有者）
│ └─ validate # 公共校验器（参数校验，业务校验） │ └─ validate # 公共校验器（参数校验，业务校验）
``` ```
@@ -204,7 +210,8 @@ continew-admin
│ │ ├─ auth # 认证模块 │ │ ├─ auth # 认证模块
│ │ ├─ common # 公共模块 │ │ ├─ common # 公共模块
│ │ ├─ monitor # 系统监控模块 │ │ ├─ monitor # 系统监控模块
│ │ └─ system # 系统管理模块 │ │ ├─ system # 系统管理模块
│ │ └─ tool # 系统工具模块
│ ├─ assets # 静态资源 │ ├─ assets # 静态资源
│ │ ├─ icons # 图标资源 │ │ ├─ icons # 图标资源
│ │ ├─ images # 图片资源 │ │ ├─ images # 图片资源
@@ -222,6 +229,8 @@ continew-admin
│ ├─ types # TypeScript 类型 │ ├─ types # TypeScript 类型
│ ├─ utils # 工具库 │ ├─ utils # 工具库
│ ├─ views # 页面模板 │ ├─ views # 页面模板
│ │ ├─ arco-design # Arco Design 相关示例模块
│ │ ├─ dashboard # 仪表盘模块
│ │ ├─ login # 登录模块 │ │ ├─ login # 登录模块
│ │ ├─ monitor # 系统监控模块 │ │ ├─ monitor # 系统监控模块
│ │ │ ├─ log # 日志管理 │ │ │ ├─ log # 日志管理
@@ -230,12 +239,13 @@ continew-admin
│ │ │ │ └─ system # 系统日志 │ │ │ │ └─ system # 系统日志
│ │ │ └─ online # 在线用户 │ │ │ └─ online # 在线用户
│ │ └─ system # 系统管理模块 │ │ └─ system # 系统管理模块
│ │ ├─ announcement # 公告管理
│ │ ├─ dept # 部门管理 │ │ ├─ dept # 部门管理
│ │ ├─ menu # 菜单管理 │ │ ├─ menu # 菜单管理
│ │ ├─ role # 角色管理 │ │ ├─ role # 角色管理
│ │ └─ user # 用户模块 │ │ └─ user # 用户模块
│ │ └─ center # 个人中心 │ │ └─ center # 个人中心
│ ├─ App.vue # 视图入口 │ ├─ App.vue
│ └─ main.ts # 入口文件 │ └─ main.ts # 入口文件
├─ .env.development ├─ .env.development
├─ .env.production ├─ .env.production
@@ -250,7 +260,7 @@ continew-admin
| :----------------------------------------------------------- | :----------- | :----------------------------------------------------------- | | :----------------------------------------------------------- | :----------- | :----------------------------------------------------------- |
| <a href="https://cn.vuejs.org/" target="_blank">Vue</a> | 3.2.47 | 渐进式 JavaScript 框架，易学易用，性能出色，适用场景丰富的 Web 前端框架。 | | <a href="https://cn.vuejs.org/" target="_blank">Vue</a> | 3.2.47 | 渐进式 JavaScript 框架，易学易用，性能出色，适用场景丰富的 Web 前端框架。 |
| <a href="https://www.typescriptlang.org/zh/" target="_blank">TypeScript</a> | 4.9.5 | TypeScript 是微软开发的一个开源的编程语言，通过在 JavaScript 的基础上添加静态类型定义构建而成。 | | <a href="https://www.typescriptlang.org/zh/" target="_blank">TypeScript</a> | 4.9.5 | TypeScript 是微软开发的一个开源的编程语言，通过在 JavaScript 的基础上添加静态类型定义构建而成。 |
| <a href="https://arco.design/vue/docs/start" target="_blank">Arco Design Vue</a> | 2.44.5 | 字节跳动推出的前端 UI 框架，样式美观，组件丰富。 | | <a href="https://arco.design/vue/docs/start" target="_blank">Arco Design Vue</a> | 2.44.7 | 字节跳动推出的前端 UI 框架，样式美观，组件丰富。 |
| <a href="https://spring.io/projects/spring-boot" target="_blank">Spring Boot</a> | 2.7.10 | 简化新 Spring 应用的初始搭建以及开发过程。 | | <a href="https://spring.io/projects/spring-boot" target="_blank">Spring Boot</a> | 2.7.10 | 简化新 Spring 应用的初始搭建以及开发过程。 |
| <a href="https://undertow.io/" target="_blank">Undertow</a> | 2.2.23.Final | 采用 Java 开发的灵活的高性能 Web 服务器，提供包括阻塞和基于 NIO 的非堵塞机制。 | | <a href="https://undertow.io/" target="_blank">Undertow</a> | 2.2.23.Final | 采用 Java 开发的灵活的高性能 Web 服务器，提供包括阻塞和基于 NIO 的非堵塞机制。 |
| <a href="https://sa-token.dev33.cn/" target="_blank">Sa-Token + JWT</a> | 1.34.0 | 轻量级 Java 权限认证框架，让鉴权变得简单、优雅。 | | <a href="https://sa-token.dev33.cn/" target="_blank">Sa-Token + JWT</a> | 1.34.0 | 轻量级 Java 权限认证框架，让鉴权变得简单、优雅。 |
@@ -390,6 +400,7 @@ pnpm dev
<div align="left"> <div align="left">
<img src="https://s1.ax1x.com/2023/03/09/ppnhe0A.jpg" alt="二维码" width="200" /> <img src="https://s1.ax1x.com/2023/03/09/ppnhe0A.jpg" alt="二维码" width="200" />
</div> </div>
## 贡献代码 ## 贡献代码
ContiNew Admin 致力于持续以最新流行技术栈构建，拥抱变化，迭代优化。作为一个开源项目，Creator 的初心是希望 ContiNew Admin 在社区贡献者的支持和参与下，持续发展并源源不断地为企业级项目开发提供助力。我们非常欢迎广大社区用户为 ContiNew Admin 贡献或优化代码。 ContiNew Admin 致力于持续以最新流行技术栈构建，拥抱变化，迭代优化。作为一个开源项目，Creator 的初心是希望 ContiNew Admin 在社区贡献者的支持和参与下，持续发展并源源不断地为企业级项目开发提供助力。我们非常欢迎广大社区用户为 ContiNew Admin 贡献或优化代码。
@@ -407,7 +418,7 @@ ContiNew Admin 致力于持续以最新流行技术栈构建，拥抱变化，
> 欢迎大家为 ContiNew Admin 贡献代码，我们非常感谢您的支持！为了更好地管理项目，维护者有一些要求： > 欢迎大家为 ContiNew Admin 贡献代码，我们非常感谢您的支持！为了更好地管理项目，维护者有一些要求：
> >
> 1. 请确保代码、配置文件的结构和命名规范良好，注释完善，并遵循阿里巴巴的 <a href="https://github.com/Charles7c/continew-admin/blob/dev/code-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/Charles7c/continew-admin/blob/dev/code-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） > 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 配置会自动进行代码格式化 > 3. 提交代码之前，请关闭所有代码窗口，执行 mvn compile 命令（项目已配置代码格式化插件，编译通过的同时也会自动进行代码格式化），编译通过后，不要再打开查看任何代码窗口，直接提交即可，以免不同的 IDE 配置会自动进行代码格式化