Compare commits

5 Commits

Author SHA1 Message Date
36962221f5 feat(dbms): 增加数据库备份任务停止重启功能和MySQL支持
- 添加了备份任务停止和重启接口及实现
- 实现了对MySQL数据库的支持,包括数据库名配置
- 重构了数据库连接和备份操作的SPI架构
- 优化了备份文件删除逻辑,支持目录递归删除
- 增加了连接名称唯一性校验
- 完善了备份任务状态管理和错误处理机制
- 更新了数据库连接参数验证逻辑
2026-06-09 13:14:43 +08:00
5f6c10b9cb feat(add-ledger): 新增线路类型和设备单位管理功能
- 添加线路类型常量定义(主网0,配网1)及验证逻辑
- 新增设备单位查询和保存接口及实现
- 新增监测点限值查询接口
- 扩展AddLedgerDetailVO和AddLedgerLinePO实体类以支持线路类型字段
- 在测点保存时自动计算并保存限值信息
- 添加设备单位默认配置初始化逻辑
- 新增COverlimitUtil工具类用于限值计算
- 完善相关单元测试用例
2026-05-29 15:15:22 +08:00
66d351afe4 feat(steady): 新增数据校验功能并优化稳态趋势查询
- 在 AddLedgerLineMapper.xml 中添加 lineInterval 字段映射
- 在 AddLedgerLinePathVO 中添加 lineInterval 属性用于存储统计间隔
- 为稳态趋势查询服务添加详细的执行日志记录和性能监控
- 重构 InfluxDB 查询组件,添加诊断信息构建方法和异常处理
- 限制谐波次数最大展示数量从 6 个调整为 3 个
- 新增数据校验相关组件、控制器和服务实现
- 实现数据连续性检查和缺失数据统计功能
- 添加数据校验查询参数和返回结果的数据结构定义
- 完善相关单元测试确保功能正确性
2026-05-27 08:04:49 +08:00
e5369fef5a docs: 规划deploy Linux远程运维实现 2026-05-21 21:13:17 +08:00
ba8bc43377 docs: 设计deploy Linux远程运维方案 2026-05-21 16:44:42 +08:00
113 changed files with 10382 additions and 10 deletions

2
.gitignore vendored
View File

@@ -5,6 +5,8 @@
target/
logs/
docs/
.codex-tmp/
.docs/
# Log file
*.log

File diff suppressed because it is too large Load Diff

View File

@@ -0,0 +1,514 @@
# Linux 服务器部署运维设计
## 1. 背景
`system-ops/deploy` 当前只提供系统部署菜单的基础入口:
- `GET /deploy/overview`
- `DeployController`
- `DeployService`
- `DeployOverviewVO`
本次需求是在 `deploy` 模块中补充 Linux 服务器远程运维能力。用户可以维护 Linux 服务器连接配置,基于 SSH/SFTP 连接服务器,完成远程文件上传、下载和基础命令终端操作。命令终端目标体验接近 Xshell 的基础能力。
当前仓库没有前端代码,本设计只定义页面布局、接口契约、后端模块拆分、数据存储和验证方式,不实现真实前端页面。
## 2. 范围确认
本期只支持 Linux 服务器。
本期包含:
- Linux SSH 连接配置的新增、编辑、删除、查询。
- SSH 连接测试。
- SFTP 文件列表、上传、下载、删除、新建目录。
- SSH Shell 基础命令交互。
- 前端单页运维工作台布局设计。
- 连接配置使用文件方式存储,不新建数据库表。
本期不包含:
- Windows 服务器。
- FTP 协议。
- 数据库存储连接配置。
- 部署任务编排。
- 命令审批、命令黑名单、命令历史。
- 批量文件压缩下载。
- 数据库专用客户端封装。
- Maven 编译、打包、测试。
说明:需求中提到的 “FPT” 本期按 Linux 服务器常用能力理解为 SFTP。SFTP 复用 SSH 账号、密码和端口,比单独 FTP 更适合本期场景。
## 3. 总体方案
推荐采用 “SSH/SFTP + WebSocket 终端” 方案:
- 服务器连接配置保存到本地 JSON 文件。
- 后端通过 SSH 建立 Linux 连接。
- 文件操作通过 SFTP 通道完成。
- 终端操作通过 SSH Shell 通道完成。
- 前端通过 WebSocket 与后端交换终端输入输出。
该方案可以复用同一份服务器连接配置,不需要引入 Windows 远程协议,也能满足类 Xshell 的基础交互需求。
## 4. 前端页面布局
页面路径建议沿用当前菜单路径:
```text
/systemOps/deploy
```
页面采用三块工作区:
- 左侧:服务器列表。
- 中间:远程文件管理。
- 右侧:连接详情和快捷操作。
- 底部SSH 终端区。
推荐布局:
```text
┌──────────────────────────────────────────────────────────────┐
│ 顶部工具栏:新增连接 测试连接 刷新 当前连接状态 │
├──────────────┬──────────────────────────────┬────────────────┤
│ 服务器列表 │ 远程文件管理 │ 连接详情/操作 │
│ │ │ │
│ Linux-测试 │ 路径栏:/opt/app │ 主机/IP │
│ Linux-生产 │ 上传 下载 新建目录 删除 刷新 │ 用户名 │
│ │ │ 端口 │
│ │ 文件表格 │ 测试连接 │
│ │ │ 打开终端 │
├──────────────┴──────────────────────────────┴────────────────┤
│ 终端 TabsLinux-测试 │
│ $ pwd │
│ /opt/app │
└──────────────────────────────────────────────────────────────┘
```
### 4.1 服务器列表
左侧服务器列表用于选择当前操作目标。
展示字段:
| 字段 | 说明 |
|---|---|
| 名称 | 服务器显示名称 |
| 主机地址 | IP 或域名 |
| SSH 端口 | 默认 22 |
| 连接状态 | 未测试、连接成功、连接失败 |
交互:
- 支持按名称、主机地址搜索。
- 点击服务器后加载连接详情,并将文件管理区切换到该服务器。
- 列表项提供编辑、删除、测试连接入口。
- 删除连接前必须二次确认。
### 4.2 连接配置弹窗
新增和编辑使用同一个弹窗。
字段:
| 字段 | 是否必填 | 说明 |
|---|---|---|
| 名称 | 是 | 页面展示名称 |
| 主机地址 | 是 | Linux 服务器 IP 或域名 |
| SSH 端口 | 是 | 默认 22范围 1-65535 |
| 用户名 | 是 | SSH 登录用户 |
| 密码 | 新增必填 | 编辑时留空表示不修改 |
| 备注 | 否 | 环境说明 |
按钮:
- 测试连接。
- 保存。
- 取消。
密码规则:
- 新增连接时密码必填。
- 编辑连接时密码不回显。
- 编辑时密码为空表示沿用原密码。
- 查询列表和详情接口均不返回密码。
### 4.3 远程文件管理
中间文件管理区基于当前选中的服务器工作。
顶部路径栏:
- 展示当前远程目录,例如 `/opt/app`
- 支持返回上级目录。
- 支持点击面包屑跳转到上级路径。
工具栏:
- 上传。
- 下载。
- 新建目录。
- 删除。
- 刷新。
文件表格字段:
| 字段 | 说明 |
|---|---|
| 名称 | 文件或目录名称 |
| 类型 | 文件、目录、软链接 |
| 大小 | 文件大小,目录可为空 |
| 权限 | Linux 权限字符串 |
| 修改时间 | 远程文件修改时间 |
交互规则:
- 双击目录进入下级目录。
- 下载只支持普通文件。
- 删除文件或目录前必须二次确认。
- 本期支持单文件上传和单文件下载。
- 上传目标目录为当前路径。
- 下载目录、批量压缩下载不在本期范围。
### 4.4 SSH 终端区
底部终端区用于执行 Linux 命令。
交互规则:
- 点击“打开终端”后创建 SSH Shell 会话。
- 前端输入通过 WebSocket 实时发送给后端。
- 后端将 Shell 输出通过 WebSocket 实时推送给前端。
- 本期建议限制为每台服务器最多一个终端会话。
- 关闭终端 Tab 时通知后端释放 SSH 会话。
- 终端断开后显示状态,不自动重连。
用户可以在终端中自行执行数据库命令,例如:
```bash
mysql -uroot -p
psql -h 127.0.0.1 -U postgres
redis-cli
```
后端不解析数据库命令,也不保存命令历史。
## 5. 后端结构设计
`system-ops/deploy` 模块内按职责新增类,保留现有 `DeployController``/deploy/overview`
建议结构:
```text
system-ops/deploy/src/main/java/com/njcn/gather/systemops/deploy/
├── config/
├── controller/
├── pojo/param/
├── pojo/vo/
├── pojo/dto/
├── repository/
├── service/
├── service/impl/
└── websocket/
```
职责拆分:
| 类 | 职责 |
|---|---|
| `DeployServerController` | 连接配置查询、新增、编辑、删除、测试连接 |
| `DeployFileController` | SFTP 文件列表、上传、下载、删除、新建目录 |
| `DeployTerminalWebSocketHandler` | SSH 终端 WebSocket 输入输出转发 |
| `DeployServerConfigService` | 连接配置业务校验和编排 |
| `DeployServerConfigRepository` | JSON 文件读写 |
| `DeploySftpService` | SFTP 文件操作 |
| `DeploySshTerminalService` | SSH Shell 会话创建、输入、输出、关闭 |
| `DeployCryptoService` | 密码加密和解密 |
| `DeployProperties` | deploy 配置项绑定 |
## 6. 连接配置存储
连接配置不入库,使用 JSON 文件落盘。存储目录通过配置指定。
建议配置:
```yaml
deploy:
storage-dir: ${log.homeDir}/deploy
terminal-idle-timeout-minutes: 30
```
`deploy.crypto-key` 不建议在默认 `application.yml` 中配置明文值。后续实现时可通过环境覆盖或外部配置提供,业务代码只读取配置,不写死密钥。
落盘文件:
```text
D:\logs\deploy\deploy-server-connections.json
```
JSON 结构:
```json
{
"servers": [
{
"id": "uuid",
"name": "测试服务器",
"host": "192.168.1.10",
"sshPort": 22,
"username": "root",
"password": "加密密文",
"description": "测试环境",
"createdTime": "2026-05-21 14:00:00",
"updatedTime": "2026-05-21 14:00:00"
}
]
}
```
写文件规则:
- 启动时如果文件不存在,自动创建空配置文件。
- 读写方法集中在 `DeployServerConfigRepository`
- 写入时先写临时文件,再替换正式文件,避免进程中断导致 JSON 损坏。
- 保存和删除操作需要加进程内锁,避免并发写入互相覆盖。
密码规则:
- 密码必须加密后落盘。
- 接口返回不包含密码。
- 日志不打印密码。
- 优先复用项目已有加密能力;如没有合适工具,则在 `deploy` 内封装 AES 加解密组件。
- 加密密钥通过配置提供,不在业务代码中硬编码。
## 7. 接口设计
接口风格沿用当前仓库常见写法:查询和变更优先使用 `POST`,返回 `HttpResult<T>`
### 7.1 连接配置接口
| 方法 | 路径 | 说明 |
|---|---|---|
| `POST` | `/deploy/server/list` | 查询服务器连接配置列表 |
| `POST` | `/deploy/server/add` | 新增服务器连接配置 |
| `POST` | `/deploy/server/update` | 修改服务器连接配置 |
| `POST` | `/deploy/server/delete` | 删除服务器连接配置 |
| `POST` | `/deploy/server/test` | 测试 SSH 连接 |
列表返回字段:
| 字段 | 说明 |
|---|---|
| `id` | 连接 ID |
| `name` | 服务器名称 |
| `host` | 主机地址 |
| `sshPort` | SSH 端口 |
| `username` | 用户名 |
| `description` | 备注 |
| `createdTime` | 创建时间 |
| `updatedTime` | 更新时间 |
新增参数:
| 字段 | 是否必填 |
|---|---|
| `name` | 是 |
| `host` | 是 |
| `sshPort` | 是 |
| `username` | 是 |
| `password` | 是 |
| `description` | 否 |
编辑参数:
| 字段 | 是否必填 | 说明 |
|---|---|---|
| `id` | 是 | 连接 ID |
| `name` | 是 | 服务器名称 |
| `host` | 是 | 主机地址 |
| `sshPort` | 是 | SSH 端口 |
| `username` | 是 | 用户名 |
| `password` | 否 | 为空表示不修改 |
| `description` | 否 | 备注 |
### 7.2 文件接口
| 方法 | 路径 | 说明 |
|---|---|---|
| `POST` | `/deploy/file/list` | 查询远程目录文件列表 |
| `POST` | `/deploy/file/mkdir` | 新建远程目录 |
| `POST` | `/deploy/file/delete` | 删除远程文件或目录 |
| `POST` | `/deploy/file/upload` | 上传本地文件到远程目录 |
| `POST` | `/deploy/file/download` | 下载远程普通文件 |
文件列表参数:
| 字段 | 是否必填 | 说明 |
|---|---|---|
| `serverId` | 是 | 服务器连接 ID |
| `path` | 是 | 远程目录路径 |
文件列表返回字段:
| 字段 | 说明 |
|---|---|
| `name` | 文件名 |
| `path` | 完整路径 |
| `type` | `FILE``DIRECTORY``LINK` |
| `size` | 文件大小 |
| `permissions` | 权限字符串 |
| `modifiedTime` | 修改时间 |
下载接口直接写入 `HttpServletResponse`。下载文件名沿用远程文件名,不追加日期;仓库“导出或生成文件追加日期”的规则适用于后端生成或导出文件,本功能是下载远程已有文件,不改变原文件名。
### 7.3 终端 WebSocket
终端连接:
```text
WebSocket /deploy/terminal?serverId={serverId}
```
前端发送输入:
```json
{
"type": "input",
"data": "ls -la\n"
}
```
前端发送窗口大小:
```json
{
"type": "resize",
"cols": 120,
"rows": 30
}
```
后端输出:
```json
{
"type": "output",
"data": "total 20\r\n..."
}
```
后端状态:
```json
{
"type": "status",
"status": "CONNECTED"
}
```
异常消息:
```json
{
"type": "error",
"message": "SSH连接失败"
}
```
## 8. 参数校验
后端至少补充以下校验:
- 服务器名称不能为空。
- 主机地址不能为空。
- SSH 端口范围为 `1-65535`
- 用户名不能为空。
- 新增连接时密码不能为空。
- 编辑连接时 `id` 必须存在。
- 删除连接时 `id` 必须存在。
- 同一主机、端口、用户名组合不建议重复保存。
- 文件路径不能为空。
- 文件上传目标必须是远程目录。
- 下载目标必须是远程普通文件。
- 删除路径不能为空,不能删除空路径或根目录 `/`
- 新建目录名称不能为空,不能包含路径分隔符。
## 9. 安全与资源控制
安全规则:
- 密码不明文落盘。
- 接口返回不包含密码。
- 日志不打印密码、终端输入内容、文件内容。
- 终端不保存命令历史。
- 文件路径需要做基础规范化,避免空路径、非法路径和目录穿越。
- 下载只允许下载普通文件。
资源规则:
- SSH 连接测试设置连接超时,例如 5 秒。
- SFTP 操作每次请求创建短连接,操作完成后释放。
- 终端会话保持长连接,关闭 WebSocket 后释放 SSH Session 和 Channel。
- 终端会话设置空闲超时,默认 30 分钟。
- 本期每台服务器最多保留一个终端会话。
## 10. 依赖建议
后续实现 SSH/SFTP 时建议优先选择 Java 8 可用、项目易接入的 SSH 客户端库,例如 JSch 或 sshj。
选择标准:
- 支持 SSH 密码登录。
- 支持 SFTP 文件操作。
- 支持 Shell Channel。
- 能在 Spring Boot 2.3 和 Java 8 下稳定使用。
最终依赖需要写入 `system-ops/deploy/pom.xml`,不影响其他模块。
## 11. 错误处理
连接测试需要区分常见错误:
| 场景 | 返回说明 |
|---|---|
| 主机不可达 | 连接服务器失败 |
| 端口不通 | SSH端口连接失败 |
| 账号或密码错误 | SSH认证失败 |
| SFTP 打开失败 | 文件通道打开失败 |
| 终端打开失败 | Shell通道打开失败 |
接口层仍使用项目现有 `HttpResult``CommonResponseEnum` 风格。具体错误文案由 Service 返回给 Controller不新增全局异常体系。
## 12. 验证方式
默认不执行 Maven 编译、打包、测试命令。后续实现完成后按以下方式验证:
- 检查 `deploy` 新增代码只位于 `system-ops/deploy`
- 新增连接后,接口返回和 JSON 文件内容一致。
- 编辑连接时密码留空不会覆盖原密码。
- 删除连接后JSON 文件同步移除对应记录。
- 查询接口不返回密码。
- JSON 文件中密码不是明文。
- 测试连接能识别成功、主机不可达、端口不通、账号密码错误。
- 文件列表能展示远程目录内容。
- 上传文件后远程目录可见。
- 下载普通文件内容与远程文件一致。
- 删除文件或目录后远程路径不存在。
- 新建目录后远程路径存在。
- 终端能打开 Linux Shell执行 `pwd``ls -la``mysql --version` 等基础命令。
- 关闭终端后,后端 SSH 会话被释放。
## 13. 后续扩展
后续如需求增加,可以在当前方案基础上扩展:
- SSH 私钥登录。
- 多终端 Tab。
- 命令审计和历史记录。
- 命令黑名单或审批。
- 部署脚本编排。
- 文件批量上传和批量下载。
- Windows WinRM 或 PowerShell Remoting。
这些能力不进入本期实现,避免当前 `deploy` 模块从基础入口一次扩张为完整运维平台。

View File

@@ -0,0 +1,75 @@
package com.njcn.gather.steady.checksquare.component;
import com.njcn.gather.steady.checksquare.pojo.vo.SteadyChecksquareSegmentVO;
import org.springframework.stereotype.Component;
import java.time.LocalDateTime;
import java.time.format.DateTimeFormatter;
import java.util.ArrayList;
import java.util.List;
import java.util.Set;
/**
* 数据校验连续性计算组件。
*/
@Component
public class SteadyChecksquareCalculator {
public static final String STATUS_NORMAL = "NORMAL";
public static final String STATUS_MISSING = "MISSING";
private static final DateTimeFormatter OUTPUT_TIME_FORMATTER = DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss");
public List<SteadyChecksquareSegmentVO> buildSegments(List<LocalDateTime> slots, Set<LocalDateTime> actualSlots,
int intervalMinutes) {
List<SteadyChecksquareSegmentVO> result = new ArrayList<SteadyChecksquareSegmentVO>();
if (slots == null || slots.isEmpty()) {
return result;
}
String currentStatus = resolveStatus(slots.get(0), actualSlots);
LocalDateTime segmentStart = slots.get(0);
LocalDateTime previousSlot = slots.get(0);
int pointCount = 1;
for (int i = 1; i < slots.size(); i++) {
LocalDateTime slot = slots.get(i);
String status = resolveStatus(slot, actualSlots);
if (!currentStatus.equals(status)) {
result.add(buildSegment(segmentStart, previousSlot, currentStatus, pointCount, intervalMinutes));
segmentStart = slot;
pointCount = 0;
currentStatus = status;
}
previousSlot = slot;
pointCount++;
}
result.add(buildSegment(segmentStart, previousSlot, currentStatus, pointCount, intervalMinutes));
return result;
}
public int maxContinuousMissingMinutes(List<SteadyChecksquareSegmentVO> segments) {
int result = 0;
if (segments == null) {
return result;
}
for (SteadyChecksquareSegmentVO segment : segments) {
if (segment != null && STATUS_MISSING.equals(segment.getStatus()) && segment.getDurationMinutes() != null) {
result = Math.max(result, segment.getDurationMinutes());
}
}
return result;
}
private SteadyChecksquareSegmentVO buildSegment(LocalDateTime startTime, LocalDateTime endTime, String status,
int pointCount, int intervalMinutes) {
SteadyChecksquareSegmentVO segment = new SteadyChecksquareSegmentVO();
segment.setStartTime(OUTPUT_TIME_FORMATTER.format(startTime));
segment.setEndTime(OUTPUT_TIME_FORMATTER.format(endTime));
segment.setStatus(status);
segment.setMissingPointCount(STATUS_MISSING.equals(status) ? pointCount : 0);
segment.setDurationMinutes(pointCount * intervalMinutes);
return segment;
}
private String resolveStatus(LocalDateTime slot, Set<LocalDateTime> actualSlots) {
return actualSlots != null && actualSlots.contains(slot) ? STATUS_NORMAL : STATUS_MISSING;
}
}

View File

@@ -0,0 +1,256 @@
package com.njcn.gather.steady.checksquare.component;
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.njcn.common.pojo.enums.response.CommonResponseEnum;
import com.njcn.common.pojo.exception.BusinessException;
import com.njcn.gather.steady.checksquare.pojo.bo.SteadyChecksquareValuePointBO;
import com.njcn.gather.steady.datavie.config.SteadyInfluxDbProperties;
import com.njcn.gather.steady.datavie.pojo.bo.SteadyTrendResolvedFieldBO;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Component;
import java.math.BigDecimal;
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.net.HttpURLConnection;
import java.net.URLEncoder;
import java.net.URL;
import java.nio.charset.StandardCharsets;
import java.time.LocalDateTime;
import java.time.OffsetDateTime;
import java.time.ZoneOffset;
import java.time.format.DateTimeFormatter;
import java.util.ArrayList;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
/**
* 数据校验 InfluxDB 查询组件。
*/
@Slf4j
@Component
@RequiredArgsConstructor
public class SteadyChecksquareInfluxQueryComponent {
private static final DateTimeFormatter INFLUX_TIME_FORMATTER = DateTimeFormatter.ofPattern("yyyy-MM-dd'T'HH:mm:ss'Z'");
private static final ObjectMapper OBJECT_MAPPER = new ObjectMapper();
private final SteadyInfluxDbProperties properties;
public Set<LocalDateTime> queryExistingSlots(SteadyTrendResolvedFieldBO field, LocalDateTime startTime,
LocalDateTime endTime, int intervalMinutes) {
validateConfig();
String query = buildChecksquareQuery(field, startTime, endTime);
long startMillis = System.currentTimeMillis();
log.info("数据校验 InfluxDB 查询开始measurement={}field={}lineId={}phase={}statType={}query={}",
field.getMeasurement(), field.getField(), field.getLineId(), field.getPhase(), field.getStatType(), query);
try {
String body = executeQuery(query);
Set<LocalDateTime> slots = parseExistingSlots(body, intervalMinutes);
log.info("数据校验 InfluxDB 查询结束slotCount={}costMs={}", slots.size(), System.currentTimeMillis() - startMillis);
return slots;
} catch (RuntimeException ex) {
log.warn("数据校验 InfluxDB 查询异常costMs={}error={}", System.currentTimeMillis() - startMillis, ex.getMessage());
throw ex;
}
}
public List<SteadyChecksquareValuePointBO> queryValuePoints(SteadyTrendResolvedFieldBO field, LocalDateTime startTime,
LocalDateTime endTime, int intervalMinutes) {
validateConfig();
String query = buildValuePointQuery(field, startTime, endTime);
long startMillis = System.currentTimeMillis();
log.info("数据校验指标值 InfluxDB 查询开始measurement={}field={}lineId={}phase={}statType={}query={}",
field.getMeasurement(), field.getField(), field.getLineId(), field.getPhase(), field.getStatType(), query);
try {
String body = executeQuery(query);
List<SteadyChecksquareValuePointBO> points = parseValuePoints(body, intervalMinutes);
log.info("数据校验指标值 InfluxDB 查询结束pointCount={}costMs={}", points.size(), System.currentTimeMillis() - startMillis);
return points;
} catch (RuntimeException ex) {
log.warn("数据校验指标值 InfluxDB 查询异常costMs={}error={}", System.currentTimeMillis() - startMillis, ex.getMessage());
throw ex;
}
}
public String buildChecksquareQuery(SteadyTrendResolvedFieldBO field, LocalDateTime startTime, LocalDateTime endTime) {
return buildValuePointQuery(field, startTime, endTime);
}
public String buildValuePointQuery(SteadyTrendResolvedFieldBO field, LocalDateTime startTime, LocalDateTime endTime) {
StringBuilder sql = new StringBuilder();
sql.append("SELECT \"").append(field.getField()).append("\" AS \"value\"");
sql.append(" FROM \"").append(field.getMeasurement()).append("\"");
sql.append(" WHERE time >= '").append(INFLUX_TIME_FORMATTER.format(startTime)).append("'");
sql.append(" AND time <= '").append(INFLUX_TIME_FORMATTER.format(endTime)).append("'");
sql.append(" AND \"line_id\" = '").append(escapeTagValue(field.getLineId())).append("'");
sql.append(" AND \"phasic_type\" = '").append(escapeTagValue(field.getPhase())).append("'");
if (hasValueTypeTag(field.getMeasurement())) {
sql.append(" AND \"value_type\" = '").append(resolveValueType(field.getStatType())).append("'");
}
sql.append(" ORDER BY time ASC");
return sql.toString();
}
private Set<LocalDateTime> parseExistingSlots(String body, int intervalMinutes) {
try {
JsonNode root = OBJECT_MAPPER.readTree(body);
JsonNode values = root.path("results").path(0).path("series").path(0).path("values");
Set<LocalDateTime> result = new HashSet<LocalDateTime>();
if (!values.isArray()) {
return result;
}
for (JsonNode value : values) {
if (value.size() < 2 || value.get(1).isNull()) {
continue;
}
LocalDateTime time = parseInfluxTime(value.get(0).asText());
if (time != null) {
result.add(alignToPreviousSlot(time, intervalMinutes));
}
}
return result;
} catch (IOException ex) {
throw fail("InfluxDB 返回结果解析失败:" + ex.getMessage());
}
}
private List<SteadyChecksquareValuePointBO> parseValuePoints(String body, int intervalMinutes) {
try {
JsonNode root = OBJECT_MAPPER.readTree(body);
JsonNode values = root.path("results").path(0).path("series").path(0).path("values");
List<SteadyChecksquareValuePointBO> result = new ArrayList<SteadyChecksquareValuePointBO>();
if (!values.isArray()) {
return result;
}
for (JsonNode value : values) {
if (value.size() < 2 || value.get(1).isNull()) {
continue;
}
LocalDateTime time = parseInfluxTime(value.get(0).asText());
if (time == null) {
continue;
}
SteadyChecksquareValuePointBO point = new SteadyChecksquareValuePointBO();
point.setTime(alignToPreviousSlot(time, intervalMinutes));
point.setValue(new BigDecimal(value.get(1).asText()));
result.add(point);
}
return result;
} catch (IOException ex) {
throw fail("InfluxDB 返回结果解析失败:" + ex.getMessage());
} catch (NumberFormatException ex) {
throw fail("InfluxDB 返回指标值格式不正确:" + ex.getMessage());
}
}
private LocalDateTime alignToPreviousSlot(LocalDateTime time, int intervalMinutes) {
LocalDateTime minuteFloor = time.withSecond(0).withNano(0);
int minuteOfDay = minuteFloor.getHour() * 60 + minuteFloor.getMinute();
int remainder = minuteOfDay % intervalMinutes;
return minuteFloor.minusMinutes(remainder);
}
private LocalDateTime parseInfluxTime(String value) {
try {
return OffsetDateTime.parse(value).withOffsetSameInstant(ZoneOffset.UTC).toLocalDateTime();
} catch (RuntimeException ex) {
return null;
}
}
private String executeQuery(String query) {
HttpURLConnection connection = null;
try {
URL url = new URL(buildQueryUrl(query));
connection = (HttpURLConnection) url.openConnection();
connection.setRequestMethod("GET");
connection.setConnectTimeout(properties.getConnectTimeoutMs());
connection.setReadTimeout(properties.getReadTimeoutMs());
int status = connection.getResponseCode();
InputStream stream = status >= 200 && status < 300 ? connection.getInputStream() : connection.getErrorStream();
String body = readBody(stream);
if (status < 200 || status >= 300) {
throw fail("InfluxDB 查询失败:" + body);
}
return body;
} catch (IOException ex) {
throw fail("InfluxDB 查询异常:" + ex.getMessage());
} finally {
if (connection != null) {
connection.disconnect();
}
}
}
private String buildQueryUrl(String query) throws IOException {
StringBuilder url = new StringBuilder(trimRightSlash(properties.getUrl())).append("/query?");
url.append("db=").append(encode(properties.getDatabase()));
if (properties.getUsername() != null && !properties.getUsername().trim().isEmpty()) {
url.append("&u=").append(encode(properties.getUsername().trim()));
}
if (properties.getPassword() != null && !properties.getPassword().trim().isEmpty()) {
url.append("&p=").append(encode(properties.getPassword()));
}
url.append("&q=").append(encode(query));
return url.toString();
}
private void validateConfig() {
if (properties.getUrl() == null || properties.getUrl().trim().isEmpty()) {
throw fail("InfluxDB 地址未配置");
}
if (properties.getDatabase() == null || properties.getDatabase().trim().isEmpty()) {
throw fail("InfluxDB database 未配置");
}
}
private String readBody(InputStream stream) throws IOException {
if (stream == null) {
return "";
}
BufferedReader reader = new BufferedReader(new InputStreamReader(stream, StandardCharsets.UTF_8));
StringBuilder body = new StringBuilder();
String line;
while ((line = reader.readLine()) != null) {
body.append(line);
}
return body.toString();
}
private String escapeTagValue(String value) {
return value == null ? "" : value.replace("\\", "\\\\").replace("'", "\\'");
}
private String resolveValueType(String statType) {
if (statType == null || statType.trim().isEmpty()) {
return "AVG";
}
return statType.trim().toUpperCase();
}
private boolean hasValueTypeTag(String measurement) {
return !"data_flicker".equals(measurement) && !"data_fluc".equals(measurement) && !"data_plt".equals(measurement);
}
private String trimRightSlash(String value) {
String text = value.trim();
while (text.endsWith("/")) {
text = text.substring(0, text.length() - 1);
}
return text;
}
private String encode(String value) throws IOException {
return URLEncoder.encode(value, StandardCharsets.UTF_8.name());
}
private BusinessException fail(String message) {
return new BusinessException(CommonResponseEnum.FAIL, message);
}
}

View File

@@ -0,0 +1,143 @@
package com.njcn.gather.steady.checksquare.component;
import com.njcn.gather.steady.checksquare.pojo.bo.SteadyChecksquareValuePointBO;
import com.njcn.gather.steady.checksquare.pojo.vo.SteadyChecksquareValueOrderDetailVO;
import com.njcn.gather.steady.checksquare.pojo.vo.SteadyChecksquareValueOrderRuleVO;
import com.njcn.gather.steady.datavie.pojo.bo.SteadyTrendIndicatorDefinitionBO;
import com.njcn.gather.steady.datavie.pojo.bo.SteadyTrendResolvedFieldBO;
import com.njcn.gather.steady.datavie.pojo.bo.SteadyTrendSeriesFieldBO;
import lombok.RequiredArgsConstructor;
import org.springframework.stereotype.Component;
import java.math.BigDecimal;
import java.time.LocalDateTime;
import java.time.format.DateTimeFormatter;
import java.util.Arrays;
import java.util.Collections;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
/**
* 数据校验指标值大小关系规则。
*/
@Component
@RequiredArgsConstructor
public class SteadyChecksquareValueOrderRuleComponent {
private static final DateTimeFormatter OUTPUT_TIME_FORMATTER = DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss");
private static final List<String> REQUIRED_STATS = Collections.unmodifiableList(Arrays.asList("MAX", "CP95", "AVG", "MIN"));
private static final int ABNORMAL_THRESHOLD = 1;
private final SteadyChecksquareInfluxQueryComponent influxQueryComponent;
public SteadyChecksquareValueOrderRuleVO check(String lineId, SteadyTrendIndicatorDefinitionBO indicator,
Integer harmonicOrder, LocalDateTime startTime,
LocalDateTime endTime, int intervalMinutes) {
SteadyChecksquareValueOrderRuleVO result = new SteadyChecksquareValueOrderRuleVO();
if (!supportValueOrderRule(indicator)) {
return result;
}
for (String phase : indicator.getPhaseCodes()) {
Map<String, Map<LocalDateTime, BigDecimal>> statValueMap = queryStatValueMap(lineId, indicator,
harmonicOrder, phase, startTime, endTime, intervalMinutes);
appendAbnormalDetails(result, phase, statValueMap);
}
result.setAbnormalPointCount(result.getAbnormalDetails().size());
result.setAbnormal(result.getAbnormalPointCount() > ABNORMAL_THRESHOLD);
return result;
}
private boolean supportValueOrderRule(SteadyTrendIndicatorDefinitionBO indicator) {
return indicator != null && indicator.getSupportStats() != null && indicator.getSupportStats().containsAll(REQUIRED_STATS);
}
private Map<String, Map<LocalDateTime, BigDecimal>> queryStatValueMap(String lineId,
SteadyTrendIndicatorDefinitionBO indicator,
Integer harmonicOrder, String phase,
LocalDateTime startTime, LocalDateTime endTime,
int intervalMinutes) {
Map<String, Map<LocalDateTime, BigDecimal>> result = new LinkedHashMap<String, Map<LocalDateTime, BigDecimal>>();
for (String statType : REQUIRED_STATS) {
SteadyTrendResolvedFieldBO field = buildResolvedField(lineId, indicator, harmonicOrder, phase, statType);
result.put(statType, toValueMap(influxQueryComponent.queryValuePoints(field, startTime, endTime, intervalMinutes)));
}
return result;
}
private void appendAbnormalDetails(SteadyChecksquareValueOrderRuleVO result, String phase,
Map<String, Map<LocalDateTime, BigDecimal>> statValueMap) {
Map<LocalDateTime, BigDecimal> maxValues = statValueMap.get("MAX");
Map<LocalDateTime, BigDecimal> cp95Values = statValueMap.get("CP95");
Map<LocalDateTime, BigDecimal> avgValues = statValueMap.get("AVG");
Map<LocalDateTime, BigDecimal> minValues = statValueMap.get("MIN");
if (maxValues == null || cp95Values == null || avgValues == null || minValues == null) {
return;
}
for (Map.Entry<LocalDateTime, BigDecimal> entry : maxValues.entrySet()) {
LocalDateTime time = entry.getKey();
BigDecimal maxValue = entry.getValue();
BigDecimal cp95Value = cp95Values.get(time);
BigDecimal avgValue = avgValues.get(time);
BigDecimal minValue = minValues.get(time);
// 缺少任一统计值时由缺数校验负责,不重复计入大小关系异常。
if (maxValue == null || cp95Value == null || avgValue == null || minValue == null) {
continue;
}
if (maxValue.compareTo(cp95Value) > 0 && cp95Value.compareTo(avgValue) > 0 && avgValue.compareTo(minValue) > 0) {
continue;
}
result.getAbnormalDetails().add(buildDetail(time, phase, maxValue, minValue, avgValue, cp95Value));
}
}
private SteadyChecksquareValueOrderDetailVO buildDetail(LocalDateTime time, String phase, BigDecimal maxValue,
BigDecimal minValue, BigDecimal avgValue, BigDecimal cp95Value) {
SteadyChecksquareValueOrderDetailVO detail = new SteadyChecksquareValueOrderDetailVO();
detail.setTime(OUTPUT_TIME_FORMATTER.format(time));
detail.setPhase(phase);
detail.setMaxValue(maxValue);
detail.setMinValue(minValue);
detail.setAvgValue(avgValue);
detail.setCp95Value(cp95Value);
return detail;
}
private Map<LocalDateTime, BigDecimal> toValueMap(List<SteadyChecksquareValuePointBO> points) {
Map<LocalDateTime, BigDecimal> result = new LinkedHashMap<LocalDateTime, BigDecimal>();
if (points == null || points.isEmpty()) {
return result;
}
for (SteadyChecksquareValuePointBO point : points) {
if (point != null && point.getTime() != null && point.getValue() != null) {
result.put(point.getTime(), point.getValue());
}
}
return result;
}
private SteadyTrendResolvedFieldBO buildResolvedField(String lineId, SteadyTrendIndicatorDefinitionBO indicator,
Integer harmonicOrder, String phase, String statType) {
SteadyTrendResolvedFieldBO field = new SteadyTrendResolvedFieldBO();
field.setMeasurement(indicator.getTableName());
field.setField(resolveField(indicator, harmonicOrder));
field.setLineId(lineId);
field.setIndicatorCode(indicator.getIndicatorCode());
field.setIndicatorName(indicator.getName());
field.setPhase(phase);
field.setStatType(statType);
field.setUnit(indicator.getUnit());
return field;
}
private String resolveField(SteadyTrendIndicatorDefinitionBO indicator, Integer harmonicOrder) {
if (Boolean.TRUE.equals(indicator.getHarmonic())) {
return indicator.getHarmonicFieldPrefix() + "_" + harmonicOrder;
}
List<SteadyTrendSeriesFieldBO> fields = indicator.getSeriesFields();
if (fields == null || fields.isEmpty()) {
return "";
}
return fields.get(0).getField();
}
}

