tsai
/
abp-next-admin2
mirror of https://github.com/colinin/abp-next-admin.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
这是基于vue-vben-admin 模板适用于abp vNext的前端管理项目
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
2888 Commits
72 Branches
54 Tags
77 MiB
 
 
 
 
 
 
Tree: ac7a940a9e
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'ac7a940a9e'
${ noResults }
abp-next-admin2/docs/wiki/扩展开发/插件开发/插件测试与部署/插件CI_CD流水线.md

11 KiB
Raw Blame History

插件CI/CD流水线

**本文档引用的文件** - [lefthook.yml](file://lefthook.yml) - [deploy.ps1](file://deploy\deploy.ps1) - [docker-compose.yml](file://docker-compose.yml) - [docker-compose.middleware.yml](file://docker-compose.middleware.yml) - [create-database.bat](file://aspnet-core\create-database.bat) - [migrate-database.bat](file://aspnet-core\migrate-database.bat) - [migrate-db-cmd.bat](file://aspnet-core\migrate-db-cmd.bat) - [build-aspnetcore-release-sln.ps1](file://build\build-aspnetcore-release-sln.ps1) - [apps\vben5\lefthook.yml](file://apps\vben5\lefthook.yml) - [tye.yaml](file://tye.yaml)

目录

  1. 简介
  2. 项目结构
  3. 核心组件
  4. 架构概述
  5. 详细组件分析
  6. 依赖分析
  7. 性能考虑
  8. 故障排除指南
  9. 结论

简介

本指南旨在为ABP Next Admin项目提供一个全面的插件CI/CD流水线配置方案。文档详细阐述了自动化构建、测试、打包和部署的流程配置，包括使用lefthook进行本地钩子管理和持续集成服务器的配置。同时涵盖了代码质量检查、安全扫描和性能测试的集成方法，以及多环境（开发、测试、预生产、生产）发布的策略和审批流程。此外，还说明了如何实现自动化回滚机制和部署监控，并包含流水线可视化和报告生成的指导，确保发布过程的透明度和可追溯性。

项目结构

该项目是一个基于ABP框架的微服务架构应用，包含多个模块和服务。主要目录结构如下：

  • aspnet-core: 包含所有.NET Core相关的源代码，分为框架、迁移、模块、服务等子目录。
  • deploy: 包含部署脚本和Docker配置文件。
  • gateways: 包含内部和外部API网关的实现。
  • starter: 包含快速启动脚本。
  • build: 包含构建脚本。
  • 根目录下有多个Docker Compose配置文件和CI/CD相关配置。
graph TD
A[根目录] --> B[aspnet-core]
A --> C[deploy]
A --> D[gateways]
A --> E[starter]
A --> F[build]
A --> G[docker-compose文件]
A --> H[CI/CD配置]
B --> B1[framework]
B --> B2[migrations]
B --> B3[modules]
B --> B4[services]
C --> C1[deploy.ps1]
C --> C2[docker-compose.middleware.yml]
F --> F1[build-aspnetcore-release-sln.ps1]
F --> F2[build-aspnetcore-common.ps1]

Diagram sources

  • project_structure

Section sources

  • project_structure

核心组件

项目的核心组件包括多个微服务、数据库迁移工具、API网关和前端应用。每个微服务都独立部署并通过Docker容器运行。数据库迁移通过专门的DbMigrator项目完成，确保数据库模式与代码同步。API网关负责路由请求到相应的后端服务，并提供统一的入口点。

Section sources

  • docker-compose.yml
  • tye.yaml

架构概述

系统采用微服务架构，使用Docker和Docker Compose进行容器化部署。整体架构包括多个后端微服务、中间件服务（如MySQL、Redis、RabbitMQ、Elasticsearch等）和前端应用。API网关作为系统的入口，将请求路由到相应的后端服务。所有服务通过网络隔离的方式部署在同一个Docker网络中。

graph TB
subgraph "前端"
UI[用户界面]
Gateway[API网关]
end
subgraph "后端"
Auth[认证服务]
Admin[管理API]
Platform[平台API]
Localization[本地化API]
Messages[消息API]
Task[任务API]
Webhook[Webhook API]
Workflow[工作流API]
WeChat[微信API]
end
subgraph "中间件"
MySQL[(MySQL)]
Redis[(Redis)]
RabbitMQ[(RabbitMQ)]
Elasticsearch[(Elasticsearch)]
Kibana[Kibana]
Logstash[Logstash]
end
UI --> Gateway
Gateway --> Auth
Gateway --> Admin
Gateway --> Platform
Gateway --> Localization
Gateway --> Messages
Gateway --> Task
Gateway --> Webhook
Gateway --> Workflow
Gateway --> WeChat
Auth --> MySQL
Auth --> Redis
Admin --> MySQL
Admin --> Redis
Platform --> MySQL
Platform --> Redis
Messages --> RabbitMQ
Messages --> MySQL
Messages --> Redis
Elasticsearch --> Kibana
Elasticsearch --> Logstash

Diagram sources

  • docker-compose.yml
  • docker-compose.middleware.yml

详细组件分析

CI/CD配置分析

项目的CI/CD流水线配置主要由以下几个部分组成：本地钩子管理、自动化部署脚本、容器编排配置和构建脚本。

本地钩子管理

项目使用lefthook工具来管理Git钩子，确保代码提交前的质量检查。在根目录和前端应用目录中都有lefthook配置文件。

flowchart TD
Start([代码提交]) --> PreCommit["pre-commit钩子"]
PreCommit --> CodeCheck["代码格式化检查"]
CodeCheck --> LintCheck["Lint检查"]
LintCheck --> TestRun["运行单元测试"]
TestRun --> CommitSuccess["提交成功"]
TestRun --> CommitFail["提交失败"]
PostMerge["post-merge钩子"] --> InstallDeps["安装依赖"]
InstallDeps --> End([完成])
CommitMsg["commit-msg钩子"] --> CommitLint["提交信息检查"]
CommitLint --> MsgValid{"消息有效?"}
MsgValid --> |是| ContinueCommit
MsgValid --> |否| RejectCommit["拒绝提交"]

Diagram sources

  • lefthook.yml
  • apps\vben5\lefthook.yml

自动化部署流程

部署流程通过PowerShell脚本deploy.ps1实现，包含以下步骤：

  1. 部署中间件服务（数据库、缓存、消息队列等）
  2. 等待数据库初始化完成
  3. 创建数据库
  4. 执行数据库迁移
  5. 发布.NET项目
  6. 构建前端项目
  7. 运行应用程序
sequenceDiagram
participant User as 开发者
participant DeployScript as deploy.ps1
participant Docker as Docker
participant Database as 数据库
participant Build as 构建系统
User->>DeployScript : 执行deploy.ps1
DeployScript->>Docker : 启动中间件容器
DeployScript->>DeployScript : 等待30秒
DeployScript->>Database : 创建数据库
DeployScript->>Build : 执行数据库迁移
Build->>Database : 应用迁移
Database-->>Build : 迁移完成
DeployScript->>Build : 发布.NET项目
Build->>Build : dotnet publish
DeployScript->>Build : 构建前端项目
Build->>Build : pnpm install && pnpm build
DeployScript->>Docker : 启动应用容器
Docker-->>User : 部署完成

Diagram sources

  • deploy.ps1

多环境部署策略

项目通过多个Docker Compose覆盖文件实现多环境部署：

graph TD
Base[基础配置 docker-compose.yml] --> Dev[开发环境 docker-compose.override.yml]
Base --> Agile[敏捷环境 docker-compose.override.agile.yml]
Base --> Config[配置环境 docker-compose.override.configuration.yml]
Base --> Middleware[中间件 docker-compose.middleware.yml]
Dev --> DevDB[(开发数据库)]
Dev --> DevRedis[(开发Redis)]
Agile --> AgileDB[(敏捷数据库)]
Agile --> AgileRedis[(敏捷Redis)]
Config --> ConfigDB[(配置数据库)]
Config --> ConfigRedis[(配置Redis)]
Middleware --> MySQL[(MySQL)]
Middleware --> Redis[(Redis)]
Middleware --> RabbitMQ[(RabbitMQ)]
Middleware --> Elasticsearch[(Elasticsearch)]

Diagram sources

  • docker-compose.yml
  • docker-compose.middleware.yml
  • docker-compose.override.configuration.yml

数据库迁移机制

数据库迁移通过专门的DbMigrator项目和批处理脚本实现：

flowchart TD
Start([开始]) --> CreateDB["create-database.bat"]
CreateDB --> MigrateCmd["migrate-db-cmd.bat"]
MigrateCmd --> CheckParam{参数检查}
CheckParam --> |--run| RunMigration["dotnet run --no-build"]
CheckParam --> |--ef-u| EFUpdate["dotnet ef database update"]
CheckParam --> |--restore| Restore["dotnet restore"]
RunMigration --> Success["迁移成功"]
EFUpdate --> Success
Restore --> Success
Success --> End([结束])

Diagram sources

  • create-database.bat
  • migrate-database.bat
  • migrate-db-cmd.bat

依赖分析

项目依赖关系复杂，主要包括以下几个层面：

erDiagram
SERVICE {
string name PK
string type
string status
datetime created_at
datetime updated_at
}
DATABASE {
string name PK
string type
string version
string connection_string
}
MIDDLEWARE {
string name PK
string type
string version
string configuration
}
FRONTEND {
string name PK
string framework
string version
string build_command
}
SERVICE ||--o{ DATABASE : "uses"
SERVICE ||--o{ MIDDLEWARE : "depends on"
FRONTEND ||--o{ SERVICE : "consumes"
SERVICE }|--|| SERVICE : "communicates with"

Diagram sources

  • docker-compose.yml
  • tye.yaml

性能考虑

在设计CI/CD流水线时，需要考虑以下性能因素：

  • 并行执行任务以减少总体构建时间
  • 缓存依赖项以避免重复下载
  • 使用增量构建而不是全量构建
  • 优化Docker镜像大小
  • 合理配置资源限制和请求

虽然这些内容没有直接体现在代码中，但它们是高效CI/CD流水线的重要组成部分。

故障排除指南

当CI/CD流水线出现问题时，可以按照以下步骤进行排查：

flowchart TD
Problem{流水线失败?}
Problem --> |是| CheckLogs["检查日志输出"]
CheckLogs --> IdentifyStage{确定失败阶段}
IdentifyStage --> |构建阶段| BuildIssue["检查编译错误"]
IdentifyStage --> |测试阶段| TestIssue["检查测试失败"]
IdentifyStage --> |部署阶段| DeployIssue["检查部署配置"]
BuildIssue --> FixCode["修复代码并重新提交"]
TestIssue --> DebugTest["调试测试用例"]
DeployIssue --> CheckConfig["检查Docker配置"]
FixCode --> ReRun["重新运行流水线"]
DebugTest --> ReRun
CheckConfig --> ReRun
ReRun --> Success{"成功?"}
Success --> |是| Done["完成"]
Success --> |否| Repeat["重复排查过程"]
Problem --> |否| Monitor["监控系统状态"]

Section sources

  • deploy.ps1
  • migrate-db-cmd.bat

结论

ABP Next Admin项目的CI/CD流水线设计充分考虑了微服务架构的特点，通过Docker容器化部署、自动化脚本和多环境配置实现了高效的开发和部署流程。lefthook的使用确保了代码质量，而详细的部署脚本则简化了环境搭建过程。未来可以进一步完善流水线，例如添加更多的自动化测试、性能监控和安全扫描环节，以提高软件交付的质量和可靠性。