odboy
fae0447242
- 新增 flow_host_group 表用于管理主机组 - 新增 flow_host_instance 表用于管理主机实例 - 新增 flow_instance 表用于管理流水线实例 - 新增 flow_kubernetes_cluster 表用于管理 Kubernetes 集群 - 新增 flow_role 表用于管理角色权限 - 新增 flow_role_user 表用于管理角色用户关联 - 新增 flow_task 表用于管理流水线任务 - 新增 flow_template 表用于管理流水线模板 - 更新系统菜单表，添加流水线组件菜单项 - 更新项目简介说明，支持 Spring Boot 多版本
121 lines
6.0 KiB
Markdown
121 lines
6.0 KiB
Markdown
<h1 style="text-align: center">CuteJava 后台管理系统</h1>
|
||
|
||
#### 项目简介
|
||
|
||
一个基于 Spring Boot 2/3/4 、 Mybatis-Plus、 JWT、Spring Security、Redis、Vue2的前后端分离的后台管理系统
|
||
|
||
**账号密码：** `admin / 123456`
|
||
|
||
#### 项目源码
|
||
|
||
[https://gitee.com/odboy-tianjun/cutejava](https://gitee.com/odboy-tianjun/cutejava)
|
||
|
||
#### 项目文档
|
||
|
||
[https://cutejava-doc.odboy.cn/](https://cutejava-doc.odboy.cn/)
|
||
|
||
#### 编码规范
|
||
|
||
- 和数据库表一一对应的类, 以`Tb`结尾
|
||
- API请求参数类名, 以`Args`结尾
|
||
- API响应参数类名, 以`Vo`结尾
|
||
- 事件驱动类名, 以`Event`结尾
|
||
- 消息队列/Socket传输类名，以`Message`结尾
|
||
- ~~常用的辅助类的类名, 以`Cs`开头~~
|
||
- 常用的辅助类的类名, 以`Kit`开头。Kit有套件、装备等意思。
|
||
- 枚举类名，以`Enum`结尾
|
||
- 内部调用一律声明this
|
||
- 拒绝过度包装
|
||
- 命名规则(Mapper or Service)
|
||
- 简单查询：get + 名词
|
||
- 列表查询：list + 名词
|
||
- 复杂查询：query + 名词 + By + 条件
|
||
- 搜索(分页)功能：search + 名词
|
||
- 统计计数：count + By + 条件
|
||
- 存在检查：exists + By + 条件
|
||
- 增删改：save/delete/update
|
||
- 例子: 查询分页、查询列表的方法
|
||
- 分页：searchUser(args, page)
|
||
- 列表：listUser + (args)
|
||
- 单个：getUser + by + (args)
|
||
- Mapper
|
||
- 分页与列表共用
|
||
- selectUserByArgs(args, page)
|
||
- selectUserByArgs(args)
|
||
- MapperXml selectUserByArgs
|
||
- 单个：getUser + by + (args)
|
||
- 统计计数：count + By + (args)
|
||
|
||
#### 编码规范：举例说明
|
||
|
||
1. getUser - 简单查询
|
||
核心： 获取单个特定实体。
|
||
|
||
- 输入： 通常是一个唯一标识符（如ID 123）。
|
||
- 筛选： 非常精确，只匹配一个。
|
||
- 返回： 单个对象或文档，包含该用户的完整/详细信息。
|
||
- 示例： getUser(123) -> 返回 {id: 123, name: “Alice”, email: “...”}
|
||
|
||
2. listUsers - 列表查询
|
||
核心： 获取一个符合简单条件的实体集合，通常是有限的、预定义的。
|
||
|
||
- 输入： 可能没有参数，或只有非常简单的过滤条件（如 status=‘active’）。
|
||
- 筛选： 简单、常规。
|
||
- 返回： 一个数组/列表，包含多个用户的基本信息（通常是摘要字段，非完整详情）。
|
||
- 通常不分页，或隐式返回所有符合条件的（数据量预期不大）。
|
||
- 示例： listUsers() -> 返回 [{id: 1, name: “Alice”}, {id: 2, name: “Bob”}]
|
||
- 示例： listUsers({role: ‘admin’}) -> 返回所有管理员用户的列表。
|
||
|
||
3. queryUsersByCondition - 复杂查询
|
||
核心： 基于多个、可能较复杂的条件进行筛选。
|
||
|
||
- 输入： 一个组合条件对象，可能涉及多个字段的比较（如 age > 18 AND department = ‘Sales’ AND joinDate < ‘2023-01-01’）。
|
||
- 筛选： 复杂、灵活，类似数据库的WHERE子句。
|
||
- 返回： 一个匹配条件的数组/列表。
|
||
- 分页： 可能分页，也可能不分页。关键是它的侧重点在于复杂的“筛选”能力，而非分页机制。（这是标准，但是对于此项目来说，定为不分页的，复杂条件的，列表查询服务）
|
||
- 示例： queryUsersByCondition({minAge: 18, department: ‘Sales’, hasCertification: true})
|
||
|
||
4. searchUsers - 搜索（分页）功能
|
||
核心： 针对大量数据进行模糊匹配、全文检索，并强制包含分页机制以管理性能。
|
||
|
||
- 输入：
|
||
- 搜索关键词（可能对多个字段进行模糊匹配）。
|
||
- 分页参数（pageNumber, pageSize 或 limit, offset）。
|
||
- 可能附加的其他过滤条件。
|
||
- 筛选： 通常包含文本搜索（如 name LIKE ‘%Al%’），结果可能按相关性排序。
|
||
- 返回： 一个分页响应对象，而不仅仅是数组。
|
||
- 包含：data（当前页的数据列表）、total（总匹配数）、page（当前页）、pageSize（每页大小）等元数据。
|
||
- 示例： searchUsers({keyword: ‘Al’, page: 1, pageSize: 20}) -> 返回 {data: […], total: 45, page: 1, pageSize: 20}
|
||
|
||
#### 主要特性
|
||
|
||
- 使用最新技术栈，社区资源丰富。
|
||
- 高效率开发，代码生成器可一键生成前后端代码
|
||
- 支持数据字典，可方便地对一些状态进行管理
|
||
- 支持接口限流，避免恶意请求导致服务层压力过大
|
||
- 支持接口级别的功能权限与数据权限，可自定义操作
|
||
- 自定义权限注解与匿名接口注解，可快速对接口拦截与放行
|
||
- 对一些常用地前端组件封装：表格数据请求、数据字典等
|
||
- 前后端统一异常拦截处理，统一输出异常，避免繁琐的判断
|
||
- 支持在线用户管理与服务器性能监控，支持限制单用户登录
|
||
- 支持一键复制菜单项，避免菜单繁琐配置
|
||
|
||
#### 系统功能
|
||
|
||
- 用户管理：提供用户的相关配置，新增用户后，默认密码为123456
|
||
- 角色管理：对权限与菜单进行分配，可根据部门设置角色的数据权限
|
||
- 菜单管理：已实现菜单动态路由，后端可配置化，支持多级菜单
|
||
- 部门管理：可配置系统组织架构，树形表格展示
|
||
- 岗位管理：配置各个部门的职位
|
||
- 字典管理：可维护常用一些固定的数据，如：状态，性别等
|
||
- SQL监控：采用druid 监控数据库访问性能，默认用户名admin，密码123456
|
||
- 定时任务：整合Quartz做定时任务，加入任务日志，任务运行情况一目了然
|
||
- 邮件工具：配合富文本，发送html格式的邮件
|
||
- 存储管理：本地存储、Minio存储
|
||
- 服务监控：监控服务器的负载情况
|
||
|
||
#### 系统模块
|
||
|
||
- cutejava-framework：系统基础框架。提供核心功能，如：权限、数据权限、异常处理、缓存、工具类、接口限流、接口防重、接口幂等。
|
||
- cutejava-module-system：系统功能模块。提供用户、角色、菜单、部门、岗位、字典、定时任务、邮件、Minio存储、服务监控等功能
|