View File

@@ -0,0 +1,43 @@
package com.njcn.gather.steady.checksquare.controller;
import com.njcn.common.pojo.annotation.OperateInfo;
import com.njcn.common.pojo.enums.common.LogEnum;
import com.njcn.common.pojo.enums.response.CommonResponseEnum;
import com.njcn.common.pojo.response.HttpResult;
import com.njcn.common.utils.LogUtil;
import com.njcn.gather.steady.checksquare.pojo.param.SteadyChecksquareQueryParam;
import com.njcn.gather.steady.checksquare.pojo.vo.SteadyChecksquareQueryVO;
import com.njcn.gather.steady.checksquare.service.SteadyChecksquareService;
import com.njcn.web.controller.BaseController;
import com.njcn.web.utils.HttpResultUtil;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
/**
* 数据校验接口。
*/
@Slf4j
@Api(tags = "数据校验")
@RestController
@RequestMapping("/steady/data-view/checksquare")
@RequiredArgsConstructor
public class SteadyChecksquareController extends BaseController {
private final SteadyChecksquareService checksquareService;
@OperateInfo(info = LogEnum.BUSINESS_COMMON)
@ApiOperation("查询数据校验结果")
@PostMapping("/query")
public HttpResult<SteadyChecksquareQueryVO> query(@RequestBody SteadyChecksquareQueryParam param) {
String methodDescribe = getMethodDescribe("query");
LogUtil.njcnDebug(log, "{}开始查询数据校验结果param={}", methodDescribe, param);
SteadyChecksquareQueryVO result = checksquareService.query(param);
return HttpResultUtil.assembleCommonResponseResult(CommonResponseEnum.SUCCESS, result, methodDescribe);
}
}

View File

@@ -0,0 +1,22 @@
package com.njcn.gather.steady.checksquare.pojo.bo;
import lombok.Data;
import java.io.Serializable;
import java.math.BigDecimal;
import java.time.LocalDateTime;
/**
* 数据校验指标值时间点。
*/
@Data
public class SteadyChecksquareValuePointBO implements Serializable {
private static final long serialVersionUID = 1L;
/** 对齐后的统计时间。 */
private LocalDateTime time;
/** 指标值。 */
private BigDecimal value;
}

View File

@@ -0,0 +1,33 @@
package com.njcn.gather.steady.checksquare.pojo.param;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;
import java.io.Serializable;
import java.util.List;
/**
* 数据校验查询参数。
*/
@Data
@ApiModel("数据校验查询参数")
public class SteadyChecksquareQueryParam implements Serializable {
private static final long serialVersionUID = 1L;
@ApiModelProperty("监测点 ID")
private String lineId;
@ApiModelProperty("指标编码")
private List<String> indicatorCodes;
@ApiModelProperty("开始时间,格式 yyyy-MM-dd HH:mm:ss")
private String timeStart;
@ApiModelProperty("结束时间,格式 yyyy-MM-dd HH:mm:ss")
private String timeEnd;
@ApiModelProperty("谐波次数,谐波指标按请求次数查询")
private List<Integer> harmonicOrders;
}

View File

@@ -0,0 +1,71 @@
package com.njcn.gather.steady.checksquare.pojo.vo;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;
import java.io.Serializable;
import java.math.BigDecimal;
import java.util.ArrayList;
import java.util.List;
/**
* 数据校验总览项。
*/
@Data
@ApiModel("数据校验总览项")
public class SteadyChecksquareItemVO implements Serializable {
private static final long serialVersionUID = 1L;
@ApiModelProperty("校验项唯一键")
private String itemKey;
@ApiModelProperty("指标编码")
private String indicatorCode;
@ApiModelProperty("指标名称")
private String indicatorName;
@ApiModelProperty("谐波次数")
private Integer harmonicOrder;
@ApiModelProperty("当前校验项统计间隔,单位分钟")
private Integer intervalMinutes;
@ApiModelProperty("时间范围内是否存在任意数据")
private Boolean hasData;
@ApiModelProperty("期望点数")
private Integer expectedPointCount;
@ApiModelProperty("实际点数")
private Integer actualPointCount;
@ApiModelProperty("缺失点数")
private Integer missingPointCount;
@ApiModelProperty("缺失率")
private BigDecimal missingRate;
@ApiModelProperty("缺失率文本")
private String missingRateText;
@ApiModelProperty("最大连续缺失时长,单位分钟")
private Integer maxContinuousMissingMinutes;
@ApiModelProperty("指标值大小关系是否异常")
private Boolean abnormal;
@ApiModelProperty("指标值大小关系异常累计值")
private Integer abnormalPointCount;
@ApiModelProperty("指标值大小关系异常明细")
private List<SteadyChecksquareValueOrderDetailVO> abnormalDetails = new ArrayList<SteadyChecksquareValueOrderDetailVO>();
@ApiModelProperty("统计类型摘要")
private List<SteadyChecksquareStatSummaryVO> statSummaries = new ArrayList<SteadyChecksquareStatSummaryVO>();
@ApiModelProperty("统计类型明细")
private List<SteadyChecksquareStatDetailVO> statDetails = new ArrayList<SteadyChecksquareStatDetailVO>();
}

View File

@@ -0,0 +1,37 @@
package com.njcn.gather.steady.checksquare.pojo.vo;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.List;
/**
* 数据校验查询结果。
*/
@Data
@ApiModel("数据校验查询结果")
public class SteadyChecksquareQueryVO implements Serializable {
private static final long serialVersionUID = 1L;
@ApiModelProperty("监测点 ID")
private String lineId;
@ApiModelProperty("监测点名称")
private String lineName;
@ApiModelProperty("开始时间")
private String timeStart;
@ApiModelProperty("结束时间")
private String timeEnd;
@ApiModelProperty("统计间隔,单位分钟")
private Integer intervalMinutes;
@ApiModelProperty("校验项")
private List<SteadyChecksquareItemVO> items = new ArrayList<SteadyChecksquareItemVO>();
}

View File

@@ -0,0 +1,32 @@
package com.njcn.gather.steady.checksquare.pojo.vo;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;
import java.io.Serializable;
/**
* 数据校验连续性区间。
*/
@Data
@ApiModel("数据校验连续性区间")
public class SteadyChecksquareSegmentVO implements Serializable {
private static final long serialVersionUID = 1L;
@ApiModelProperty("开始时间")
private String startTime;
@ApiModelProperty("结束时间")
private String endTime;
@ApiModelProperty("状态NORMAL/MISSING")
private String status;
@ApiModelProperty("缺失点数")
private Integer missingPointCount;
@ApiModelProperty("持续时长,单位分钟")
private Integer durationMinutes;
}

View File

@@ -0,0 +1,28 @@
package com.njcn.gather.steady.checksquare.pojo.vo;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.List;
/**
* 数据校验统计类型明细。
*/
@Data
@ApiModel("数据校验统计类型明细")
public class SteadyChecksquareStatDetailVO implements Serializable {
private static final long serialVersionUID = 1L;
@ApiModelProperty("统计类型")
private String statType;
@ApiModelProperty("是否支持")
private Boolean supported;
@ApiModelProperty("连续性区间")
private List<SteadyChecksquareSegmentVO> segments = new ArrayList<SteadyChecksquareSegmentVO>();
}

View File

@@ -0,0 +1,45 @@
package com.njcn.gather.steady.checksquare.pojo.vo;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;
import java.io.Serializable;
import java.math.BigDecimal;
/**
* 数据校验统计类型摘要。
*/
@Data
@ApiModel("数据校验统计类型摘要")
public class SteadyChecksquareStatSummaryVO implements Serializable {
private static final long serialVersionUID = 1L;
@ApiModelProperty("统计类型")
private String statType;
@ApiModelProperty("是否支持")
private Boolean supported;
@ApiModelProperty("是否存在数据")
private Boolean hasData;
@ApiModelProperty("期望点数")
private Integer expectedPointCount;
@ApiModelProperty("实际点数")
private Integer actualPointCount;
@ApiModelProperty("缺失点数")
private Integer missingPointCount;
@ApiModelProperty("缺失率")
private BigDecimal missingRate;
@ApiModelProperty("缺失率文本")
private String missingRateText;
@ApiModelProperty("最大连续缺失时长,单位分钟")
private Integer maxContinuousMissingMinutes;
}

View File

@@ -0,0 +1,36 @@
package com.njcn.gather.steady.checksquare.pojo.vo;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;
import java.io.Serializable;
import java.math.BigDecimal;
/**
* 数据校验指标值大小关系异常明细。
*/
@Data
@ApiModel("数据校验指标值大小关系异常明细")
public class SteadyChecksquareValueOrderDetailVO implements Serializable {
private static final long serialVersionUID = 1L;
@ApiModelProperty("时间")
private String time;
@ApiModelProperty("相别")
private String phase;
@ApiModelProperty("最大值")
private BigDecimal maxValue;
@ApiModelProperty("最小值")
private BigDecimal minValue;
@ApiModelProperty("平均值")
private BigDecimal avgValue;
@ApiModelProperty("CP95 值")
private BigDecimal cp95Value;
}

View File

@@ -0,0 +1,22 @@
package com.njcn.gather.steady.checksquare.pojo.vo;
import lombok.Data;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.List;
/**
* 数据校验指标值大小关系规则结果。
*/
@Data
public class SteadyChecksquareValueOrderRuleVO implements Serializable {
private static final long serialVersionUID = 1L;
private Boolean abnormal = false;
private Integer abnormalPointCount = 0;
private List<SteadyChecksquareValueOrderDetailVO> abnormalDetails = new ArrayList<SteadyChecksquareValueOrderDetailVO>();
}

View File

@@ -0,0 +1,12 @@
package com.njcn.gather.steady.checksquare.service;
import com.njcn.gather.steady.checksquare.pojo.param.SteadyChecksquareQueryParam;
import com.njcn.gather.steady.checksquare.pojo.vo.SteadyChecksquareQueryVO;
/**
* 数据校验服务。
*/
public interface SteadyChecksquareService {
SteadyChecksquareQueryVO query(SteadyChecksquareQueryParam param);
}

View File

@@ -0,0 +1,363 @@
package com.njcn.gather.steady.checksquare.service.impl;
import com.njcn.common.pojo.enums.response.CommonResponseEnum;
import com.njcn.common.pojo.exception.BusinessException;
import com.njcn.gather.steady.checksquare.component.SteadyChecksquareCalculator;
import com.njcn.gather.steady.checksquare.component.SteadyChecksquareInfluxQueryComponent;
import com.njcn.gather.steady.checksquare.component.SteadyChecksquareValueOrderRuleComponent;
import com.njcn.gather.steady.checksquare.pojo.param.SteadyChecksquareQueryParam;
import com.njcn.gather.steady.checksquare.pojo.vo.SteadyChecksquareItemVO;
import com.njcn.gather.steady.checksquare.pojo.vo.SteadyChecksquareQueryVO;
import com.njcn.gather.steady.checksquare.pojo.vo.SteadyChecksquareSegmentVO;
import com.njcn.gather.steady.checksquare.pojo.vo.SteadyChecksquareStatDetailVO;
import com.njcn.gather.steady.checksquare.pojo.vo.SteadyChecksquareStatSummaryVO;
import com.njcn.gather.steady.checksquare.pojo.vo.SteadyChecksquareValueOrderRuleVO;
import com.njcn.gather.steady.checksquare.service.SteadyChecksquareService;
import com.njcn.gather.steady.datavie.component.SteadyTrendIndicatorCatalog;
import com.njcn.gather.steady.datavie.pojo.bo.SteadyTrendIndicatorDefinitionBO;
import com.njcn.gather.steady.datavie.pojo.bo.SteadyTrendResolvedFieldBO;
import com.njcn.gather.steady.datavie.pojo.bo.SteadyTrendSeriesFieldBO;
import com.njcn.gather.tool.adddata.component.AddDataTimeSlotCalculator;
import com.njcn.gather.tool.addledger.pojo.constant.AddLedgerConst;
import com.njcn.gather.tool.addledger.pojo.vo.AddLedgerLinePathVO;
import com.njcn.gather.tool.addledger.service.AddLedgerService;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Service;
import java.math.BigDecimal;
import java.math.RoundingMode;
import java.time.LocalDateTime;
import java.time.format.DateTimeFormatter;
import java.time.format.DateTimeParseException;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashSet;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
/**
* 数据校验服务实现。
*/
@Slf4j
@Service
@RequiredArgsConstructor
public class SteadyChecksquareServiceImpl implements SteadyChecksquareService {
private static final DateTimeFormatter TIME_FORMATTER = DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss");
private static final String EMPTY_TEXT = "-";
private static final int FLICKER_SHORT_INTERVAL_MINUTES = 10;
private static final int FLICKER_LONG_INTERVAL_MINUTES = 120;
private final SteadyTrendIndicatorCatalog indicatorCatalog;
private final SteadyChecksquareInfluxQueryComponent influxQueryComponent;
private final SteadyChecksquareCalculator calculator;
private final SteadyChecksquareValueOrderRuleComponent valueOrderRuleComponent;
private final AddDataTimeSlotCalculator timeSlotCalculator;
private final AddLedgerService addLedgerService;
@Override
public SteadyChecksquareQueryVO query(SteadyChecksquareQueryParam param) {
validateParam(param);
String lineId = trimToNull(param.getLineId());
LocalDateTime startTime = parseRequiredTime(param.getTimeStart(), "开始时间不能为空");
LocalDateTime endTime = parseRequiredTime(param.getTimeEnd(), "结束时间不能为空");
if (startTime.isAfter(endTime)) {
throw fail("开始时间不能大于结束时间");
}
AddLedgerLinePathVO linePath = requireLinePath(lineId);
int intervalMinutes = resolveIntervalMinutes(linePath);
SteadyChecksquareQueryVO result = new SteadyChecksquareQueryVO();
result.setLineId(lineId);
result.setLineName(trimToNull(linePath.getLineName()) == null ? EMPTY_TEXT : linePath.getLineName());
result.setTimeStart(param.getTimeStart());
result.setTimeEnd(param.getTimeEnd());
result.setIntervalMinutes(intervalMinutes);
long startMillis = System.currentTimeMillis();
List<String> indicatorCodes = normalizeTextList(param.getIndicatorCodes());
List<Integer> harmonicOrders = normalizeHarmonicOrders(param.getHarmonicOrders());
log.info("数据校验查询开始lineId={}indicatorCount={}timeStart={}timeEnd={}intervalMinutes={}",
lineId, indicatorCodes.size(), startTime, endTime, intervalMinutes);
for (String indicatorCode : indicatorCodes) {
SteadyTrendIndicatorDefinitionBO indicator = requireIndicator(indicatorCode);
int itemIntervalMinutes = resolveIndicatorIntervalMinutes(indicator, intervalMinutes);
List<LocalDateTime> itemSlots = timeSlotCalculator.buildTimeSlots(startTime, endTime, itemIntervalMinutes);
result.getItems().addAll(buildIndicatorItems(lineId, indicator, harmonicOrders, startTime, endTime, itemSlots, itemIntervalMinutes));
}
log.info("数据校验查询结束lineId={}itemCount={}costMs={}", lineId, result.getItems().size(), System.currentTimeMillis() - startMillis);
return result;
}
private List<SteadyChecksquareItemVO> buildIndicatorItems(String lineId, SteadyTrendIndicatorDefinitionBO indicator,
List<Integer> harmonicOrders,
LocalDateTime startTime, LocalDateTime endTime,
List<LocalDateTime> slots, int intervalMinutes) {
List<SteadyChecksquareItemVO> result = new ArrayList<SteadyChecksquareItemVO>();
if (Boolean.TRUE.equals(indicator.getHarmonic())) {
for (Integer order : requireValidHarmonicOrders(indicator, harmonicOrders)) {
result.add(buildItem(lineId, indicator, order, startTime, endTime, slots, intervalMinutes));
}
return result;
}
result.add(buildItem(lineId, indicator, null, startTime, endTime, slots, intervalMinutes));
return result;
}
private SteadyChecksquareItemVO buildItem(String lineId, SteadyTrendIndicatorDefinitionBO indicator, Integer harmonicOrder,
LocalDateTime startTime, LocalDateTime endTime,
List<LocalDateTime> slots, int intervalMinutes) {
SteadyChecksquareItemVO item = new SteadyChecksquareItemVO();
item.setItemKey(buildItemKey(lineId, indicator, harmonicOrder));
item.setIndicatorCode(indicator.getIndicatorCode());
item.setIndicatorName(indicator.getName());
item.setHarmonicOrder(harmonicOrder);
item.setIntervalMinutes(intervalMinutes);
int totalExpected = 0;
int totalActual = 0;
int maxContinuousMissingMinutes = 0;
boolean hasData = false;
for (String statType : indicator.getSupportStats()) {
Set<LocalDateTime> actualSlots = queryMergedActualSlots(lineId, indicator, harmonicOrder, statType, startTime, endTime, intervalMinutes);
Set<LocalDateTime> effectiveActualSlots = retainExpectedSlots(slots, actualSlots);
List<SteadyChecksquareSegmentVO> segments = calculator.buildSegments(slots, effectiveActualSlots, intervalMinutes);
SteadyChecksquareStatSummaryVO summary = buildSummary(statType, slots.size(), effectiveActualSlots.size(), segments);
SteadyChecksquareStatDetailVO detail = buildDetail(statType, segments);
item.getStatSummaries().add(summary);
item.getStatDetails().add(detail);
totalExpected += summary.getExpectedPointCount();
totalActual += summary.getActualPointCount();
maxContinuousMissingMinutes = Math.max(maxContinuousMissingMinutes, summary.getMaxContinuousMissingMinutes());
hasData = hasData || Boolean.TRUE.equals(summary.getHasData());
}
item.setHasData(hasData);
item.setExpectedPointCount(totalExpected);
item.setActualPointCount(totalActual);
item.setMissingPointCount(Math.max(0, totalExpected - totalActual));
item.setMissingRate(calculateRate(item.getMissingPointCount(), totalExpected));
item.setMissingRateText(formatRateText(item.getMissingRate()));
item.setMaxContinuousMissingMinutes(maxContinuousMissingMinutes);
fillValueOrderRuleResult(item, lineId, indicator, harmonicOrder, startTime, endTime, intervalMinutes);
return item;
}
private void fillValueOrderRuleResult(SteadyChecksquareItemVO item, String lineId, SteadyTrendIndicatorDefinitionBO indicator,
Integer harmonicOrder, LocalDateTime startTime, LocalDateTime endTime,
int intervalMinutes) {
SteadyChecksquareValueOrderRuleVO ruleResult = valueOrderRuleComponent.check(lineId, indicator, harmonicOrder,
startTime, endTime, intervalMinutes);
item.setAbnormal(ruleResult.getAbnormal());
item.setAbnormalPointCount(ruleResult.getAbnormalPointCount());
item.setAbnormalDetails(ruleResult.getAbnormalDetails());
}
private Set<LocalDateTime> queryMergedActualSlots(String lineId, SteadyTrendIndicatorDefinitionBO indicator, Integer harmonicOrder,
String statType, LocalDateTime startTime, LocalDateTime endTime,
int intervalMinutes) {
Set<LocalDateTime> result = new HashSet<LocalDateTime>();
for (String phase : indicator.getPhaseCodes()) {
SteadyTrendResolvedFieldBO field = buildResolvedField(lineId, indicator, harmonicOrder, phase, statType);
result.addAll(influxQueryComponent.queryExistingSlots(field, startTime, endTime, intervalMinutes));
}
return result;
}
private Set<LocalDateTime> retainExpectedSlots(List<LocalDateTime> slots, Set<LocalDateTime> actualSlots) {
Set<LocalDateTime> result = new HashSet<LocalDateTime>();
if (slots == null || actualSlots == null || actualSlots.isEmpty()) {
return result;
}
for (LocalDateTime slot : slots) {
if (actualSlots.contains(slot)) {
result.add(slot);
}
}
return result;
}
private SteadyTrendResolvedFieldBO buildResolvedField(String lineId, SteadyTrendIndicatorDefinitionBO indicator,
Integer harmonicOrder, String phase, String statType) {
SteadyTrendResolvedFieldBO field = new SteadyTrendResolvedFieldBO();
field.setMeasurement(indicator.getTableName());
field.setField(resolveField(indicator, harmonicOrder));
field.setLineId(lineId);
field.setIndicatorCode(indicator.getIndicatorCode());
field.setIndicatorName(indicator.getName());
field.setPhase(phase);
field.setStatType(statType);
field.setUnit(indicator.getUnit());
return field;
}
private String resolveField(SteadyTrendIndicatorDefinitionBO indicator, Integer harmonicOrder) {
if (Boolean.TRUE.equals(indicator.getHarmonic())) {
return indicator.getHarmonicFieldPrefix() + "_" + harmonicOrder;
}
List<SteadyTrendSeriesFieldBO> fields = indicator.getSeriesFields();
if (fields == null || fields.isEmpty()) {
throw fail("稳态指标不支持:" + indicator.getIndicatorCode());
}
return fields.get(0).getField();
}
private SteadyChecksquareStatSummaryVO buildSummary(String statType, int expectedCount, int actualCount,
List<SteadyChecksquareSegmentVO> segments) {
SteadyChecksquareStatSummaryVO summary = new SteadyChecksquareStatSummaryVO();
summary.setStatType(statType);
summary.setSupported(true);
summary.setHasData(actualCount > 0);
summary.setExpectedPointCount(expectedCount);
summary.setActualPointCount(actualCount);
summary.setMissingPointCount(Math.max(0, expectedCount - actualCount));
summary.setMissingRate(calculateRate(summary.getMissingPointCount(), expectedCount));
summary.setMissingRateText(formatRateText(summary.getMissingRate()));
summary.setMaxContinuousMissingMinutes(calculator.maxContinuousMissingMinutes(segments));
return summary;
}
private SteadyChecksquareStatDetailVO buildDetail(String statType, List<SteadyChecksquareSegmentVO> segments) {
SteadyChecksquareStatDetailVO detail = new SteadyChecksquareStatDetailVO();
detail.setStatType(statType);
detail.setSupported(true);
detail.setSegments(segments);
return detail;
}
private String buildItemKey(String lineId, SteadyTrendIndicatorDefinitionBO indicator, Integer harmonicOrder) {
if (harmonicOrder == null) {
return lineId + "|" + indicator.getIndicatorCode();
}
return lineId + "|" + indicator.getIndicatorCode() + "|" + harmonicOrder;
}
private void validateParam(SteadyChecksquareQueryParam param) {
if (param == null) {
throw fail("数据校验参数不能为空");
}
if (trimToNull(param.getLineId()) == null) {
throw fail("监测点 ID 不能为空");
}
if (normalizeTextList(param.getIndicatorCodes()).isEmpty()) {
throw fail("指标不能为空");
}
parseRequiredTime(param.getTimeStart(), "开始时间不能为空");
parseRequiredTime(param.getTimeEnd(), "结束时间不能为空");
}
private LocalDateTime parseRequiredTime(String time, String emptyMessage) {
String text = trimToNull(time);
if (text == null) {
throw fail(emptyMessage);
}
try {
return LocalDateTime.parse(text, TIME_FORMATTER);
} catch (DateTimeParseException ex) {
throw fail("时间格式不正确,仅支持 yyyy-MM-dd HH:mm:ss");
}
}
private AddLedgerLinePathVO requireLinePath(String lineId) {
Map<String, AddLedgerLinePathVO> linePathMap = addLedgerService.listLinePathByLineIds(Collections.singletonList(lineId));
AddLedgerLinePathVO linePath = linePathMap.get(lineId);
if (linePath == null) {
throw fail("监测点不存在或不可用");
}
return linePath;
}
private int resolveIntervalMinutes(AddLedgerLinePathVO linePath) {
Integer interval = linePath.getLineInterval();
if (interval == null || interval <= 0) {
return AddLedgerConst.LINE_INTERVAL_DEFAULT;
}
return interval;
}
private int resolveIndicatorIntervalMinutes(SteadyTrendIndicatorDefinitionBO indicator, int lineIntervalMinutes) {
String indicatorCode = indicator == null ? null : indicator.getIndicatorCode();
if ("FLUC".equals(indicatorCode) || "PST".equals(indicatorCode)) {
return FLICKER_SHORT_INTERVAL_MINUTES;
}
if ("PLT".equals(indicatorCode)) {
return FLICKER_LONG_INTERVAL_MINUTES;
}
return lineIntervalMinutes;
}
private SteadyTrendIndicatorDefinitionBO requireIndicator(String indicatorCode) {
SteadyTrendIndicatorDefinitionBO indicator = indicatorCatalog.getIndicator(indicatorCode);
if (indicator == null) {
throw fail("稳态指标不支持:" + indicatorCode);
}
return indicator;
}
private BigDecimal calculateRate(int missingCount, int expectedCount) {
if (expectedCount <= 0) {
return BigDecimal.ZERO.setScale(6, RoundingMode.HALF_UP);
}
return new BigDecimal(missingCount).divide(new BigDecimal(expectedCount), 6, RoundingMode.HALF_UP);
}
private String formatRateText(BigDecimal rate) {
if (rate == null) {
return null;
}
return rate.multiply(new BigDecimal("100")).setScale(2, RoundingMode.HALF_UP).toPlainString() + "%";
}
private List<String> normalizeTextList(List<String> values) {
if (values == null || values.isEmpty()) {
return new ArrayList<String>();
}
Set<String> result = new LinkedHashSet<String>();
for (String value : values) {
String text = trimToNull(value);
if (text != null) {
result.add(text);
}
}
return new ArrayList<String>(result);
}
private List<Integer> normalizeHarmonicOrders(List<Integer> values) {
if (values == null || values.isEmpty()) {
return new ArrayList<Integer>();
}
List<Integer> result = new ArrayList<Integer>();
for (Integer value : values) {
if (value != null && !result.contains(value)) {
result.add(value);
}
}
return result;
}
private List<Integer> requireValidHarmonicOrders(SteadyTrendIndicatorDefinitionBO indicator, List<Integer> harmonicOrders) {
if (harmonicOrders == null || harmonicOrders.isEmpty()) {
throw fail("谐波次数不能为空");
}
for (Integer order : harmonicOrders) {
if (order < indicator.getHarmonicOrderStart() || order > indicator.getHarmonicOrderEnd()) {
throw fail("谐波次数只能在 " + indicator.getHarmonicOrderStart() + "" + indicator.getHarmonicOrderEnd() + " 之间");
}
}
return harmonicOrders;
}
private String trimToNull(String value) {
if (value == null) {
return null;
}
String trimmed = value.trim();
return trimmed.isEmpty() ? null : trimmed;
}
private BusinessException fail(String message) {
return new BusinessException(CommonResponseEnum.FAIL, message);
}
}

View File

