feat: 更新端口配置并添加监控支持
fix: 修复测试配置和依赖检查 perf: 优化雪花算法性能 refactor: 清理冗余代码和未使用的导入 style: 统一代码格式和注释 test: 添加单元测试和集成测试 ci: 更新CI配置和构建脚本 chore: 更新依赖和配置文件
This commit is contained in:
张翔
@@ -0,0 +1,323 @@
|
||||
# Novalon 管理系统 - 系统架构设计文档
|
||||
|
||||
## 1. 系统概述
|
||||
|
||||
Novalon 管理系统是一个企业级后台管理系统，采用前后端分离架构，基于 Spring WebFlux 响应式编程模型。
|
||||
|
||||
## 2. 技术架构
|
||||
|
||||
### 2.1 后端架构
|
||||
|
||||
- **框架**: Spring Boot 3.4.1
|
||||
- **编程模型**: 响应式 WebFlux
|
||||
- **数据库**: PostgreSQL 15 + R2DBC
|
||||
- **认证**: JWT + Spring Security
|
||||
- **缓存**: Caffeine
|
||||
- **文档**: SpringDoc OpenAPI 3.0
|
||||
- **构建工具**: Maven 3.9
|
||||
- **JDK**: Java 21
|
||||
|
||||
### 2.2 前端架构
|
||||
|
||||
- **框架**: Vue 3 + TypeScript 5.0
|
||||
- **UI 组件**: Ant Design Vue 4.0
|
||||
- **状态管理**: Pinia
|
||||
- **路由**: Vue Router 4.0
|
||||
- **构建工具**: Vite 5.0
|
||||
- **HTTP 客户端**: Axios
|
||||
|
||||
### 2.3 基础设施
|
||||
|
||||
- **容器化**: Docker
|
||||
- **编排**: Docker Compose
|
||||
- **CI/CD**: Woodpecker
|
||||
- **监控**: Prometheus + Grafana
|
||||
- **日志**: 结构化日志 (SLF4J)
|
||||
|
||||
## 3. 分层架构
|
||||
|
||||
```
|
||||
┌─────────────────────────────────────┐
|
||||
│ Frontend (Vue 3) │
|
||||
│ - TypeScript │
|
||||
│ - Ant Design Vue │
|
||||
│ - Pinia State │
|
||||
└──────────────┬──────────────────────┘
|
||||
│ HTTP/WebSocket
|
||||
┌──────────────▼──────────────────────┐
|
||||
│ Handler Layer │
|
||||
│ (Functional WebFlux Routes) │
|
||||
│ - Request Validation │
|
||||
│ - Response Formatting │
|
||||
└──────────────┬──────────────────────┘
|
||||
│
|
||||
┌──────────────▼──────────────────────┐
|
||||
│ Service Layer │
|
||||
│ (Business Logic) │
|
||||
│ - @Cacheable │
|
||||
│ - Transaction Management │
|
||||
└──────────────┬──────────────────────┘
|
||||
│
|
||||
┌──────────────▼──────────────────────┐
|
||||
│ DAO Layer │
|
||||
│ (Data Access Object) │
|
||||
│ - Repository Pattern │
|
||||
│ - R2DBC Operations │
|
||||
└──────────────┬──────────────────────┘
|
||||
│
|
||||
┌──────────────▼──────────────────────┐
|
||||
│ Entity Layer │
|
||||
│ (Database Entities) │
|
||||
│ - MapStruct Mappers │
|
||||
│ - Domain Objects │
|
||||
└──────────────┬──────────────────────┘
|
||||
│
|
||||
┌──────────────▼──────────────────────┐
|
||||
│ Database (PostgreSQL) │
|
||||
│ - Connection Pool (HikariCP) │
|
||||
│ - Indexes │
|
||||
└─────────────────────────────────────┘
|
||||
```
|
||||
|
||||
## 4. 核心模块
|
||||
|
||||
### 4.1 用户管理 (User Management)
|
||||
- 用户 CRUD 操作
|
||||
- 用户认证与授权
|
||||
- 密码管理 (BCrypt 加密)
|
||||
- 角色分配
|
||||
- 用户状态管理 (启用/禁用)
|
||||
- 逻辑删除与恢复
|
||||
|
||||
### 4.2 角色管理 (Role Management)
|
||||
- 角色定义与维护
|
||||
- 权限配置
|
||||
- 菜单关联
|
||||
- 角色排序
|
||||
- 角色状态管理
|
||||
|
||||
### 4.3 菜单管理 (Menu Management)
|
||||
- 菜单树结构
|
||||
- 路由配置
|
||||
- 权限控制
|
||||
- 菜单类型 (目录/菜单/按钮)
|
||||
- 图标配置
|
||||
|
||||
### 4.4 字典管理 (Dictionary Management)
|
||||
- 字典类型管理
|
||||
- 字典数据管理
|
||||
- 字典缓存
|
||||
- 字典查询优化
|
||||
|
||||
### 4.5 系统配置 (System Configuration)
|
||||
- 系统参数配置
|
||||
- 配置管理
|
||||
- 配置缓存
|
||||
- 配置类型分类
|
||||
|
||||
### 4.6 审计日志 (Audit Logs)
|
||||
- 操作日志记录
|
||||
- 登录日志记录
|
||||
- 异常日志记录
|
||||
- 日志查询与导出
|
||||
|
||||
### 4.7 通知中心 (Notification Center)
|
||||
- 通知公告管理
|
||||
- 用户消息管理
|
||||
- WebSocket 实时推送
|
||||
- 消息状态跟踪
|
||||
|
||||
### 4.8 文件管理 (File Management)
|
||||
- 文件上传 (Multipart)
|
||||
- 文件下载
|
||||
- 文件预览
|
||||
- 文件类型限制
|
||||
- 文件大小限制
|
||||
|
||||
## 5. 数据流
|
||||
|
||||
### 5.1 请求流程
|
||||
|
||||
```
|
||||
1. 前端发送 HTTP 请求
|
||||
↓
|
||||
2. Handler 层接收请求并解析参数
|
||||
↓
|
||||
3. Service 层处理业务逻辑
|
||||
- 缓存检查
|
||||
- 数据验证
|
||||
↓
|
||||
4. DAO 层访问数据库
|
||||
- R2DBC 非阻塞查询
|
||||
↓
|
||||
5. 数据库返回结果
|
||||
↓
|
||||
6. 逐层返回给前端
|
||||
- Mono/Flux 响应式流
|
||||
```
|
||||
|
||||
### 5.2 响应式数据流
|
||||
|
||||
```
|
||||
Frontend Request
|
||||
↓
|
||||
Handler (Mono/Flux)
|
||||
- ServerRequest → Mono<ServerResponse>
|
||||
↓
|
||||
Service (Mono/Flux)
|
||||
- @Cacheable 缓存拦截
|
||||
- 业务逻辑处理
|
||||
↓
|
||||
DAO (Mono/Flux)
|
||||
- R2DBC 非阻塞 I/O
|
||||
↓
|
||||
Database (R2DBC Driver)
|
||||
- 异步数据库操作
|
||||
↓
|
||||
Response (Mono/Flux)
|
||||
- 响应式流返回
|
||||
↓
|
||||
Frontend
|
||||
```
|
||||
|
||||
## 6. 安全设计
|
||||
|
||||
### 6.1 认证机制
|
||||
- JWT Token 认证
|
||||
- Token 刷新机制
|
||||
- 密码 BCrypt 加密存储
|
||||
- 登录失败次数限制
|
||||
- Token 过期时间控制
|
||||
|
||||
### 6.2 授权机制
|
||||
- 基于角色的访问控制 (RBAC)
|
||||
- API 级别权限控制
|
||||
- 菜单级别权限控制
|
||||
- 数据级权限控制
|
||||
|
||||
### 6.3 审计机制
|
||||
- 操作日志记录 (CRUD 操作)
|
||||
- 登录日志记录 (成功/失败)
|
||||
- 异常日志记录
|
||||
- 敏感操作审计
|
||||
|
||||
### 6.4 数据安全
|
||||
- SQL 注入防护 (R2DBC 参数化查询)
|
||||
- XSS 防护 (输入验证)
|
||||
- CSRF 防护 (Token 验证)
|
||||
- 文件上传安全 (类型/大小限制)
|
||||
|
||||
## 7. 性能优化
|
||||
|
||||
### 7.1 响应式编程优势
|
||||
- 非阻塞 I/O 操作
|
||||
- 背压机制 (Backpressure)
|
||||
- 异步处理能力
|
||||
- 高并发支持
|
||||
|
||||
### 7.2 缓存策略
|
||||
- Caffeine 本地缓存
|
||||
- 缓存预热
|
||||
- 缓存失效策略 (TTL 30 分钟)
|
||||
- 缓存命中率监控
|
||||
|
||||
### 7.3 数据库优化
|
||||
- 索引优化 (单列/复合索引)
|
||||
- 查询优化 (EXPLAIN ANALYZE)
|
||||
- 连接池配置 (HikariCP)
|
||||
- 慢查询监控
|
||||
|
||||
### 7.4 性能指标
|
||||
- P95 响应时间 < 500ms
|
||||
- P99 响应时间 < 1000ms
|
||||
- 并发支持 > 50 QPS
|
||||
- 数据库连接池利用率 < 80%
|
||||
|
||||
## 8. 监控与运维
|
||||
|
||||
### 8.1 健康检查
|
||||
- Spring Boot Actuator 端点
|
||||
- 数据库连接检查
|
||||
- 缓存状态检查
|
||||
- 磁盘空间检查
|
||||
|
||||
### 8.2 指标监控
|
||||
- Prometheus 指标采集
|
||||
- Grafana 可视化
|
||||
- JVM 内存使用
|
||||
- HTTP 请求指标
|
||||
- 数据库连接池状态
|
||||
- 缓存命中率
|
||||
|
||||
### 8.3 日志管理
|
||||
- 结构化日志 (JSON 格式)
|
||||
- 日志级别控制 (DEBUG/INFO/WARN/ERROR)
|
||||
- 日志归档策略
|
||||
- ELK 集成 (可选)
|
||||
|
||||
### 8.4 告警规则
|
||||
- 响应时间 > 1s 告警
|
||||
- 错误率 > 1% 告警
|
||||
- 数据库连接池耗尽告警
|
||||
- JVM 内存使用 > 80% 告警
|
||||
|
||||
## 9. 部署架构
|
||||
|
||||
### 9.1 容器化部署
|
||||
- Docker 镜像构建 (多阶段构建)
|
||||
- Docker Compose 编排
|
||||
- 环境变量配置
|
||||
- 数据持久化卷
|
||||
|
||||
### 9.2 CI/CD 流水线
|
||||
- Woodpecker CI 配置
|
||||
- 自动化测试 (单元/集成/E2E)
|
||||
- 代码覆盖率检查 (JaCoCo >= 80%)
|
||||
- 静态代码分析 (SpotBugs)
|
||||
- 安全扫描 (OWASP Dependency Check)
|
||||
- 自动化部署
|
||||
|
||||
### 9.3 环境配置
|
||||
- 开发环境 (localhost)
|
||||
- 测试环境 (staging)
|
||||
- 生产环境 (production)
|
||||
- 配置文件分离
|
||||
|
||||
## 10. 扩展性设计
|
||||
|
||||
### 10.1 水平扩展
|
||||
- 无状态设计 (Stateless)
|
||||
- 负载均衡 (Nginx)
|
||||
- 会话共享 (JWT 无状态)
|
||||
- 数据库读写分离 (可选)
|
||||
|
||||
### 10.2 垂直扩展
|
||||
- 资源优化 (CPU/内存)
|
||||
- 连接池调优
|
||||
- 缓存容量扩展
|
||||
- 数据库分表 (可选)
|
||||
|
||||
## 11. 技术债务与改进
|
||||
|
||||
### 11.1 当前技术债务
|
||||
- 部分 Mapper 警告 (MapStruct 未映射字段)
|
||||
- WebSocket 未检查操作警告
|
||||
- 测试覆盖率需提升 (当前 10%，目标 80%)
|
||||
|
||||
### 11.2 改进计划
|
||||
- 修复 Mapper 映射问题
|
||||
- 添加 WebSocket 类型安全
|
||||
- 补充单元测试提升覆盖率
|
||||
- 集成测试覆盖关键业务流程
|
||||
- E2E 测试覆盖用户主要路径
|
||||
|
||||
## 12. 附录
|
||||
|
||||
### 12.1 相关文档
|
||||
- [部署指南](../deployment/deployment-guide.md)
|
||||
- [API 文档](http://localhost:8080/swagger-ui.html)
|
||||
- [数据库设计](../database/database-schema.md)
|
||||
|
||||
### 12.2 联系方式
|
||||
- 技术支持: support@novalon.cn
|
||||
- 文档地址: https://docs.novalon.cn
|
||||
@@ -0,0 +1,703 @@
|
||||
# Novalon 管理系统 - 部署指南
|
||||
|
||||
## 1. 环境要求
|
||||
|
||||
### 1.1 硬件要求
|
||||
|
||||
| 组件 | 最低配置 | 推荐配置 |
|
||||
|------|----------|----------|
|
||||
| CPU | 2 核 | 4 核+ |
|
||||
| 内存 | 4 GB | 8 GB+ |
|
||||
| 磁盘 | 20 GB | 50 GB+ SSD |
|
||||
| 网络 | 100 Mbps | 1 Gbps |
|
||||
|
||||
### 1.2 软件要求
|
||||
|
||||
| 软件 | 版本 | 说明 |
|
||||
|------|------|------|
|
||||
| JDK | 21 | OpenJDK 或 Oracle JDK |
|
||||
| Maven | 3.9+ | 构建工具 |
|
||||
| Node.js | 21+ | 前端构建 |
|
||||
| Docker | 24.0+ | 容器化部署 |
|
||||
| PostgreSQL | 15+ | 数据库 |
|
||||
| Nginx | 1.24+ | 反向代理 |
|
||||
|
||||
### 1.3 端口要求
|
||||
|
||||
| 端口 | 协议 | 用途 |
|
||||
|------|------|------|
|
||||
| 8080 | HTTP | 后端 API 服务 |
|
||||
| 3000 | HTTP | 前端开发服务 |
|
||||
| 5432 | TCP | PostgreSQL 数据库 |
|
||||
| 9090 | HTTP | Prometheus 监控 |
|
||||
| 3000 | HTTP | Grafana 可视化 |
|
||||
|
||||
## 2. 本地开发环境部署
|
||||
|
||||
### 2.1 数据库部署
|
||||
|
||||
#### 启动 PostgreSQL
|
||||
|
||||
```bash
|
||||
# 使用 Docker 启动 PostgreSQL
|
||||
docker run -d \
|
||||
--name novalon-postgres \
|
||||
-e POSTGRES_DB=manage_system \
|
||||
-e POSTGRES_USER=postgres \
|
||||
-e POSTGRES_PASSWORD=postgres \
|
||||
-p 55432:5432 \
|
||||
-v postgres-data:/var/lib/postgresql/data \
|
||||
postgres:15-alpine
|
||||
```
|
||||
|
||||
#### 初始化数据库
|
||||
|
||||
```bash
|
||||
# 运行 Flyway 迁移
|
||||
cd novalon-manage-api/manage-sys
|
||||
mvn flyway:migrate
|
||||
```
|
||||
|
||||
### 2.2 后端部署
|
||||
|
||||
#### 配置环境变量
|
||||
|
||||
```bash
|
||||
# 创建 .env 文件
|
||||
cat > novalon-manage-api/manage-sys/.env << EOF
|
||||
SPRING_DATASOURCE_URL=r2dbc:pool:postgresql://localhost:55432/manage_system
|
||||
SPRING_DATASOURCE_USERNAME=postgres
|
||||
SPRING_DATASOURCE_PASSWORD=postgres
|
||||
JWT_SECRET=novalon-manage-secret-key-change-in-production
|
||||
JWT_EXPIRATION=86400000
|
||||
EOF
|
||||
```
|
||||
|
||||
#### 启动后端服务
|
||||
|
||||
```bash
|
||||
cd novalon-manage-api/manage-sys
|
||||
|
||||
# 开发模式启动
|
||||
mvn spring-boot:run
|
||||
|
||||
# 或打包后启动
|
||||
mvn clean package
|
||||
java -jar target/manage-sys-1.0.0.jar
|
||||
```
|
||||
|
||||
#### 验证后端服务
|
||||
|
||||
```bash
|
||||
# 健康检查
|
||||
curl http://localhost:8080/actuator/health
|
||||
|
||||
# 查看 API 文档
|
||||
open http://localhost:8080/swagger-ui.html
|
||||
```
|
||||
|
||||
### 2.3 前端部署
|
||||
|
||||
#### 安装依赖
|
||||
|
||||
```bash
|
||||
cd novalon-manage-web
|
||||
|
||||
# 使用 npm
|
||||
npm install
|
||||
|
||||
# 或使用 pnpm (更快)
|
||||
pnpm install
|
||||
```
|
||||
|
||||
#### 配置 API 地址
|
||||
|
||||
```typescript
|
||||
// 修改 src/utils/request.ts
|
||||
const baseURL = import.meta.env.VITE_API_BASE_URL || 'http://localhost:8080';
|
||||
```
|
||||
|
||||
#### 启动前端服务
|
||||
|
||||
```bash
|
||||
# 开发模式
|
||||
npm run dev
|
||||
|
||||
# 生产构建
|
||||
npm run build
|
||||
```
|
||||
|
||||
#### 验证前端服务
|
||||
|
||||
```bash
|
||||
# 访问前端
|
||||
open http://localhost:5173
|
||||
```
|
||||
|
||||
## 3. Docker 容器化部署
|
||||
|
||||
### 3.1 构建镜像
|
||||
|
||||
#### 后端镜像
|
||||
|
||||
```bash
|
||||
cd novalon-manage-api/manage-sys
|
||||
|
||||
# 构建镜像
|
||||
docker build -t novalon-manage-api:latest .
|
||||
|
||||
# 查看镜像
|
||||
docker images | grep novalon
|
||||
```
|
||||
|
||||
#### 前端镜像
|
||||
|
||||
```bash
|
||||
cd novalon-manage-web
|
||||
|
||||
# 构建镜像
|
||||
docker build -t novalon-manage-web:latest .
|
||||
|
||||
# 查看镜像
|
||||
docker images | grep novalon
|
||||
```
|
||||
|
||||
### 3.2 Docker Compose 部署
|
||||
|
||||
#### 创建 docker-compose.yml
|
||||
|
||||
```yaml
|
||||
version: '3.8'
|
||||
|
||||
services:
|
||||
postgres:
|
||||
image: postgres:15-alpine
|
||||
container_name: novalon-postgres
|
||||
environment:
|
||||
POSTGRES_DB: manage_system
|
||||
POSTGRES_USER: postgres
|
||||
POSTGRES_PASSWORD: ${DB_PASSWORD:-postgres}
|
||||
ports:
|
||||
- "55432:5432"
|
||||
volumes:
|
||||
- postgres-data:/var/lib/postgresql/data
|
||||
healthcheck:
|
||||
test: ["CMD-SHELL", "pg_isready -U postgres"]
|
||||
interval: 10s
|
||||
timeout: 5s
|
||||
retries: 5
|
||||
|
||||
backend:
|
||||
image: novalon-manage-api:latest
|
||||
container_name: novalon-api
|
||||
environment:
|
||||
SPRING_DATASOURCE_URL: r2dbc:pool:postgresql://postgres:5432/manage_system
|
||||
SPRING_DATASOURCE_USERNAME: postgres
|
||||
SPRING_DATASOURCE_PASSWORD: ${DB_PASSWORD:-postgres}
|
||||
JWT_SECRET: ${JWT_SECRET:-novalon-manage-secret-key}
|
||||
ports:
|
||||
- "8080:8080"
|
||||
depends_on:
|
||||
postgres:
|
||||
condition: service_healthy
|
||||
healthcheck:
|
||||
test: ["CMD", "wget", "--spider", "http://localhost:8080/actuator/health"]
|
||||
interval: 30s
|
||||
timeout: 10s
|
||||
retries: 3
|
||||
|
||||
frontend:
|
||||
image: novalon-manage-web:latest
|
||||
container_name: novalon-web
|
||||
ports:
|
||||
- "80:80"
|
||||
depends_on:
|
||||
- backend
|
||||
volumes:
|
||||
- ./nginx.conf:/etc/nginx/nginx.conf:ro
|
||||
|
||||
prometheus:
|
||||
image: prom/prometheus:latest
|
||||
container_name: novalon-prometheus
|
||||
ports:
|
||||
- "9090:9090"
|
||||
volumes:
|
||||
- ./monitoring/prometheus.yml:/etc/prometheus/prometheus.yml:ro
|
||||
command:
|
||||
- '--config.file=/etc/prometheus/prometheus.yml'
|
||||
- '--storage.tsdb.path=/prometheus'
|
||||
|
||||
grafana:
|
||||
image: grafana/grafana:latest
|
||||
container_name: novalon-grafana
|
||||
ports:
|
||||
- "3000:3000"
|
||||
environment:
|
||||
GF_SECURITY_ADMIN_PASSWORD: ${GRAFANA_PASSWORD:-admin}
|
||||
volumes:
|
||||
- grafana-data:/var/lib/grafana
|
||||
|
||||
volumes:
|
||||
postgres-data:
|
||||
grafana-data:
|
||||
```
|
||||
|
||||
#### 启动服务
|
||||
|
||||
```bash
|
||||
# 启动所有服务
|
||||
docker-compose up -d
|
||||
|
||||
# 查看日志
|
||||
docker-compose logs -f
|
||||
|
||||
# 停止服务
|
||||
docker-compose down
|
||||
|
||||
# 停止并删除数据卷
|
||||
docker-compose down -v
|
||||
```
|
||||
|
||||
## 4. 生产环境部署
|
||||
|
||||
### 4.1 服务器准备
|
||||
|
||||
#### 系统配置
|
||||
|
||||
```bash
|
||||
# 更新系统
|
||||
sudo apt update && sudo apt upgrade -y
|
||||
|
||||
# 安装 Docker
|
||||
curl -fsSL https://get.docker.com -o get-docker.sh
|
||||
sudo sh get-docker.sh
|
||||
|
||||
# 安装 Docker Compose
|
||||
sudo curl -L "https://github.com/docker/compose/releases/download/v2.24.0/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
|
||||
sudo chmod +x /usr/local/bin/docker-compose
|
||||
|
||||
# 安装 Nginx
|
||||
sudo apt install nginx -y
|
||||
```
|
||||
|
||||
#### 防火墙配置
|
||||
|
||||
```bash
|
||||
# 开放必要端口
|
||||
sudo ufw allow 80/tcp
|
||||
sudo ufw allow 443/tcp
|
||||
sudo ufw allow 22/tcp
|
||||
sudo ufw enable
|
||||
```
|
||||
|
||||
### 4.2 数据库部署
|
||||
|
||||
#### 生产数据库配置
|
||||
|
||||
```bash
|
||||
# 使用生产级配置
|
||||
docker run -d \
|
||||
--name novalon-postgres \
|
||||
-e POSTGRES_DB=manage_system \
|
||||
-e POSTGRES_USER=${DB_USER} \
|
||||
-e POSTGRES_PASSWORD=${DB_PASSWORD} \
|
||||
-p 5432:5432 \
|
||||
-v /data/postgres:/var/lib/postgresql/data \
|
||||
-v /etc/postgresql/postgresql.conf:/etc/postgresql/postgresql.conf:ro \
|
||||
postgres:15-alpine \
|
||||
-c max_connections=200 \
|
||||
-c shared_buffers=256MB \
|
||||
-c effective_cache_size=1GB
|
||||
```
|
||||
|
||||
#### 数据库备份
|
||||
|
||||
```bash
|
||||
# 创建备份脚本
|
||||
cat > /scripts/backup-db.sh << 'EOF'
|
||||
#!/bin/bash
|
||||
BACKUP_DIR="/backup/postgres"
|
||||
DATE=$(date +%Y%m%d_%H%M%S)
|
||||
BACKUP_FILE="$BACKUP_DIR/manage_system_$DATE.sql"
|
||||
|
||||
mkdir -p $BACKUP_DIR
|
||||
|
||||
docker exec novalon-postgres pg_dump -U postgres manage_system > $BACKUP_FILE
|
||||
|
||||
# 压缩备份
|
||||
gzip $BACKUP_FILE
|
||||
|
||||
# 删除 7 天前的备份
|
||||
find $BACKUP_DIR -name "*.sql.gz" -mtime +7 -delete
|
||||
|
||||
echo "Backup completed: $BACKUP_FILE.gz"
|
||||
EOF
|
||||
|
||||
chmod +x /scripts/backup-db.sh
|
||||
|
||||
# 添加定时任务 (每天凌晨 2 点备份)
|
||||
crontab -e
|
||||
# 0 2 * * * /scripts/backup-db.sh
|
||||
```
|
||||
|
||||
### 4.3 后端部署
|
||||
|
||||
#### 构建生产镜像
|
||||
|
||||
```bash
|
||||
cd novalon-manage-api/manage-sys
|
||||
|
||||
# 构建生产镜像
|
||||
docker build \
|
||||
--build-arg SPRING_PROFILES_ACTIVE=prod \
|
||||
-t registry.novalon.cn/novalon-manage-api:${VERSION} \
|
||||
-t registry.novalon.cn/novalon-manage-api:latest \
|
||||
.
|
||||
|
||||
# 推送到镜像仓库
|
||||
docker push registry.novalon.cn/novalon-manage-api:${VERSION}
|
||||
docker push registry.novalon.cn/novalon-manage-api:latest
|
||||
```
|
||||
|
||||
#### 部署后端服务
|
||||
|
||||
```bash
|
||||
# 拉取最新镜像
|
||||
docker pull registry.novalon.cn/novalon-manage-api:latest
|
||||
|
||||
# 停止旧容器
|
||||
docker stop novalon-api
|
||||
docker rm novalon-api
|
||||
|
||||
# 启动新容器
|
||||
docker run -d \
|
||||
--name novalon-api \
|
||||
--restart unless-stopped \
|
||||
-p 8080:8080 \
|
||||
-e SPRING_DATASOURCE_URL=${DB_URL} \
|
||||
-e SPRING_DATASOURCE_USERNAME=${DB_USER} \
|
||||
-e SPRING_DATASOURCE_PASSWORD=${DB_PASSWORD} \
|
||||
-e JWT_SECRET=${JWT_SECRET} \
|
||||
-e SPRING_PROFILES_ACTIVE=prod \
|
||||
-v /var/log/novalon:/app/logs \
|
||||
registry.novalon.cn/novalon-manage-api:latest
|
||||
```
|
||||
|
||||
#### 健康检查
|
||||
|
||||
```bash
|
||||
# 检查服务状态
|
||||
curl http://localhost:8080/actuator/health
|
||||
|
||||
# 预期输出
|
||||
{
|
||||
"status": "UP"
|
||||
}
|
||||
```
|
||||
|
||||
### 4.4 前端部署
|
||||
|
||||
#### 构建生产镜像
|
||||
|
||||
```bash
|
||||
cd novalon-manage-web
|
||||
|
||||
# 构建生产镜像
|
||||
docker build \
|
||||
-t registry.novalon.cn/novalon-manage-web:${VERSION} \
|
||||
-t registry.novalon.cn/novalon-manage-web:latest \
|
||||
.
|
||||
|
||||
# 推送到镜像仓库
|
||||
docker push registry.novalon.cn/novalon-manage-web:${VERSION}
|
||||
docker push registry.novalon.cn/novalon-manage-web:latest
|
||||
```
|
||||
|
||||
#### Nginx 配置
|
||||
|
||||
```nginx
|
||||
# /etc/nginx/sites-available/novalon-manage
|
||||
upstream backend {
|
||||
server 127.0.0.1:8080;
|
||||
}
|
||||
|
||||
server {
|
||||
listen 80;
|
||||
server_name api.novalon.cn;
|
||||
|
||||
# 后端 API 代理
|
||||
location /api/ {
|
||||
proxy_pass http://backend;
|
||||
proxy_set_header Host $host;
|
||||
proxy_set_header X-Real-IP $remote_addr;
|
||||
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||||
proxy_set_header X-Forwarded-Proto $scheme;
|
||||
}
|
||||
|
||||
# WebSocket 代理
|
||||
location /ws/ {
|
||||
proxy_pass http://backend;
|
||||
proxy_http_version 1.1;
|
||||
proxy_set_header Upgrade $http_upgrade;
|
||||
proxy_set_header Connection "upgrade";
|
||||
}
|
||||
|
||||
# 健康检查
|
||||
location /actuator/health {
|
||||
proxy_pass http://backend;
|
||||
access_log off;
|
||||
}
|
||||
}
|
||||
|
||||
server {
|
||||
listen 80;
|
||||
server_name www.novalon.cn novalon.cn;
|
||||
|
||||
# 前端静态文件
|
||||
root /var/www/novalon-manage-web;
|
||||
index index.html;
|
||||
|
||||
# SPA 路由支持
|
||||
location / {
|
||||
try_files $uri $uri/ /index.html;
|
||||
}
|
||||
|
||||
# 静态资源缓存
|
||||
location ~* \.(js|css|png|jpg|jpeg|gif|ico|svg|woff|woff2|ttf|eot)$ {
|
||||
expires 1y;
|
||||
add_header Cache-Control "public, immutable";
|
||||
}
|
||||
|
||||
# Gzip 压缩
|
||||
gzip on;
|
||||
gzip_types text/plain text/css application/json application/javascript text/xml application/xml application/xml+rss text/javascript;
|
||||
gzip_comp_level 6;
|
||||
}
|
||||
```
|
||||
|
||||
#### 启用站点
|
||||
|
||||
```bash
|
||||
# 创建符号链接
|
||||
sudo ln -s /etc/nginx/sites-available/novalon-manage /etc/nginx/sites-enabled/
|
||||
|
||||
# 测试配置
|
||||
sudo nginx -t
|
||||
|
||||
# 重载 Nginx
|
||||
sudo systemctl reload nginx
|
||||
```
|
||||
|
||||
### 4.5 HTTPS 配置
|
||||
|
||||
#### 使用 Let's Encrypt
|
||||
|
||||
```bash
|
||||
# 安装 Certbot
|
||||
sudo apt install certbot python3-certbot-nginx -y
|
||||
|
||||
# 获取证书
|
||||
sudo certbot --nginx -d api.novalon.cn -d www.novalon.cn -d novalon.cn
|
||||
|
||||
# 自动续期
|
||||
sudo certbot renew --dry-run
|
||||
```
|
||||
|
||||
## 5. 监控部署
|
||||
|
||||
### 5.1 Prometheus 配置
|
||||
|
||||
```yaml
|
||||
# /opt/monitoring/prometheus.yml
|
||||
global:
|
||||
scrape_interval: 15s
|
||||
evaluation_interval: 15s
|
||||
|
||||
alerting:
|
||||
alertmanagers:
|
||||
- static_configs:
|
||||
- targets: ['localhost:9093']
|
||||
|
||||
rule_files:
|
||||
- '/opt/monitoring/alerts/*.yml'
|
||||
|
||||
scrape_configs:
|
||||
- job_name: 'novalon-manage-system'
|
||||
metrics_path: '/actuator/prometheus'
|
||||
static_configs:
|
||||
- targets: ['localhost:8080']
|
||||
relabel_configs:
|
||||
- source_labels: [__address__]
|
||||
target_label: instance
|
||||
replacement: 'novalon-manage-api'
|
||||
```
|
||||
|
||||
### 5.2 Grafana 配置
|
||||
|
||||
#### 导入仪表板
|
||||
|
||||
1. 访问 Grafana: http://localhost:3000
|
||||
2. 登录 (admin/admin)
|
||||
3. 添加 Prometheus 数据源
|
||||
4. 导入预配置的仪表板
|
||||
|
||||
#### 关键指标
|
||||
|
||||
| 指标 | 说明 | 告警阈值 |
|
||||
|------|------|----------|
|
||||
| jvm_memory_used_bytes | JVM 内存使用 | > 80% |
|
||||
| http_server_requests_seconds | API 响应时间 | P95 > 500ms |
|
||||
| hikaricp_connections_active | 数据库连接数 | > 80% |
|
||||
| cache_gets_total | 缓存命中率 | < 90% |
|
||||
| system_cpu_usage | CPU 使用率 | > 80% |
|
||||
|
||||
## 6. CI/CD 部署
|
||||
|
||||
### 6.1 Woodpecker 配置
|
||||
|
||||
```yaml
|
||||
# .woodpecker.yml
|
||||
pipeline:
|
||||
name: Novalon Manage System CI/CD
|
||||
|
||||
steps:
|
||||
- name: Backend Build
|
||||
image: maven:3.9-eclipse-temurin-21
|
||||
commands:
|
||||
- cd novalon-manage-api
|
||||
- mvn clean package -DskipTests
|
||||
|
||||
- name: Backend Test
|
||||
image: maven:3.9-eclipse-temurin-21
|
||||
commands:
|
||||
- cd novalon-manage-api
|
||||
- mvn test
|
||||
|
||||
- name: Build Docker Image
|
||||
image: docker:dind
|
||||
commands:
|
||||
- cd novalon-manage-api/manage-sys
|
||||
- docker build -t ${REGISTRY}/novalon-manage-api:${CI_COMMIT_SHA:0:8} .
|
||||
|
||||
- name: Push Docker Image
|
||||
image: docker:dind
|
||||
commands:
|
||||
- docker push ${REGISTRY}/novalon-manage-api:${CI_COMMIT_SHA:0:8}
|
||||
|
||||
- name: Deploy to Production
|
||||
image: alpine:latest
|
||||
commands:
|
||||
- ssh ${DEPLOY_USER}@${DEPLOY_HOST} "docker pull ${REGISTRY}/novalon-manage-api:${CI_COMMIT_SHA:0:8} && docker stop novalon-api && docker rm novalon-api && docker run -d --name novalon-api -p 8080:8080 ${REGISTRY}/novalon-manage-api:${CI_COMMIT_SHA:0:8}"
|
||||
secrets: [ deploy_ssh_key, deploy_host, deploy_user ]
|
||||
when:
|
||||
branch: [main]
|
||||
```
|
||||
|
||||
## 7. 运维操作
|
||||
|
||||
### 7.1 查看日志
|
||||
|
||||
```bash
|
||||
# 查看应用日志
|
||||
docker logs -f novalon-api
|
||||
|
||||
# 查看数据库日志
|
||||
docker logs -f novalon-postgres
|
||||
|
||||
# 查看所有服务日志
|
||||
docker-compose logs -f
|
||||
```
|
||||
|
||||
### 7.2 数据库备份
|
||||
|
||||
```bash
|
||||
# 手动备份
|
||||
docker exec novalon-postgres pg_dump -U postgres manage_system > backup.sql
|
||||
|
||||
# 恢复备份
|
||||
docker exec -i novalon-postgres psql -U postgres manage_system < backup.sql
|
||||
```
|
||||
|
||||
### 7.3 服务重启
|
||||
|
||||
```bash
|
||||
# 重启后端
|
||||
docker restart novalon-api
|
||||
|
||||
# 重启数据库
|
||||
docker restart novalon-postgres
|
||||
|
||||
# 重启所有服务
|
||||
docker-compose restart
|
||||
```
|
||||
|
||||
### 7.4 查看资源使用
|
||||
|
||||
```bash
|
||||
# 查看容器资源使用
|
||||
docker stats
|
||||
|
||||
# 查看磁盘使用
|
||||
df -h
|
||||
|
||||
# 查看内存使用
|
||||
free -h
|
||||
```
|
||||
|
||||
## 8. 故障排查
|
||||
|
||||
### 8.1 常见问题
|
||||
|
||||
| 问题 | 可能原因 | 解决方案 |
|
||||
|------|----------|----------|
|
||||
| 数据库连接失败 | 数据库未启动或网络不通 | 检查数据库状态和网络连接 |
|
||||
| API 请求超时 | 数据库查询慢或资源不足 | 检查慢查询日志和资源使用 |
|
||||
| 前端无法访问 | Nginx 配置错误 | 检查 Nginx 配置和日志 |
|
||||
| 内存溢出 | JVM 堆内存不足 | 调整 JVM 参数或增加内存 |
|
||||
|
||||
### 8.2 日志分析
|
||||
|
||||
```bash
|
||||
# 查看错误日志
|
||||
docker logs novalon-api 2>&1 | grep ERROR
|
||||
|
||||
# 查看慢查询
|
||||
docker exec novalon-postgres psql -U postgres -d manage_system -c "SELECT query, mean_exec_time FROM pg_stat_statements ORDER BY mean_exec_time DESC LIMIT 10"
|
||||
```
|
||||
|
||||
## 9. 安全加固
|
||||
|
||||
### 9.1 网络安全
|
||||
|
||||
- 启用 HTTPS
|
||||
- 配置防火墙规则
|
||||
- 限制 API 访问频率
|
||||
- 使用 WAF (Web Application Firewall)
|
||||
|
||||
### 9.2 应用安全
|
||||
|
||||
- 定期更新依赖
|
||||
- 运行安全扫描
|
||||
- 审计日志监控
|
||||
- 敏感数据加密
|
||||
|
||||
### 9.3 数据安全
|
||||
|
||||
- 定期备份数据
|
||||
- 加密备份数据
|
||||
- 异地备份存储
|
||||
- 备份恢复演练
|
||||
|
||||
## 10. 附录
|
||||
|
||||
### 10.1 相关文档
|
||||
|
||||
- [系统架构设计](../architecture/system-architecture.md)
|
||||
- [API 文档](http://localhost:8080/swagger-ui.html)
|
||||
- [数据库设计](../database/database-schema.md)
|
||||
|
||||
### 10.2 联系方式
|
||||
|
||||
- 技术支持: support@novalon.cn
|
||||
- 紧急联系: emergency@novalon.cn
|
||||
- 文档地址: https://docs.novalon.cn
|
||||
@@ -0,0 +1,104 @@
|
||||
-- Performance Optimization SQL Script
|
||||
-- This script adds necessary indexes to improve query performance
|
||||
|
||||
-- Enable slow query logging (PostgreSQL)
|
||||
ALTER SYSTEM SET log_min_duration_statement = 1000;
|
||||
SELECT pg_reload_conf();
|
||||
|
||||
-- ============================================
|
||||
-- User Table Indexes
|
||||
-- ============================================
|
||||
CREATE INDEX IF NOT EXISTS idx_users_username ON sys_users(username);
|
||||
CREATE INDEX IF NOT EXISTS idx_users_email ON sys_users(email);
|
||||
CREATE INDEX IF NOT EXISTS idx_users_status ON sys_users(status);
|
||||
CREATE INDEX IF NOT EXISTS idx_users_deleted_at ON sys_users(deleted_at);
|
||||
CREATE INDEX IF NOT EXISTS idx_users_created_at ON sys_users(created_at);
|
||||
|
||||
-- ============================================
|
||||
-- Role Table Indexes
|
||||
-- ============================================
|
||||
CREATE INDEX IF NOT EXISTS idx_roles_role_key ON sys_roles(role_key);
|
||||
CREATE INDEX IF NOT EXISTS idx_roles_role_name ON sys_roles(role_name);
|
||||
CREATE INDEX IF NOT EXISTS idx_roles_status ON sys_roles(status);
|
||||
CREATE INDEX IF NOT EXISTS idx_roles_deleted_at ON sys_roles(deleted_at);
|
||||
|
||||
-- ============================================
|
||||
-- Menu Table Indexes
|
||||
-- ============================================
|
||||
CREATE INDEX IF NOT EXISTS idx_menus_parent_id ON sys_menus(parent_id);
|
||||
CREATE INDEX IF NOT EXISTS idx_menus_status ON sys_menus(status);
|
||||
CREATE INDEX IF NOT EXISTS idx_menus_menu_type ON sys_menus(menu_type);
|
||||
|
||||
-- ============================================
|
||||
-- Config Table Indexes
|
||||
-- ============================================
|
||||
CREATE INDEX IF NOT EXISTS idx_sys_config_config_key ON sys_config(config_key);
|
||||
CREATE INDEX IF NOT EXISTS idx_sys_config_deleted_at ON sys_config(deleted_at);
|
||||
|
||||
-- ============================================
|
||||
-- Notice Table Indexes
|
||||
-- ============================================
|
||||
CREATE INDEX IF NOT EXISTS idx_sys_notice_status ON sys_notice(status);
|
||||
CREATE INDEX IF NOT EXISTS idx_sys_notice_deleted_at ON sys_notice(deleted_at);
|
||||
CREATE INDEX IF NOT EXISTS idx_sys_notice_created_at ON sys_notice(created_at);
|
||||
|
||||
-- ============================================
|
||||
-- File Table Indexes
|
||||
-- ============================================
|
||||
CREATE INDEX IF NOT EXISTS idx_sys_file_file_name ON sys_file(file_name);
|
||||
CREATE INDEX IF NOT EXISTS idx_sys_file_file_type ON sys_file(file_type);
|
||||
CREATE INDEX IF NOT EXISTS idx_sys_file_deleted_at ON sys_file(deleted_at);
|
||||
|
||||
-- ============================================
|
||||
-- Dictionary Table Indexes
|
||||
-- ============================================
|
||||
CREATE INDEX IF NOT EXISTS idx_dictionary_type ON dictionary(type);
|
||||
CREATE INDEX IF NOT EXISTS idx_dictionary_code ON dictionary(code);
|
||||
CREATE INDEX IF NOT EXISTS idx_dictionary_type_code ON dictionary(type, code);
|
||||
CREATE INDEX IF NOT EXISTS idx_dictionary_deleted_at ON dictionary(deleted_at);
|
||||
|
||||
-- ============================================
|
||||
-- Dict Type Table Indexes
|
||||
-- ============================================
|
||||
CREATE INDEX IF NOT EXISTS idx_sys_dict_type_dict_type ON sys_dict_type(dict_type);
|
||||
CREATE INDEX IF NOT EXISTS idx_sys_dict_type_deleted_at ON sys_dict_type(deleted_at);
|
||||
|
||||
-- ============================================
|
||||
-- Dict Data Table Indexes
|
||||
-- ============================================
|
||||
CREATE INDEX IF NOT EXISTS idx_sys_dict_data_dict_type ON sys_dict_data(dict_type);
|
||||
CREATE INDEX IF NOT EXISTS idx_sys_dict_data_dict_code ON sys_dict_data(dict_code);
|
||||
CREATE INDEX IF NOT EXISTS idx_sys_dict_data_deleted_at ON sys_dict_data(deleted_at);
|
||||
|
||||
-- ============================================
|
||||
-- User Message Table Indexes
|
||||
-- ============================================
|
||||
CREATE INDEX IF NOT EXISTS idx_sys_user_message_user_id ON sys_user_message(user_id);
|
||||
CREATE INDEX IF NOT EXISTS idx_sys_user_message_is_read ON sys_user_message(is_read);
|
||||
CREATE INDEX IF NOT EXISTS idx_sys_user_message_deleted_at ON sys_user_message(deleted_at);
|
||||
|
||||
-- ============================================
|
||||
-- Composite Indexes for Common Queries
|
||||
-- ============================================
|
||||
CREATE INDEX IF NOT EXISTS idx_users_status_deleted ON sys_users(status, deleted_at);
|
||||
CREATE INDEX IF NOT EXISTS idx_roles_status_deleted ON sys_roles(status, deleted_at);
|
||||
|
||||
-- ============================================
|
||||
-- Analyze Tables After Index Creation
|
||||
-- ============================================
|
||||
ANALYZE sys_users;
|
||||
ANALYZE sys_roles;
|
||||
ANALYZE sys_menus;
|
||||
ANALYZE sys_config;
|
||||
ANALYZE sys_notice;
|
||||
ANALYZE sys_file;
|
||||
ANALYZE dictionary;
|
||||
ANALYZE sys_dict_type;
|
||||
ANALYZE sys_dict_data;
|
||||
ANALYZE sys_user_message;
|
||||
|
||||
-- ============================================
|
||||
-- Query Performance Verification
|
||||
-- ============================================
|
||||
-- Use EXPLAIN ANALYZE to verify query performance
|
||||
-- Example: EXPLAIN ANALYZE SELECT * FROM sys_users WHERE username = 'testuser';
|
||||
Reference in New Issue
Block a user