@@ -8,6 +8,7 @@ import com.njcn.gather.steady.datavie.config.SteadyInfluxDbProperties;
import com.njcn.gather.steady.datavie.pojo.bo.SteadyTrendResolvedFieldBO;
import com.njcn.gather.steady.datavie.pojo.vo.SteadyTrendPointVO;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Component;
import java.io.BufferedReader;
@@ -29,6 +30,7 @@ import java.util.List;
/**
* 稳态趋势 InfluxDB 查询组件。
*/
@Slf4j
@Component
@RequiredArgsConstructor
public class SteadyInfluxQueryComponent {
@@ -43,8 +45,32 @@ public class SteadyInfluxQueryComponent {
LocalDateTime endTime, Integer qualityFlag) {
validateConfig();
String query = buildTrendQuery(field, startTime, endTime, qualityFlag);
String body = executeQuery(query);
return parseTrendPoints(body);
String diagnostic = buildTrendQueryDiagnostic(field, startTime, endTime, qualityFlag);
long startMillis = System.currentTimeMillis();
log.info("稳态趋势 InfluxDB 查询开始,{}query={}", diagnostic, query);
try {
String body = executeQuery(query);
List<SteadyTrendPointVO> points = parseTrendPoints(body);
log.info("稳态趋势 InfluxDB 查询结束,{}pointCount={}costMs={}", diagnostic, points.size(), System.currentTimeMillis() - startMillis);
return points;
} catch (RuntimeException ex) {
log.warn("稳态趋势 InfluxDB 查询异常,{}costMs={}error={}", diagnostic, System.currentTimeMillis() - startMillis, ex.getMessage());
throw ex;
}
}
String buildTrendQueryDiagnostic(SteadyTrendResolvedFieldBO field, LocalDateTime startTime, LocalDateTime endTime,
Integer qualityFlag) {
StringBuilder diagnostic = new StringBuilder();
diagnostic.append("measurement=").append(field.getMeasurement());
diagnostic.append(", field=").append(field.getField());
diagnostic.append(", lineId=").append(field.getLineId());
diagnostic.append(", phase=").append(field.getPhase());
diagnostic.append(", statType=").append(resolveValueType(field.getStatType()));
diagnostic.append(", qualityFlag=").append(qualityFlag);
diagnostic.append(", timeStart=").append(startTime);
diagnostic.append(", timeEnd=").append(endTime);
return diagnostic.toString();
}
public String buildTrendQuery(SteadyTrendResolvedFieldBO field, LocalDateTime startTime, LocalDateTime endTime,

View File

@@ -26,7 +26,7 @@ public class SteadyTrendFieldResolver {
private static final int MAX_LINE_COUNT = 8;
private static final int MAX_INDICATOR_COUNT = 8;
private static final int MAX_SERIES_COUNT = 24;
private static final int MAX_HARMONIC_ORDER_COUNT = 6;
private static final int MAX_HARMONIC_ORDER_COUNT = 3;
private static final DateTimeFormatter TIME_FORMATTER = DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss");
private final SteadyTrendIndicatorCatalog indicatorCatalog;
@@ -89,7 +89,7 @@ public class SteadyTrendFieldResolver {
throw fail("谐波次数不能为空");
}
if (orders.size() > MAX_HARMONIC_ORDER_COUNT) {
throw fail("谐波次数最多选择 6 ");
throw fail("谐波次数不允许一次展示超过3");
}
List<SteadyTrendResolvedFieldBO> result = new ArrayList<SteadyTrendResolvedFieldBO>();
for (Integer order : orders) {

View File

@@ -32,6 +32,6 @@ public class SteadyTrendQueryParam {
@ApiModelProperty("质量标识")
private Integer qualityFlag;
@ApiModelProperty("谐波次数,谐波指标必填,最多 6")
@ApiModelProperty("谐波次数,谐波指标必填,默认最多展示 3")
private List<Integer> harmonicOrders = new ArrayList<Integer>();
}

View File

@@ -13,6 +13,7 @@ import com.njcn.gather.steady.datavie.service.SteadyDataViewTrendService;
import com.njcn.gather.tool.addledger.pojo.vo.AddLedgerLinePathVO;
import com.njcn.gather.tool.addledger.service.AddLedgerService;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Service;
import java.math.BigDecimal;
@@ -28,6 +29,7 @@ import java.util.Map;
/**
* 稳态趋势查询服务实现。
*/
@Slf4j
@Service
@RequiredArgsConstructor
public class SteadyDataViewTrendServiceImpl implements SteadyDataViewTrendService {
@@ -70,11 +72,14 @@ public class SteadyDataViewTrendServiceImpl implements SteadyDataViewTrendServic
result.setSampled(false);
result.setLoadableDays(resolveLoadableDays(startTime, endTime));
int displayPointCount = 0;
long startMillis = System.currentTimeMillis();
log.info("稳态趋势查询开始seriesCount={}timeStart={}timeEnd={}qualityFlag={}", fields.size(), startTime, endTime, param.getQualityFlag());
for (SteadyTrendResolvedFieldBO field : fields) {
List<SteadyTrendPointVO> points = influxQueryComponent.queryTrendPoints(field, startTime, endTime, param.getQualityFlag());
displayPointCount += points.size();
result.getSeries().add(buildSeries(field, points));
}
log.info("稳态趋势查询结束seriesCount={}displayPointCount={}costMs={}", fields.size(), displayPointCount, System.currentTimeMillis() - startMillis);
/*
* 当前 Influx 查询按曲线独立执行,未额外发 count 查询sourcePointCount 保持与实际返回点数一致。
* 后续如需要精确原始点数,可单独增加 count(field) 查询。

View File

@@ -0,0 +1,41 @@
-- 稳态数据查看建议索引。
-- 本脚本不自动执行,请按数据库现状审阅后单独执行。
CREATE INDEX idx_data_v_time_line_phase
ON data_v (TIMEID, LINEID, PHASIC_TYPE);
CREATE INDEX idx_data_i_time_line_phase
ON data_i (TIMEID, LINEID, PHASIC_TYPE);
CREATE INDEX idx_data_flicker_time_line_phase
ON data_flicker (TIMEID, LINEID, PHASIC_TYPE);
CREATE INDEX idx_data_fluc_time_line_phase
ON data_fluc (TIMEID, LINEID, PHASIC_TYPE);
CREATE INDEX idx_data_harmphasic_i_time_line_phase
ON data_harmphasic_i (TIMEID, LINEID, PHASIC_TYPE);
CREATE INDEX idx_data_harmphasic_v_time_line_phase
ON data_harmphasic_v (TIMEID, LINEID, PHASIC_TYPE);
CREATE INDEX idx_data_harmpower_p_time_line_phase
ON data_harmpower_p (TIMEID, LINEID, PHASIC_TYPE);
CREATE INDEX idx_data_harmpower_q_time_line_phase
ON data_harmpower_q (TIMEID, LINEID, PHASIC_TYPE);
CREATE INDEX idx_data_harmpower_s_time_line_phase
ON data_harmpower_s (TIMEID, LINEID, PHASIC_TYPE);
CREATE INDEX idx_data_harmrate_i_time_line_phase
ON data_harmrate_i (TIMEID, LINEID, PHASIC_TYPE);
CREATE INDEX idx_data_harmrate_v_time_line_phase
ON data_harmrate_v (TIMEID, LINEID, PHASIC_TYPE);
CREATE INDEX idx_data_inharm_i_time_line_phase
ON data_inharm_i (TIMEID, LINEID, PHASIC_TYPE);
CREATE INDEX idx_data_plt_time_line_phase
ON data_plt (TIMEID, LINEID, PHASIC_TYPE);

View File

@@ -0,0 +1,42 @@
-- 稳态模块菜单图标修正脚本。
-- 本脚本不自动执行,请按数据库现状审阅后单独执行。
UPDATE sys_function
SET Icon = 'DataAnalysis'
WHERE State = 1
AND Type = 0
AND (
Name = '稳态模块'
OR Code IN ('steady', 'steadyModule', 'steadyDataView')
OR Path IN ('/steady', '/steadyDataView', '/steady/data-view')
);
UPDATE sys_function
SET Icon = 'DataBoard'
WHERE State = 1
AND Type = 0
AND (
Name = '稳态数据'
OR Code IN ('steadyData', 'steadyDataDetail')
OR Path IN ('/steady/data', '/steady/data-view/detail', '/steadyDataView/index')
);
UPDATE sys_function
SET Icon = 'TrendCharts'
WHERE State = 1
AND Type = 0
AND (
Name = '稳态趋势'
OR Code IN ('steadyTrend', 'steadyDataTrend')
OR Path IN ('/steady/trend', '/steady/data-view/trend', '/steadyTrend/index')
);
UPDATE sys_function
SET Icon = 'CircleCheck'
WHERE State = 1
AND Type = 0
AND (
Name = '数据验证'
OR Code IN ('dataValidation', 'steadyDataValidation')
OR Path IN ('/steady/data-validation', '/steady/data-view/validation', '/dataValidation/index')
);

View File

@@ -0,0 +1,38 @@
package com.njcn.gather.steady.checksquare.component;
import com.njcn.gather.steady.checksquare.pojo.vo.SteadyChecksquareSegmentVO;
import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.Test;
import java.time.LocalDateTime;
import java.util.Arrays;
import java.util.HashSet;
import java.util.List;
/**
* 数据校验缺失区间计算测试。
*/
class SteadyChecksquareCalculatorTest {
@Test
void shouldMergeContinuousMissingSlots() {
SteadyChecksquareCalculator calculator = new SteadyChecksquareCalculator();
List<LocalDateTime> slots = Arrays.asList(
LocalDateTime.of(2026, 5, 1, 0, 0),
LocalDateTime.of(2026, 5, 1, 0, 1),
LocalDateTime.of(2026, 5, 1, 0, 2),
LocalDateTime.of(2026, 5, 1, 0, 3),
LocalDateTime.of(2026, 5, 1, 0, 4)
);
List<SteadyChecksquareSegmentVO> segments = calculator.buildSegments(slots,
new HashSet<LocalDateTime>(Arrays.asList(slots.get(0), slots.get(3))), 1);
Assertions.assertEquals(4, segments.size());
Assertions.assertEquals("MISSING", segments.get(1).getStatus());
Assertions.assertEquals("2026-05-01 00:01:00", segments.get(1).getStartTime());
Assertions.assertEquals("2026-05-01 00:02:00", segments.get(1).getEndTime());
Assertions.assertEquals(Integer.valueOf(2), segments.get(1).getMissingPointCount());
Assertions.assertEquals(Integer.valueOf(2), segments.get(1).getDurationMinutes());
}
}

View File

@@ -0,0 +1,57 @@
package com.njcn.gather.steady.checksquare.component;
import com.njcn.gather.steady.datavie.config.SteadyInfluxDbProperties;
import com.njcn.gather.steady.datavie.pojo.bo.SteadyTrendResolvedFieldBO;
import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.Test;
import java.time.LocalDateTime;
/**
* 数据校验 InfluxQL 构造契约测试。
*/
class SteadyChecksquareInfluxQueryComponentTest {
@Test
void shouldBuildChecksquareQueryWithoutQualityFlag() {
SteadyChecksquareInfluxQueryComponent component = new SteadyChecksquareInfluxQueryComponent(new SteadyInfluxDbProperties());
SteadyTrendResolvedFieldBO field = new SteadyTrendResolvedFieldBO();
field.setMeasurement("data_v");
field.setField("rms");
field.setLineId("line-001");
field.setPhase("A");
field.setStatType("AVG");
String query = component.buildChecksquareQuery(field,
LocalDateTime.of(2026, 5, 1, 0, 0, 0),
LocalDateTime.of(2026, 5, 1, 23, 59, 59));
Assertions.assertTrue(query.contains("SELECT \"rms\" AS \"value\""));
Assertions.assertTrue(query.contains("\"line_id\" = 'line-001'"));
Assertions.assertTrue(query.contains("\"phasic_type\" = 'A'"));
Assertions.assertTrue(query.contains("\"value_type\" = 'AVG'"));
Assertions.assertFalse(query.contains("quality_flag"));
Assertions.assertFalse(query.contains("GROUP BY time"));
}
@Test
void shouldBuildValuePointQueryWithStatTypeFilter() {
SteadyChecksquareInfluxQueryComponent component = new SteadyChecksquareInfluxQueryComponent(new SteadyInfluxDbProperties());
SteadyTrendResolvedFieldBO field = new SteadyTrendResolvedFieldBO();
field.setMeasurement("data_v");
field.setField("rms");
field.setLineId("line-001");
field.setPhase("A");
field.setStatType("CP95");
String query = component.buildValuePointQuery(field,
LocalDateTime.of(2026, 5, 1, 0, 0, 0),
LocalDateTime.of(2026, 5, 1, 23, 59, 59));
Assertions.assertTrue(query.contains("SELECT \"rms\" AS \"value\""));
Assertions.assertTrue(query.contains("\"line_id\" = 'line-001'"));
Assertions.assertTrue(query.contains("\"phasic_type\" = 'A'"));
Assertions.assertTrue(query.contains("\"value_type\" = 'CP95'"));
Assertions.assertTrue(query.endsWith("ORDER BY time ASC"));
}
}

View File

@@ -0,0 +1,155 @@
package com.njcn.gather.steady.checksquare.component;
import com.njcn.gather.steady.checksquare.pojo.bo.SteadyChecksquareValuePointBO;
import com.njcn.gather.steady.checksquare.pojo.vo.SteadyChecksquareValueOrderRuleVO;
import com.njcn.gather.steady.datavie.pojo.bo.SteadyTrendIndicatorDefinitionBO;
import com.njcn.gather.steady.datavie.pojo.bo.SteadyTrendSeriesFieldBO;
import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.Test;
import java.math.BigDecimal;
import java.time.LocalDateTime;
import java.util.Arrays;
import java.util.Collections;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.ArgumentMatchers.eq;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.when;
/**
* 数据校验指标值大小关系规则测试。
*/
class SteadyChecksquareValueOrderRuleComponentTest {
@Test
void shouldMarkIndicatorAbnormalWhenInvalidPointCountGreaterThanOne() {
SteadyChecksquareInfluxQueryComponent influxQueryComponent = mock(SteadyChecksquareInfluxQueryComponent.class);
SteadyChecksquareValueOrderRuleComponent component = new SteadyChecksquareValueOrderRuleComponent(influxQueryComponent);
LocalDateTime firstTime = LocalDateTime.of(2026, 5, 1, 0, 0);
LocalDateTime secondTime = LocalDateTime.of(2026, 5, 1, 0, 1);
when(influxQueryComponent.queryValuePoints(any(), any(LocalDateTime.class), any(LocalDateTime.class), eq(1)))
.thenAnswer(invocation -> {
String statType = invocation.getArgument(0, com.njcn.gather.steady.datavie.pojo.bo.SteadyTrendResolvedFieldBO.class).getStatType();
if ("MAX".equals(statType)) {
return Arrays.asList(point(firstTime, "8"), point(secondTime, "9"));
}
if ("CP95".equals(statType)) {
return Arrays.asList(point(firstTime, "8"), point(secondTime, "10"));
}
if ("AVG".equals(statType)) {
return Arrays.asList(point(firstTime, "7"), point(secondTime, "8"));
}
if ("MIN".equals(statType)) {
return Arrays.asList(point(firstTime, "1"), point(secondTime, "8"));
}
return Collections.emptyList();
});
SteadyChecksquareValueOrderRuleVO result = component.check("line-001", indicator(), null,
LocalDateTime.of(2026, 5, 1, 0, 0), LocalDateTime.of(2026, 5, 1, 0, 2), 1);
Assertions.assertEquals(Integer.valueOf(2), result.getAbnormalPointCount());
Assertions.assertEquals(Boolean.TRUE, result.getAbnormal());
Assertions.assertEquals(2, result.getAbnormalDetails().size());
Assertions.assertEquals("2026-05-01 00:00:00", result.getAbnormalDetails().get(0).getTime());
Assertions.assertEquals("A", result.getAbnormalDetails().get(0).getPhase());
Assertions.assertEquals(new BigDecimal("8"), result.getAbnormalDetails().get(0).getMaxValue());
Assertions.assertEquals(new BigDecimal("1"), result.getAbnormalDetails().get(0).getMinValue());
Assertions.assertEquals(new BigDecimal("7"), result.getAbnormalDetails().get(0).getAvgValue());
Assertions.assertEquals(new BigDecimal("8"), result.getAbnormalDetails().get(0).getCp95Value());
}
@Test
void shouldNotMarkIndicatorAbnormalWhenOnlyOneInvalidPointExists() {
SteadyChecksquareInfluxQueryComponent influxQueryComponent = mock(SteadyChecksquareInfluxQueryComponent.class);
SteadyChecksquareValueOrderRuleComponent component = new SteadyChecksquareValueOrderRuleComponent(influxQueryComponent);
LocalDateTime time = LocalDateTime.of(2026, 5, 1, 0, 0);
when(influxQueryComponent.queryValuePoints(any(), any(LocalDateTime.class), any(LocalDateTime.class), eq(1)))
.thenAnswer(invocation -> {
String statType = invocation.getArgument(0, com.njcn.gather.steady.datavie.pojo.bo.SteadyTrendResolvedFieldBO.class).getStatType();
if ("MAX".equals(statType)) {
return Collections.singletonList(point(time, "10"));
}
if ("CP95".equals(statType)) {
return Collections.singletonList(point(time, "8"));
}
if ("AVG".equals(statType)) {
return Collections.singletonList(point(time, "8"));
}
if ("MIN".equals(statType)) {
return Collections.singletonList(point(time, "1"));
}
return Collections.emptyList();
});
SteadyChecksquareValueOrderRuleVO result = component.check("line-001", indicator(), null,
LocalDateTime.of(2026, 5, 1, 0, 0), LocalDateTime.of(2026, 5, 1, 0, 1), 1);
Assertions.assertEquals(Integer.valueOf(1), result.getAbnormalPointCount());
Assertions.assertEquals(Boolean.FALSE, result.getAbnormal());
Assertions.assertEquals(1, result.getAbnormalDetails().size());
}
@Test
void shouldSkipPointWhenAnyRequiredStatValueMissing() {
SteadyChecksquareInfluxQueryComponent influxQueryComponent = mock(SteadyChecksquareInfluxQueryComponent.class);
SteadyChecksquareValueOrderRuleComponent component = new SteadyChecksquareValueOrderRuleComponent(influxQueryComponent);
LocalDateTime time = LocalDateTime.of(2026, 5, 1, 0, 0);
when(influxQueryComponent.queryValuePoints(any(), any(LocalDateTime.class), any(LocalDateTime.class), eq(1)))
.thenAnswer(invocation -> {
String statType = invocation.getArgument(0, com.njcn.gather.steady.datavie.pojo.bo.SteadyTrendResolvedFieldBO.class).getStatType();
if ("MAX".equals(statType)) {
return Collections.singletonList(point(time, "10"));
}
if ("CP95".equals(statType)) {
return Collections.singletonList(point(time, "11"));
}
if ("MIN".equals(statType)) {
return Collections.singletonList(point(time, "1"));
}
return Collections.emptyList();
});
SteadyChecksquareValueOrderRuleVO result = component.check("line-001", indicator(), null,
LocalDateTime.of(2026, 5, 1, 0, 0), LocalDateTime.of(2026, 5, 1, 0, 1), 1);
Assertions.assertEquals(Integer.valueOf(0), result.getAbnormalPointCount());
Assertions.assertEquals(Boolean.FALSE, result.getAbnormal());
Assertions.assertTrue(result.getAbnormalDetails().isEmpty());
}
@Test
void shouldSkipIndicatorWhenNotAllFourStatsSupported() {
SteadyChecksquareInfluxQueryComponent influxQueryComponent = mock(SteadyChecksquareInfluxQueryComponent.class);
SteadyChecksquareValueOrderRuleComponent component = new SteadyChecksquareValueOrderRuleComponent(influxQueryComponent);
SteadyTrendIndicatorDefinitionBO indicator = indicator();
indicator.setSupportStats(Collections.singletonList("AVG"));
SteadyChecksquareValueOrderRuleVO result = component.check("line-001", indicator, null,
LocalDateTime.of(2026, 5, 1, 0, 0), LocalDateTime.of(2026, 5, 1, 0, 1), 1);
Assertions.assertEquals(Integer.valueOf(0), result.getAbnormalPointCount());
Assertions.assertEquals(Boolean.FALSE, result.getAbnormal());
Assertions.assertTrue(result.getAbnormalDetails().isEmpty());
}
private SteadyTrendIndicatorDefinitionBO indicator() {
SteadyTrendIndicatorDefinitionBO indicator = new SteadyTrendIndicatorDefinitionBO();
indicator.setIndicatorCode("V_RMS");
indicator.setName("相电压有效值");
indicator.setTableName("data_v");
indicator.setPhaseCodes(Collections.singletonList("A"));
indicator.setSeriesFields(Collections.singletonList(new SteadyTrendSeriesFieldBO("rms", "相电压有效值")));
indicator.setSupportStats(Arrays.asList("AVG", "MAX", "MIN", "CP95"));
indicator.setUnit("V");
return indicator;
}
private SteadyChecksquareValuePointBO point(LocalDateTime time, String value) {
SteadyChecksquareValuePointBO point = new SteadyChecksquareValuePointBO();
point.setTime(time);
point.setValue(new BigDecimal(value));
return point;
}
}

View File

@@ -0,0 +1,24 @@
package com.njcn.gather.steady.checksquare.controller;
import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.Test;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import java.lang.reflect.Method;
/**
* 数据校验接口契约测试。
*/
class SteadyChecksquareControllerTest {
@Test
void shouldExposeChecksquareQueryEndpointInSeparateController() throws Exception {
RequestMapping requestMapping = SteadyChecksquareController.class.getAnnotation(RequestMapping.class);
Assertions.assertArrayEquals(new String[]{"/steady/data-view/checksquare"}, requestMapping.value());
Method method = SteadyChecksquareController.class.getDeclaredMethod("query", com.njcn.gather.steady.checksquare.pojo.param.SteadyChecksquareQueryParam.class);
PostMapping postMapping = method.getAnnotation(PostMapping.class);
Assertions.assertArrayEquals(new String[]{"/query"}, postMapping.value());
}
}

View File

@@ -0,0 +1,32 @@
package com.njcn.gather.steady.checksquare.pojo.param;
import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.Test;
import java.lang.reflect.Field;
/**
* 数据校验查询参数契约测试。
*/
class SteadyChecksquareQueryParamTest {
@Test
void shouldOnlyExposeChecksquareQueryFields() {
Assertions.assertNotNull(field("lineId"));
Assertions.assertNotNull(field("indicatorCodes"));
Assertions.assertNotNull(field("timeStart"));
Assertions.assertNotNull(field("timeEnd"));
Assertions.assertNull(field("qualityFlag"));
Assertions.assertNull(field("statTypes"));
Assertions.assertNull(field("phases"));
Assertions.assertNotNull(field("harmonicOrders"));
}
private Field field(String name) {
try {
return SteadyChecksquareQueryParam.class.getDeclaredField(name);
} catch (NoSuchFieldException ex) {
return null;
}
}
}

View File

@@ -0,0 +1,188 @@
package com.njcn.gather.steady.checksquare.service.impl;
import com.njcn.gather.steady.checksquare.component.SteadyChecksquareCalculator;
import com.njcn.gather.steady.checksquare.component.SteadyChecksquareInfluxQueryComponent;
import com.njcn.gather.steady.checksquare.component.SteadyChecksquareValueOrderRuleComponent;
import com.njcn.gather.steady.checksquare.pojo.param.SteadyChecksquareQueryParam;
import com.njcn.gather.steady.checksquare.pojo.vo.SteadyChecksquareItemVO;
import com.njcn.gather.steady.checksquare.pojo.vo.SteadyChecksquareQueryVO;
import com.njcn.gather.steady.checksquare.pojo.vo.SteadyChecksquareValueOrderDetailVO;
import com.njcn.gather.steady.checksquare.pojo.vo.SteadyChecksquareValueOrderRuleVO;
import com.njcn.gather.steady.datavie.component.SteadyTrendIndicatorCatalog;
import com.njcn.gather.tool.adddata.component.AddDataTimeSlotCalculator;
import com.njcn.gather.tool.addledger.pojo.vo.AddLedgerLinePathVO;
import com.njcn.gather.tool.addledger.service.AddLedgerService;
import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.Test;
import java.time.LocalDateTime;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.ArgumentMatchers.anyInt;
import static org.mockito.ArgumentMatchers.eq;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.when;
/**
* 数据校验服务测试。
*/
class SteadyChecksquareServiceImplTest {
@Test
void shouldUseFixedFlickerIntervalsPerIndicator() {
SteadyChecksquareInfluxQueryComponent influxQueryComponent = mock(SteadyChecksquareInfluxQueryComponent.class);
SteadyChecksquareValueOrderRuleComponent valueOrderRuleComponent = mock(SteadyChecksquareValueOrderRuleComponent.class);
AddLedgerService addLedgerService = mock(AddLedgerService.class);
SteadyChecksquareServiceImpl service = new SteadyChecksquareServiceImpl(new SteadyTrendIndicatorCatalog(),
influxQueryComponent, new SteadyChecksquareCalculator(), valueOrderRuleComponent, new AddDataTimeSlotCalculator(), addLedgerService);
when(valueOrderRuleComponent.check(any(), any(), any(), any(LocalDateTime.class), any(LocalDateTime.class), anyInt()))
.thenReturn(emptyRuleResult());
AddLedgerLinePathVO linePath = new AddLedgerLinePathVO();
linePath.setLineId("line-001");
linePath.setLineName("进线一");
linePath.setLineInterval(1);
when(addLedgerService.listLinePathByLineIds(eq(Collections.singletonList("line-001"))))
.thenReturn(Collections.singletonMap("line-001", linePath));
when(influxQueryComponent.queryExistingSlots(any(), any(LocalDateTime.class), any(LocalDateTime.class), eq(10)))
.thenReturn(new HashSet<LocalDateTime>(Arrays.asList(
LocalDateTime.of(2026, 5, 1, 0, 0),
LocalDateTime.of(2026, 5, 1, 0, 10))));
when(influxQueryComponent.queryExistingSlots(any(), any(LocalDateTime.class), any(LocalDateTime.class), eq(120)))
.thenReturn(new HashSet<LocalDateTime>(Collections.singletonList(
LocalDateTime.of(2026, 5, 1, 0, 0))));
SteadyChecksquareQueryParam param = new SteadyChecksquareQueryParam();
param.setLineId("line-001");
param.setIndicatorCodes(Arrays.asList("FLUC", "PST", "PLT"));
param.setTimeStart("2026-05-01 00:00:00");
param.setTimeEnd("2026-05-01 02:00:00");
SteadyChecksquareQueryVO result = service.query(param);
Assertions.assertEquals(Integer.valueOf(1), result.getIntervalMinutes());
Assertions.assertEquals(3, result.getItems().size());
assertItemInterval(result.getItems().get(0), "FLUC", 10, 13);
assertItemInterval(result.getItems().get(1), "PST", 10, 13);
assertItemInterval(result.getItems().get(2), "PLT", 120, 2);
}
@Test
void shouldOnlyQueryRequestedHarmonicOrders() {
SteadyChecksquareInfluxQueryComponent influxQueryComponent = mock(SteadyChecksquareInfluxQueryComponent.class);
SteadyChecksquareValueOrderRuleComponent valueOrderRuleComponent = mock(SteadyChecksquareValueOrderRuleComponent.class);
AddLedgerService addLedgerService = mock(AddLedgerService.class);
SteadyChecksquareServiceImpl service = new SteadyChecksquareServiceImpl(new SteadyTrendIndicatorCatalog(),
influxQueryComponent, new SteadyChecksquareCalculator(), valueOrderRuleComponent, new AddDataTimeSlotCalculator(), addLedgerService);
when(valueOrderRuleComponent.check(any(), any(), any(), any(LocalDateTime.class), any(LocalDateTime.class), anyInt()))
.thenReturn(emptyRuleResult());
AddLedgerLinePathVO linePath = new AddLedgerLinePathVO();
linePath.setLineId("line-001");
linePath.setLineName("进线一");
linePath.setLineInterval(1);
when(addLedgerService.listLinePathByLineIds(eq(Collections.singletonList("line-001"))))
.thenReturn(Collections.singletonMap("line-001", linePath));
when(influxQueryComponent.queryExistingSlots(any(), any(LocalDateTime.class), any(LocalDateTime.class), eq(1)))
.thenReturn(new HashSet<LocalDateTime>(Collections.singletonList(
LocalDateTime.of(2026, 5, 1, 0, 0))));
SteadyChecksquareQueryParam param = new SteadyChecksquareQueryParam();
param.setLineId("line-001");
param.setIndicatorCodes(Collections.singletonList("V_HARMONIC"));
param.setHarmonicOrders(Collections.singletonList(5));
param.setTimeStart("2026-05-01 00:00:00");
param.setTimeEnd("2026-05-01 00:01:00");
SteadyChecksquareQueryVO result = service.query(param);
Assertions.assertEquals(1, result.getItems().size());
Assertions.assertEquals(Integer.valueOf(5), result.getItems().get(0).getHarmonicOrder());
}
@Test
void shouldKeepRequestedHarmonicOrdersDistinctAndOrdered() {
SteadyChecksquareInfluxQueryComponent influxQueryComponent = mock(SteadyChecksquareInfluxQueryComponent.class);
SteadyChecksquareValueOrderRuleComponent valueOrderRuleComponent = mock(SteadyChecksquareValueOrderRuleComponent.class);
AddLedgerService addLedgerService = mock(AddLedgerService.class);
SteadyChecksquareServiceImpl service = new SteadyChecksquareServiceImpl(new SteadyTrendIndicatorCatalog(),
influxQueryComponent, new SteadyChecksquareCalculator(), valueOrderRuleComponent, new AddDataTimeSlotCalculator(), addLedgerService);
when(valueOrderRuleComponent.check(any(), any(), any(), any(LocalDateTime.class), any(LocalDateTime.class), anyInt()))
.thenReturn(emptyRuleResult());
AddLedgerLinePathVO linePath = new AddLedgerLinePathVO();
linePath.setLineId("line-001");
linePath.setLineName("进线一");
linePath.setLineInterval(1);
when(addLedgerService.listLinePathByLineIds(eq(Collections.singletonList("line-001"))))
.thenReturn(Collections.singletonMap("line-001", linePath));
when(influxQueryComponent.queryExistingSlots(any(), any(LocalDateTime.class), any(LocalDateTime.class), eq(1)))
.thenReturn(new HashSet<LocalDateTime>());
SteadyChecksquareQueryParam param = new SteadyChecksquareQueryParam();
param.setLineId("line-001");
param.setIndicatorCodes(Collections.singletonList("V_HARMONIC"));
param.setHarmonicOrders(Arrays.asList(7, 5, 7));
param.setTimeStart("2026-05-01 00:00:00");
param.setTimeEnd("2026-05-01 00:01:00");
SteadyChecksquareQueryVO result = service.query(param);
List<SteadyChecksquareItemVO> items = result.getItems();
Assertions.assertEquals(2, items.size());
Assertions.assertEquals(Integer.valueOf(7), items.get(0).getHarmonicOrder());
Assertions.assertEquals(Integer.valueOf(5), items.get(1).getHarmonicOrder());
}
@Test
void shouldAssembleValueOrderRuleResultIntoItem() {
SteadyChecksquareInfluxQueryComponent influxQueryComponent = mock(SteadyChecksquareInfluxQueryComponent.class);
SteadyChecksquareValueOrderRuleComponent valueOrderRuleComponent = mock(SteadyChecksquareValueOrderRuleComponent.class);
AddLedgerService addLedgerService = mock(AddLedgerService.class);
SteadyChecksquareServiceImpl service = new SteadyChecksquareServiceImpl(new SteadyTrendIndicatorCatalog(),
influxQueryComponent, new SteadyChecksquareCalculator(), valueOrderRuleComponent, new AddDataTimeSlotCalculator(), addLedgerService);
AddLedgerLinePathVO linePath = new AddLedgerLinePathVO();
linePath.setLineId("line-001");
linePath.setLineName("进线一");
linePath.setLineInterval(1);
when(addLedgerService.listLinePathByLineIds(eq(Collections.singletonList("line-001"))))
.thenReturn(Collections.singletonMap("line-001", linePath));
when(influxQueryComponent.queryExistingSlots(any(), any(LocalDateTime.class), any(LocalDateTime.class), eq(1)))
.thenReturn(new HashSet<LocalDateTime>(Collections.singletonList(
LocalDateTime.of(2026, 5, 1, 0, 0))));
SteadyChecksquareValueOrderRuleVO ruleResult = new SteadyChecksquareValueOrderRuleVO();
SteadyChecksquareValueOrderDetailVO detail = new SteadyChecksquareValueOrderDetailVO();
detail.setTime("2026-05-01 00:00:00");
detail.setPhase("A");
ruleResult.setAbnormalPointCount(2);
ruleResult.setAbnormal(true);
ruleResult.setAbnormalDetails(Collections.singletonList(detail));
when(valueOrderRuleComponent.check(any(), any(), any(), any(LocalDateTime.class), any(LocalDateTime.class), eq(1)))
.thenReturn(ruleResult);
SteadyChecksquareQueryParam param = new SteadyChecksquareQueryParam();
param.setLineId("line-001");
param.setIndicatorCodes(Collections.singletonList("V_RMS"));
param.setTimeStart("2026-05-01 00:00:00");
param.setTimeEnd("2026-05-01 00:01:00");
SteadyChecksquareQueryVO result = service.query(param);
SteadyChecksquareItemVO item = result.getItems().get(0);
Assertions.assertEquals(Boolean.TRUE, item.getAbnormal());
Assertions.assertEquals(Integer.valueOf(2), item.getAbnormalPointCount());
Assertions.assertEquals(1, item.getAbnormalDetails().size());
Assertions.assertEquals("A", item.getAbnormalDetails().get(0).getPhase());
}
private void assertItemInterval(SteadyChecksquareItemVO item, String indicatorCode, int intervalMinutes, int expectedPointCount) {
Assertions.assertEquals(indicatorCode, item.getIndicatorCode());
Assertions.assertEquals(Integer.valueOf(intervalMinutes), item.getIntervalMinutes());
Assertions.assertEquals(Integer.valueOf(expectedPointCount), item.getExpectedPointCount());
}
private SteadyChecksquareValueOrderRuleVO emptyRuleResult() {
return new SteadyChecksquareValueOrderRuleVO();
}
}

View File

@@ -73,6 +73,31 @@ class SteadyInfluxQueryComponentTest {
Assertions.assertTrue(query.contains("\"value_type\" = 'AVG'"));
}
@Test
void shouldBuildDiagnosticTextForTrendQuery() {
SteadyInfluxQueryComponent component = new SteadyInfluxQueryComponent(new SteadyInfluxDbProperties());
SteadyTrendResolvedFieldBO field = new SteadyTrendResolvedFieldBO();
field.setMeasurement("data_harmpower_p");
field.setField("p_3");
field.setLineId("f828bc42132841c2aeebc6859f5a9b7c");
field.setPhase("A");
field.setStatType("AVG");
String diagnostic = component.buildTrendQueryDiagnostic(field,
LocalDateTime.of(2026, 5, 1, 0, 0, 0),
LocalDateTime.of(2026, 5, 31, 23, 59, 59),
0);
Assertions.assertTrue(diagnostic.contains("measurement=data_harmpower_p"));
Assertions.assertTrue(diagnostic.contains("field=p_3"));
Assertions.assertTrue(diagnostic.contains("lineId=f828bc42132841c2aeebc6859f5a9b7c"));
Assertions.assertTrue(diagnostic.contains("phase=A"));
Assertions.assertTrue(diagnostic.contains("statType=AVG"));
Assertions.assertTrue(diagnostic.contains("qualityFlag=0"));
Assertions.assertTrue(diagnostic.contains("timeStart=2026-05-01T00:00"));
Assertions.assertTrue(diagnostic.contains("timeEnd=2026-05-31T23:59:59"));
}
@Test
void shouldSkipValueTypeWhenMeasurementHasNoValueTypeTag() {
SteadyInfluxQueryComponent component = new SteadyInfluxQueryComponent(new SteadyInfluxDbProperties());

View File

@@ -109,6 +109,21 @@ class SteadyTrendFieldResolverTest {
Assertions.assertTrue(exception.getMessage().contains("谐波次数不能为空"));
}
@Test
void shouldRejectHarmonicTrendWithMoreThanThreeOrders() {
SteadyTrendQueryParam param = new SteadyTrendQueryParam();
param.setLineIds(Arrays.asList("line-001"));
param.setIndicatorCodes(Arrays.asList("V_HARMONIC"));
param.setStatTypes(Arrays.asList("AVG"));
param.setHarmonicOrders(Arrays.asList(3, 5, 7, 11));
param.setTimeStart("2026-05-01 00:00:00");
param.setTimeEnd("2026-05-01 01:00:00");
BusinessException exception = Assertions.assertThrows(BusinessException.class, () -> resolver.resolveFields(param));
Assertions.assertTrue(exception.getMessage().contains("谐波次数不允许一次展示超过3个"));
}
@Test
void shouldResolveSelectedHarmonicOrdersForAllCatalogPhases() {
SteadyTrendQueryParam param = new SteadyTrendQueryParam();

View File

@@ -2,13 +2,100 @@
## 模块定位
`dbms``system-ops` 下的数据库监控模块,当前先提供数据库监控菜单对应的后端基础入口
`dbms``system-ops` 下的数据库运维模块,当前支持 Oracle、MySQL 两类数据库运维能力,其中 Oracle 支持 `DATA_PUMP``JDBC_EXPORT`MySQL 当前支持 `JDBC_EXPORT`
## 当前接口
- `GET /database/overview`
- 查询数据库监控基础信息。
- 查询数据库运维概览信息。
- `POST /database/connections/list`
- 查询数据库连接配置。
- `POST /database/connections/add`
- 新增 Oracle 数据库连接配置。
- `POST /database/connections/update`
- 修改 Oracle 数据库连接配置。
- `POST /database/connections/delete`
- 删除数据库连接配置。
- `POST /database/connections/test`
- 测试 Oracle 数据库连接。
- `POST /database/connections/tables`
- 查询 Oracle 表列表。
- `POST /database/backups/create`
- 创建备份任务,默认使用 `DATA_PUMP`,可选 `JDBC_EXPORT`
- `POST /database/backups/tasks/list`
- 查询备份任务列表。
- `GET /database/backups/tasks/status`
- 查询任务状态。
- `POST /database/backups/files/list`
- 查询备份文件记录。
- `POST /database/restores/create`
- 创建恢复任务。
- `GET /database/restores/tasks/status`
- 查询恢复任务状态。
- `POST /database/delete/backup-file`
- 删除备份文件,要求 `confirmText=确认删除`
- `POST /database/delete/task`
- 删除任务记录,要求 `confirmText=确认删除`
## 数据脚本
- `src/main/resources/sql/system-ops/system-ops-init.sql`
- 系统运维菜单初始化脚本。
- `src/main/resources/sql/system-ops/dbms-database-ops-init.sql`
- 数据库运维连接、任务、备份文件和恢复记录表结构。
## 配置项
建议通过环境配置覆盖:
```yaml
dbms:
backup:
storage-path: D:/dbms-backup
default-max-file-size-mb: 512
mysql-fetch-size: 1000
tools:
expdp-path:
impdp-path:
```
说明:
- `backup.storage-path`
- `JDBC_EXPORT` 生成的 CSV 和元数据 JSON 的受管根目录。
- `backup.default-max-file-size-mb`
- MySQL `JDBC_EXPORT` 默认分片大小,前端可通过 `maxFileSizeMb` 覆盖,默认 512MB。
- `backup.mysql-fetch-size`
- MySQL `JDBC_EXPORT` 流式读取批量大小,默认 1000。
- `tools.expdp-path``tools.impdp-path`
- Oracle Data Pump 工具路径;为空时尝试走系统 `PATH`
## 当前行为
- 当前能力矩阵如下:
| 数据库类型 | 连接测试 | 表列表 | JDBC_EXPORT | DATA_PUMP |
| --- | --- | --- | --- | --- |
| ORACLE | 支持 | 支持 | 支持 | 支持 |
| MYSQL | 支持 | 支持 | 支持 | 不支持 |
- 备份和恢复只允许基于已保存且连接可用的连接配置发起。
- 新增连接前的测试接口仍可传 `temporaryPassword` 做临时连通性测试。
- 备份任务异步执行,只有实际文件生成成功后才会写入 `dbms_backup_file` 记录。
- `JDBC_EXPORT` 当前会生成两类文件:
- MySQL `JDBC_EXPORT` 会按任务号创建独立备份目录,每张表独立 CSV默认按 512MB 分片:
- 数据分片文件:`<table>_part001_yyyyMMdd_<taskNo>.csv`
- 元数据文件:`mysql_jdbc_export_metadata_yyyyMMdd_<taskNo>.json`
- 备份任务支持停止和重新开始:
- `POST /database/backups/tasks/stop`
- `POST /database/backups/tasks/restart`
- `JDBC_EXPORT` 恢复依赖元数据文件,不再允许缺少元数据直接发起恢复。
- 删除备份文件时,会校验目标路径必须位于受管备份目录下,避免误删非备份文件。
## 当前限制
- 当前只完成后端基础入口,不包含真实数据库连接状态、容量或性能指标探测逻辑
- `DATA_PUMP` 仍依赖部署机器可执行 `expdp``impdp`,并且 Oracle 侧已准备好 `directory` 对象和权限
- 当前代码要求 `DATA_PUMP` 连接配置里补齐可管理的 `directoryPath`,否则虽然 Oracle 端可能已导出成功,后端无法安全管理文件记录与删除。
- `JDBC_EXPORT` 恢复当前仅覆盖表数据,不承诺恢复索引、约束、触发器、序列、存储过程、权限等数据库对象。
- `TIME_RANGE` 模式当前只在 `JDBC_EXPORT` 场景真正参与查询过滤;`DATA_PUMP` 尚未接入 Oracle `QUERY` 参数。
- MySQL `JDBC_EXPORT` 已实现按大小分片Oracle `JDBC_EXPORT` 仍沿用原单文件导出路径。
- 本轮仅完成代码路径和文档收口,未执行 `mvn` 编译、测试或真实库联调。

View File

@@ -26,5 +26,19 @@
<artifactId>spingboot2.3.12</artifactId>
<version>2.3.12</version>
</dependency>
<dependency>
<groupId>com.njcn</groupId>
<artifactId>mybatis-plus</artifactId>
<version>0.0.1</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-tx</artifactId>
</dependency>
<dependency>
<groupId>com.oracle</groupId>
<artifactId>ojdbc6</artifactId>
<version>11.2.0.3</version>
</dependency>
</dependencies>
</project>

View File

@@ -0,0 +1,111 @@
package com.njcn.gather.systemops.database.component;
import cn.hutool.core.util.StrUtil;
import com.njcn.gather.systemops.database.config.DbmsProperties;
import com.njcn.gather.systemops.database.pojo.po.DatabaseConnection;
import lombok.Data;
import lombok.RequiredArgsConstructor;
import org.springframework.stereotype.Component;
import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.nio.charset.Charset;
import java.util.ArrayList;
import java.util.List;
/**
* Oracle Data Pump 命令执行组件。
*/
@Component
@RequiredArgsConstructor
public class DataPumpCommandExecutor {
private final DbmsProperties dbmsProperties;
public CommandResult expdp(DatabaseConnection connection, String password, String directoryName,
String dumpFileName, String logFileName, List<String> tableNames) {
List<String> command = new ArrayList<>();
command.add(resolveTool(dbmsProperties.getTools().getExpdpPath(), "expdp"));
fillCommonArgs(command, connection, password, directoryName, dumpFileName, logFileName);
if (tableNames != null && !tableNames.isEmpty()) {
command.add("tables=" + connection.getSchemaName() + "." + String.join("," + connection.getSchemaName() + ".", tableNames));
}
return execute(command);
}
public CommandResult impdp(DatabaseConnection connection, String password, String directoryName,
String dumpFileName, String logFileName, String tableExistsAction) {
List<String> command = new ArrayList<>();
command.add(resolveTool(dbmsProperties.getTools().getImpdpPath(), "impdp"));
fillCommonArgs(command, connection, password, directoryName, dumpFileName, logFileName);
if (StrUtil.isNotBlank(tableExistsAction)) {
command.add("table_exists_action=" + tableExistsAction);
}
return execute(command);
}
private void fillCommonArgs(List<String> command, DatabaseConnection connection, String password,
String directoryName, String dumpFileName, String logFileName) {
command.add(connection.getUsername() + "/" + password + "@" + buildConnectIdentifier(connection));
command.add("directory=" + directoryName);
command.add("dumpfile=" + dumpFileName);
command.add("logfile=" + logFileName);
}
private String buildConnectIdentifier(DatabaseConnection connection) {
if (StrUtil.isNotBlank(connection.getServiceName())) {
return "//" + connection.getHost() + ":" + connection.getPort() + "/" + connection.getServiceName();
}
return connection.getHost() + ":" + connection.getPort() + ":" + connection.getSid();
}
private String resolveTool(String configuredPath, String defaultName) {
return StrUtil.blankToDefault(configuredPath, defaultName);
}
private CommandResult execute(List<String> command) {
CommandResult result = new CommandResult();
result.setCommand(maskPassword(command));
try {
Process process = new ProcessBuilder(command).redirectErrorStream(true).start();
StringBuilder output = new StringBuilder();
try (BufferedReader reader = new BufferedReader(new InputStreamReader(process.getInputStream(), Charset.defaultCharset()))) {
String line;
while ((line = reader.readLine()) != null) {
output.append(line).append(System.lineSeparator());
}
}
int exitCode = process.waitFor();
result.setExitCode(exitCode);
result.setOutput(output.toString());
result.setSuccess(exitCode == 0);
} catch (Exception exception) {
result.setExitCode(-1);
result.setOutput(exception.getMessage());
result.setSuccess(false);
}
return result;
}
private String maskPassword(List<String> command) {
if (command.size() < 2) {
return String.join(" ", command);
}
List<String> masked = new ArrayList<>(command);
String credential = masked.get(1);
int slashIndex = credential.indexOf('/');
int atIndex = credential.indexOf('@');
if (slashIndex > 0 && atIndex > slashIndex) {
masked.set(1, credential.substring(0, slashIndex + 1) + "******" + credential.substring(atIndex));
}
return String.join(" ", masked);
}
@Data
public static class CommandResult {
private Boolean success;
private Integer exitCode;
private String command;
private String output;
}
}

View File

@@ -0,0 +1,28 @@
package com.njcn.gather.systemops.database.component;
import cn.hutool.core.util.StrUtil;
import org.springframework.stereotype.Component;
/**
* 数据库连接密码处理组件。
*/
@Component
public class DatabasePasswordComponent {
public String encrypt(String plainText) {
if (StrUtil.isBlank(plainText)) {
return null;
}
return plainText;
}
/**
* 优先使用本次请求传入的临时密码;否则复用已保存的数据库密码。
*/
public String resolveRuntimePassword(String passwordCipher, String temporaryPassword) {
if (StrUtil.isNotBlank(temporaryPassword)) {
return temporaryPassword;
}
return StrUtil.isBlank(passwordCipher) ? null : passwordCipher;
}
}

View File

@@ -0,0 +1,541 @@
package com.njcn.gather.systemops.database.component;
import cn.hutool.core.util.StrUtil;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.njcn.gather.systemops.database.constant.DatabaseOpsConst;
import com.njcn.gather.systemops.database.pojo.param.DatabaseBackupParam;
import com.njcn.gather.systemops.database.util.DatabaseFileNameUtil;
import lombok.Data;
import lombok.RequiredArgsConstructor;
import org.springframework.stereotype.Component;
import java.io.BufferedReader;
import java.io.BufferedWriter;
import java.io.IOException;
import java.nio.charset.StandardCharsets;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.sql.Connection;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.ResultSetMetaData;
import java.sql.Statement;
import java.time.format.DateTimeFormatter;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.regex.Pattern;
import java.util.function.BooleanSupplier;
/**
* JDBC 表数据导出与恢复组件。
*/
@Component
@RequiredArgsConstructor
public class JdbcExportComponent {
private static final Pattern IDENTIFIER_PATTERN = Pattern.compile("^[A-Za-z][A-Za-z0-9_#$]*$");
private static final DateTimeFormatter DATE_TIME_FORMATTER = DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss");
private final ObjectMapper objectMapper;
public void exportCsv(Connection jdbcConnection, String ownerName, DatabaseBackupParam.CreateParam param,
Path dataFilePath, Path metadataFilePath) throws Exception {
Files.createDirectories(dataFilePath.getParent());
if (metadataFilePath.getParent() != null) {
Files.createDirectories(metadataFilePath.getParent());
}
List<TableMetadata> metadataList = new ArrayList<>();
try (BufferedWriter writer = Files.newBufferedWriter(dataFilePath, StandardCharsets.UTF_8)) {
for (String tableName : param.getTargetNames()) {
metadataList.add(exportTable(jdbcConnection, ownerName, tableName, param, writer));
}
}
try (BufferedWriter metadataWriter = Files.newBufferedWriter(metadataFilePath, StandardCharsets.UTF_8)) {
objectMapper.writeValue(metadataWriter, metadataList);
}
}
public void importCsv(Connection jdbcConnection, Path dataFilePath, Path metadataFilePath, String dbType,
String restoreMode, String targetOwnerName) throws Exception {
String metadataText = new String(Files.readAllBytes(metadataFilePath), StandardCharsets.UTF_8);
if (metadataText.trim().startsWith("{")) {
importCsvV2(jdbcConnection, metadataFilePath, dbType, restoreMode, targetOwnerName);
return;
}
List<TableMetadata> metadataList = Arrays.asList(objectMapper.readValue(metadataFilePath.toFile(), TableMetadata[].class));
Map<String, TableMetadata> metadataMap = new LinkedHashMap<>();
for (TableMetadata metadata : metadataList) {
metadataMap.put(metadata.getFullTableName(), metadata);
}
jdbcConnection.setAutoCommit(false);
try (BufferedReader reader = Files.newBufferedReader(dataFilePath, StandardCharsets.UTF_8)) {
try {
String line;
TableMetadata currentMetadata = null;
List<String> currentColumns = null;
while ((line = reader.readLine()) != null) {
if (line.startsWith("-- TABLE ")) {
currentMetadata = metadataMap.get(line.substring("-- TABLE ".length()).trim());
if (currentMetadata == null) {
throw new IllegalArgumentException("未找到表元数据:" + line);
}
currentColumns = null;
prepareTargetTable(jdbcConnection, currentMetadata, dbType, restoreMode, targetOwnerName);
continue;
}
if (currentMetadata == null) {
continue;
}
if (currentColumns == null) {
currentColumns = parseCsvLine(line);
continue;
}
List<String> values = parseCsvLine(line);
insertRow(jdbcConnection, currentMetadata, currentColumns, values, dbType, restoreMode, targetOwnerName);
}
jdbcConnection.commit();
} catch (Exception exception) {
jdbcConnection.rollback();
throw exception;
}
}
}
public ExportManifest exportMysqlCsvV2(Connection jdbcConnection, String databaseName, String taskNo,
DatabaseBackupParam.CreateParam param, Path backupDirectory,
Path metadataFilePath, int fetchSize, long maxPartBytes,
BooleanSupplier cancelled) throws Exception {
Files.createDirectories(backupDirectory);
ExportManifest manifest = new ExportManifest();
manifest.setVersion(2);
manifest.setDbType("MYSQL");
manifest.setBackupStrategy("JDBC_EXPORT");
manifest.setTaskNo(taskNo);
manifest.setDatabaseName(databaseName);
List<TableExportMetadata> tableMetadataList = new ArrayList<>();
manifest.setTables(tableMetadataList);
for (String tableName : param.getTargetNames()) {
checkCancelled(cancelled, backupDirectory);
tableMetadataList.add(exportMysqlTableV2(jdbcConnection, tableName, param, backupDirectory, taskNo,
fetchSize, maxPartBytes, cancelled));
}
try (BufferedWriter metadataWriter = Files.newBufferedWriter(metadataFilePath, StandardCharsets.UTF_8)) {
objectMapper.writeValue(metadataWriter, manifest);
}
return manifest;
}
private TableMetadata exportTable(Connection connection, String ownerName, String tableName,
DatabaseBackupParam.CreateParam param, BufferedWriter writer) throws Exception {
String normalizedOwner = normalizeOwner(ownerName);
String normalizedTable = normalizeMysqlIdentifier(tableName);
String fullTableName = buildFullTableName(normalizedOwner, normalizedTable);
String querySql = buildQuerySql(fullTableName, param);
TableMetadata metadata = new TableMetadata();
metadata.setOwnerName(normalizedOwner);
metadata.setTableName(normalizedTable);
metadata.setFullTableName(fullTableName);
metadata.setTimeColumn(StrUtil.isBlank(param.getTimeColumn()) ? null : normalizeMysqlIdentifier(param.getTimeColumn()));
metadata.setStartTime(param.getStartTime() == null ? null : param.getStartTime().format(DATE_TIME_FORMATTER));
metadata.setEndTime(param.getEndTime() == null ? null : param.getEndTime().format(DATE_TIME_FORMATTER));
writer.write("-- TABLE " + fullTableName);
writer.newLine();
try (PreparedStatement statement = connection.prepareStatement(querySql)) {
fillQueryParams(statement, param);
try (ResultSet resultSet = statement.executeQuery()) {
ResultSetMetaData resultSetMetaData = resultSet.getMetaData();
int columnCount = resultSetMetaData.getColumnCount();
List<String> columnNames = new ArrayList<>();
List<String> columnTypes = new ArrayList<>();
for (int i = 1; i <= columnCount; i++) {
String columnName = resultSetMetaData.getColumnName(i);
columnNames.add(normalizeMysqlIdentifier(columnName));
columnTypes.add(resultSetMetaData.getColumnTypeName(i));
if (i > 1) {
writer.write(",");
}
writer.write(escape(columnName));
}
writer.newLine();
long rowCount = 0L;
while (resultSet.next()) {
for (int i = 1; i <= columnCount; i++) {
if (i > 1) {
writer.write(",");
}
writer.write(escape(resultSet.getString(i)));
}
writer.newLine();
rowCount++;
}
metadata.setColumnNames(columnNames);
metadata.setColumnTypes(columnTypes);
metadata.setRowCount(rowCount);
return metadata;
}
}
}
private TableExportMetadata exportMysqlTableV2(Connection connection, String tableName,
DatabaseBackupParam.CreateParam param, Path backupDirectory,
String taskNo, int fetchSize, long maxPartBytes,
BooleanSupplier cancelled) throws Exception {
String normalizedTable = normalizeIdentifier(tableName);
String querySql = buildQuerySql(normalizedTable, param);
TableExportMetadata metadata = new TableExportMetadata();
metadata.setTableName(normalizedTable);
metadata.setFullTableName(normalizedTable);
metadata.setTimeColumn(StrUtil.isBlank(param.getTimeColumn()) ? null : normalizeIdentifier(param.getTimeColumn()));
metadata.setStartTime(param.getStartTime() == null ? null : param.getStartTime().format(DATE_TIME_FORMATTER));
metadata.setEndTime(param.getEndTime() == null ? null : param.getEndTime().format(DATE_TIME_FORMATTER));
metadata.setColumns(new ArrayList<>());
metadata.setParts(new ArrayList<>());
try (PreparedStatement statement = connection.prepareStatement(querySql, ResultSet.TYPE_FORWARD_ONLY, ResultSet.CONCUR_READ_ONLY)) {
statement.setFetchSize(fetchSize);
fillQueryParams(statement, param);
try (ResultSet resultSet = statement.executeQuery()) {
ResultSetMetaData resultSetMetaData = resultSet.getMetaData();
int columnCount = resultSetMetaData.getColumnCount();
List<String> columnNames = new ArrayList<>();
for (int i = 1; i <= columnCount; i++) {
String columnName = resultSetMetaData.getColumnName(i);
columnNames.add(columnName);
ColumnMetadata columnMetadata = new ColumnMetadata();
columnMetadata.setName(columnName);
columnMetadata.setType(resultSetMetaData.getColumnTypeName(i));
metadata.getColumns().add(columnMetadata);
}
PartWriter partWriter = openPartWriter(backupDirectory, normalizedTable, taskNo,
metadata.getParts().size() + 1, columnNames);
metadata.getParts().add(partWriter.getPart());
long totalRows = 0L;
try {
while (resultSet.next()) {
checkCancelled(cancelled, backupDirectory);
if (partWriter.shouldRotate(maxPartBytes)) {
partWriter.close();
partWriter = openPartWriter(backupDirectory, normalizedTable, taskNo,
metadata.getParts().size() + 1, columnNames);
metadata.getParts().add(partWriter.getPart());
}
partWriter.writeRow(resultSet, columnCount);
totalRows++;
}
} finally {
partWriter.close();
}
metadata.setRowCount(totalRows);
return metadata;
}
}
}
private String buildQuerySql(String fullTableName, DatabaseBackupParam.CreateParam param) {
StringBuilder sql = new StringBuilder("SELECT * FROM ").append(fullTableName);
if (param.getStartTime() != null && param.getEndTime() != null && StrUtil.isNotBlank(param.getTimeColumn())) {
sql.append(" WHERE ").append(normalizeIdentifier(param.getTimeColumn())).append(" BETWEEN ? AND ?");
}
return sql.toString();
}
private void fillQueryParams(PreparedStatement statement, DatabaseBackupParam.CreateParam param) throws Exception {
if (param.getStartTime() != null && param.getEndTime() != null && StrUtil.isNotBlank(param.getTimeColumn())) {
statement.setString(1, param.getStartTime().format(DATE_TIME_FORMATTER));
statement.setString(2, param.getEndTime().format(DATE_TIME_FORMATTER));
}
}
private void prepareTargetTable(Connection connection, TableMetadata metadata, String dbType, String restoreMode,
String targetOwnerName) throws Exception {
if (!"TRUNCATE".equalsIgnoreCase(restoreMode)
&& !("REPLACE".equalsIgnoreCase(restoreMode) && !isMysql(dbType))) {
return;
}
String fullTargetName = buildTargetTableName(metadata, targetOwnerName);
try (Statement statement = connection.createStatement()) {
statement.execute("TRUNCATE TABLE " + fullTargetName);
}
}
private void insertRow(Connection connection, TableMetadata metadata, List<String> columns,
List<String> values, String dbType, String restoreMode, String targetOwnerName) throws Exception {
String fullTargetName = buildTargetTableName(metadata, targetOwnerName);
StringBuilder placeholders = new StringBuilder();
for (int i = 0; i < columns.size(); i++) {
if (i > 0) {
placeholders.append(",");
}
placeholders.append("?");
}
String sql = buildInsertSql(dbType, restoreMode, fullTargetName, columns, placeholders.toString());
try (PreparedStatement statement = connection.prepareStatement(sql)) {
for (int i = 0; i < columns.size(); i++) {
statement.setString(i + 1, i < values.size() ? values.get(i) : null);
}
statement.executeUpdate();
}
}
private String buildInsertSql(String dbType, String restoreMode, String fullTargetName, List<String> columns,
String placeholders) {
String command = "INSERT INTO";
if (isMysql(dbType) && "SKIP".equalsIgnoreCase(restoreMode)) {
// MySQL 跳过重复主键行,避免普通恢复因历史数据重复而整体失败。
command = "INSERT IGNORE INTO";
} else if (isMysql(dbType) && "REPLACE".equalsIgnoreCase(restoreMode)) {
command = "REPLACE INTO";
}
return command + " " + fullTargetName + " (" + String.join(",", columns) + ") VALUES (" + placeholders + ")";
}
private void importCsvV2(Connection jdbcConnection, Path metadataFilePath, String dbType, String restoreMode,
String targetOwnerName) throws Exception {
ExportManifest manifest = objectMapper.readValue(metadataFilePath.toFile(), ExportManifest.class);
jdbcConnection.setAutoCommit(false);
try {
for (TableExportMetadata tableMetadata : manifest.getTables()) {
prepareTargetTable(jdbcConnection, toLegacyMetadata(tableMetadata), dbType, restoreMode, targetOwnerName);
for (FilePartMetadata part : tableMetadata.getParts()) {
importPart(jdbcConnection, metadataFilePath.getParent(), tableMetadata, part, dbType, restoreMode, targetOwnerName);
}
}
jdbcConnection.commit();
} catch (Exception exception) {
jdbcConnection.rollback();
throw exception;
}
}
private void importPart(Connection jdbcConnection, Path backupDirectory, TableExportMetadata tableMetadata,
FilePartMetadata part, String dbType, String restoreMode, String targetOwnerName) throws Exception {
Path partPath = backupDirectory.resolve(part.getFileName()).normalize();
if (!partPath.startsWith(backupDirectory.normalize())) {
throw new IllegalArgumentException("备份分片路径不在元数据目录内:" + part.getFileName());
}
try (BufferedReader reader = Files.newBufferedReader(partPath, StandardCharsets.UTF_8)) {
List<String> columns = null;
String line;
while ((line = reader.readLine()) != null) {
if (line.startsWith("-- TABLE ")) {
continue;
}
if (columns == null) {
columns = parseCsvLine(line);
continue;
}
List<String> values = parseCsvLine(line);
insertRow(jdbcConnection, toLegacyMetadata(tableMetadata), columns, values, dbType, restoreMode, targetOwnerName);
}
}
}
private boolean isMysql(String dbType) {
return DatabaseOpsConst.DB_TYPE_MYSQL.equalsIgnoreCase(dbType);
}
private PartWriter openPartWriter(Path backupDirectory, String tableName, String taskNo, int partIndex,
List<String> columnNames) throws IOException {
String rawName = tableName.toLowerCase(Locale.ROOT) + "_part" + String.format("%03d", partIndex) + ".csv";
String fileName = DatabaseFileNameUtil.appendTodayWithTask(rawName, taskNo);
Path filePath = backupDirectory.resolve(fileName).normalize();
BufferedWriter writer = Files.newBufferedWriter(filePath, StandardCharsets.UTF_8);
writer.write("-- TABLE " + tableName);
writer.newLine();
for (int i = 0; i < columnNames.size(); i++) {
if (i > 0) {
writer.write(",");
}
writer.write(escape(columnNames.get(i)));
}
writer.newLine();
FilePartMetadata part = new FilePartMetadata();
part.setFileName(fileName);
part.setFilePath(filePath.toString());
part.setRowCount(0L);
part.setFileSize(0L);
return new PartWriter(writer, filePath, part);
}
private TableMetadata toLegacyMetadata(TableExportMetadata metadata) {
TableMetadata legacy = new TableMetadata();
legacy.setOwnerName(null);
legacy.setTableName(metadata.getTableName());
legacy.setFullTableName(metadata.getFullTableName());
legacy.setTimeColumn(metadata.getTimeColumn());
legacy.setStartTime(metadata.getStartTime());
legacy.setEndTime(metadata.getEndTime());
legacy.setRowCount(metadata.getRowCount());
List<String> columnNames = new ArrayList<>();
List<String> columnTypes = new ArrayList<>();
for (ColumnMetadata column : metadata.getColumns()) {
columnNames.add(column.getName());
columnTypes.add(column.getType());
}
legacy.setColumnNames(columnNames);
legacy.setColumnTypes(columnTypes);
return legacy;
}
private void checkCancelled(BooleanSupplier cancelled, Path backupDirectory) {
if (cancelled != null && cancelled.getAsBoolean()) {
throw new IllegalStateException("备份任务已停止,已生成文件保留在:" + backupDirectory);
}
}
private String buildTargetTableName(TableMetadata metadata, String targetOwnerName) {
String owner = normalizeOwner(StrUtil.blankToDefault(targetOwnerName, metadata.getOwnerName()));
return buildFullTableName(owner, metadata.getTableName());
}
private String buildFullTableName(String ownerName, String tableName) {
if (StrUtil.isBlank(ownerName)) {
return tableName;
}
return ownerName + "." + tableName;
}
private String normalizeOwner(String ownerName) {
if (StrUtil.isBlank(ownerName)) {
return null;
}
return normalizeIdentifier(ownerName);
}
private List<String> parseCsvLine(String line) {
List<String> result = new ArrayList<>();
StringBuilder current = new StringBuilder();
boolean quoted = false;
for (int i = 0; i < line.length(); i++) {
char currentChar = line.charAt(i);
if (currentChar == '"') {
if (quoted && i + 1 < line.length() && line.charAt(i + 1) == '"') {
current.append('"');
i++;
} else {
quoted = !quoted;
}
continue;
}
if (currentChar == ',' && !quoted) {
result.add(current.toString());
current.setLength(0);
continue;
}
current.append(currentChar);
}
result.add(current.toString());
return result;
}
private String escape(String value) {
if (value == null) {
return "";
}
return "\"" + value.replace("\"", "\"\"") + "\"";
}
private String normalizeIdentifier(String value) {
if (value == null || !IDENTIFIER_PATTERN.matcher(value).matches()) {
throw new IllegalArgumentException("数据库对象名称格式不正确:" + value);
}
return value.trim().toUpperCase(Locale.ROOT);
}
private String normalizeMysqlIdentifier(String value) {
if (value == null || !IDENTIFIER_PATTERN.matcher(value).matches()) {
throw new IllegalArgumentException("数据库对象名称格式不正确:" + value);
}
return value.trim();
}
@Data
public static class TableMetadata {
private String ownerName;
private String tableName;
private String fullTableName;
private List<String> columnNames;
private List<String> columnTypes;
private String timeColumn;
private String startTime;
private String endTime;
private Long rowCount;
}
@Data
public static class ExportManifest {
private Integer version;
private String dbType;
private String backupStrategy;
private String taskNo;
private String databaseName;
private List<TableExportMetadata> tables;
}
@Data
public static class TableExportMetadata {
private String tableName;
private String fullTableName;
private String timeColumn;
private String startTime;
private String endTime;
private List<ColumnMetadata> columns;
private Long rowCount;
private List<FilePartMetadata> parts;
}
@Data
public static class ColumnMetadata {
private String name;
private String type;
}
@Data
public static class FilePartMetadata {
private String fileName;
private String filePath;
private Long rowCount;
private Long fileSize;
}
private class PartWriter {
private final BufferedWriter writer;
private final Path filePath;
private final FilePartMetadata part;
private PartWriter(BufferedWriter writer, Path filePath, FilePartMetadata part) {
this.writer = writer;
this.filePath = filePath;
this.part = part;
}
private FilePartMetadata getPart() {
return part;
}
private boolean shouldRotate(long maxPartBytes) throws IOException {
writer.flush();
return part.getRowCount() > 0 && Files.size(filePath) >= maxPartBytes;
}
private void writeRow(ResultSet resultSet, int columnCount) throws Exception {
for (int i = 1; i <= columnCount; i++) {
if (i > 1) {
writer.write(",");
}
writer.write(escape(resultSet.getString(i)));
}
writer.newLine();
part.setRowCount(part.getRowCount() + 1);
}
private void close() throws IOException {
writer.close();
part.setFileSize(Files.exists(filePath) ? Files.size(filePath) : 0L);
}
}
}

View File

@@ -0,0 +1,89 @@
package com.njcn.gather.systemops.database.component;
import cn.hutool.core.util.StrUtil;
import com.njcn.gather.systemops.database.constant.DatabaseOpsConst;
import com.njcn.gather.systemops.database.pojo.po.DatabaseConnection;
import com.njcn.gather.systemops.database.pojo.vo.DatabaseTableVO;
import com.njcn.gather.systemops.database.pojo.vo.DatabaseTestResultVO;
import org.springframework.stereotype.Component;
import java.sql.Connection;
import java.sql.DriverManager;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.Timestamp;
import java.util.ArrayList;
import java.util.List;
import java.util.Locale;
/**
* Oracle JDBC 连接与元数据探测组件。
*/
@Component
public class OracleJdbcComponent {
public DatabaseTestResultVO test(DatabaseConnection connection, String password) {
DatabaseTestResultVO result = new DatabaseTestResultVO();
try (Connection ignored = openConnection(connection, password)) {
result.setSuccess(true);
result.setMessage("连接成功");
} catch (Exception exception) {
result.setSuccess(false);
result.setMessage(exception.getMessage());
}
return result;
}
public List<DatabaseTableVO> listTables(DatabaseConnection connection, String password, String schemaName) throws Exception {
String owner = StrUtil.blankToDefault(schemaName, connection.getSchemaName());
if (StrUtil.isBlank(owner)) {
owner = connection.getUsername();
}
owner = owner.trim().toUpperCase(Locale.ROOT);
String sql = "SELECT t.owner, t.table_name, t.num_rows, o.last_ddl_time, c.comments "
+ "FROM all_tables t "
+ "LEFT JOIN all_tab_comments c "
+ "ON t.owner = c.owner AND t.table_name = c.table_name "
+ "LEFT JOIN all_objects o "
+ "ON t.owner = o.owner AND t.table_name = o.object_name AND o.object_type = 'TABLE' "
+ "WHERE t.owner = ? ORDER BY t.table_name";
try (Connection jdbcConnection = openConnection(connection, password);
PreparedStatement statement = jdbcConnection.prepareStatement(sql)) {
statement.setString(1, owner);
try (ResultSet resultSet = statement.executeQuery()) {
List<DatabaseTableVO> result = new ArrayList<>();
while (resultSet.next()) {
DatabaseTableVO table = new DatabaseTableVO();
table.setOwner(resultSet.getString("owner"));
table.setTableName(resultSet.getString("table_name"));
table.setEngine(DatabaseOpsConst.DB_TYPE_ORACLE);
table.setTableRows(getLongValue(resultSet, "num_rows"));
Timestamp updateTime = resultSet.getTimestamp("last_ddl_time");
table.setUpdateTime(updateTime == null ? null : updateTime.toLocalDateTime());
table.setComments(resultSet.getString("comments"));
result.add(table);
}
return result;
}
}
}
private Long getLongValue(ResultSet resultSet, String columnName) throws Exception {
long value = resultSet.getLong(columnName);
return resultSet.wasNull() ? null : value;
}
public Connection openConnection(DatabaseConnection connection, String password) throws Exception {
if (StrUtil.isBlank(password)) {
throw new IllegalArgumentException("数据库密码不能为空");
}
return DriverManager.getConnection(buildJdbcUrl(connection), connection.getUsername(), password);
}
public String buildJdbcUrl(DatabaseConnection connection) {
if (DatabaseOpsConst.CONNECT_TYPE_SID.equalsIgnoreCase(connection.getConnectType())) {
return "jdbc:oracle:thin:@" + connection.getHost() + ":" + connection.getPort() + ":" + connection.getSid();
}
return "jdbc:oracle:thin:@//" + connection.getHost() + ":" + connection.getPort() + "/" + connection.getServiceName();
}
}

View File

@@ -0,0 +1,37 @@
package com.njcn.gather.systemops.database.config;
import lombok.extern.slf4j.Slf4j;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.LinkedBlockingQueue;
import java.util.concurrent.ThreadPoolExecutor;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicInteger;
/**
* 数据库运维后台任务线程池。
*/
@Slf4j
@Configuration
public class DbmsExecutorConfig {
@Bean(name = "dbmsTaskExecutorService", destroyMethod = "shutdown")
public ExecutorService dbmsTaskExecutorService() {
AtomicInteger threadIndex = new AtomicInteger(1);
return new ThreadPoolExecutor(
1,
1,
30,
TimeUnit.SECONDS,
new LinkedBlockingQueue<Runnable>(8),
runnable -> {
Thread thread = new Thread(runnable);
thread.setName("dbms-task-" + threadIndex.getAndIncrement());
return thread;
},
(runnable, executor) -> log.warn("数据库运维任务线程池已满,拒绝新的任务")
);
}
}

View File

@@ -0,0 +1,30 @@
package com.njcn.gather.systemops.database.config;
import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
/**
* 数据库运维配置。
*/
@Data
@Component
@ConfigurationProperties(prefix = "dbms")
public class DbmsProperties {
private Backup backup = new Backup();
private Tools tools = new Tools();
@Data
public static class Backup {
private String storagePath = "D:/dbms-backup";
private Integer defaultMaxFileSizeMb = 512;
private Integer mysqlFetchSize = 1000;
}
@Data
public static class Tools {
private String expdpPath;
private String impdpPath;
}
}

View File

@@ -0,0 +1,21 @@
package com.njcn.gather.systemops.database.constant;
/**
* 数据库运维常量。
*/
public final class DatabaseOpsConst {
public static final String DB_TYPE_ORACLE = "ORACLE";
public static final String DB_TYPE_MYSQL = "MYSQL";
public static final String CONNECT_TYPE_SERVICE_NAME = "SERVICE_NAME";
public static final String CONNECT_TYPE_SID = "SID";
public static final String CONFIRM_DELETE = "确认删除";
public static final String CONFIRM_OVERWRITE = "确认覆盖";
public static final int STATE_DELETED = 0;
public static final int STATE_ENABLED = 1;
public static final int SAVE_PASSWORD_YES = 1;
public static final int SAVE_PASSWORD_NO = 0;
private DatabaseOpsConst() {
}
}

View File

@@ -0,0 +1,87 @@
package com.njcn.gather.systemops.database.controller;
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import com.njcn.common.pojo.annotation.OperateInfo;
import com.njcn.common.pojo.constant.OperateType;
import com.njcn.common.pojo.enums.common.LogEnum;
import com.njcn.common.pojo.enums.response.CommonResponseEnum;
import com.njcn.common.pojo.response.HttpResult;
import com.njcn.gather.systemops.database.pojo.param.DatabaseBackupParam;
import com.njcn.gather.systemops.database.pojo.vo.DatabaseBackupFileVO;
import com.njcn.gather.systemops.database.pojo.vo.DatabaseTaskCreateVO;
import com.njcn.gather.systemops.database.pojo.vo.DatabaseTaskVO;
import com.njcn.gather.systemops.database.service.DatabaseBackupFileService;
import com.njcn.gather.systemops.database.service.DatabaseOperationTaskService;
import com.njcn.web.controller.BaseController;
import com.njcn.web.utils.HttpResultUtil;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import lombok.RequiredArgsConstructor;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
/**
* 数据库备份接口。
*/
@Api(tags = "数据库备份")
@RestController
@RequestMapping("/database/backups")
@RequiredArgsConstructor
public class DatabaseBackupController extends BaseController {
private final DatabaseOperationTaskService databaseOperationTaskService;
private final DatabaseBackupFileService databaseBackupFileService;
@OperateInfo(info = LogEnum.BUSINESS_COMMON, operateType = OperateType.ADD)
@ApiOperation("创建备份任务")
@PostMapping("/create")
public HttpResult<DatabaseTaskCreateVO> create(@RequestBody @Validated DatabaseBackupParam.CreateParam param) {
String methodDescribe = getMethodDescribe("create");
return HttpResultUtil.assembleCommonResponseResult(CommonResponseEnum.SUCCESS, databaseOperationTaskService.createBackupTask(param), methodDescribe);
}
@OperateInfo(info = LogEnum.BUSINESS_COMMON)
@ApiOperation("查询备份任务")
@PostMapping("/tasks/list")
public HttpResult<Page<DatabaseTaskVO>> listTasks(@RequestBody @Validated DatabaseBackupParam.TaskQueryParam param) {
String methodDescribe = getMethodDescribe("listTasks");
return HttpResultUtil.assembleCommonResponseResult(CommonResponseEnum.SUCCESS, databaseOperationTaskService.listBackupTasks(param), methodDescribe);
}
@OperateInfo(info = LogEnum.BUSINESS_COMMON)
@ApiOperation("查询任务状态")
@GetMapping("/tasks/status")
public HttpResult<DatabaseTaskVO> status(@RequestParam("taskId") String taskId) {
String methodDescribe = getMethodDescribe("status");
return HttpResultUtil.assembleCommonResponseResult(CommonResponseEnum.SUCCESS, databaseOperationTaskService.getStatus(taskId), methodDescribe);
}
@OperateInfo(info = LogEnum.BUSINESS_COMMON, operateType = OperateType.UPDATE)
@ApiOperation("停止备份任务")
@PostMapping("/tasks/stop")
public HttpResult<Boolean> stop(@RequestBody @Validated DatabaseBackupParam.StopParam param) {
String methodDescribe = getMethodDescribe("stop");
return HttpResultUtil.assembleCommonResponseResult(CommonResponseEnum.SUCCESS, databaseOperationTaskService.stopBackupTask(param), methodDescribe);
}
@OperateInfo(info = LogEnum.BUSINESS_COMMON, operateType = OperateType.ADD)
@ApiOperation("重新开始备份任务")
@PostMapping("/tasks/restart")
public HttpResult<DatabaseTaskCreateVO> restart(@RequestBody @Validated DatabaseBackupParam.RestartParam param) {
String methodDescribe = getMethodDescribe("restart");
return HttpResultUtil.assembleCommonResponseResult(CommonResponseEnum.SUCCESS, databaseOperationTaskService.restartBackupTask(param), methodDescribe);
}
@OperateInfo(info = LogEnum.BUSINESS_COMMON)
@ApiOperation("查询备份文件")
@PostMapping("/files/list")
public HttpResult<Page<DatabaseBackupFileVO>> listFiles(@RequestBody @Validated DatabaseBackupParam.FileQueryParam param) {
String methodDescribe = getMethodDescribe("listFiles");
return HttpResultUtil.assembleCommonResponseResult(CommonResponseEnum.SUCCESS, databaseBackupFileService.listFiles(param), methodDescribe);
}
}

View File

@@ -0,0 +1,88 @@
package com.njcn.gather.systemops.database.controller;
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import com.njcn.common.pojo.annotation.OperateInfo;
import com.njcn.common.pojo.constant.OperateType;
import com.njcn.common.pojo.enums.common.LogEnum;
import com.njcn.common.pojo.enums.response.CommonResponseEnum;
import com.njcn.common.pojo.response.HttpResult;
import com.njcn.gather.systemops.database.pojo.param.DatabaseConnectionParam;
import com.njcn.gather.systemops.database.pojo.vo.DatabaseConnectionVO;
import com.njcn.gather.systemops.database.pojo.vo.DatabaseTableVO;
import com.njcn.gather.systemops.database.pojo.vo.DatabaseTestResultVO;
import com.njcn.gather.systemops.database.service.DatabaseConnectionService;
import com.njcn.web.controller.BaseController;
import com.njcn.web.utils.HttpResultUtil;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import lombok.RequiredArgsConstructor;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import java.util.List;
/**
* 数据库连接配置接口。
*/
@Api(tags = "数据库连接配置")
@RestController
@RequestMapping("/database/connections")
@RequiredArgsConstructor
public class DatabaseConnectionController extends BaseController {
private final DatabaseConnectionService databaseConnectionService;
@OperateInfo(info = LogEnum.BUSINESS_COMMON)
@ApiOperation("查询数据库连接配置")
@PostMapping("/list")
public HttpResult<Page<DatabaseConnectionVO>> list(@RequestBody @Validated DatabaseConnectionParam.QueryParam param) {
String methodDescribe = getMethodDescribe("list");
return HttpResultUtil.assembleCommonResponseResult(CommonResponseEnum.SUCCESS, databaseConnectionService.listConnections(param), methodDescribe);
}
@OperateInfo(info = LogEnum.BUSINESS_COMMON, operateType = OperateType.ADD)
@ApiOperation("新增数据库连接配置")
@PostMapping("/add")
public HttpResult<Boolean> add(@RequestBody @Validated DatabaseConnectionParam param) {
String methodDescribe = getMethodDescribe("add");
boolean result = databaseConnectionService.addConnection(param);
return HttpResultUtil.assembleCommonResponseResult(result ? CommonResponseEnum.SUCCESS : CommonResponseEnum.FAIL, result, methodDescribe);
}
@OperateInfo(info = LogEnum.BUSINESS_COMMON, operateType = OperateType.UPDATE)
@ApiOperation("修改数据库连接配置")
@PostMapping("/update")
public HttpResult<Boolean> update(@RequestBody @Validated DatabaseConnectionParam.UpdateParam param) {
String methodDescribe = getMethodDescribe("update");
boolean result = databaseConnectionService.updateConnection(param);
return HttpResultUtil.assembleCommonResponseResult(result ? CommonResponseEnum.SUCCESS : CommonResponseEnum.FAIL, result, methodDescribe);
}
@OperateInfo(info = LogEnum.BUSINESS_COMMON, operateType = OperateType.DELETE)
@ApiOperation("删除数据库连接配置")
@PostMapping("/delete")
public HttpResult<Boolean> delete(@RequestBody @Validated DatabaseConnectionParam.DeleteParam param) {
String methodDescribe = getMethodDescribe("delete");
boolean result = databaseConnectionService.deleteConnection(param);
return HttpResultUtil.assembleCommonResponseResult(result ? CommonResponseEnum.SUCCESS : CommonResponseEnum.FAIL, result, methodDescribe);
}
@OperateInfo(info = LogEnum.BUSINESS_COMMON)
@ApiOperation("测试数据库连接")
@PostMapping("/test")
public HttpResult<DatabaseTestResultVO> test(@RequestBody @Validated DatabaseConnectionParam.TestParam param) {
String methodDescribe = getMethodDescribe("test");
return HttpResultUtil.assembleCommonResponseResult(CommonResponseEnum.SUCCESS, databaseConnectionService.testConnection(param), methodDescribe);
}
@OperateInfo(info = LogEnum.BUSINESS_COMMON)
@ApiOperation("查询 Oracle 表列表")
@PostMapping("/tables")
public HttpResult<List<DatabaseTableVO>> tables(@RequestBody @Validated DatabaseConnectionParam.TablesParam param) {
String methodDescribe = getMethodDescribe("tables");
return HttpResultUtil.assembleCommonResponseResult(CommonResponseEnum.SUCCESS, databaseConnectionService.listTables(param), methodDescribe);
}
}

View File

@@ -0,0 +1,51 @@
package com.njcn.gather.systemops.database.controller;
import com.njcn.common.pojo.annotation.OperateInfo;
import com.njcn.common.pojo.constant.OperateType;
import com.njcn.common.pojo.enums.common.LogEnum;
import com.njcn.common.pojo.enums.response.CommonResponseEnum;
import com.njcn.common.pojo.response.HttpResult;
import com.njcn.gather.systemops.database.pojo.param.DatabaseDeleteParam;
import com.njcn.gather.systemops.database.service.DatabaseBackupFileService;
import com.njcn.gather.systemops.database.service.DatabaseOperationTaskService;
import com.njcn.web.controller.BaseController;
import com.njcn.web.utils.HttpResultUtil;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import lombok.RequiredArgsConstructor;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
/**
* 数据库运维删除接口。
*/
@Api(tags = "数据库运维删除")
@RestController
@RequestMapping("/database/delete")
@RequiredArgsConstructor
public class DatabaseDeleteController extends BaseController {
private final DatabaseBackupFileService databaseBackupFileService;
private final DatabaseOperationTaskService databaseOperationTaskService;
@OperateInfo(info = LogEnum.BUSINESS_COMMON, operateType = OperateType.DELETE)
@ApiOperation("删除备份文件")
@PostMapping("/backup-file")
public HttpResult<Boolean> deleteBackupFile(@RequestBody @Validated DatabaseDeleteParam.BackupFileParam param) {
String methodDescribe = getMethodDescribe("deleteBackupFile");
boolean result = databaseBackupFileService.deleteBackupFile(param.getBackupFileId(), param.getConfirmText());
return HttpResultUtil.assembleCommonResponseResult(result ? CommonResponseEnum.SUCCESS : CommonResponseEnum.FAIL, result, methodDescribe);
}
@OperateInfo(info = LogEnum.BUSINESS_COMMON, operateType = OperateType.DELETE)
@ApiOperation("删除任务记录")
@PostMapping("/task")
public HttpResult<Boolean> deleteTask(@RequestBody @Validated DatabaseDeleteParam.TaskParam param) {
String methodDescribe = getMethodDescribe("deleteTask");
boolean result = databaseOperationTaskService.deleteTask(param.getTaskId(), param.getConfirmText());
return HttpResultUtil.assembleCommonResponseResult(result ? CommonResponseEnum.SUCCESS : CommonResponseEnum.FAIL, result, methodDescribe);
}
}

View File

@@ -0,0 +1,53 @@
package com.njcn.gather.systemops.database.controller;
import com.njcn.common.pojo.annotation.OperateInfo;
import com.njcn.common.pojo.constant.OperateType;
import com.njcn.common.pojo.enums.common.LogEnum;
import com.njcn.common.pojo.enums.response.CommonResponseEnum;
import com.njcn.common.pojo.response.HttpResult;
import com.njcn.gather.systemops.database.pojo.param.DatabaseRestoreParam;
import com.njcn.gather.systemops.database.pojo.vo.DatabaseTaskCreateVO;
import com.njcn.gather.systemops.database.pojo.vo.DatabaseTaskVO;
import com.njcn.gather.systemops.database.service.DatabaseOperationTaskService;
import com.njcn.gather.systemops.database.service.DatabaseRestoreService;
import com.njcn.web.controller.BaseController;
import com.njcn.web.utils.HttpResultUtil;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import lombok.RequiredArgsConstructor;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
/**
* 数据库恢复接口。
*/
@Api(tags = "数据库恢复")
@RestController
@RequestMapping("/database/restores")
@RequiredArgsConstructor
public class DatabaseRestoreController extends BaseController {
private final DatabaseRestoreService databaseRestoreService;
private final DatabaseOperationTaskService databaseOperationTaskService;
@OperateInfo(info = LogEnum.BUSINESS_COMMON, operateType = OperateType.ADD)
@ApiOperation("创建恢复任务")
@PostMapping("/create")
public HttpResult<DatabaseTaskCreateVO> create(@RequestBody @Validated DatabaseRestoreParam.CreateParam param) {
String methodDescribe = getMethodDescribe("create");
return HttpResultUtil.assembleCommonResponseResult(CommonResponseEnum.SUCCESS, databaseRestoreService.createRestoreTask(param), methodDescribe);
}
@OperateInfo(info = LogEnum.BUSINESS_COMMON)
@ApiOperation("查询恢复任务状态")
@GetMapping("/tasks/status")
public HttpResult<DatabaseTaskVO> status(@RequestParam("taskId") String taskId) {
String methodDescribe = getMethodDescribe("status");
return HttpResultUtil.assembleCommonResponseResult(CommonResponseEnum.SUCCESS, databaseOperationTaskService.getStatus(taskId), methodDescribe);
}
}

View File

@@ -0,0 +1,10 @@
package com.njcn.gather.systemops.database.mapper;
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.njcn.gather.systemops.database.pojo.po.DatabaseBackupFile;
/**
* 数据库备份文件 Mapper。
*/
public interface DatabaseBackupFileMapper extends BaseMapper<DatabaseBackupFile> {
}

View File

@@ -0,0 +1,10 @@
package com.njcn.gather.systemops.database.mapper;
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.njcn.gather.systemops.database.pojo.po.DatabaseConnection;
/**
* 数据库连接配置 Mapper。
*/
public interface DatabaseConnectionMapper extends BaseMapper<DatabaseConnection> {
}

View File

@@ -0,0 +1,10 @@
package com.njcn.gather.systemops.database.mapper;
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.njcn.gather.systemops.database.pojo.po.DatabaseOperationTask;
/**
* 数据库运维任务 Mapper。
*/
public interface DatabaseOperationTaskMapper extends BaseMapper<DatabaseOperationTask> {
}

View File

@@ -0,0 +1,10 @@
package com.njcn.gather.systemops.database.mapper;
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.njcn.gather.systemops.database.pojo.po.DatabaseRestoreRecord;
/**
* 数据库恢复记录 Mapper。
*/
public interface DatabaseRestoreRecordMapper extends BaseMapper<DatabaseRestoreRecord> {
}

View File

@@ -0,0 +1,10 @@
package com.njcn.gather.systemops.database.pojo.enums;
/**
* 备份模式。
*/
public enum BackupModeEnum {
FULL_TABLE,
TIME_RANGE,
SIZE_SPLIT
}

View File

@@ -0,0 +1,9 @@
package com.njcn.gather.systemops.database.pojo.enums;
/**
* 备份策略。
*/
public enum BackupStrategyEnum {
DATA_PUMP,
JDBC_EXPORT
}

View File

@@ -0,0 +1,10 @@
package com.njcn.gather.systemops.database.pojo.enums;
/**
* 备份文件格式。
*/
public enum FileFormatEnum {
DMP,
SQL,
CSV
}

View File

@@ -0,0 +1,10 @@
package com.njcn.gather.systemops.database.pojo.enums;
/**
* 数据库运维操作类型。
*/
public enum OperationTypeEnum {
BACKUP,
RESTORE,
DELETE
}

View File

@@ -0,0 +1,11 @@
package com.njcn.gather.systemops.database.pojo.enums;
/**
* 恢复模式。
*/
public enum RestoreModeEnum {
SKIP,
APPEND,
TRUNCATE,
REPLACE
}

View File

@@ -0,0 +1,12 @@
package com.njcn.gather.systemops.database.pojo.enums;
/**
* 运维任务状态。
*/
public enum TaskStatusEnum {
WAITING,
RUNNING,
SUCCESS,
FAIL,
CANCELLED
}

View File

@@ -0,0 +1,85 @@
package com.njcn.gather.systemops.database.pojo.param;
import com.njcn.web.pojo.param.BaseParam;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;
import lombok.EqualsAndHashCode;
import javax.validation.constraints.NotBlank;
import java.time.LocalDateTime;
import java.util.List;
/**
* 数据库备份参数。
*/
public class DatabaseBackupParam {
@Data
@ApiModel("创建备份任务参数")
public static class CreateParam {
@ApiModelProperty("连接 ID")
@NotBlank(message = "连接 ID 不能为空")
private String connectionId;
@ApiModelProperty("备份策略DATA_PUMP、JDBC_EXPORT默认 DATA_PUMP")
private String backupStrategy;
@ApiModelProperty("Schema")
private String schemaName;
@ApiModelProperty("表名列表")
private List<String> targetNames;
@ApiModelProperty("备份模式FULL_TABLE、TIME_RANGE、SIZE_SPLIT")
private String backupMode;
@ApiModelProperty("时间字段")
private String timeColumn;
@ApiModelProperty("开始时间")
private LocalDateTime startTime;
@ApiModelProperty("结束时间")
private LocalDateTime endTime;
@ApiModelProperty("最大文件大小 MB")
private Integer maxFileSizeMb;
@ApiModelProperty("Oracle Directory 名称")
private String directoryName;
@ApiModelProperty("临时密码,不保存密码时传入")
private String temporaryPassword;
}
@Data
@EqualsAndHashCode(callSuper = true)
@ApiModel("备份任务查询参数")
public static class TaskQueryParam extends BaseParam {
@ApiModelProperty("连接 ID")
private String connectionId;
@ApiModelProperty("任务状态")
private String taskStatus;
}
@Data
@EqualsAndHashCode(callSuper = true)
@ApiModel("备份文件查询参数")
public static class FileQueryParam extends BaseParam {
@ApiModelProperty("连接 ID")
private String connectionId;
@ApiModelProperty("任务 ID")
private String taskId;
@ApiModelProperty("备份策略")
private String backupStrategy;
}
@Data
@ApiModel("停止备份任务参数")
public static class StopParam {
@ApiModelProperty("备份任务 ID")
@NotBlank(message = "备份任务 ID 不能为空")
private String taskId;
}
@Data
@ApiModel("重新开始备份任务参数")
public static class RestartParam {
@ApiModelProperty("备份任务 ID")
@NotBlank(message = "备份任务 ID 不能为空")
private String taskId;
@ApiModelProperty("临时密码,原连接未保存密码时传入")
private String temporaryPassword;
}
}

View File

@@ -0,0 +1,130 @@
package com.njcn.gather.systemops.database.pojo.param;
import com.fasterxml.jackson.annotation.JsonAlias;
import com.njcn.web.pojo.param.BaseParam;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;
import lombok.EqualsAndHashCode;
import javax.validation.constraints.NotBlank;
import javax.validation.constraints.NotNull;
/**
* 数据库连接配置参数。
*/
@Data
@ApiModel("数据库连接配置参数")
public class DatabaseConnectionParam {
@ApiModelProperty("连接名称")
@NotBlank(message = "连接名称不能为空")
private String connectionName;
@ApiModelProperty("数据库类型ORACLE、MYSQL")
private String dbType;
@ApiModelProperty("数据库主机地址")
@NotBlank(message = "数据库主机地址不能为空")
private String host;
@ApiModelProperty("数据库端口")
@NotNull(message = "数据库端口不能为空")
private Integer port;
@ApiModelProperty("连接类型SERVICE_NAME、SID")
private String connectType;
@ApiModelProperty("服务名")
private String serviceName;
@ApiModelProperty("SID")
private String sid;
@ApiModelProperty("数据库名MySQL 使用")
private String databaseName;
@ApiModelProperty("Schema")
private String schemaName;
@ApiModelProperty("用户名")
@NotBlank(message = "用户名不能为空")
private String username;
@ApiModelProperty("密码")
private String password;
@ApiModelProperty("是否保存密码0-否1-是")
private Integer savePassword;
@ApiModelProperty("Oracle Directory 名称")
private String directoryName;
@ApiModelProperty("Oracle Directory 物理路径")
private String directoryPath;
@ApiModelProperty("扩展配置 JSON")
private String extraConfigJson;
@ApiModelProperty("备注")
private String remark;
@Data
@EqualsAndHashCode(callSuper = true)
@ApiModel("数据库连接更新参数")
public static class UpdateParam extends DatabaseConnectionParam {
@ApiModelProperty("连接 ID")
@NotBlank(message = "连接 ID 不能为空")
private String id;
}
@Data
@EqualsAndHashCode(callSuper = true)
@ApiModel("数据库连接查询参数")
public static class QueryParam extends BaseParam {
@ApiModelProperty("连接名称")
private String connectionName;
@ApiModelProperty("数据库类型")
private String dbType;
@ApiModelProperty("Schema")
private String schemaName;
}
@Data
@ApiModel("数据库连接删除参数")
public static class DeleteParam {
@ApiModelProperty("连接 ID")
@NotBlank(message = "连接 ID 不能为空")
private String id;
}
@Data
@ApiModel("数据库连接测试参数")
public static class TestParam {
@ApiModelProperty("连接 ID已有连接测试时传入")
private String connectionId;
@ApiModelProperty("临时连接参数,新增前测试时传入")
private DatabaseConnectionParam connection;
@ApiModelProperty("临时密码,测试时允许只传该字段而不写入 connection.password")
private String temporaryPassword;
}
@Data
@ApiModel("数据库表查询参数")
public static class TablesParam {
@ApiModelProperty("连接 ID")
@NotBlank(message = "连接 ID 不能为空")
private String connectionId;
@ApiModelProperty("临时密码,不保存密码时传入")
private String temporaryPassword;
@ApiModelProperty("兼容前端传入的运行时密码;为空时复用数据库 password_cipher")
private String password;
@JsonAlias("password_cipher")
@ApiModelProperty("兼容前端传入的已保存密码")
private String passwordCipher;
@ApiModelProperty("兼容前端传入的临时连接参数")
private DatabaseConnectionParam connection;
@ApiModelProperty("Schema 或数据库名,不传则使用连接默认值")
private String schemaName;
}
}

View File

@@ -0,0 +1,33 @@
package com.njcn.gather.systemops.database.pojo.param;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;
import javax.validation.constraints.NotBlank;
/**
* 数据库运维删除参数。
*/
public class DatabaseDeleteParam {
@Data
@ApiModel("删除备份文件参数")
public static class BackupFileParam {
@ApiModelProperty("备份文件 ID")
@NotBlank(message = "备份文件 ID 不能为空")
private String backupFileId;
@ApiModelProperty("确认文案")
private String confirmText;
}
@Data
@ApiModel("删除任务参数")
public static class TaskParam {
@ApiModelProperty("任务 ID")
@NotBlank(message = "任务 ID 不能为空")
private String taskId;
@ApiModelProperty("确认文案")
private String confirmText;
}
}

View File

@@ -0,0 +1,32 @@
package com.njcn.gather.systemops.database.pojo.param;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;
import javax.validation.constraints.NotBlank;
/**
* 数据库恢复参数。
*/
public class DatabaseRestoreParam {
@Data
@ApiModel("创建恢复任务参数")
public static class CreateParam {
@ApiModelProperty("目标连接 ID")
@NotBlank(message = "连接 ID 不能为空")
private String connectionId;
@ApiModelProperty("备份文件 ID")
@NotBlank(message = "备份文件 ID 不能为空")
private String backupFileId;
@ApiModelProperty("恢复模式SKIP、APPEND、TRUNCATE、REPLACE")
private String restoreMode;
@ApiModelProperty("目标 Schema")
private String targetSchemaName;
@ApiModelProperty("临时密码,不保存密码时传入")
private String temporaryPassword;
@ApiModelProperty("覆盖确认文案")
private String overwriteConfirmText;
}
}

View File

@@ -0,0 +1,71 @@
package com.njcn.gather.systemops.database.pojo.po;
import com.baomidou.mybatisplus.annotation.TableField;
import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;
import lombok.Data;
import java.io.Serializable;
import java.time.LocalDateTime;
/**
* 数据库备份文件记录。
*/
@Data
@TableName("dbms_backup_file")
public class DatabaseBackupFile implements Serializable {
private static final long serialVersionUID = 3119981982091873277L;
@TableId("id")
private String id;
@TableField("task_id")
private String taskId;
@TableField("connection_id")
private String connectionId;
@TableField("db_type")
private String dbType;
@TableField("backup_strategy")
private String backupStrategy;
@TableField("file_format")
private String fileFormat;
@TableField("schema_name")
private String schemaName;
@TableField("target_names_json")
private String targetNamesJson;
@TableField("backup_mode")
private String backupMode;
@TableField("backup_start_time")
private LocalDateTime backupStartTime;
@TableField("backup_end_time")
private LocalDateTime backupEndTime;
@TableField("time_column")
private String timeColumn;
@TableField("directory_name")
private String directoryName;
@TableField("dump_file_name")
private String dumpFileName;
@TableField("log_file_name")
private String logFileName;
@TableField("file_name")
private String fileName;
@TableField("file_path")
private String filePath;
@TableField("log_file_path")
private String logFilePath;
@TableField("metadata_file_path")
private String metadataFilePath;
@TableField("file_size")
private Long fileSize;
@TableField("checksum")
private String checksum;
@TableField("state")
private Integer state;
@TableField("create_by")
private String createBy;
@TableField("create_time")
private LocalDateTime createTime;
@TableField("update_by")
private String updateBy;
@TableField("update_time")
private LocalDateTime updateTime;
}

View File

@@ -0,0 +1,69 @@
package com.njcn.gather.systemops.database.pojo.po;
import com.baomidou.mybatisplus.annotation.TableField;
import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;
import lombok.Data;
import java.io.Serializable;
import java.time.LocalDateTime;
/**
* 数据库连接配置。
*/
@Data
@TableName("dbms_connection")
public class DatabaseConnection implements Serializable {
private static final long serialVersionUID = -5821519248914313778L;
@TableId("id")
private String id;
@TableField("connection_name")
private String connectionName;
@TableField("db_type")
private String dbType;
@TableField("host")
private String host;
@TableField("port")
private Integer port;
@TableField("connect_type")
private String connectType;
@TableField("service_name")
private String serviceName;
@TableField("sid")
private String sid;
@TableField("database_name")
private String databaseName;
@TableField("schema_name")
private String schemaName;
@TableField("username")
private String username;
@TableField("password_cipher")
private String passwordCipher;
@TableField("save_password")
private Integer savePassword;
@TableField("directory_name")
private String directoryName;
@TableField("directory_path")
private String directoryPath;
@TableField("extra_config_json")
private String extraConfigJson;
@TableField("remark")
private String remark;
@TableField("last_test_status")
private String lastTestStatus;
@TableField("last_test_message")
private String lastTestMessage;
@TableField("last_test_time")
private LocalDateTime lastTestTime;
@TableField("state")
private Integer state;
@TableField("create_by")
private String createBy;
@TableField("create_time")
private LocalDateTime createTime;
@TableField("update_by")
private String updateBy;
@TableField("update_time")
private LocalDateTime updateTime;
}

View File

@@ -0,0 +1,58 @@
package com.njcn.gather.systemops.database.pojo.po;
import com.baomidou.mybatisplus.annotation.TableField;
import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;
import lombok.Data;
import java.io.Serializable;
import java.math.BigDecimal;
import java.time.LocalDateTime;
/**
* 数据库运维任务。
*/
@Data
@TableName("dbms_operation_task")
public class DatabaseOperationTask implements Serializable {
private static final long serialVersionUID = 1831235987236858769L;
@TableId("id")
private String id;
@TableField("task_no")
private String taskNo;
@TableField("connection_id")
private String connectionId;
@TableField("db_type")
private String dbType;
@TableField("operation_type")
private String operationType;
@TableField("backup_strategy")
private String backupStrategy;
@TableField("task_status")
private String taskStatus;
@TableField("schema_name")
private String schemaName;
@TableField("target_names_json")
private String targetNamesJson;
@TableField("request_param_json")
private String requestParamJson;
@TableField("result_message")
private String resultMessage;
@TableField("progress_percent")
private BigDecimal progressPercent;
@TableField("started_at")
private LocalDateTime startedAt;
@TableField("finished_at")
private LocalDateTime finishedAt;
@TableField("state")
private Integer state;
@TableField("create_by")
private String createBy;
@TableField("create_time")
private LocalDateTime createTime;
@TableField("update_by")
private String updateBy;
@TableField("update_time")
private LocalDateTime updateTime;
}

View File

@@ -0,0 +1,51 @@
package com.njcn.gather.systemops.database.pojo.po;
import com.baomidou.mybatisplus.annotation.TableField;
import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;
import lombok.Data;
import java.io.Serializable;
import java.time.LocalDateTime;
/**
* 数据库恢复记录。
*/
@Data
@TableName("dbms_restore_record")
public class DatabaseRestoreRecord implements Serializable {
private static final long serialVersionUID = -5638979151924581277L;
@TableId("id")
private String id;
@TableField("task_id")
private String taskId;
@TableField("backup_file_id")
private String backupFileId;
@TableField("connection_id")
private String connectionId;
@TableField("db_type")
private String dbType;
@TableField("restore_mode")
private String restoreMode;
@TableField("target_schema_name")
private String targetSchemaName;
@TableField("target_names_json")
private String targetNamesJson;
@TableField("table_exists_action")
private String tableExistsAction;
@TableField("overwrite_confirmed")
private Integer overwriteConfirmed;
@TableField("result_message")
private String resultMessage;
@TableField("state")
private Integer state;
@TableField("create_by")
private String createBy;
@TableField("create_time")
private LocalDateTime createTime;
@TableField("update_by")
private String updateBy;
@TableField("update_time")
private LocalDateTime updateTime;
}

View File

@@ -0,0 +1,29 @@
package com.njcn.gather.systemops.database.pojo.vo;
import lombok.Data;
import java.time.LocalDateTime;
/**
* 数据库备份文件响应。
*/
@Data
public class DatabaseBackupFileVO {
private String id;
private String taskId;
private String connectionId;
private String dbType;
private String backupStrategy;
private String fileFormat;
private String schemaName;
private String targetNamesJson;
private String backupMode;
private String fileName;
private String filePath;
private String logFileName;
private String logFilePath;
private Long fileSize;
private String checksum;
private Integer state;
private LocalDateTime createTime;
}

View File

@@ -0,0 +1,34 @@
package com.njcn.gather.systemops.database.pojo.vo;
import lombok.Data;
import java.time.LocalDateTime;
/**
* 数据库连接配置响应。
*/
@Data
public class DatabaseConnectionVO {
private String id;
private String connectionName;
private String dbType;
private String host;
private Integer port;
private String connectType;
private String serviceName;
private String sid;
private String databaseName;
private String schemaName;
private String username;
private Integer savePassword;
private String directoryName;
private String directoryPath;
private String extraConfigJson;
private String remark;
private String lastTestStatus;
private String lastTestMessage;
private LocalDateTime lastTestTime;
private Integer state;
private LocalDateTime createTime;
private LocalDateTime updateTime;
}

View File

@@ -0,0 +1,21 @@
package com.njcn.gather.systemops.database.pojo.vo;
import lombok.Data;
import java.time.LocalDateTime;
/**
* 数据库表信息。
*/
@Data
public class DatabaseTableVO {
private String owner;
private String tableName;
private Long autoIncrementValue = 0L;
private Long autoIncrement = 0L;
private LocalDateTime updateTime;
private Long dataLength;
private String engine;
private Long tableRows;
private String comments;
}

View File

@@ -0,0 +1,13 @@
package com.njcn.gather.systemops.database.pojo.vo;
import lombok.Data;
/**
* 运维任务创建结果。
*/
@Data
public class DatabaseTaskCreateVO {
private String taskId;
private String taskNo;
private String taskStatus;
}

View File

@@ -0,0 +1,28 @@
package com.njcn.gather.systemops.database.pojo.vo;
import lombok.Data;
import java.math.BigDecimal;
import java.time.LocalDateTime;
/**
* 数据库运维任务响应。
*/
@Data
public class DatabaseTaskVO {
private String id;
private String taskNo;
private String connectionId;
private String dbType;
private String operationType;
private String backupStrategy;
private String taskStatus;
private String schemaName;
private String targetNamesJson;
private String resultMessage;
private BigDecimal progressPercent;
private LocalDateTime startedAt;
private LocalDateTime finishedAt;
private LocalDateTime createTime;
private LocalDateTime updateTime;
}

View File

@@ -0,0 +1,12 @@
package com.njcn.gather.systemops.database.pojo.vo;
import lombok.Data;
/**
* 数据库连接测试结果。
*/
@Data
public class DatabaseTestResultVO {
private Boolean success;
private String message;
}

View File

@@ -0,0 +1,23 @@
package com.njcn.gather.systemops.database.service;
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import com.baomidou.mybatisplus.extension.service.IService;
import com.njcn.gather.systemops.database.pojo.param.DatabaseBackupParam;
import com.njcn.gather.systemops.database.pojo.po.DatabaseBackupFile;
import com.njcn.gather.systemops.database.pojo.vo.DatabaseBackupFileVO;
import java.nio.file.Path;
/**
* 数据库备份文件服务。
*/
public interface DatabaseBackupFileService extends IService<DatabaseBackupFile> {
Page<DatabaseBackupFileVO> listFiles(DatabaseBackupParam.FileQueryParam param);
boolean deleteBackupFile(String backupFileId, String confirmText);
void validateBackupFileReadable(DatabaseBackupFile backupFile);
Path resolveManagedPath(DatabaseBackupFile backupFile, String filePath);
}

View File

@@ -0,0 +1,33 @@
package com.njcn.gather.systemops.database.service;
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import com.baomidou.mybatisplus.extension.service.IService;
import com.njcn.gather.systemops.database.pojo.param.DatabaseConnectionParam;
import com.njcn.gather.systemops.database.pojo.po.DatabaseConnection;
import com.njcn.gather.systemops.database.pojo.vo.DatabaseConnectionVO;
import com.njcn.gather.systemops.database.pojo.vo.DatabaseTableVO;
import com.njcn.gather.systemops.database.pojo.vo.DatabaseTestResultVO;
import java.util.List;
/**
* 数据库连接配置服务。
*/
public interface DatabaseConnectionService extends IService<DatabaseConnection> {
Page<DatabaseConnectionVO> listConnections(DatabaseConnectionParam.QueryParam queryParam);
boolean addConnection(DatabaseConnectionParam param);
boolean updateConnection(DatabaseConnectionParam.UpdateParam param);
boolean deleteConnection(DatabaseConnectionParam.DeleteParam param);
DatabaseTestResultVO testConnection(DatabaseConnectionParam.TestParam param);
List<DatabaseTableVO> listTables(DatabaseConnectionParam.TablesParam param);
DatabaseConnection requireEnabled(String connectionId);
String resolvePassword(DatabaseConnection connection, String temporaryPassword);
}

View File

@@ -0,0 +1,28 @@
package com.njcn.gather.systemops.database.service;
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import com.baomidou.mybatisplus.extension.service.IService;
import com.njcn.gather.systemops.database.pojo.param.DatabaseBackupParam;
import com.njcn.gather.systemops.database.pojo.po.DatabaseOperationTask;
import com.njcn.gather.systemops.database.pojo.vo.DatabaseTaskCreateVO;
import com.njcn.gather.systemops.database.pojo.vo.DatabaseTaskVO;
/**
* 数据库运维任务服务。
*/
public interface DatabaseOperationTaskService extends IService<DatabaseOperationTask> {
DatabaseTaskCreateVO createBackupTask(DatabaseBackupParam.CreateParam param);
Page<DatabaseTaskVO> listBackupTasks(DatabaseBackupParam.TaskQueryParam param);
DatabaseTaskVO getStatus(String taskId);
boolean stopBackupTask(DatabaseBackupParam.StopParam param);
DatabaseTaskCreateVO restartBackupTask(DatabaseBackupParam.RestartParam param);
boolean deleteTask(String taskId, String confirmText);
boolean existsRunningTask(String connectionId);
}

View File

@@ -0,0 +1,14 @@
package com.njcn.gather.systemops.database.service;
import com.baomidou.mybatisplus.extension.service.IService;
import com.njcn.gather.systemops.database.pojo.param.DatabaseRestoreParam;
import com.njcn.gather.systemops.database.pojo.po.DatabaseRestoreRecord;
import com.njcn.gather.systemops.database.pojo.vo.DatabaseTaskCreateVO;
/**
* 数据库恢复服务。
*/
public interface DatabaseRestoreService extends IService<DatabaseRestoreRecord> {
DatabaseTaskCreateVO createRestoreTask(DatabaseRestoreParam.CreateParam param);
}

View File

@@ -0,0 +1,179 @@
package com.njcn.gather.systemops.database.service.impl;
import cn.hutool.core.bean.BeanUtil;
import cn.hutool.core.util.StrUtil;
import com.baomidou.mybatisplus.core.conditions.query.LambdaQueryWrapper;
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
import com.njcn.common.pojo.enums.response.CommonResponseEnum;
import com.njcn.common.pojo.exception.BusinessException;
import com.njcn.gather.systemops.database.config.DbmsProperties;
import com.njcn.gather.systemops.database.constant.DatabaseOpsConst;
import com.njcn.gather.systemops.database.mapper.DatabaseBackupFileMapper;
import com.njcn.gather.systemops.database.pojo.param.DatabaseBackupParam;
import com.njcn.gather.systemops.database.pojo.po.DatabaseBackupFile;
import com.njcn.gather.systemops.database.pojo.vo.DatabaseBackupFileVO;
import com.njcn.gather.systemops.database.service.DatabaseBackupFileService;
import com.njcn.gather.systemops.database.util.DatabaseChecksumUtil;
import com.njcn.gather.systemops.database.util.DatabasePathUtil;
import com.njcn.web.factory.PageFactory;
import lombok.RequiredArgsConstructor;
import org.springframework.stereotype.Service;
import org.springframework.transaction.annotation.Transactional;
import java.nio.file.Files;
import java.nio.file.Path;
import java.time.LocalDateTime;
import java.util.Comparator;
import java.util.stream.Collectors;
import java.util.stream.Stream;
/**
* 数据库备份文件服务实现。
*/
@Service
@RequiredArgsConstructor
public class DatabaseBackupFileServiceImpl extends ServiceImpl<DatabaseBackupFileMapper, DatabaseBackupFile> implements DatabaseBackupFileService {
private final DbmsProperties dbmsProperties;
@Override
public Page<DatabaseBackupFileVO> listFiles(DatabaseBackupParam.FileQueryParam param) {
DatabaseBackupParam.FileQueryParam query = param == null ? new DatabaseBackupParam.FileQueryParam() : param;
LambdaQueryWrapper<DatabaseBackupFile> wrapper = new LambdaQueryWrapper<>();
wrapper.eq(DatabaseBackupFile::getState, DatabaseOpsConst.STATE_ENABLED)
.eq(StrUtil.isNotBlank(query.getConnectionId()), DatabaseBackupFile::getConnectionId, query.getConnectionId())
.eq(StrUtil.isNotBlank(query.getTaskId()), DatabaseBackupFile::getTaskId, query.getTaskId())
.eq(StrUtil.isNotBlank(query.getBackupStrategy()), DatabaseBackupFile::getBackupStrategy, query.getBackupStrategy())
.orderByDesc(DatabaseBackupFile::getCreateTime);
Page<DatabaseBackupFile> page = this.page(new Page<>(PageFactory.getPageNum(query), PageFactory.getPageSize(query)), wrapper);
Page<DatabaseBackupFileVO> result = new Page<>(page.getCurrent(), page.getSize(), page.getTotal());
result.setRecords(page.getRecords().stream().map(this::toVO).collect(Collectors.toList()));
return result;
}
@Override
@Transactional(rollbackFor = Exception.class)
public boolean deleteBackupFile(String backupFileId, String confirmText) {
if (!DatabaseOpsConst.CONFIRM_DELETE.equals(confirmText)) {
throw new BusinessException(CommonResponseEnum.FAIL, "确认文案不正确");
}
DatabaseBackupFile file = this.lambdaQuery()
.eq(DatabaseBackupFile::getId, backupFileId)
.eq(DatabaseBackupFile::getState, DatabaseOpsConst.STATE_ENABLED)
.one();
if (file == null) {
throw new BusinessException(CommonResponseEnum.FAIL, "备份文件不存在或已删除");
}
deletePhysicalPath(file, file.getFilePath());
deletePhysicalPath(file, file.getLogFilePath());
deletePhysicalPath(file, file.getMetadataFilePath());
file.setState(DatabaseOpsConst.STATE_DELETED);
file.setUpdateTime(LocalDateTime.now());
return this.updateById(file);
}
@Override
public void validateBackupFileReadable(DatabaseBackupFile backupFile) {
validateReadablePath(backupFile, backupFile.getFilePath(), "备份文件", false, true);
validateReadablePath(backupFile, backupFile.getMetadataFilePath(), "备份元数据文件",
StrUtil.isBlank(backupFile.getMetadataFilePath()), false);
if (StrUtil.isBlank(backupFile.getChecksum())) {
throw new BusinessException(CommonResponseEnum.FAIL, "备份文件缺少校验值");
}
Path checksumPath = resolveChecksumPath(backupFile);
String actualChecksum = DatabaseChecksumUtil.sha256(checksumPath);
if (!backupFile.getChecksum().equalsIgnoreCase(actualChecksum)) {
throw new BusinessException(CommonResponseEnum.FAIL, "备份文件校验失败");
}
}
@Override
public Path resolveManagedPath(DatabaseBackupFile backupFile, String filePath) {
if (StrUtil.isBlank(filePath)) {
return null;
}
Path path = DatabasePathUtil.normalize(filePath);
if (path == null) {
return null;
}
Path storageRoot = DatabasePathUtil.normalize(dbmsProperties.getBackup().getStoragePath());
if (DatabasePathUtil.isUnder(path, storageRoot)) {
return path;
}
Path primaryFilePath = DatabasePathUtil.normalize(backupFile.getFilePath());
if (primaryFilePath != null) {
Path allowedRoot = Files.isDirectory(primaryFilePath) ? primaryFilePath : primaryFilePath.getParent();
if (allowedRoot != null && DatabasePathUtil.isUnder(path, allowedRoot)) {
return path;
}
}
throw new BusinessException(CommonResponseEnum.FAIL, "文件路径不在允许的备份目录内");
}
private Path resolveChecksumPath(DatabaseBackupFile backupFile) {
Path metadataPath = resolveManagedPath(backupFile, backupFile.getMetadataFilePath());
if (metadataPath != null && Files.exists(metadataPath) && !Files.isDirectory(metadataPath)) {
return metadataPath;
}
Path filePath = resolveManagedPath(backupFile, backupFile.getFilePath());
if (filePath == null || !Files.exists(filePath) || Files.isDirectory(filePath)) {
throw new BusinessException(CommonResponseEnum.FAIL, "备份校验文件不存在");
}
return filePath;
}
private void deletePhysicalPath(DatabaseBackupFile backupFile, String filePath) {
if (StrUtil.isBlank(filePath)) {
return;
}
try {
Path path = resolveManagedPath(backupFile, filePath);
if (path == null || !Files.exists(path)) {
return;
}
if (Files.isDirectory(path)) {
try (Stream<Path> paths = Files.walk(path)) {
paths.sorted(Comparator.reverseOrder()).forEach(this::deleteSinglePath);
}
} else {
Files.delete(path);
}
} catch (BusinessException exception) {
throw exception;
} catch (Exception exception) {
throw new BusinessException(CommonResponseEnum.FAIL, "删除物理文件失败:" + exception.getMessage());
}
}
private void deleteSinglePath(Path path) {
try {
Files.deleteIfExists(path);
} catch (Exception exception) {
throw new BusinessException(CommonResponseEnum.FAIL, "删除物理文件失败:" + exception.getMessage());
}
}
private void validateReadablePath(DatabaseBackupFile backupFile, String filePath, String fileType,
boolean allowBlank, boolean allowDirectory) {
if (StrUtil.isBlank(filePath)) {
if (allowBlank) {
return;
}
throw new BusinessException(CommonResponseEnum.FAIL, fileType + "路径不能为空");
}
Path path = resolveManagedPath(backupFile, filePath);
if (path == null || !Files.exists(path)) {
throw new BusinessException(CommonResponseEnum.FAIL, fileType + "不存在");
}
if (Files.isDirectory(path) && !allowDirectory) {
throw new BusinessException(CommonResponseEnum.FAIL, fileType + "不能是目录");
}
}
private DatabaseBackupFileVO toVO(DatabaseBackupFile file) {
DatabaseBackupFileVO vo = new DatabaseBackupFileVO();
BeanUtil.copyProperties(file, vo);
return vo;
}
}

View File

@@ -0,0 +1,287 @@
package com.njcn.gather.systemops.database.service.impl;
import cn.hutool.core.bean.BeanUtil;
import cn.hutool.core.util.StrUtil;
import com.baomidou.mybatisplus.core.conditions.query.LambdaQueryWrapper;
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
import com.njcn.common.pojo.enums.response.CommonResponseEnum;
import com.njcn.common.pojo.exception.BusinessException;
import com.njcn.gather.systemops.database.component.DatabasePasswordComponent;
import com.njcn.gather.systemops.database.constant.DatabaseOpsConst;
import com.njcn.gather.systemops.database.mapper.DatabaseConnectionMapper;
import com.njcn.gather.systemops.database.pojo.param.DatabaseConnectionParam;
import com.njcn.gather.systemops.database.pojo.po.DatabaseConnection;
import com.njcn.gather.systemops.database.pojo.vo.DatabaseConnectionVO;
import com.njcn.gather.systemops.database.pojo.vo.DatabaseTableVO;
import com.njcn.gather.systemops.database.pojo.vo.DatabaseTestResultVO;
import com.njcn.gather.systemops.database.service.DatabaseConnectionService;
import com.njcn.gather.systemops.database.service.DatabaseOperationTaskService;
import com.njcn.gather.systemops.database.support.spi.DatabaseConnectionOperator;
import com.njcn.gather.systemops.database.support.spi.DatabaseOperatorRegistry;
import com.njcn.gather.systemops.database.util.DatabaseOpsIdUtil;
import com.njcn.web.factory.PageFactory;
import lombok.RequiredArgsConstructor;
import org.springframework.beans.factory.ObjectProvider;
import org.springframework.stereotype.Service;
import org.springframework.transaction.annotation.Transactional;
import java.time.LocalDateTime;
import java.util.List;
import java.util.Locale;
import java.util.stream.Collectors;
/**
* 数据库连接配置服务实现。
*/
@Service
@RequiredArgsConstructor
public class DatabaseConnectionServiceImpl extends ServiceImpl<DatabaseConnectionMapper, DatabaseConnection> implements DatabaseConnectionService {
private final DatabasePasswordComponent databasePasswordComponent;
private final DatabaseOperatorRegistry databaseOperatorRegistry;
private final ObjectProvider<DatabaseOperationTaskService> databaseOperationTaskServiceProvider;
@Override
public Page<DatabaseConnectionVO> listConnections(DatabaseConnectionParam.QueryParam queryParam) {
DatabaseConnectionParam.QueryParam query = queryParam == null ? new DatabaseConnectionParam.QueryParam() : queryParam;
LambdaQueryWrapper<DatabaseConnection> wrapper = new LambdaQueryWrapper<>();
wrapper.eq(DatabaseConnection::getState, DatabaseOpsConst.STATE_ENABLED)
.like(StrUtil.isNotBlank(query.getConnectionName()), DatabaseConnection::getConnectionName, query.getConnectionName())
.eq(StrUtil.isNotBlank(query.getDbType()), DatabaseConnection::getDbType, query.getDbType())
.like(StrUtil.isNotBlank(query.getSchemaName()), DatabaseConnection::getSchemaName, query.getSchemaName())
.orderByDesc(DatabaseConnection::getUpdateTime);
Page<DatabaseConnection> page = this.page(new Page<>(PageFactory.getPageNum(query), PageFactory.getPageSize(query)), wrapper);
Page<DatabaseConnectionVO> result = new Page<>(page.getCurrent(), page.getSize(), page.getTotal());
result.setRecords(page.getRecords().stream().map(this::toVO).collect(Collectors.toList()));
return result;
}
@Override
@Transactional(rollbackFor = Exception.class)
public boolean addConnection(DatabaseConnectionParam param) {
DatabaseConnection connection = new DatabaseConnection();
fillConnection(connection, param, true);
checkConnectionNameUnique(connection.getConnectionName());
connection.setId(DatabaseOpsIdUtil.uuid());
connection.setState(DatabaseOpsConst.STATE_ENABLED);
connection.setCreateTime(LocalDateTime.now());
connection.setUpdateTime(LocalDateTime.now());
return this.save(connection);
}
@Override
@Transactional(rollbackFor = Exception.class)
public boolean updateConnection(DatabaseConnectionParam.UpdateParam param) {
DatabaseConnection connection = requireEnabled(param.getId());
fillConnection(connection, param, false);
connection.setUpdateTime(LocalDateTime.now());
return this.updateById(connection);
}
@Override
@Transactional(rollbackFor = Exception.class)
public boolean deleteConnection(DatabaseConnectionParam.DeleteParam param) {
requireEnabled(param.getId());
if (databaseOperationTaskServiceProvider.getObject().existsRunningTask(param.getId())) {
throw new BusinessException(CommonResponseEnum.FAIL, "存在运行中的任务,不能删除连接");
}
return this.lambdaUpdate()
.set(DatabaseConnection::getState, DatabaseOpsConst.STATE_DELETED)
.set(DatabaseConnection::getUpdateTime, LocalDateTime.now())
.eq(DatabaseConnection::getId, param.getId())
.update();
}
@Override
@Transactional(rollbackFor = Exception.class)
public DatabaseTestResultVO testConnection(DatabaseConnectionParam.TestParam param) {
DatabaseConnection connection = resolveTestConnection(param);
DatabaseConnectionOperator operator = databaseOperatorRegistry.getConnectionOperator(connection.getDbType());
DatabaseTestResultVO result = operator.test(connection, resolvePassword(connection, param.getTemporaryPassword()));
if (StrUtil.isNotBlank(connection.getId())) {
updateLastTestResult(connection.getId(), result);
}
return result;
}
@Override
public List<DatabaseTableVO> listTables(DatabaseConnectionParam.TablesParam param) {
DatabaseConnection connection = requireEnabled(param.getConnectionId());
try {
DatabaseConnectionOperator operator = databaseOperatorRegistry.getConnectionOperator(connection.getDbType());
String password = resolveTablesPassword(connection, param);
return operator.listTables(connection, password,
resolveSchemaOrDatabase(param, connection));
} catch (Exception exception) {
throw new BusinessException(CommonResponseEnum.FAIL, exception.getMessage());
}
}
@Override
public DatabaseConnection requireEnabled(String connectionId) {
if (StrUtil.isBlank(connectionId)) {
throw new BusinessException(CommonResponseEnum.FAIL, "连接 ID 不能为空");
}
DatabaseConnection connection = this.lambdaQuery()
.eq(DatabaseConnection::getId, connectionId)
.eq(DatabaseConnection::getState, DatabaseOpsConst.STATE_ENABLED)
.one();
if (connection == null) {
throw new BusinessException(CommonResponseEnum.FAIL, "数据库连接不存在或已删除");
}
return connection;
}
@Override
public String resolvePassword(DatabaseConnection connection, String temporaryPassword) {
try {
return databasePasswordComponent.resolveRuntimePassword(connection.getPasswordCipher(), temporaryPassword);
} catch (IllegalArgumentException exception) {
throw new BusinessException(CommonResponseEnum.FAIL, exception.getMessage());
}
}
private DatabaseConnection resolveTestConnection(DatabaseConnectionParam.TestParam param) {
if (StrUtil.isNotBlank(param.getConnectionId())) {
DatabaseConnection savedConnection = requireEnabled(param.getConnectionId());
if (param.getConnection() == null) {
return savedConnection;
}
DatabaseConnection connection = new DatabaseConnection();
fillConnection(connection, param.getConnection(), true, true);
connection.setId(savedConnection.getId());
if (StrUtil.isBlank(param.getConnection().getPassword())) {
// 已有连接测试编辑后参数时,未传密码则复用库里保存的密码。
connection.setPasswordCipher(savedConnection.getPasswordCipher());
}
return connection;
}
if (param.getConnection() == null) {
throw new BusinessException(CommonResponseEnum.FAIL, "连接测试参数不能为空");
}
DatabaseConnection connection = new DatabaseConnection();
fillConnection(connection, param.getConnection(), true, StrUtil.isNotBlank(param.getTemporaryPassword()));
return connection;
}
private void updateLastTestResult(String connectionId, DatabaseTestResultVO result) {
this.lambdaUpdate()
.set(DatabaseConnection::getLastTestStatus, Boolean.TRUE.equals(result.getSuccess()) ? "SUCCESS" : "FAIL")
.set(DatabaseConnection::getLastTestMessage, result.getMessage())
.set(DatabaseConnection::getLastTestTime, LocalDateTime.now())
.eq(DatabaseConnection::getId, connectionId)
.update();
}
private String resolveTablesPassword(DatabaseConnection connection, DatabaseConnectionParam.TablesParam param) {
if (StrUtil.isNotBlank(param.getTemporaryPassword())) {
return param.getTemporaryPassword();
}
if (StrUtil.isNotBlank(param.getPassword())) {
return param.getPassword();
}
if (param.getConnection() != null && StrUtil.isNotBlank(param.getConnection().getPassword())) {
return param.getConnection().getPassword();
}
if (StrUtil.isNotBlank(param.getPasswordCipher())) {
return databasePasswordComponent.resolveRuntimePassword(param.getPasswordCipher(), null);
}
return resolvePassword(connection, null);
}
private void fillConnection(DatabaseConnection connection, DatabaseConnectionParam param, boolean create) {
fillConnection(connection, param, create, false);
}
private void fillConnection(DatabaseConnection connection, DatabaseConnectionParam param, boolean create,
boolean allowTemporaryPasswordOnly) {
String dbType = resolveDbType(param.getDbType());
validateConnectionParam(param, dbType);
connection.setConnectionName(param.getConnectionName().trim());
connection.setDbType(dbType);
connection.setHost(param.getHost().trim());
connection.setPort(param.getPort());
connection.setConnectType(DatabaseOpsConst.DB_TYPE_ORACLE.equals(dbType) ? resolveConnectType(param.getConnectType()) : null);
connection.setServiceName(DatabaseOpsConst.DB_TYPE_ORACLE.equals(dbType) ? trimToNull(param.getServiceName()) : null);
connection.setSid(DatabaseOpsConst.DB_TYPE_ORACLE.equals(dbType) ? trimToNull(param.getSid()) : null);
connection.setDatabaseName(DatabaseOpsConst.DB_TYPE_MYSQL.equals(dbType) ? trimToNull(param.getDatabaseName()) : null);
connection.setSchemaName(trimToNull(param.getSchemaName()));
connection.setUsername(param.getUsername().trim());
connection.setSavePassword(param.getSavePassword() == null ? DatabaseOpsConst.SAVE_PASSWORD_YES : param.getSavePassword());
if (connection.getSavePassword() != DatabaseOpsConst.SAVE_PASSWORD_YES
&& connection.getSavePassword() != DatabaseOpsConst.SAVE_PASSWORD_NO) {
throw new BusinessException(CommonResponseEnum.FAIL, "savePassword 只能是 0 或 1");
}
if (DatabaseOpsConst.SAVE_PASSWORD_YES == connection.getSavePassword() && StrUtil.isNotBlank(param.getPassword())) {
connection.setPasswordCipher(databasePasswordComponent.encrypt(param.getPassword()));
}
if (DatabaseOpsConst.SAVE_PASSWORD_NO == connection.getSavePassword()) {
connection.setPasswordCipher(null);
} else if (create && StrUtil.isBlank(param.getPassword()) && !allowTemporaryPasswordOnly) {
throw new BusinessException(CommonResponseEnum.FAIL, "保存密码时密码不能为空");
}
connection.setDirectoryName(DatabaseOpsConst.DB_TYPE_ORACLE.equals(dbType) ? trimToNull(param.getDirectoryName()) : null);
connection.setDirectoryPath(DatabaseOpsConst.DB_TYPE_ORACLE.equals(dbType) ? trimToNull(param.getDirectoryPath()) : null);
connection.setExtraConfigJson(trimToNull(param.getExtraConfigJson()));
connection.setRemark(param.getRemark());
}
private void validateConnectionParam(DatabaseConnectionParam param, String dbType) {
if (DatabaseOpsConst.DB_TYPE_ORACLE.equals(dbType)) {
String connectType = resolveConnectType(param.getConnectType());
if (DatabaseOpsConst.CONNECT_TYPE_SERVICE_NAME.equals(connectType) && StrUtil.isBlank(param.getServiceName())) {
throw new BusinessException(CommonResponseEnum.FAIL, "SERVICE_NAME 连接方式下服务名不能为空");
}
if (DatabaseOpsConst.CONNECT_TYPE_SID.equals(connectType) && StrUtil.isBlank(param.getSid())) {
throw new BusinessException(CommonResponseEnum.FAIL, "SID 连接方式下 SID 不能为空");
}
return;
}
if (StrUtil.isBlank(param.getDatabaseName())) {
throw new BusinessException(CommonResponseEnum.FAIL, "MYSQL 数据库名不能为空");
}
}
/**
* 新增连接时,连接名称在有效记录中必须唯一。
*/
private void checkConnectionNameUnique(String connectionName) {
long count = this.lambdaQuery()
.eq(DatabaseConnection::getConnectionName, connectionName)
.eq(DatabaseConnection::getState, DatabaseOpsConst.STATE_ENABLED)
.count();
if (count > 0) {
throw new BusinessException(CommonResponseEnum.FAIL, "连接名称已存在");
}
}
private String resolveConnectType(String connectType) {
return StrUtil.blankToDefault(connectType, DatabaseOpsConst.CONNECT_TYPE_SERVICE_NAME).trim().toUpperCase(Locale.ROOT);
}
private String resolveDbType(String dbType) {
String resolved = StrUtil.blankToDefault(dbType, DatabaseOpsConst.DB_TYPE_ORACLE).trim().toUpperCase(Locale.ROOT);
if (!DatabaseOpsConst.DB_TYPE_ORACLE.equals(resolved) && !DatabaseOpsConst.DB_TYPE_MYSQL.equals(resolved)) {
throw new BusinessException(CommonResponseEnum.FAIL, "不支持的数据库类型:" + dbType);
}
return resolved;
}
private String resolveSchemaOrDatabase(DatabaseConnectionParam.TablesParam param, DatabaseConnection connection) {
if (DatabaseOpsConst.DB_TYPE_MYSQL.equals(connection.getDbType())) {
return StrUtil.blankToDefault(param.getSchemaName(), connection.getDatabaseName());
}
return param.getSchemaName();
}
private String trimToNull(String value) {
return StrUtil.isBlank(value) ? null : value.trim();
}
private DatabaseConnectionVO toVO(DatabaseConnection connection) {
DatabaseConnectionVO vo = new DatabaseConnectionVO();
BeanUtil.copyProperties(connection, vo);
return vo;
}
}

View File

@@ -0,0 +1,333 @@
package com.njcn.gather.systemops.database.service.impl;
import cn.hutool.core.bean.BeanUtil;
import cn.hutool.core.util.StrUtil;
import com.baomidou.mybatisplus.core.conditions.query.LambdaQueryWrapper;
import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.njcn.common.pojo.enums.response.CommonResponseEnum;
import com.njcn.common.pojo.exception.BusinessException;
import com.njcn.gather.systemops.database.constant.DatabaseOpsConst;
import com.njcn.gather.systemops.database.mapper.DatabaseOperationTaskMapper;
import com.njcn.gather.systemops.database.pojo.enums.BackupModeEnum;
import com.njcn.gather.systemops.database.pojo.enums.BackupStrategyEnum;
import com.njcn.gather.systemops.database.pojo.enums.OperationTypeEnum;
import com.njcn.gather.systemops.database.pojo.enums.TaskStatusEnum;
import com.njcn.gather.systemops.database.pojo.param.DatabaseBackupParam;
import com.njcn.gather.systemops.database.pojo.po.DatabaseBackupFile;
import com.njcn.gather.systemops.database.pojo.po.DatabaseConnection;
import com.njcn.gather.systemops.database.pojo.po.DatabaseOperationTask;
import com.njcn.gather.systemops.database.pojo.vo.DatabaseTaskCreateVO;
import com.njcn.gather.systemops.database.pojo.vo.DatabaseTaskVO;
import com.njcn.gather.systemops.database.service.DatabaseBackupFileService;
import com.njcn.gather.systemops.database.service.DatabaseConnectionService;
import com.njcn.gather.systemops.database.service.DatabaseOperationTaskService;
import com.njcn.gather.systemops.database.support.spi.DatabaseBackupOperator;
import com.njcn.gather.systemops.database.support.spi.DatabaseOperatorRegistry;
import com.njcn.gather.systemops.database.util.DatabaseOpsIdUtil;
import com.njcn.web.factory.PageFactory;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Service;
import org.springframework.transaction.annotation.Transactional;
import javax.annotation.Resource;
import java.math.BigDecimal;
import java.time.LocalDateTime;
import java.util.Arrays;
import java.util.Locale;
import java.util.concurrent.ExecutorService;
import java.util.stream.Collectors;
/**
* 数据库运维任务服务实现。
*/
@Slf4j
@Service
@RequiredArgsConstructor
public class DatabaseOperationTaskServiceImpl extends ServiceImpl<DatabaseOperationTaskMapper, DatabaseOperationTask> implements DatabaseOperationTaskService {
private final DatabaseConnectionService databaseConnectionService;
private final DatabaseBackupFileService databaseBackupFileService;
private final DatabaseOperatorRegistry databaseOperatorRegistry;
private final ObjectMapper objectMapper;
@Resource(name = "dbmsTaskExecutorService")
private ExecutorService dbmsTaskExecutorService;
@Override
@Transactional(rollbackFor = Exception.class)
public DatabaseTaskCreateVO createBackupTask(DatabaseBackupParam.CreateParam param) {
DatabaseConnection connection = databaseConnectionService.requireEnabled(param.getConnectionId());
validateBackupParam(param, connection);
if (existsRunningTask(connection.getId())) {
throw new BusinessException(CommonResponseEnum.FAIL, "当前连接存在运行中的任务");
}
DatabaseOperationTask task = buildBackupTask(param, connection);
this.save(task);
dbmsTaskExecutorService.submit(() -> executeBackupTask(task.getId(), param));
return toCreateVO(task);
}
@Override
public Page<DatabaseTaskVO> listBackupTasks(DatabaseBackupParam.TaskQueryParam param) {
DatabaseBackupParam.TaskQueryParam query = param == null ? new DatabaseBackupParam.TaskQueryParam() : param;
LambdaQueryWrapper<DatabaseOperationTask> wrapper = new LambdaQueryWrapper<>();
wrapper.eq(DatabaseOperationTask::getState, DatabaseOpsConst.STATE_ENABLED)
.eq(DatabaseOperationTask::getOperationType, OperationTypeEnum.BACKUP.name())
.eq(StrUtil.isNotBlank(query.getConnectionId()), DatabaseOperationTask::getConnectionId, query.getConnectionId())
.eq(StrUtil.isNotBlank(query.getTaskStatus()), DatabaseOperationTask::getTaskStatus, query.getTaskStatus())
.orderByDesc(DatabaseOperationTask::getCreateTime);
Page<DatabaseOperationTask> page = this.page(new Page<>(PageFactory.getPageNum(query), PageFactory.getPageSize(query)), wrapper);
Page<DatabaseTaskVO> result = new Page<>(page.getCurrent(), page.getSize(), page.getTotal());
result.setRecords(page.getRecords().stream().map(this::toVO).collect(Collectors.toList()));
return result;
}
@Override
public DatabaseTaskVO getStatus(String taskId) {
return toVO(requireEnabledTask(taskId));
}
@Override
@Transactional(rollbackFor = Exception.class)
public boolean stopBackupTask(DatabaseBackupParam.StopParam param) {
DatabaseOperationTask task = requireEnabledTask(param.getTaskId());
if (!OperationTypeEnum.BACKUP.name().equals(task.getOperationType())) {
throw new BusinessException(CommonResponseEnum.FAIL, "仅支持停止备份任务");
}
if (!TaskStatusEnum.WAITING.name().equals(task.getTaskStatus())
&& !TaskStatusEnum.RUNNING.name().equals(task.getTaskStatus())) {
throw new BusinessException(CommonResponseEnum.FAIL, "仅等待中或运行中的任务允许停止");
}
task.setTaskStatus(TaskStatusEnum.CANCELLED.name());
task.setResultMessage("用户请求停止备份任务");
task.setFinishedAt(LocalDateTime.now());
task.setUpdateTime(LocalDateTime.now());
return this.updateById(task);
}
@Override
@Transactional(rollbackFor = Exception.class)
public DatabaseTaskCreateVO restartBackupTask(DatabaseBackupParam.RestartParam param) {
DatabaseOperationTask sourceTask = requireEnabledTask(param.getTaskId());
if (!OperationTypeEnum.BACKUP.name().equals(sourceTask.getOperationType())) {
throw new BusinessException(CommonResponseEnum.FAIL, "仅支持重新开始备份任务");
}
if (!TaskStatusEnum.FAIL.name().equals(sourceTask.getTaskStatus())
&& !TaskStatusEnum.CANCELLED.name().equals(sourceTask.getTaskStatus())) {
throw new BusinessException(CommonResponseEnum.FAIL, "仅失败或已取消的任务允许重新开始");
}
DatabaseBackupParam.CreateParam createParam = readCreateParam(sourceTask.getRequestParamJson());
createParam.setTemporaryPassword(param.getTemporaryPassword());
return createBackupTask(createParam);
}
@Override
@Transactional(rollbackFor = Exception.class)
public boolean deleteTask(String taskId, String confirmText) {
if (!DatabaseOpsConst.CONFIRM_DELETE.equals(confirmText)) {
throw new BusinessException(CommonResponseEnum.FAIL, "确认文案不正确");
}
DatabaseOperationTask task = requireEnabledTask(taskId);
if (TaskStatusEnum.RUNNING.name().equals(task.getTaskStatus()) || TaskStatusEnum.WAITING.name().equals(task.getTaskStatus())) {
throw new BusinessException(CommonResponseEnum.FAIL, "运行中的任务不能删除");
}
task.setState(DatabaseOpsConst.STATE_DELETED);
task.setUpdateTime(LocalDateTime.now());
return this.updateById(task);
}
@Override
public boolean existsRunningTask(String connectionId) {
return this.lambdaQuery()
.eq(DatabaseOperationTask::getConnectionId, connectionId)
.eq(DatabaseOperationTask::getState, DatabaseOpsConst.STATE_ENABLED)
.in(DatabaseOperationTask::getTaskStatus, Arrays.asList(TaskStatusEnum.WAITING.name(), TaskStatusEnum.RUNNING.name()))
.count() > 0;
}
private void executeBackupTask(String taskId, DatabaseBackupParam.CreateParam param) {
DatabaseOperationTask task = this.getById(taskId);
try {
if (task == null || TaskStatusEnum.CANCELLED.name().equals(task.getTaskStatus())) {
return;
}
markRunning(task);
DatabaseConnection connection = databaseConnectionService.requireEnabled(task.getConnectionId());
connection.setSchemaName(task.getSchemaName());
String password = databaseConnectionService.resolvePassword(connection, param.getTemporaryPassword());
DatabaseBackupOperator operator = databaseOperatorRegistry.getBackupOperator(connection.getDbType(), task.getBackupStrategy());
DatabaseBackupFile backupFile = operator.executeBackup(task, connection, password, param);
task = this.getById(taskId);
if (task == null || TaskStatusEnum.CANCELLED.name().equals(task.getTaskStatus())) {
return;
}
databaseBackupFileService.save(backupFile);
markSuccess(task, "备份任务执行成功");
} catch (Exception exception) {
log.error("数据库备份任务失败taskId={}", taskId, exception);
task = this.getById(taskId);
if (task != null && TaskStatusEnum.CANCELLED.name().equals(task.getTaskStatus())) {
markCancelled(task, exception.getMessage());
return;
}
markFail(task, exception.getMessage());
}
}
private DatabaseOperationTask buildBackupTask(DatabaseBackupParam.CreateParam param, DatabaseConnection connection) {
DatabaseOperationTask task = new DatabaseOperationTask();
task.setId(DatabaseOpsIdUtil.uuid());
task.setTaskNo(DatabaseOpsIdUtil.taskNo("DBMSB"));
task.setConnectionId(connection.getId());
task.setDbType(connection.getDbType());
task.setOperationType(OperationTypeEnum.BACKUP.name());
task.setBackupStrategy(resolveBackupStrategy(param.getBackupStrategy(), connection.getDbType()));
task.setTaskStatus(TaskStatusEnum.WAITING.name());
task.setSchemaName(resolveSchemaName(param, connection));
task.setTargetNamesJson(writeJson(param.getTargetNames()));
task.setRequestParamJson(writeJsonWithoutPassword(param));
task.setProgressPercent(BigDecimal.ZERO);
task.setState(DatabaseOpsConst.STATE_ENABLED);
task.setCreateTime(LocalDateTime.now());
task.setUpdateTime(LocalDateTime.now());
return task;
}
private void validateBackupParam(DatabaseBackupParam.CreateParam param, DatabaseConnection connection) {
if (param.getTargetNames() == null || param.getTargetNames().isEmpty()) {
throw new BusinessException(CommonResponseEnum.FAIL, "备份表不能为空");
}
if (DatabaseOpsConst.DB_TYPE_ORACLE.equals(connection.getDbType())
&& StrUtil.isBlank(StrUtil.blankToDefault(param.getSchemaName(), connection.getSchemaName()))) {
throw new BusinessException(CommonResponseEnum.FAIL, "备份 Schema 不能为空");
}
if (DatabaseOpsConst.DB_TYPE_MYSQL.equals(connection.getDbType()) && StrUtil.isBlank(connection.getDatabaseName())) {
throw new BusinessException(CommonResponseEnum.FAIL, "MYSQL 数据库名不能为空");
}
String backupMode = StrUtil.blankToDefault(param.getBackupMode(), BackupModeEnum.FULL_TABLE.name()).toUpperCase(Locale.ROOT);
if (BackupModeEnum.TIME_RANGE.name().equals(backupMode)
&& (param.getStartTime() == null || param.getEndTime() == null)) {
throw new BusinessException(CommonResponseEnum.FAIL, "按时间备份必须传入开始时间和结束时间");
}
if (BackupModeEnum.TIME_RANGE.name().equals(backupMode)
&& param.getStartTime() != null && param.getEndTime() != null
&& param.getStartTime().isAfter(param.getEndTime())) {
throw new BusinessException(CommonResponseEnum.FAIL, "开始时间不能晚于结束时间");
}
if (BackupModeEnum.SIZE_SPLIT.name().equals(backupMode)
&& (param.getMaxFileSizeMb() == null || param.getMaxFileSizeMb() <= 0)) {
throw new BusinessException(CommonResponseEnum.FAIL, "按大小分片必须传入大于 0 的文件大小");
}
if (BackupModeEnum.TIME_RANGE.name().equals(backupMode) && StrUtil.isBlank(param.getTimeColumn())) {
throw new BusinessException(CommonResponseEnum.FAIL, "按时间备份必须传入时间字段");
}
resolveBackupStrategy(param.getBackupStrategy(), connection.getDbType());
}
private String resolveBackupStrategy(String backupStrategy, String dbType) {
String value = StrUtil.blankToDefault(backupStrategy,
DatabaseOpsConst.DB_TYPE_ORACLE.equals(dbType) ? BackupStrategyEnum.DATA_PUMP.name() : BackupStrategyEnum.JDBC_EXPORT.name())
.trim()
.toUpperCase(Locale.ROOT);
try {
BackupStrategyEnum strategyEnum = BackupStrategyEnum.valueOf(value);
if (DatabaseOpsConst.DB_TYPE_MYSQL.equals(dbType) && BackupStrategyEnum.DATA_PUMP == strategyEnum) {
throw new BusinessException(CommonResponseEnum.FAIL, "MYSQL 不支持 DATA_PUMP");
}
return strategyEnum.name();
} catch (BusinessException exception) {
throw exception;
} catch (Exception exception) {
throw new BusinessException(CommonResponseEnum.FAIL, "不支持的备份策略:" + backupStrategy);
}
}
private String resolveSchemaName(DatabaseBackupParam.CreateParam param, DatabaseConnection connection) {
if (DatabaseOpsConst.DB_TYPE_MYSQL.equals(connection.getDbType())) {
return StrUtil.blankToDefault(param.getSchemaName(), connection.getDatabaseName());
}
return StrUtil.blankToDefault(param.getSchemaName(), connection.getSchemaName());
}
private void markRunning(DatabaseOperationTask task) {
task.setTaskStatus(TaskStatusEnum.RUNNING.name());
task.setStartedAt(LocalDateTime.now());
task.setUpdateTime(LocalDateTime.now());
this.updateById(task);
}
private void markSuccess(DatabaseOperationTask task, String message) {
task.setTaskStatus(TaskStatusEnum.SUCCESS.name());
task.setResultMessage(message);
task.setProgressPercent(new BigDecimal("100.00"));
task.setFinishedAt(LocalDateTime.now());
task.setUpdateTime(LocalDateTime.now());
this.updateById(task);
}
private void markFail(DatabaseOperationTask task, String message) {
if (task == null) {
return;
}
task.setTaskStatus(TaskStatusEnum.FAIL.name());
task.setResultMessage(message);
task.setFinishedAt(LocalDateTime.now());
task.setUpdateTime(LocalDateTime.now());
this.updateById(task);
}
private void markCancelled(DatabaseOperationTask task, String message) {
task.setTaskStatus(TaskStatusEnum.CANCELLED.name());
task.setResultMessage(StrUtil.blankToDefault(message, "备份任务已停止"));
task.setFinishedAt(LocalDateTime.now());
task.setUpdateTime(LocalDateTime.now());
this.updateById(task);
}
private DatabaseOperationTask requireEnabledTask(String taskId) {
DatabaseOperationTask task = this.getById(taskId);
if (task == null || !Integer.valueOf(DatabaseOpsConst.STATE_ENABLED).equals(task.getState())) {
throw new BusinessException(CommonResponseEnum.FAIL, "任务不存在或已删除");
}
return task;
}
private String writeJson(Object value) {
try {
return objectMapper.writeValueAsString(value);
} catch (Exception exception) {
throw new BusinessException(CommonResponseEnum.JSON_CONVERT_EXCEPTION, exception.getMessage());
}
}
private String writeJsonWithoutPassword(DatabaseBackupParam.CreateParam param) {
DatabaseBackupParam.CreateParam copy = new DatabaseBackupParam.CreateParam();
BeanUtil.copyProperties(param, copy);
copy.setTemporaryPassword(null);
return writeJson(copy);
}
private DatabaseBackupParam.CreateParam readCreateParam(String requestParamJson) {
try {
return objectMapper.readValue(requestParamJson, DatabaseBackupParam.CreateParam.class);
} catch (Exception exception) {
throw new BusinessException(CommonResponseEnum.JSON_CONVERT_EXCEPTION, exception.getMessage());
}
}
private DatabaseTaskCreateVO toCreateVO(DatabaseOperationTask task) {
DatabaseTaskCreateVO vo = new DatabaseTaskCreateVO();
vo.setTaskId(task.getId());
vo.setTaskNo(task.getTaskNo());
vo.setTaskStatus(task.getTaskStatus());
return vo;
}
private DatabaseTaskVO toVO(DatabaseOperationTask task) {
DatabaseTaskVO vo = new DatabaseTaskVO();
BeanUtil.copyProperties(task, vo);
return vo;
}
}

View File

@@ -0,0 +1,226 @@
package com.njcn.gather.systemops.database.service.impl;
import cn.hutool.core.util.StrUtil;
import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.njcn.common.pojo.enums.response.CommonResponseEnum;
import com.njcn.common.pojo.exception.BusinessException;
import com.njcn.gather.systemops.database.constant.DatabaseOpsConst;
import com.njcn.gather.systemops.database.mapper.DatabaseRestoreRecordMapper;
import com.njcn.gather.systemops.database.pojo.enums.BackupStrategyEnum;
import com.njcn.gather.systemops.database.pojo.enums.OperationTypeEnum;
import com.njcn.gather.systemops.database.pojo.enums.RestoreModeEnum;
import com.njcn.gather.systemops.database.pojo.enums.TaskStatusEnum;
import com.njcn.gather.systemops.database.pojo.param.DatabaseRestoreParam;
import com.njcn.gather.systemops.database.pojo.po.DatabaseBackupFile;
import com.njcn.gather.systemops.database.pojo.po.DatabaseConnection;
import com.njcn.gather.systemops.database.pojo.po.DatabaseOperationTask;
import com.njcn.gather.systemops.database.pojo.po.DatabaseRestoreRecord;
import com.njcn.gather.systemops.database.pojo.vo.DatabaseTaskCreateVO;
import com.njcn.gather.systemops.database.service.DatabaseBackupFileService;
import com.njcn.gather.systemops.database.service.DatabaseConnectionService;
import com.njcn.gather.systemops.database.service.DatabaseOperationTaskService;
import com.njcn.gather.systemops.database.service.DatabaseRestoreService;
import com.njcn.gather.systemops.database.support.spi.DatabaseConnectionOperator;
import com.njcn.gather.systemops.database.support.spi.DatabaseOperatorRegistry;
import com.njcn.gather.systemops.database.support.spi.DatabaseRestoreOperator;
import com.njcn.gather.systemops.database.util.DatabaseOpsIdUtil;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Service;
import org.springframework.transaction.annotation.Transactional;
import javax.annotation.Resource;
import java.math.BigDecimal;
import java.time.LocalDateTime;
import java.util.Locale;
import java.util.concurrent.ExecutorService;
/**
* 数据库恢复服务实现。
*/
@Slf4j
@Service
@RequiredArgsConstructor
public class DatabaseRestoreServiceImpl extends ServiceImpl<DatabaseRestoreRecordMapper, DatabaseRestoreRecord> implements DatabaseRestoreService {
private final DatabaseConnectionService databaseConnectionService;
private final DatabaseOperationTaskService databaseOperationTaskService;
private final DatabaseBackupFileService databaseBackupFileService;
private final DatabaseOperatorRegistry databaseOperatorRegistry;
private final ObjectMapper objectMapper;
@Resource(name = "dbmsTaskExecutorService")
private ExecutorService dbmsTaskExecutorService;
@Override
@Transactional(rollbackFor = Exception.class)
public DatabaseTaskCreateVO createRestoreTask(DatabaseRestoreParam.CreateParam param) {
DatabaseConnection connection = databaseConnectionService.requireEnabled(param.getConnectionId());
DatabaseBackupFile backupFile = requireBackupFile(param.getBackupFileId());
validateRestoreParam(param, connection, backupFile);
if (databaseOperationTaskService.existsRunningTask(connection.getId())) {
throw new BusinessException(CommonResponseEnum.FAIL, "当前连接存在运行中的任务");
}
DatabaseOperationTask task = buildRestoreTask(param, connection, backupFile);
databaseOperationTaskService.save(task);
DatabaseRestoreRecord record = buildRestoreRecord(param, connection, backupFile, task);
this.save(record);
dbmsTaskExecutorService.submit(() -> executeRestoreTask(task.getId(), record.getId(), param));
DatabaseTaskCreateVO vo = new DatabaseTaskCreateVO();
vo.setTaskId(task.getId());
vo.setTaskNo(task.getTaskNo());
vo.setTaskStatus(task.getTaskStatus());
return vo;
}
private void executeRestoreTask(String taskId, String recordId, DatabaseRestoreParam.CreateParam param) {
DatabaseOperationTask task = databaseOperationTaskService.getById(taskId);
DatabaseRestoreRecord record = this.getById(recordId);
try {
markRunning(task);
DatabaseConnection connection = databaseConnectionService.requireEnabled(task.getConnectionId());
DatabaseBackupFile backupFile = requireBackupFile(record.getBackupFileId());
databaseBackupFileService.validateBackupFileReadable(backupFile);
String password = databaseConnectionService.resolvePassword(connection, param.getTemporaryPassword());
DatabaseRestoreOperator operator = databaseOperatorRegistry.getRestoreOperator(connection.getDbType(), backupFile.getBackupStrategy());
operator.executeRestore(task, record, backupFile, connection, password, param);
record.setResultMessage("恢复任务执行成功");
record.setUpdateTime(LocalDateTime.now());
this.updateById(record);
markSuccess(task, "恢复任务执行成功");
} catch (Exception exception) {
log.error("数据库恢复任务失败taskId={}", taskId, exception);
record.setResultMessage(exception.getMessage());
record.setUpdateTime(LocalDateTime.now());
this.updateById(record);
markFail(task, exception.getMessage());
}
}
private void validateRestoreParam(DatabaseRestoreParam.CreateParam param, DatabaseConnection connection, DatabaseBackupFile backupFile) {
if (!connection.getDbType().equals(backupFile.getDbType())) {
throw new BusinessException(CommonResponseEnum.FAIL, "备份文件数据库类型和目标连接数据库类型不一致");
}
String restoreMode = resolveRestoreMode(param.getRestoreMode());
if ((RestoreModeEnum.TRUNCATE.name().equals(restoreMode) || RestoreModeEnum.REPLACE.name().equals(restoreMode))
&& !DatabaseOpsConst.CONFIRM_OVERWRITE.equals(param.getOverwriteConfirmText())) {
throw new BusinessException(CommonResponseEnum.FAIL, "覆盖类恢复必须输入确认覆盖");
}
databaseBackupFileService.validateBackupFileReadable(backupFile);
String password = databaseConnectionService.resolvePassword(connection, param.getTemporaryPassword());
DatabaseConnectionOperator operator = databaseOperatorRegistry.getConnectionOperator(connection.getDbType());
if (!Boolean.TRUE.equals(operator.test(connection, password).getSuccess())) {
throw new BusinessException(CommonResponseEnum.FAIL, "目标连接测试失败,不能创建恢复任务");
}
if (BackupStrategyEnum.DATA_PUMP.name().equals(backupFile.getBackupStrategy())) {
if (StrUtil.isBlank(backupFile.getDirectoryName()) || StrUtil.isBlank(backupFile.getDumpFileName())) {
throw new BusinessException(CommonResponseEnum.FAIL, "Data Pump 备份记录缺少目录或文件名");
}
}
if (BackupStrategyEnum.JDBC_EXPORT.name().equals(backupFile.getBackupStrategy())
&& StrUtil.isBlank(backupFile.getMetadataFilePath())) {
throw new BusinessException(CommonResponseEnum.FAIL, "JDBC_EXPORT 备份缺少元数据文件,不能恢复");
}
}
private DatabaseOperationTask buildRestoreTask(DatabaseRestoreParam.CreateParam param, DatabaseConnection connection, DatabaseBackupFile backupFile) {
DatabaseOperationTask task = new DatabaseOperationTask();
task.setId(DatabaseOpsIdUtil.uuid());
task.setTaskNo(DatabaseOpsIdUtil.taskNo("DBMSR"));
task.setConnectionId(connection.getId());
task.setDbType(connection.getDbType());
task.setOperationType(OperationTypeEnum.RESTORE.name());
task.setBackupStrategy(backupFile.getBackupStrategy());
task.setTaskStatus(TaskStatusEnum.WAITING.name());
task.setSchemaName(resolveTargetSchemaName(param, connection));
task.setTargetNamesJson(backupFile.getTargetNamesJson());
task.setRequestParamJson(writeJsonWithoutPassword(param));
task.setProgressPercent(BigDecimal.ZERO);
task.setState(DatabaseOpsConst.STATE_ENABLED);
task.setCreateTime(LocalDateTime.now());
task.setUpdateTime(LocalDateTime.now());
return task;
}
private DatabaseRestoreRecord buildRestoreRecord(DatabaseRestoreParam.CreateParam param, DatabaseConnection connection,
DatabaseBackupFile backupFile, DatabaseOperationTask task) {
String restoreMode = resolveRestoreMode(param.getRestoreMode());
DatabaseRestoreRecord record = new DatabaseRestoreRecord();
record.setId(DatabaseOpsIdUtil.uuid());
record.setTaskId(task.getId());
record.setBackupFileId(backupFile.getId());
record.setConnectionId(connection.getId());
record.setDbType(connection.getDbType());
record.setRestoreMode(restoreMode);
record.setTargetSchemaName(resolveTargetSchemaName(param, connection));
record.setTargetNamesJson(backupFile.getTargetNamesJson());
record.setTableExistsAction(restoreMode);
record.setOverwriteConfirmed(DatabaseOpsConst.CONFIRM_OVERWRITE.equals(param.getOverwriteConfirmText()) ? 1 : 0);
record.setState(DatabaseOpsConst.STATE_ENABLED);
record.setCreateTime(LocalDateTime.now());
record.setUpdateTime(LocalDateTime.now());
return record;
}
private String resolveTargetSchemaName(DatabaseRestoreParam.CreateParam param, DatabaseConnection connection) {
if (DatabaseOpsConst.DB_TYPE_MYSQL.equals(connection.getDbType())) {
return StrUtil.blankToDefault(param.getTargetSchemaName(), connection.getDatabaseName());
}
return StrUtil.blankToDefault(param.getTargetSchemaName(), connection.getSchemaName());
}
private DatabaseBackupFile requireBackupFile(String backupFileId) {
DatabaseBackupFile backupFile = databaseBackupFileService.getById(backupFileId);
if (backupFile == null || !Integer.valueOf(DatabaseOpsConst.STATE_ENABLED).equals(backupFile.getState())) {
throw new BusinessException(CommonResponseEnum.FAIL, "备份文件不存在或已删除");
}
return backupFile;
}
private String resolveRestoreMode(String restoreMode) {
String value = StrUtil.blankToDefault(restoreMode, RestoreModeEnum.SKIP.name()).trim().toUpperCase(Locale.ROOT);
try {
return RestoreModeEnum.valueOf(value).name();
} catch (Exception exception) {
throw new BusinessException(CommonResponseEnum.FAIL, "不支持的恢复模式:" + restoreMode);
}
}
private void markRunning(DatabaseOperationTask task) {
task.setTaskStatus(TaskStatusEnum.RUNNING.name());
task.setStartedAt(LocalDateTime.now());
task.setUpdateTime(LocalDateTime.now());
databaseOperationTaskService.updateById(task);
}
private void markSuccess(DatabaseOperationTask task, String message) {
task.setTaskStatus(TaskStatusEnum.SUCCESS.name());
task.setResultMessage(message);
task.setProgressPercent(new BigDecimal("100.00"));
task.setFinishedAt(LocalDateTime.now());
task.setUpdateTime(LocalDateTime.now());
databaseOperationTaskService.updateById(task);
}
private void markFail(DatabaseOperationTask task, String message) {
task.setTaskStatus(TaskStatusEnum.FAIL.name());
task.setResultMessage(message);
task.setFinishedAt(LocalDateTime.now());
task.setUpdateTime(LocalDateTime.now());
databaseOperationTaskService.updateById(task);
}
private String writeJsonWithoutPassword(DatabaseRestoreParam.CreateParam param) {
try {
DatabaseRestoreParam.CreateParam copy = new DatabaseRestoreParam.CreateParam();
copy.setConnectionId(param.getConnectionId());
copy.setBackupFileId(param.getBackupFileId());
copy.setRestoreMode(param.getRestoreMode());
copy.setTargetSchemaName(param.getTargetSchemaName());
copy.setOverwriteConfirmText(param.getOverwriteConfirmText());
return objectMapper.writeValueAsString(copy);
} catch (Exception exception) {
throw new BusinessException(CommonResponseEnum.JSON_CONVERT_EXCEPTION, exception.getMessage());
}
}
}

View File

@@ -0,0 +1,102 @@
package com.njcn.gather.systemops.database.support.mysql;
import cn.hutool.core.util.StrUtil;
import com.njcn.gather.systemops.database.constant.DatabaseOpsConst;
import com.njcn.gather.systemops.database.pojo.po.DatabaseConnection;
import com.njcn.gather.systemops.database.pojo.vo.DatabaseTableVO;
import com.njcn.gather.systemops.database.pojo.vo.DatabaseTestResultVO;
import com.njcn.gather.systemops.database.support.spi.DatabaseConnectionOperator;
import org.springframework.stereotype.Component;
import java.sql.Connection;
import java.sql.DriverManager;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.Timestamp;
import java.util.ArrayList;
import java.util.List;
import java.util.Locale;
/**
* MySQL 连接能力实现。
*/
@Component
public class MysqlConnectionOperator implements DatabaseConnectionOperator {
@Override
public boolean support(String dbType) {
return DatabaseOpsConst.DB_TYPE_MYSQL.equalsIgnoreCase(dbType);
}
@Override
public DatabaseTestResultVO test(DatabaseConnection connection, String password) {
DatabaseTestResultVO result = new DatabaseTestResultVO();
try (Connection ignored = openConnection(connection, password)) {
result.setSuccess(true);
result.setMessage("连接成功");
} catch (Exception exception) {
result.setSuccess(false);
result.setMessage(exception.getMessage());
}
return result;
}
@Override
public List<DatabaseTableVO> listTables(DatabaseConnection connection, String password, String schemaOrDatabaseName) throws Exception {
String databaseName = StrUtil.blankToDefault(schemaOrDatabaseName, connection.getDatabaseName());
String sql = "SELECT t.table_schema, t.table_name, t.auto_increment, t.update_time, "
+ "t.data_length, t.engine, t.table_rows, t.table_comment, "
+ "MAX(CASE WHEN c.extra LIKE '%auto_increment%' THEN 1 ELSE 0 END) AS has_auto_increment "
+ "FROM information_schema.tables t "
+ "LEFT JOIN information_schema.columns c "
+ "ON t.table_schema = c.table_schema AND t.table_name = c.table_name "
+ "WHERE t.table_schema = ? AND t.table_type = 'BASE TABLE' "
+ "GROUP BY t.table_schema, t.table_name, t.auto_increment, t.update_time, "
+ "t.data_length, t.engine, t.table_rows, t.table_comment "
+ "ORDER BY t.table_name";
try (Connection jdbcConnection = openConnection(connection, password);
PreparedStatement statement = jdbcConnection.prepareStatement(sql)) {
statement.setString(1, databaseName);
try (ResultSet resultSet = statement.executeQuery()) {
List<DatabaseTableVO> result = new ArrayList<>();
while (resultSet.next()) {
DatabaseTableVO table = new DatabaseTableVO();
table.setOwner(resultSet.getString("table_schema").toUpperCase(Locale.ROOT));
table.setTableName(resultSet.getString("table_name"));
if (resultSet.getInt("has_auto_increment") == 1) {
fillAutoIncrement(table, defaultZero(getLongValue(resultSet, "auto_increment")));
}
Timestamp updateTime = resultSet.getTimestamp("update_time");
table.setUpdateTime(updateTime == null ? null : updateTime.toLocalDateTime());
table.setDataLength(getLongValue(resultSet, "data_length"));
table.setEngine(resultSet.getString("engine"));
table.setTableRows(getLongValue(resultSet, "table_rows"));
table.setComments(resultSet.getString("table_comment"));
result.add(table);
}
return result;
}
}
}
private Long getLongValue(ResultSet resultSet, String columnName) throws Exception {
long value = resultSet.getLong(columnName);
return resultSet.wasNull() ? null : value;
}
private Long defaultZero(Long value) {
return value == null ? 0L : value;
}
private void fillAutoIncrement(DatabaseTableVO table, Long autoIncrement) {
table.setAutoIncrementValue(autoIncrement);
table.setAutoIncrement(autoIncrement);
}
private Connection openConnection(DatabaseConnection connection, String password) throws Exception {
if (StrUtil.isBlank(password)) {
throw new IllegalArgumentException("数据库密码不能为空");
}
return DriverManager.getConnection(MysqlJdbcUrlUtil.build(connection), connection.getUsername(), password);
}
}

View File

@@ -0,0 +1,146 @@
package com.njcn.gather.systemops.database.support.mysql;
import cn.hutool.core.util.StrUtil;
import com.njcn.common.pojo.enums.response.CommonResponseEnum;
import com.njcn.common.pojo.exception.BusinessException;
import com.njcn.gather.systemops.database.component.JdbcExportComponent;
import com.njcn.gather.systemops.database.config.DbmsProperties;
import com.njcn.gather.systemops.database.mapper.DatabaseOperationTaskMapper;
import com.njcn.gather.systemops.database.pojo.enums.BackupModeEnum;
import com.njcn.gather.systemops.database.pojo.enums.BackupStrategyEnum;
import com.njcn.gather.systemops.database.pojo.enums.FileFormatEnum;
import com.njcn.gather.systemops.database.pojo.enums.TaskStatusEnum;
import com.njcn.gather.systemops.database.pojo.param.DatabaseBackupParam;
import com.njcn.gather.systemops.database.pojo.po.DatabaseBackupFile;
import com.njcn.gather.systemops.database.pojo.po.DatabaseConnection;
import com.njcn.gather.systemops.database.pojo.po.DatabaseOperationTask;
import com.njcn.gather.systemops.database.support.spi.DatabaseBackupOperator;
import com.njcn.gather.systemops.database.util.DatabaseChecksumUtil;
import com.njcn.gather.systemops.database.util.DatabaseFileNameUtil;
import com.njcn.gather.systemops.database.util.DatabaseOpsIdUtil;
import com.njcn.gather.systemops.database.util.DatabasePathUtil;
import lombok.RequiredArgsConstructor;
import org.springframework.stereotype.Component;
import java.nio.file.Files;
import java.nio.file.Path;
import java.sql.Connection;
import java.sql.DriverManager;
import java.time.LocalDateTime;
import java.util.Locale;
import java.util.stream.Stream;
/**
* MySQL JDBC_EXPORT 大数据量备份实现。
*/
@Component
@RequiredArgsConstructor
public class MysqlJdbcExportBackupOperator implements DatabaseBackupOperator {
private final JdbcExportComponent jdbcExportComponent;
private final DbmsProperties dbmsProperties;
private final DatabaseOperationTaskMapper databaseOperationTaskMapper;
@Override
public boolean support(String dbType, String backupStrategy) {
return "MYSQL".equalsIgnoreCase(dbType) && BackupStrategyEnum.JDBC_EXPORT.name().equals(backupStrategy);
}
@Override
public DatabaseBackupFile executeBackup(DatabaseOperationTask task, DatabaseConnection connection, String password,
DatabaseBackupParam.CreateParam param) throws Exception {
Path backupDirectory = buildManagedPath(dbmsProperties.getBackup().getStoragePath(), task.getTaskNo());
String metadataFileName = DatabaseFileNameUtil.appendTodayWithTask("mysql_jdbc_export_metadata.json", task.getTaskNo());
Path metadataFilePath = backupDirectory.resolve(metadataFileName).normalize();
int fetchSize = positiveOrDefault(dbmsProperties.getBackup().getMysqlFetchSize(), 1000);
long maxPartBytes = resolveMaxPartBytes(param);
try (Connection jdbcConnection = DriverManager.getConnection(MysqlJdbcUrlUtil.build(connection), connection.getUsername(), password)) {
jdbcExportComponent.exportMysqlCsvV2(jdbcConnection, connection.getDatabaseName(), task.getTaskNo(), param,
backupDirectory, metadataFilePath, fetchSize, maxPartBytes, () -> isTaskCancelled(task.getId()));
} catch (Exception exception) {
throw new BusinessException(CommonResponseEnum.FAIL, exception.getMessage() + ",导出目录:" + backupDirectory);
}
return buildBackupFile(task, connection, param, backupDirectory, metadataFilePath);
}
private boolean isTaskCancelled(String taskId) {
DatabaseOperationTask task = databaseOperationTaskMapper.selectById(taskId);
return task != null && TaskStatusEnum.CANCELLED.name().equals(task.getTaskStatus());
}
private DatabaseBackupFile buildBackupFile(DatabaseOperationTask task, DatabaseConnection connection,
DatabaseBackupParam.CreateParam param, Path backupDirectory,
Path metadataFilePath) throws Exception {
if (!Files.exists(metadataFilePath)) {
throw new BusinessException(CommonResponseEnum.FAIL, "备份元数据文件未生成");
}
DatabaseBackupFile file = new DatabaseBackupFile();
file.setId(DatabaseOpsIdUtil.uuid());
file.setTaskId(task.getId());
file.setConnectionId(connection.getId());
file.setDbType(connection.getDbType());
file.setBackupStrategy(task.getBackupStrategy());
file.setFileFormat(FileFormatEnum.CSV.name());
file.setSchemaName(task.getSchemaName());
file.setTargetNamesJson(task.getTargetNamesJson());
file.setBackupMode(StrUtil.blankToDefault(param.getBackupMode(), BackupModeEnum.FULL_TABLE.name()).toUpperCase(Locale.ROOT));
file.setBackupStartTime(param.getStartTime());
file.setBackupEndTime(param.getEndTime());
file.setTimeColumn(param.getTimeColumn());
file.setDirectoryName(null);
file.setDumpFileName(null);
file.setLogFileName(null);
file.setFileName(backupDirectory.getFileName().toString());
file.setFilePath(backupDirectory.toString());
file.setLogFilePath(null);
file.setMetadataFilePath(metadataFilePath.toString());
file.setFileSize(readDirectoryFileSize(backupDirectory));
file.setChecksum(DatabaseChecksumUtil.sha256(metadataFilePath));
file.setState(1);
file.setCreateTime(LocalDateTime.now());
file.setUpdateTime(LocalDateTime.now());
return file;
}
private long resolveMaxPartBytes(DatabaseBackupParam.CreateParam param) {
Integer maxFileSizeMb = param.getMaxFileSizeMb();
if (maxFileSizeMb == null || maxFileSizeMb <= 0) {
maxFileSizeMb = positiveOrDefault(dbmsProperties.getBackup().getDefaultMaxFileSizeMb(), 512);
}
return maxFileSizeMb.longValue() * 1024L * 1024L;
}
private int positiveOrDefault(Integer value, int defaultValue) {
return value == null || value <= 0 ? defaultValue : value;
}
private Long readDirectoryFileSize(Path directory) {
try {
if (directory != null && Files.exists(directory) && Files.isDirectory(directory)) {
final long[] total = new long[]{0L};
try (Stream<Path> paths = Files.walk(directory)) {
paths.filter(path -> Files.exists(path) && !Files.isDirectory(path))
.forEach(path -> {
try {
total[0] += Files.size(path);
} catch (Exception ignored) {
// 忽略单个文件大小读取失败,避免影响备份记录生成。
}
});
}
return total[0];
}
} catch (Exception ignored) {
return null;
}
return null;
}
private Path buildManagedPath(String rootPath, String directoryName) {
Path root = DatabasePathUtil.normalize(rootPath);
if (root == null) {
throw new BusinessException(CommonResponseEnum.FAIL, "备份目录未配置");
}
return root.resolve(directoryName).normalize();
}
}

View File

@@ -0,0 +1,48 @@
package com.njcn.gather.systemops.database.support.mysql;
import com.njcn.gather.systemops.database.component.JdbcExportComponent;
import com.njcn.gather.systemops.database.pojo.enums.BackupStrategyEnum;
import com.njcn.gather.systemops.database.pojo.param.DatabaseRestoreParam;
import com.njcn.gather.systemops.database.pojo.po.DatabaseBackupFile;
import com.njcn.gather.systemops.database.pojo.po.DatabaseConnection;
import com.njcn.gather.systemops.database.pojo.po.DatabaseOperationTask;
import com.njcn.gather.systemops.database.pojo.po.DatabaseRestoreRecord;
import com.njcn.gather.systemops.database.service.DatabaseBackupFileService;
import com.njcn.gather.systemops.database.support.spi.DatabaseRestoreOperator;
import org.springframework.stereotype.Component;
import java.nio.file.Path;
import java.sql.Connection;
import java.sql.DriverManager;
/**
* MySQL JDBC_EXPORT 恢复实现。
*/
@Component
public class MysqlJdbcExportRestoreOperator implements DatabaseRestoreOperator {
private final JdbcExportComponent jdbcExportComponent;
private final DatabaseBackupFileService databaseBackupFileService;
public MysqlJdbcExportRestoreOperator(JdbcExportComponent jdbcExportComponent,
DatabaseBackupFileService databaseBackupFileService) {
this.jdbcExportComponent = jdbcExportComponent;
this.databaseBackupFileService = databaseBackupFileService;
}
@Override
public boolean support(String dbType, String backupStrategy) {
return "MYSQL".equalsIgnoreCase(dbType) && BackupStrategyEnum.JDBC_EXPORT.name().equals(backupStrategy);
}
@Override
public void executeRestore(DatabaseOperationTask task, DatabaseRestoreRecord record, DatabaseBackupFile backupFile,
DatabaseConnection connection, String password, DatabaseRestoreParam.CreateParam param) throws Exception {
Path dataFilePath = databaseBackupFileService.resolveManagedPath(backupFile, backupFile.getFilePath());
Path metadataFilePath = databaseBackupFileService.resolveManagedPath(backupFile, backupFile.getMetadataFilePath());
try (Connection jdbcConnection = DriverManager.getConnection(MysqlJdbcUrlUtil.build(connection), connection.getUsername(), password)) {
jdbcExportComponent.importCsv(jdbcConnection, dataFilePath, metadataFilePath,
connection.getDbType(), record.getRestoreMode(), null);
}
}
}

View File

@@ -0,0 +1,18 @@
package com.njcn.gather.systemops.database.support.mysql;
import com.njcn.gather.systemops.database.pojo.po.DatabaseConnection;
/**
* MySQL JDBC URL 构造工具。
*/
public final class MysqlJdbcUrlUtil {
private MysqlJdbcUrlUtil() {
}
public static String build(DatabaseConnection connection) {
return "jdbc:mysql://" + connection.getHost() + ":" + connection.getPort() + "/" + connection.getDatabaseName()
+ "?useUnicode=true&characterEncoding=utf-8&useSSL=false&serverTimezone=Asia/Shanghai"
+ "&useCursorFetch=true&connectTimeout=5000&socketTimeout=30000";
}
}

View File

@@ -0,0 +1,37 @@
package com.njcn.gather.systemops.database.support.oracle;
import com.njcn.gather.systemops.database.component.OracleJdbcComponent;
import com.njcn.gather.systemops.database.constant.DatabaseOpsConst;
import com.njcn.gather.systemops.database.pojo.po.DatabaseConnection;
import com.njcn.gather.systemops.database.pojo.vo.DatabaseTableVO;
import com.njcn.gather.systemops.database.pojo.vo.DatabaseTestResultVO;
import com.njcn.gather.systemops.database.support.spi.DatabaseConnectionOperator;
import lombok.RequiredArgsConstructor;
import org.springframework.stereotype.Component;
import java.util.List;
/**
* Oracle 连接能力实现。
*/
@Component
@RequiredArgsConstructor
public class OracleConnectionOperator implements DatabaseConnectionOperator {
private final OracleJdbcComponent oracleJdbcComponent;
@Override
public boolean support(String dbType) {
return DatabaseOpsConst.DB_TYPE_ORACLE.equalsIgnoreCase(dbType);
}
@Override
public DatabaseTestResultVO test(DatabaseConnection connection, String password) {
return oracleJdbcComponent.test(connection, password);
}
@Override
public List<DatabaseTableVO> listTables(DatabaseConnection connection, String password, String schemaOrDatabaseName) throws Exception {
return oracleJdbcComponent.listTables(connection, password, schemaOrDatabaseName);
}
}

View File

@@ -0,0 +1,122 @@
package com.njcn.gather.systemops.database.support.oracle;
import cn.hutool.core.util.StrUtil;
import com.njcn.common.pojo.enums.response.CommonResponseEnum;
import com.njcn.common.pojo.exception.BusinessException;
import com.njcn.gather.systemops.database.component.DataPumpCommandExecutor;
import com.njcn.gather.systemops.database.pojo.enums.BackupModeEnum;
import com.njcn.gather.systemops.database.pojo.enums.BackupStrategyEnum;
import com.njcn.gather.systemops.database.pojo.enums.FileFormatEnum;
import com.njcn.gather.systemops.database.pojo.param.DatabaseBackupParam;
import com.njcn.gather.systemops.database.pojo.po.DatabaseBackupFile;
import com.njcn.gather.systemops.database.pojo.po.DatabaseConnection;
import com.njcn.gather.systemops.database.pojo.po.DatabaseOperationTask;
import com.njcn.gather.systemops.database.service.DatabaseBackupFileService;
import com.njcn.gather.systemops.database.support.spi.DatabaseBackupOperator;
import com.njcn.gather.systemops.database.util.DatabaseChecksumUtil;
import com.njcn.gather.systemops.database.util.DatabaseFileNameUtil;
import com.njcn.gather.systemops.database.util.DatabaseOpsIdUtil;
import com.njcn.gather.systemops.database.util.DatabasePathUtil;
import lombok.RequiredArgsConstructor;
import org.springframework.stereotype.Component;
import java.nio.file.Files;
import java.nio.file.Path;
import java.time.LocalDateTime;
import java.util.Locale;
/**
* Oracle DATA_PUMP 备份实现。
*/
@Component
@RequiredArgsConstructor
public class OracleDataPumpBackupOperator implements DatabaseBackupOperator {
private final DataPumpCommandExecutor dataPumpCommandExecutor;
private final DatabaseBackupFileService databaseBackupFileService;
@Override
public boolean support(String dbType, String backupStrategy) {
return "ORACLE".equalsIgnoreCase(dbType) && BackupStrategyEnum.DATA_PUMP.name().equals(backupStrategy);
}
@Override
public DatabaseBackupFile executeBackup(DatabaseOperationTask task, DatabaseConnection connection, String password,
DatabaseBackupParam.CreateParam param) {
String directoryName = StrUtil.blankToDefault(param.getDirectoryName(), connection.getDirectoryName());
if (StrUtil.isBlank(directoryName)) {
throw new BusinessException(CommonResponseEnum.FAIL, "DATA_PUMP 备份需要 Oracle Directory 名称");
}
String baseName = buildBaseFileName(connection, task);
String dumpFileName = DatabaseFileNameUtil.appendTodayWithTask(baseName + ".dmp", task.getTaskNo());
String logFileName = DatabaseFileNameUtil.appendTodayWithTask(baseName + ".log", task.getTaskNo());
DataPumpCommandExecutor.CommandResult commandResult = dataPumpCommandExecutor.expdp(connection, password,
directoryName, dumpFileName, logFileName, param.getTargetNames());
if (!Boolean.TRUE.equals(commandResult.getSuccess())) {
throw new BusinessException(CommonResponseEnum.FAIL, "Data Pump 执行失败:" + commandResult.getOutput());
}
if (StrUtil.isBlank(connection.getDirectoryPath())) {
throw new BusinessException(CommonResponseEnum.FAIL, "Data Pump 备份需要配置可管理的 directoryPath");
}
Path dumpPath = buildManagedPath(connection.getDirectoryPath(), dumpFileName);
Path logPath = buildManagedPath(connection.getDirectoryPath(), logFileName);
return buildBackupFile(task, connection, param, FileFormatEnum.DMP.name(), dumpFileName, dumpPath, logFileName, logPath, null);
}
private DatabaseBackupFile buildBackupFile(DatabaseOperationTask task, DatabaseConnection connection,
DatabaseBackupParam.CreateParam param, String fileFormat, String fileName,
Path filePath, String logFileName, Path logFilePath, Path metadataFilePath) {
if (filePath == null || !Files.exists(filePath)) {
throw new BusinessException(CommonResponseEnum.FAIL, "备份文件未生成");
}
DatabaseBackupFile file = new DatabaseBackupFile();
file.setId(DatabaseOpsIdUtil.uuid());
file.setTaskId(task.getId());
file.setConnectionId(connection.getId());
file.setDbType(connection.getDbType());
file.setBackupStrategy(task.getBackupStrategy());
file.setFileFormat(fileFormat);
file.setSchemaName(task.getSchemaName());
file.setTargetNamesJson(task.getTargetNamesJson());
file.setBackupMode(StrUtil.blankToDefault(param.getBackupMode(), BackupModeEnum.FULL_TABLE.name()).toUpperCase(Locale.ROOT));
file.setBackupStartTime(param.getStartTime());
file.setBackupEndTime(param.getEndTime());
file.setTimeColumn(param.getTimeColumn());
file.setDirectoryName(StrUtil.blankToDefault(param.getDirectoryName(), connection.getDirectoryName()));
file.setDumpFileName(FileFormatEnum.DMP.name().equals(fileFormat) ? fileName : null);
file.setLogFileName(logFileName);
file.setFileName(fileName);
file.setFilePath(filePath.toString());
file.setLogFilePath(logFilePath == null ? null : logFilePath.toString());
file.setMetadataFilePath(metadataFilePath == null ? null : metadataFilePath.toString());
file.setFileSize(readFileSize(filePath));
file.setChecksum(DatabaseChecksumUtil.sha256(filePath));
file.setState(1);
file.setCreateTime(LocalDateTime.now());
file.setUpdateTime(LocalDateTime.now());
return file;
}
private Long readFileSize(Path filePath) {
try {
if (filePath != null && Files.exists(filePath) && !Files.isDirectory(filePath)) {
return Files.size(filePath);
}
} catch (Exception ignored) {
return null;
}
return null;
}
private Path buildManagedPath(String rootPath, String fileName) {
Path root = DatabasePathUtil.normalize(rootPath);
if (root == null) {
throw new BusinessException(CommonResponseEnum.FAIL, "备份目录未配置");
}
return root.resolve(fileName).normalize();
}
private String buildBaseFileName(DatabaseConnection connection, DatabaseOperationTask task) {
return connection.getSchemaName() + "_" + task.getBackupStrategy().toLowerCase(Locale.ROOT);
}
}

View File

@@ -0,0 +1,47 @@
package com.njcn.gather.systemops.database.support.oracle;
import com.njcn.common.pojo.enums.response.CommonResponseEnum;
import com.njcn.common.pojo.exception.BusinessException;
import com.njcn.gather.systemops.database.component.DataPumpCommandExecutor;
import com.njcn.gather.systemops.database.pojo.enums.BackupStrategyEnum;
import com.njcn.gather.systemops.database.pojo.param.DatabaseRestoreParam;
import com.njcn.gather.systemops.database.pojo.po.DatabaseBackupFile;
import com.njcn.gather.systemops.database.pojo.po.DatabaseConnection;
import com.njcn.gather.systemops.database.pojo.po.DatabaseOperationTask;
import com.njcn.gather.systemops.database.pojo.po.DatabaseRestoreRecord;
import com.njcn.gather.systemops.database.support.spi.DatabaseRestoreOperator;
import com.njcn.gather.systemops.database.util.DatabaseFileNameUtil;
import org.springframework.stereotype.Component;
/**
* Oracle DATA_PUMP 恢复实现。
*/
@Component
public class OracleDataPumpRestoreOperator implements DatabaseRestoreOperator {
private final DataPumpCommandExecutor dataPumpCommandExecutor;
public OracleDataPumpRestoreOperator(DataPumpCommandExecutor dataPumpCommandExecutor) {
this.dataPumpCommandExecutor = dataPumpCommandExecutor;
}
@Override
public boolean support(String dbType, String backupStrategy) {
return "ORACLE".equalsIgnoreCase(dbType) && BackupStrategyEnum.DATA_PUMP.name().equals(backupStrategy);
}
@Override
public void executeRestore(DatabaseOperationTask task, DatabaseRestoreRecord record, DatabaseBackupFile backupFile,
DatabaseConnection connection, String password, DatabaseRestoreParam.CreateParam param) {
DataPumpCommandExecutor.CommandResult result = dataPumpCommandExecutor.impdp(connection, password,
backupFile.getDirectoryName(), backupFile.getDumpFileName(), buildRestoreLogName(task),
record.getTableExistsAction());
if (!Boolean.TRUE.equals(result.getSuccess())) {
throw new BusinessException(CommonResponseEnum.FAIL, "Data Pump 恢复失败:" + result.getOutput());
}
}
private String buildRestoreLogName(DatabaseOperationTask task) {
return DatabaseFileNameUtil.appendTodayWithTask(task.getTaskNo() + "_restore.log", task.getTaskNo());
}
}

View File

@@ -0,0 +1,116 @@
package com.njcn.gather.systemops.database.support.oracle;
import cn.hutool.core.util.StrUtil;
import com.njcn.common.pojo.enums.response.CommonResponseEnum;
import com.njcn.common.pojo.exception.BusinessException;
import com.njcn.gather.systemops.database.component.JdbcExportComponent;
import com.njcn.gather.systemops.database.component.OracleJdbcComponent;
import com.njcn.gather.systemops.database.config.DbmsProperties;
import com.njcn.gather.systemops.database.pojo.enums.BackupModeEnum;
import com.njcn.gather.systemops.database.pojo.enums.BackupStrategyEnum;
import com.njcn.gather.systemops.database.pojo.enums.FileFormatEnum;
import com.njcn.gather.systemops.database.pojo.param.DatabaseBackupParam;
import com.njcn.gather.systemops.database.pojo.po.DatabaseBackupFile;
import com.njcn.gather.systemops.database.pojo.po.DatabaseConnection;
import com.njcn.gather.systemops.database.pojo.po.DatabaseOperationTask;
import com.njcn.gather.systemops.database.support.spi.DatabaseBackupOperator;
import com.njcn.gather.systemops.database.util.DatabaseChecksumUtil;
import com.njcn.gather.systemops.database.util.DatabaseFileNameUtil;
import com.njcn.gather.systemops.database.util.DatabaseOpsIdUtil;
import com.njcn.gather.systemops.database.util.DatabasePathUtil;
import lombok.RequiredArgsConstructor;
import org.springframework.stereotype.Component;
import java.nio.file.Files;
import java.nio.file.Path;
import java.sql.Connection;
import java.time.LocalDateTime;
import java.util.Locale;
/**
* Oracle JDBC_EXPORT 备份实现。
*/
@Component
@RequiredArgsConstructor
public class OracleJdbcExportBackupOperator implements DatabaseBackupOperator {
private final JdbcExportComponent jdbcExportComponent;
private final OracleJdbcComponent oracleJdbcComponent;
private final DbmsProperties dbmsProperties;
@Override
public boolean support(String dbType, String backupStrategy) {
return "ORACLE".equalsIgnoreCase(dbType) && BackupStrategyEnum.JDBC_EXPORT.name().equals(backupStrategy);
}
@Override
public DatabaseBackupFile executeBackup(DatabaseOperationTask task, DatabaseConnection connection, String password,
DatabaseBackupParam.CreateParam param) throws Exception {
String baseName = buildBaseFileName(connection, task);
String fileName = DatabaseFileNameUtil.appendTodayWithTask(baseName + ".csv", task.getTaskNo());
String metadataFileName = DatabaseFileNameUtil.appendTodayWithTask(baseName + "_metadata.json", task.getTaskNo());
Path dataFilePath = buildManagedPath(dbmsProperties.getBackup().getStoragePath(), fileName);
Path metadataFilePath = buildManagedPath(dbmsProperties.getBackup().getStoragePath(), metadataFileName);
try (Connection jdbcConnection = oracleJdbcComponent.openConnection(connection, password)) {
jdbcExportComponent.exportCsv(jdbcConnection, connection.getSchemaName(), param, dataFilePath, metadataFilePath);
}
return buildBackupFile(task, connection, param, fileName, dataFilePath, metadataFilePath);
}
private DatabaseBackupFile buildBackupFile(DatabaseOperationTask task, DatabaseConnection connection,
DatabaseBackupParam.CreateParam param, String fileName, Path filePath,
Path metadataFilePath) {
if (filePath == null || !Files.exists(filePath)) {
throw new BusinessException(CommonResponseEnum.FAIL, "备份文件未生成");
}
DatabaseBackupFile file = new DatabaseBackupFile();
file.setId(DatabaseOpsIdUtil.uuid());
file.setTaskId(task.getId());
file.setConnectionId(connection.getId());
file.setDbType(connection.getDbType());
file.setBackupStrategy(task.getBackupStrategy());
file.setFileFormat(FileFormatEnum.CSV.name());
file.setSchemaName(task.getSchemaName());
file.setTargetNamesJson(task.getTargetNamesJson());
file.setBackupMode(StrUtil.blankToDefault(param.getBackupMode(), BackupModeEnum.FULL_TABLE.name()).toUpperCase(Locale.ROOT));
file.setBackupStartTime(param.getStartTime());
file.setBackupEndTime(param.getEndTime());
file.setTimeColumn(param.getTimeColumn());
file.setDirectoryName(null);
file.setDumpFileName(null);
file.setLogFileName(null);
file.setFileName(fileName);
file.setFilePath(filePath.toString());
file.setLogFilePath(null);
file.setMetadataFilePath(metadataFilePath.toString());
file.setFileSize(readFileSize(filePath));
file.setChecksum(DatabaseChecksumUtil.sha256(filePath));
file.setState(1);
file.setCreateTime(LocalDateTime.now());
file.setUpdateTime(LocalDateTime.now());
return file;
}
private Long readFileSize(Path filePath) {
try {
if (filePath != null && Files.exists(filePath) && !Files.isDirectory(filePath)) {
return Files.size(filePath);
}
} catch (Exception ignored) {
return null;
}
return null;
}
private Path buildManagedPath(String rootPath, String fileName) {
Path root = DatabasePathUtil.normalize(rootPath);
if (root == null) {
throw new BusinessException(CommonResponseEnum.FAIL, "备份目录未配置");
}
return root.resolve(fileName).normalize();
}
private String buildBaseFileName(DatabaseConnection connection, DatabaseOperationTask task) {
return connection.getSchemaName() + "_" + task.getBackupStrategy().toLowerCase(Locale.ROOT);
}
}

View File

@@ -0,0 +1,51 @@
package com.njcn.gather.systemops.database.support.oracle;
import com.njcn.gather.systemops.database.component.JdbcExportComponent;
import com.njcn.gather.systemops.database.component.OracleJdbcComponent;
import com.njcn.gather.systemops.database.pojo.enums.BackupStrategyEnum;
import com.njcn.gather.systemops.database.pojo.param.DatabaseRestoreParam;
import com.njcn.gather.systemops.database.pojo.po.DatabaseBackupFile;
import com.njcn.gather.systemops.database.pojo.po.DatabaseConnection;
import com.njcn.gather.systemops.database.pojo.po.DatabaseOperationTask;
import com.njcn.gather.systemops.database.pojo.po.DatabaseRestoreRecord;
import com.njcn.gather.systemops.database.service.DatabaseBackupFileService;
import com.njcn.gather.systemops.database.support.spi.DatabaseRestoreOperator;
import org.springframework.stereotype.Component;
import java.nio.file.Path;
import java.sql.Connection;
/**
* Oracle JDBC_EXPORT 恢复实现。
*/
@Component
public class OracleJdbcExportRestoreOperator implements DatabaseRestoreOperator {
private final JdbcExportComponent jdbcExportComponent;
private final OracleJdbcComponent oracleJdbcComponent;
private final DatabaseBackupFileService databaseBackupFileService;
public OracleJdbcExportRestoreOperator(JdbcExportComponent jdbcExportComponent,
OracleJdbcComponent oracleJdbcComponent,
DatabaseBackupFileService databaseBackupFileService) {
this.jdbcExportComponent = jdbcExportComponent;
this.oracleJdbcComponent = oracleJdbcComponent;
this.databaseBackupFileService = databaseBackupFileService;
}
@Override
public boolean support(String dbType, String backupStrategy) {
return "ORACLE".equalsIgnoreCase(dbType) && BackupStrategyEnum.JDBC_EXPORT.name().equals(backupStrategy);
}
@Override
public void executeRestore(DatabaseOperationTask task, DatabaseRestoreRecord record, DatabaseBackupFile backupFile,
DatabaseConnection connection, String password, DatabaseRestoreParam.CreateParam param) throws Exception {
Path dataFilePath = databaseBackupFileService.resolveManagedPath(backupFile, backupFile.getFilePath());
Path metadataFilePath = databaseBackupFileService.resolveManagedPath(backupFile, backupFile.getMetadataFilePath());
try (Connection jdbcConnection = oracleJdbcComponent.openConnection(connection, password)) {
jdbcExportComponent.importCsv(jdbcConnection, dataFilePath, metadataFilePath,
connection.getDbType(), record.getRestoreMode(), record.getTargetSchemaName());
}
}
}

View File

@@ -0,0 +1,17 @@
package com.njcn.gather.systemops.database.support.spi;
import com.njcn.gather.systemops.database.pojo.param.DatabaseBackupParam;
import com.njcn.gather.systemops.database.pojo.po.DatabaseBackupFile;
import com.njcn.gather.systemops.database.pojo.po.DatabaseConnection;
import com.njcn.gather.systemops.database.pojo.po.DatabaseOperationTask;
/**
* 按数据库类型与备份策略隔离备份执行能力。
*/
public interface DatabaseBackupOperator {
boolean support(String dbType, String backupStrategy);
DatabaseBackupFile executeBackup(DatabaseOperationTask task, DatabaseConnection connection, String password,
DatabaseBackupParam.CreateParam param) throws Exception;
}

View File

@@ -0,0 +1,19 @@
package com.njcn.gather.systemops.database.support.spi;
import com.njcn.gather.systemops.database.pojo.po.DatabaseConnection;
import com.njcn.gather.systemops.database.pojo.vo.DatabaseTableVO;
import com.njcn.gather.systemops.database.pojo.vo.DatabaseTestResultVO;
import java.util.List;
/**
* 按数据库类型隔离连接测试与表查询能力。
*/
public interface DatabaseConnectionOperator {
boolean support(String dbType);
DatabaseTestResultVO test(DatabaseConnection connection, String password);
List<DatabaseTableVO> listTables(DatabaseConnection connection, String password, String schemaOrDatabaseName) throws Exception;
}

View File

@@ -0,0 +1,43 @@
package com.njcn.gather.systemops.database.support.spi;
import com.njcn.common.pojo.enums.response.CommonResponseEnum;
import com.njcn.common.pojo.exception.BusinessException;
import lombok.RequiredArgsConstructor;
import org.springframework.stereotype.Component;
import java.util.List;
/**
* 数据库能力路由注册器。
*/
@Component
@RequiredArgsConstructor
public class DatabaseOperatorRegistry {
private final List<DatabaseConnectionOperator> connectionOperators;
private final List<DatabaseBackupOperator> backupOperators;
private final List<DatabaseRestoreOperator> restoreOperators;
public DatabaseConnectionOperator getConnectionOperator(String dbType) {
return connectionOperators.stream()
.filter(operator -> operator.support(dbType))
.findFirst()
.orElseThrow(() -> new BusinessException(CommonResponseEnum.FAIL, "暂不支持的数据库类型:" + dbType));
}
public DatabaseBackupOperator getBackupOperator(String dbType, String backupStrategy) {
return backupOperators.stream()
.filter(operator -> operator.support(dbType, backupStrategy))
.findFirst()
.orElseThrow(() -> new BusinessException(CommonResponseEnum.FAIL,
"暂不支持的备份能力:" + dbType + "/" + backupStrategy));
}
public DatabaseRestoreOperator getRestoreOperator(String dbType, String backupStrategy) {
return restoreOperators.stream()
.filter(operator -> operator.support(dbType, backupStrategy))
.findFirst()
.orElseThrow(() -> new BusinessException(CommonResponseEnum.FAIL,
"暂不支持的恢复能力:" + dbType + "/" + backupStrategy));
}
}

View File

@@ -0,0 +1,18 @@
package com.njcn.gather.systemops.database.support.spi;
import com.njcn.gather.systemops.database.pojo.param.DatabaseRestoreParam;
import com.njcn.gather.systemops.database.pojo.po.DatabaseBackupFile;
import com.njcn.gather.systemops.database.pojo.po.DatabaseConnection;
import com.njcn.gather.systemops.database.pojo.po.DatabaseOperationTask;
import com.njcn.gather.systemops.database.pojo.po.DatabaseRestoreRecord;
/**
* 按数据库类型与备份策略隔离恢复执行能力。
*/
public interface DatabaseRestoreOperator {
boolean support(String dbType, String backupStrategy);
void executeRestore(DatabaseOperationTask task, DatabaseRestoreRecord record, DatabaseBackupFile backupFile,
DatabaseConnection connection, String password, DatabaseRestoreParam.CreateParam param) throws Exception;
}

View File

@@ -0,0 +1,37 @@
package com.njcn.gather.systemops.database.util;
import java.io.InputStream;
import java.nio.file.Files;
import java.nio.file.Path;
import java.security.MessageDigest;
/**
* 文件校验工具。
*/
public final class DatabaseChecksumUtil {
private DatabaseChecksumUtil() {
}
public static String sha256(Path path) {
if (path == null || !Files.exists(path) || Files.isDirectory(path)) {
return null;
}
try (InputStream inputStream = Files.newInputStream(path)) {
MessageDigest digest = MessageDigest.getInstance("SHA-256");
byte[] buffer = new byte[8192];
int length;
while ((length = inputStream.read(buffer)) != -1) {
digest.update(buffer, 0, length);
}
byte[] bytes = digest.digest();
StringBuilder builder = new StringBuilder();
for (byte item : bytes) {
builder.append(String.format("%02x", item));
}
return builder.toString();
} catch (Exception exception) {
return null;
}
}
}

View File

@@ -0,0 +1,37 @@
package com.njcn.gather.systemops.database.util;
import java.time.LocalDate;
import java.time.format.DateTimeFormatter;
/**
* 数据库运维文件名工具。
*/
public final class DatabaseFileNameUtil {
private static final DateTimeFormatter DATE_FORMATTER = DateTimeFormatter.ofPattern("yyyyMMdd");
private DatabaseFileNameUtil() {
}
public static String appendTodayWithTask(String fileName, String taskNo) {
String datedName = appendDate(fileName, LocalDate.now());
int dotIndex = datedName.lastIndexOf('.');
if (dotIndex > 0) {
return datedName.substring(0, dotIndex) + "_" + taskNo + datedName.substring(dotIndex);
}
return datedName + "_" + taskNo;
}
private static String appendDate(String fileName, LocalDate date) {
if (fileName == null || date == null) {
return fileName;
}
String dateText = DATE_FORMATTER.format(date);
int separatorIndex = Math.max(fileName.lastIndexOf('/'), fileName.lastIndexOf('\\'));
int dotIndex = fileName.lastIndexOf('.');
if (dotIndex > separatorIndex) {
return fileName.substring(0, dotIndex) + "_" + dateText + fileName.substring(dotIndex);
}
return fileName + "_" + dateText;
}
}

View File

@@ -0,0 +1,24 @@
package com.njcn.gather.systemops.database.util;
import java.time.LocalDateTime;
import java.time.format.DateTimeFormatter;
import java.util.UUID;
/**
* 数据库运维编号工具。
*/
public final class DatabaseOpsIdUtil {
private static final DateTimeFormatter TASK_FORMATTER = DateTimeFormatter.ofPattern("yyyyMMddHHmmssSSS");
private DatabaseOpsIdUtil() {
}
public static String uuid() {
return UUID.randomUUID().toString().replace("-", "");
}
public static String taskNo(String prefix) {
return prefix + LocalDateTime.now().format(TASK_FORMATTER);
}
}

View File

@@ -0,0 +1,31 @@
package com.njcn.gather.systemops.database.util;
import cn.hutool.core.util.StrUtil;
import java.nio.file.Path;
import java.nio.file.Paths;
/**
* 数据库运维文件路径工具。
*/
public final class DatabasePathUtil {
private DatabasePathUtil() {
}
public static Path normalize(String filePath) {
if (StrUtil.isBlank(filePath)) {
return null;
}
return Paths.get(filePath).toAbsolutePath().normalize();
}
public static boolean isUnder(Path path, Path root) {
if (path == null || root == null) {
return false;
}
Path normalizedPath = path.toAbsolutePath().normalize();
Path normalizedRoot = root.toAbsolutePath().normalize();
return normalizedPath.startsWith(normalizedRoot);
}
}

View File

@@ -0,0 +1,119 @@
CREATE TABLE IF NOT EXISTS `dbms_connection` (
`id` VARCHAR(64) NOT NULL COMMENT '主键',
`connection_name` VARCHAR(100) NOT NULL COMMENT '连接名称',
`db_type` VARCHAR(32) NOT NULL DEFAULT 'ORACLE' COMMENT '数据库类型ORACLE后续可扩展 MYSQL、INFLUXDB',
`host` VARCHAR(255) NOT NULL COMMENT '数据库主机地址',
`port` INT NOT NULL COMMENT '数据库端口',
`connect_type` VARCHAR(32) NULL COMMENT '连接类型SERVICE_NAME、SIDOracle 使用',
`service_name` VARCHAR(128) NULL COMMENT '服务名Oracle SERVICE_NAME 模式使用',
`sid` VARCHAR(128) NULL COMMENT 'SIDOracle SID 模式使用',
`database_name` VARCHAR(128) NULL COMMENT '数据库名或实例名,预留给 MySQL 等数据库使用',
`schema_name` VARCHAR(128) NULL COMMENT '默认 SchemaOracle 使用',
`username` VARCHAR(128) NOT NULL COMMENT '用户名',
`password_cipher` VARCHAR(1000) NULL COMMENT '保存的数据库密码;为空表示不保存密码,执行时临时输入',
`save_password` TINYINT NOT NULL DEFAULT 1 COMMENT '是否保存密码0-否1-是',
`directory_name` VARCHAR(128) NULL COMMENT '默认数据库目录对象名称Oracle Data Pump 使用',
`directory_path` VARCHAR(500) NULL COMMENT '目录对象对应物理路径,仅用于展示和校验',
`extra_config_json` JSON NULL COMMENT '扩展配置 JSON用于保存不同数据库的差异配置',
`remark` VARCHAR(500) NULL COMMENT '备注',
`last_test_status` VARCHAR(32) NULL COMMENT '最近连接测试状态SUCCESS、FAIL',
`last_test_message` VARCHAR(1000) NULL COMMENT '最近连接测试结果说明',
`last_test_time` DATETIME NULL COMMENT '最近连接测试时间',
`state` TINYINT NOT NULL DEFAULT 1 COMMENT '状态0-删除1-正常',
`create_by` VARCHAR(64) NULL COMMENT '创建人',
`create_time` DATETIME NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',
`update_by` VARCHAR(64) NULL COMMENT '更新人',
`update_time` DATETIME NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT '更新时间',
PRIMARY KEY (`id`),
KEY `idx_dbms_connection_state` (`state`),
KEY `idx_dbms_connection_db_type` (`db_type`),
KEY `idx_dbms_connection_name` (`connection_name`),
KEY `idx_dbms_connection_schema` (`schema_name`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COMMENT='数据库连接配置表';
CREATE TABLE IF NOT EXISTS `dbms_operation_task` (
`id` VARCHAR(64) NOT NULL COMMENT '主键',
`task_no` VARCHAR(64) NOT NULL COMMENT '任务编号',
`connection_id` VARCHAR(64) NOT NULL COMMENT '数据库连接配置 ID',
`db_type` VARCHAR(32) NOT NULL COMMENT '数据库类型ORACLE后续可扩展 MYSQL、INFLUXDB',
`operation_type` VARCHAR(32) NOT NULL COMMENT '操作类型BACKUP、RESTORE、DELETE',
`backup_strategy` VARCHAR(32) NULL COMMENT '备份策略DATA_PUMP、JDBC_EXPORT',
`task_status` VARCHAR(32) NOT NULL DEFAULT 'WAITING' COMMENT '任务状态WAITING、RUNNING、SUCCESS、FAIL、CANCELLED',
`schema_name` VARCHAR(128) NULL COMMENT '操作 Schema',
`target_names_json` JSON NULL COMMENT '操作对象名称列表 JSON例如表名列表',
`request_param_json` JSON NULL COMMENT '请求参数快照 JSON不保存运行时密码',
`result_message` VARCHAR(2000) NULL COMMENT '执行结果或失败原因',
`progress_percent` DECIMAL(5,2) NOT NULL DEFAULT 0.00 COMMENT '任务进度百分比',
`started_at` DATETIME NULL COMMENT '任务开始时间',
`finished_at` DATETIME NULL COMMENT '任务结束时间',
`state` TINYINT NOT NULL DEFAULT 1 COMMENT '状态0-删除1-正常',
`create_by` VARCHAR(64) NULL COMMENT '创建人',
`create_time` DATETIME NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',
`update_by` VARCHAR(64) NULL COMMENT '更新人',
`update_time` DATETIME NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT '更新时间',
PRIMARY KEY (`id`),
UNIQUE KEY `uk_dbms_operation_task_no` (`task_no`),
KEY `idx_dbms_operation_connection` (`connection_id`),
KEY `idx_dbms_operation_db_type` (`db_type`),
KEY `idx_dbms_operation_type_status` (`operation_type`, `task_status`),
KEY `idx_dbms_operation_create_time` (`create_time`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COMMENT='数据库运维任务表';
CREATE TABLE IF NOT EXISTS `dbms_backup_file` (
`id` VARCHAR(64) NOT NULL COMMENT '主键',
`task_id` VARCHAR(64) NOT NULL COMMENT '备份任务 ID',
`connection_id` VARCHAR(64) NOT NULL COMMENT '数据库连接配置 ID',
`db_type` VARCHAR(32) NOT NULL COMMENT '数据库类型ORACLE后续可扩展 MYSQL、INFLUXDB',
`backup_strategy` VARCHAR(32) NOT NULL COMMENT '备份策略DATA_PUMP、JDBC_EXPORT',
`file_format` VARCHAR(32) NOT NULL COMMENT '文件格式DMP、SQL、CSV',
`schema_name` VARCHAR(128) NULL COMMENT '备份 Schema',
`target_names_json` JSON NULL COMMENT '备份对象名称列表 JSON例如表名列表',
`backup_mode` VARCHAR(32) NOT NULL DEFAULT 'FULL_TABLE' COMMENT '备份模式FULL_TABLE、TIME_RANGE、SIZE_SPLIT',
`backup_start_time` DATETIME NULL COMMENT '按时间备份开始时间',
`backup_end_time` DATETIME NULL COMMENT '按时间备份结束时间',
`time_column` VARCHAR(128) NULL COMMENT '按时间备份使用的时间字段',
`directory_name` VARCHAR(128) NULL COMMENT '数据库目录对象名称Oracle Data Pump 使用',
`dump_file_name` VARCHAR(255) NULL COMMENT 'Data Pump dump 文件名',
`log_file_name` VARCHAR(255) NULL COMMENT 'Data Pump log 文件名',
`file_name` VARCHAR(255) NOT NULL COMMENT '主备份文件名,需包含 _yyyyMMdd',
`file_path` VARCHAR(1000) NOT NULL COMMENT '服务端记录的备份文件路径或目录对象映射路径',
`log_file_path` VARCHAR(1000) NULL COMMENT '备份日志文件路径',
`metadata_file_path` VARCHAR(1000) NULL COMMENT 'JDBC_EXPORT 元数据文件路径',
`file_size` BIGINT NULL COMMENT '文件大小,单位字节',
`checksum` VARCHAR(128) NULL COMMENT '文件校验值',
`state` TINYINT NOT NULL DEFAULT 1 COMMENT '状态0-删除1-正常',
`create_by` VARCHAR(64) NULL COMMENT '创建人',
`create_time` DATETIME NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',
`update_by` VARCHAR(64) NULL COMMENT '更新人',
`update_time` DATETIME NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT '更新时间',
PRIMARY KEY (`id`),
KEY `idx_dbms_backup_task` (`task_id`),
KEY `idx_dbms_backup_connection` (`connection_id`),
KEY `idx_dbms_backup_db_type` (`db_type`),
KEY `idx_dbms_backup_strategy` (`backup_strategy`),
KEY `idx_dbms_backup_create_time` (`create_time`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COMMENT='数据库备份文件记录表';
CREATE TABLE IF NOT EXISTS `dbms_restore_record` (
`id` VARCHAR(64) NOT NULL COMMENT '主键',
`task_id` VARCHAR(64) NOT NULL COMMENT '恢复任务 ID',
`backup_file_id` VARCHAR(64) NOT NULL COMMENT '备份文件 ID',
`connection_id` VARCHAR(64) NOT NULL COMMENT '目标数据库连接配置 ID',
`db_type` VARCHAR(32) NOT NULL COMMENT '数据库类型ORACLE后续可扩展 MYSQL、INFLUXDB',
`restore_mode` VARCHAR(32) NOT NULL DEFAULT 'SKIP' COMMENT '恢复模式SKIP、APPEND、TRUNCATE、REPLACE',
`target_schema_name` VARCHAR(128) NULL COMMENT '目标 Schema',
`target_names_json` JSON NULL COMMENT '恢复对象名称列表 JSON例如表名列表',
`table_exists_action` VARCHAR(32) NULL COMMENT 'Data Pump TABLE_EXISTS_ACTIONSKIP、APPEND、TRUNCATE、REPLACE',
`overwrite_confirmed` TINYINT NOT NULL DEFAULT 0 COMMENT '是否已确认覆盖类操作0-否1-是',
`result_message` VARCHAR(2000) NULL COMMENT '恢复结果说明',
`state` TINYINT NOT NULL DEFAULT 1 COMMENT '状态0-删除1-正常',
`create_by` VARCHAR(64) NULL COMMENT '创建人',
`create_time` DATETIME NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',
`update_by` VARCHAR(64) NULL COMMENT '更新人',
`update_time` DATETIME NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT '更新时间',
PRIMARY KEY (`id`),
KEY `idx_dbms_restore_task` (`task_id`),
KEY `idx_dbms_restore_backup_file` (`backup_file_id`),
KEY `idx_dbms_restore_connection` (`connection_id`),
KEY `idx_dbms_restore_db_type` (`db_type`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COMMENT='数据库恢复记录表';

View File

@@ -0,0 +1,14 @@
INSERT INTO `cn_tool`.`sys_function`
(`Id`, `Pid`, `Pids`, `Name`, `Code`, `Path`, `Component`, `Icon`, `Sort`, `Type`, `Remark`, `State`, `Create_By`, `Create_Time`, `Update_By`, `Update_Time`)
VALUES
('9f3b2c7a6e8d4b91a5c0f2d7e6a3b841', '0', '0', '系统运维', 'systemOps', '/systemOps', '/systemOps/index', 'Aim', 50, 0, '系统运维', 1, 'f8516cc81d964cd8b4b771a3b3985cd4', '2026-05-20 10:00:00', 'f8516cc81d964cd8b4b771a3b3985cd4', '2026-05-20 10:00:00');
INSERT INTO `cn_tool`.`sys_function`
(`Id`, `Pid`, `Pids`, `Name`, `Code`, `Path`, `Component`, `Icon`, `Sort`, `Type`, `Remark`, `State`, `Create_By`, `Create_Time`, `Update_By`, `Update_Time`)
VALUES
('2a7e5d9c1f4b4386b0c9e6f3a8d21754', '9f3b2c7a6e8d4b91a5c0f2d7e6a3b841', '0,9f3b2c7a6e8d4b91a5c0f2d7e6a3b841', '数据库监控', 'database', '/systemOps/database', '/systemOps/database/index', 'Monitor', 100, 0, '数据库监控', 1, 'f8516cc81d964cd8b4b771a3b3985cd4', '2026-05-20 10:10:00', 'f8516cc81d964cd8b4b771a3b3985cd4', '2026-05-20 10:10:00');
INSERT INTO `cn_tool`.`sys_function`
(`Id`, `Pid`, `Pids`, `Name`, `Code`, `Path`, `Component`, `Icon`, `Sort`, `Type`, `Remark`, `State`, `Create_By`, `Create_Time`, `Update_By`, `Update_Time`)
VALUES
('7c6d4a1e9b2f43c8a5e0d3f6b9c21875', '9f3b2c7a6e8d4b91a5c0f2d7e6a3b841', '0,9f3b2c7a6e8d4b91a5c0f2d7e6a3b841', '系统部署', 'deploy', '/systemOps/deploy', '/systemOps/deploy/index', 'Upload', 110, 0, '系统部署', 1, 'f8516cc81d964cd8b4b771a3b3985cd4', '2026-05-20 10:20:00', 'f8516cc81d964cd8b4b771a3b3985cd4', '2026-05-20 10:20:00');

View File

@@ -6,10 +6,13 @@ import com.njcn.common.pojo.enums.common.LogEnum;
import com.njcn.common.pojo.enums.response.CommonResponseEnum;
import com.njcn.common.pojo.response.HttpResult;
import com.njcn.common.utils.LogUtil;
import com.njcn.gather.tool.addledger.pojo.param.AddDeviceUnitSaveParam;
import com.njcn.gather.tool.addledger.pojo.param.AddLedgerEngineeringSaveParam;
import com.njcn.gather.tool.addledger.pojo.param.AddLedgerEquipmentSaveParam;
import com.njcn.gather.tool.addledger.pojo.param.AddLedgerLineSaveParam;
import com.njcn.gather.tool.addledger.pojo.param.AddLedgerProjectSaveParam;
import com.njcn.gather.tool.addledger.pojo.po.AddOverlimitPO;
import com.njcn.gather.tool.addledger.pojo.vo.AddDeviceUnitVO;
import com.njcn.gather.tool.addledger.pojo.vo.AddLedgerDetailVO;
import com.njcn.gather.tool.addledger.pojo.vo.AddLedgerTreeNodeVO;
import com.njcn.gather.tool.addledger.service.AddLedgerService;
@@ -93,6 +96,26 @@ public class AddLedgerController extends BaseController {
return HttpResultUtil.assembleCommonResponseResult(CommonResponseEnum.SUCCESS, result, methodDescribe);
}
@OperateInfo(info = LogEnum.BUSINESS_COMMON)
@ApiOperation("查询设备单位")
@GetMapping("/equipment/unit")
public HttpResult<AddDeviceUnitVO> getDeviceUnit(@RequestParam("devId") String devId) {
String methodDescribe = getMethodDescribe("getDeviceUnit");
LogUtil.njcnDebug(log, "{}开始查询设备单位devId={}", methodDescribe, devId);
AddDeviceUnitVO result = addLedgerService.getDeviceUnit(devId);
return HttpResultUtil.assembleCommonResponseResult(CommonResponseEnum.SUCCESS, result, methodDescribe);
}
@OperateInfo(info = LogEnum.BUSINESS_COMMON, operateType = OperateType.UPDATE)
@ApiOperation("保存设备单位")
@PostMapping("/equipment/unit/save")
public HttpResult<AddDeviceUnitVO> saveDeviceUnit(@RequestBody @Validated AddDeviceUnitSaveParam param) {
String methodDescribe = getMethodDescribe("saveDeviceUnit");
LogUtil.njcnDebug(log, "{}开始保存设备单位devId={}", methodDescribe, param.getDevId());
AddDeviceUnitVO result = addLedgerService.saveDeviceUnit(param);
return HttpResultUtil.assembleCommonResponseResult(CommonResponseEnum.SUCCESS, result, methodDescribe);
}
@OperateInfo(info = LogEnum.BUSINESS_COMMON, operateType = OperateType.ADD)
@ApiOperation("新增或保存测点")
@PostMapping("/line/save")
@@ -103,6 +126,16 @@ public class AddLedgerController extends BaseController {
return HttpResultUtil.assembleCommonResponseResult(CommonResponseEnum.SUCCESS, result, methodDescribe);
}
@OperateInfo(info = LogEnum.BUSINESS_COMMON)
@ApiOperation("查询监测点限值")
@GetMapping("/line/overlimit")
public HttpResult<AddOverlimitPO> getLineOverlimit(@RequestParam("lineId") String lineId) {
String methodDescribe = getMethodDescribe("getLineOverlimit");
LogUtil.njcnDebug(log, "{}开始查询监测点限值lineId={}", methodDescribe, lineId);
AddOverlimitPO result = addLedgerService.getLineOverlimit(lineId);
return HttpResultUtil.assembleCommonResponseResult(CommonResponseEnum.SUCCESS, result, methodDescribe);
}
@OperateInfo(info = LogEnum.BUSINESS_COMMON)
@ApiOperation("查询设备可用线路号")
@GetMapping("/line/availableLineNos")

View File

@@ -0,0 +1,10 @@
package com.njcn.gather.tool.addledger.mapper;
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.njcn.gather.tool.addledger.pojo.po.AddDeviceUnit;
/**
* 设备单位 Mapper。
*/
public interface AddDeviceUnitMapper extends BaseMapper<AddDeviceUnit> {
}

View File

@@ -0,0 +1,10 @@
package com.njcn.gather.tool.addledger.mapper;
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.njcn.gather.tool.addledger.pojo.po.AddOverlimitPO;
/**
* 监测点限值 Mapper。
*/
public interface AddOverlimitMapper extends BaseMapper<AddOverlimitPO> {
}

View File

@@ -34,7 +34,8 @@
equipment.name AS equipmentName,
equipment.mac AS equipmentMac,
line.line_id AS lineId,
line.name AS lineName
line.name AS lineName,
line.line_interval AS lineInterval
FROM cs_line line
INNER JOIN cs_equipment_delivery equipment ON equipment.id = line.device_id
INNER JOIN cs_project project ON project.id = equipment.associated_project
@@ -58,7 +59,8 @@
equipment.name AS equipmentName,
equipment.mac AS equipmentMac,
line.line_id AS lineId,
line.name AS lineName
line.name AS lineName,
line.line_interval AS lineInterval
FROM cs_line line
INNER JOIN cs_equipment_delivery equipment ON equipment.id = line.device_id
INNER JOIN cs_project project ON project.id = equipment.associated_project

Some files were not shown because too many files have changed in this diff Show More