16.【.NET 8 实战--孢子记账--从单体到微服务--转向微服务】--微服务基础工具与技术--Github Action

GitHub Actions 是 GitHub 提供的持续集成和持续部署(CI/CD)平台，它允许我们自动化软件开发工作流程。通过 GitHub Actions，我们可以构建、测试和部署代码，而无需手动干预。

一、基本概念

1.1 Workflow（工作流）

工作流是 GitHub Actions 中最核心的概念,它定义了一个完整的自动化流程。每个工作流都是由 YAML 格式的配置文件定义的,这些文件必须存储在仓库的 .github/workflows 目录下。工作流文件使用声明式语法,让开发者能够清晰地描述整个自动化过程中的每个步骤。通过工作流,我们可以实现代码提交后的自动构建、测试、部署等一系列操作,大大提高了开发效率。

工作流的触发机制非常灵活,可以通过多种事件来启动,比如代码推送(push)、拉取请求(pull request)、定时任务(schedule)等。每个工作流可以包含多个作业(job),这些作业可以并行执行以提高效率,也可以设置依赖关系按顺序执行。工作流还支持条件执行,可以根据不同的分支、标签或其他条件来决定是否执行某些作业,这为不同环境下的自动化处理提供了很大的灵活性。

在微服务架构中,工作流的作用更加突出。由于微服务架构包含多个独立的服务,每个服务都需要独立的构建和部署流程。通过合理配置工作流,我们可以为每个微服务定制专门的自动化流程,包括代码质量检查、单元测试、集成测试、容器镜像构建以及部署等步骤。这不仅确保了每个服务的质量,还大大减少了手动操作的工作量,使得整个微服务系统的维护和更新变得更加高效和可靠。

1.2 Job（作业）

作业(Job)是 GitHub Actions 工作流中的一个核心执行单元,它由一组相关的步骤(Steps)组成。每个作业都代表了自动化流程中的一个独立任务,比如代码构建、单元测试或部署等。作业的设计理念是将复杂的工作流程分解成多个独立且可管理的单元,这种模块化的方式不仅提高了工作流的可维护性,还使得整个自动化过程更加清晰和高效。在实际应用中,我们可以根据项目的具体需求来设计作业,确保每个作业都能专注于完成特定的任务。

作业的一个重要特征是它们在同一个运行器(Runner)上执行。运行器可以是 GitHub 提供的托管运行器,也可以是自托管的运行器。在同一个运行器上执行意味着作业中的所有步骤共享相同的执行环境,这确保了步骤之间的上下文一致性。例如,如果一个步骤在构建过程中生成了某些文件,后续的步骤可以直接访问这些文件。这种设计简化了作业内部步骤之间的数据传递和状态共享,同时也提供了更好的性能和资源利用率。运行器的选择会直接影响作业的执行效率和可用资源,因此在配置作业时需要根据实际需求选择合适的运行器类型。

GitHub Actions 支持作业的并行和顺序执行,这为工作流的优化提供了极大的灵活性。在并行执行模式下,多个作业可以同时运行,这大大缩短了整个工作流的执行时间。例如,在微服务架构中,我们可以同时构建和测试多个独立的服务。而顺序执行则允许我们设置作业之间的依赖关系,确保某些作业必须在其他作业完成后才能开始。这对于那些有严格执行顺序要求的场景非常重要,比如需要先完成测试才能进行部署的情况。通过合理配置作业的执行策略,我们可以在保证工作流正确性的同时,最大化自动化流程的执行效率。

1.3 Step（步骤）

步骤(Step)是 GitHub Actions 工作流中最基本的执行单元,它代表了作业中的一个具体任务或操作。每个步骤都是按照严格的顺序依次执行的,这确保了工作流程的可预测性和可靠性。步骤可以执行多种类型的操作,最常见的是运行命令行指令和使用预定义的 action。通过命令行指令,我们可以执行几乎任何需要的操作,比如编译代码、运行测试、部署应用等。而使用预定义的 action 则可以快速集成常用的功能,如检出代码、设置开发环境、发布构建产物等。步骤的执行结果会直接影响整个作业的状态,如果某个步骤失败,默认情况下后续步骤将不会执行,这有助于及时发现和定位问题。

在微服务架构的开发过程中,步骤的设计尤为重要。每个步骤都需要明确的目标和清晰的输出,这样可以更好地监控和调试整个工作流程。例如,在构建微服务时,我们可能需要设置多个步骤来完成代码检出、依赖恢复、编译构建、运行测试、构建容器镜像、推送镜像等任务。每个步骤都可以配置自己的环境变量、工作目录和条件判断,这种灵活性使得我们能够根据不同服务的特点定制最适合的构建流程。此外,步骤之间还可以共享数据和状态,这为复杂工作流的实现提供了便利。通过合理组织和配置步骤,我们可以构建出高效、可靠的自动化流程,显著提升微服务开发和部署的效率。

1.4 Action（动作）

Action 是 GitHub Actions 中最基础和灵活的可重用构建块。它们就像是预先打包好的功能模块,可以被工作流中的任何步骤直接调用和使用。每个 Action 都被设计为完成一个特定的任务,比如检出代码、设置运行环境、构建和测试代码等。Action 的可重用性使得开发者不必重复编写相同的自动化逻辑,大大提高了工作流的开发效率。GitHub 的 Marketplace 中提供了大量由社区贡献的 Action,涵盖了软件开发生命周期中的各个环节。这些现成的 Action 可以直接集成到工作流中,为开发者节省了大量开发和维护成本。

通过组合不同的 Action,我们可以创建功能强大的自定义工作流。每个 Action 都可以接收输入参数并产生输出,这种输入输出机制使得 Action 之间能够进行数据传递和交互。例如,我们可以先使用 checkout action 检出代码,然后使用 setup-dotnet action 配置 .NET 环境,接着使用自定义的 build action 进行代码构建。这种模块化的组合方式不仅让工作流的配置变得更加清晰和易于维护,还提供了极大的灵活性。开发者可以根据项目的具体需求,选择合适的 Action 进行组合,或者开发自己的 Action 来扩展工作流的功能。在微服务架构中,这种灵活性尤其重要,因为不同的服务可能需要不同的构建和部署流程。

从技术实现的角度来看,Action 可以通过两种方式来创建:JavaScript 文件或 Docker 容器。JavaScript 类型的 Action 直接运行在工作流的运行器环境中,执行速度较快,适合实现一些轻量级的功能。这类 Action 可以充分利用 GitHub Actions 提供的工具包(toolkit)来简化开发。而 Docker 容器类型的 Action 则提供了更大的灵活性,因为容器可以包含任何所需的运行时环境和依赖。这使得 Docker Action 特别适合那些需要特定环境或有复杂依赖要求的任务。无论选择哪种实现方式,Action 都需要遵循特定的目录结构和配置格式,并且必须包含一个 action.yml 文件来定义其元数据、输入参数和输出变量。这种标准化的结构确保了 Action 可以被其他开发者轻松理解和使用。

二、工作流示例

在微服务架构中,持续集成和持续部署(CI/CD)是保证系统稳定性和开发效率的关键。以下将展示一个典型的 .NET 项目工作流配置示例,该工作流实现了代码的自动构建和测试。这个工作流配置虽然看起来简单,但包含了 CI/CD 流程中最基础和最重要的环节,可以作为更复杂工作流的基础模板。通过这个示例,我们可以了解 GitHub Actions 的基本用法,以及如何将其应用到实际的 .NET 项目开发中。

name: .NET Core Build and Teston:push:branches: [ main ]pull_request:branches: [ main ]jobs:build:runs-on: ubuntu-lateststeps:- uses: actions/checkout@v3- name: Setup .NETuses: actions/setup-dotnet@v3with:dotnet-version: '8.0.x'- name: Restore dependenciesrun: dotnet restore- name: Buildrun: dotnet build --no-restore- name: Testrun: dotnet test --no-build --verbosity normal

让我们详细解析这个工作流配置文件的结构和各个组成部分。首先,工作流通过 name 字段定义了一个清晰的名称 “.NET Core Build and Test”。在 on 部分,我们定义了工作流的触发条件 - 当有代码推送(push)到 main 分支或者创建针对 main 分支的拉取请求(pull request)时,工作流就会被触发执行。这种配置确保了每次代码变更都会经过自动化的构建和测试流程,从而及时发现潜在的问题。在 jobs 部分,我们定义了一个名为 build 的作业,它在 ubuntu-latest 环境中运行。这个作业包含了多个按顺序执行的步骤(steps),每个步骤都完成特定的任务。

三、常用功能

3.1 环境变量

在 GitHub Actions 中配置环境变量是一项重要的基础功能，它能帮助我们更好地管理和复用配置信息。环境变量可以在不同的作用域级别进行定义：工作流级别（workflow）、作业级别（job）和步骤级别（step）。在工作流文件中，我们使用 env 关键字来声明环境变量。工作流级别的环境变量在整个工作流的所有作业中都可以访问，而作业级别的环境变量则只在特定作业内可见。这种层次化的设计让我们能够更精确地控制变量的可见范围。除了静态的字符串值外，环境变量还可以引用 GitHub 提供的上下文变量，如 github.sha（获取提交哈希值）、github.ref（获取分支或标签信息）等。这些动态值使得我们的工作流配置更加灵活和智能。此外，对于敏感信息，我们可以使用 GitHub 的 Secrets 功能来存储（如下图），然后在环境变量中通过 ${{ secrets.SECRET_NAME }} 的方式安全地引用。

在实际使用中，环境变量的引用语法是 ${{ env.变量名 }}。这种语法在 YAML 文件的任何位置都可以使用，使得配置文件更加简洁和可维护。例如，我们可以定义 .NET 版本和构建配置这样的常用变量，然后在多个步骤中重复使用。这不仅减少了重复代码，还使得版本升级变得更加容易 - 只需要修改一处定义即可。当我们需要在不同环境（如开发、测试、生产）中使用不同的配置值时，可以结合 GitHub Actions 的环境功能，为每个环境定义专属的环境变量集合。这样的配置方式既保持了灵活性，又确保了配置的可维护性。以下是一个典型的环境变量配置示例，它定义了 .NET 版本和构建配置：

env:DOTNET_VERSION: '8.0.x'CONFIGURATION: 'Release'

3.2 条件执行

GitHub Actions 的条件执行功能是工作流自动化中的一个重要特性，它允许我们基于特定条件来控制工作流中步骤或作业的执行。条件执行主要通过 if 语句来实现，可以使用多种上下文变量和表达式来构建复杂的条件逻辑。最常见的使用场景是基于分支名称、事件类型或其他 GitHub 事件上下文来控制执行流程。例如，if: github.ref == 'refs/heads/main' 这个条件表达式确保相关步骤或作业只在 main 分支上执行。这种机制特别适用于需要在不同分支上执行不同操作的场景，比如只在主分支上进行部署，或者在特性分支上执行额外的测试。除了分支判断，我们还可以使用其他条件表达式，如 github.event_name（事件类型）、github.actor（触发事件的用户）等，这些都为工作流的精确控制提供了强大的支持。

在实际开发中，条件执行还可以与环境变量、GitHub Secrets 和其他上下文信息结合使用，构建更复杂的执行逻辑。例如，我们可以使用 contains() 函数检查提交消息是否包含特定关键词，使用 startsWith() 函数检查标签前缀，或者使用 && 和 || 运算符组合多个条件。一个典型的应用是在发布流程中，可能需要检查当前是否是发布标签（如 if: startsWith(github.ref, 'refs/tags/v')），是否在主分支上（if: github.ref == 'refs/heads/main'），以及是否是由授权用户触发（if: github.actor == 'authorized-user'）。这些条件可以组合使用，例如：if: github.ref == 'refs/heads/main' && github.event_name == 'push'，确保只有在满足所有指定条件时才执行相应的步骤。这种灵活的条件控制机制使得我们能够构建既安全又高效的自动化工作流程。

3.3 矩阵构建

矩阵构建是 GitHub Actions 中一个强大的功能特性，它允许我们使用单个工作流配置在多个不同的环境中运行相同的作业。这种方式特别适合需要在不同操作系统、运行时版本或其他变量组合下进行测试和构建的场景。通过矩阵构建，我们可以确保应用程序在各种目标环境中都能正常工作，从而提高软件的兼容性和可靠性。在配置文件中，矩阵构建通过 strategy.matrix 来定义，可以指定多个变量及其可能的值，GitHub Actions 会自动创建所有可能的组合并并行执行。

矩阵构建的一个重要优势是它能显著减少配置文件的重复内容。例如，如果我们需要在三个不同的 .NET 版本和两个不同的操作系统上测试应用，传统方式需要手动编写六个独立的作业配置。而使用矩阵构建，我们只需要定义一次作业配置，然后指定变量的可能值，GitHub Actions 就会自动生成所有需要的组合。这不仅使配置文件更加简洁，也更容易维护。当需要添加新的测试环境时，只需要在矩阵定义中添加相应的值即可。以下是一个基本的矩阵构建配置示例：

strategy:matrix:dotnet: ['6.0.x', '7.0.x', '8.0.x']os: [ubuntu-latest, windows-latest]

这段代码定义了 GitHub Actions 中的矩阵构建策略。矩阵构建是一种强大的功能，允许我们使用单个工作流配置在多个不同的环境中运行相同的作业。

1. strategy 关键字：

   • 这是 GitHub Actions 工作流中的一个顶级配置项
   • 用于定义作业的执行策略，包括矩阵构建、失败策略等

2. matrix 配置：

   • 定义了构建矩阵，即所有可能的组合
   • 在这个例子中，定义了两个变量：dotnet 和 os

3. 变量定义：

   • dotnet: ['6.0.x', '7.0.x', '8.0.x']：指定了三个 .NET 版本
   • os: [ubuntu-latest, windows-latest]：指定了两个操作系统环境

当这个矩阵策略被应用时，GitHub Actions 会自动创建并执行 6 个不同的作业组合：

• .NET 6.0.x 在 ubuntu-latest 上执行
• .NET 6.0.x 在 windows-latest 上执行
• .NET 7.0.x 在 ubuntu-latest 上执行
• .NET 7.0.x 在 windows-latest 上执行
• .NET 8.0.x 在 ubuntu-latest 上执行
• .NET 8.0.x 在 windows-latest 上执行

这种配置特别适用于：

• 跨平台测试：确保应用在不同操作系统上都能正常工作
• 多版本兼容性测试：验证应用在不同 .NET 版本上的兼容性
• 并行测试：所有组合可以并行执行，大大缩短总体测试时间

在微服务架构中，这种矩阵构建策略非常有用，因为不同的微服务可能需要支持不同的 .NET 版本，微服务可能需要在不同的操作系统环境中运行，通过一次配置，可以全面测试所有可能的组合，确保系统的兼容性和稳定性

四、实际应用场景

4.1 自动发布 NuGet 包

在微服务架构中，组件的共享和复用是提高开发效率的关键因素。通过将公共功能封装为NuGet包，我们可以在不同的微服务项目中轻松引用和使用这些功能。以下是一个自动发布NuGet包的GitHub Actions工作流示例，它会在推送带有版本标签的代码时自动构建并发布NuGet包：

name: Publish NuGet Packageon:push:tags:- 'v*'jobs:publish:runs-on: ubuntu-lateststeps:- uses: actions/checkout@v3- uses: actions/setup-dotnet@v3with:dotnet-version: '8.0.x'- run: dotnet pack- run: dotnet nuget pushenv:NUGET_API_KEY: ${{ secrets.NUGET_API_KEY }}

这段代码是一个 GitHub Actions 工作流配置文件，用于自动发布 NuGet 包。工作流名称为 “Publish NuGet Package”，它会在推送带有版本标签（以 ‘v’ 开头的标签，如 v1.0.0）的代码时自动触发。工作流包含一个名为 “publish” 的作业，该作业在 ubuntu-latest 环境中运行。作业中的步骤包括：首先使用 actions/checkout@v3 检出代码，然后使用 actions/setup-dotnet@v3 设置 .NET 8.0.x 环境，接着执行 dotnet pack 命令打包项目，最后通过 dotnet nuget push 命令将包推送到 NuGet 仓库。在推送过程中，工作流使用了一个名为 NUGET_API_KEY 的密钥，该密钥存储在 GitHub 的 Secrets 中，通过 ${{ secrets.NUGET_API_KEY }} 的方式安全引用，确保敏感信息不会被泄露。这种自动化发布流程特别适合微服务架构中的共享组件管理，可以确保每次版本更新都能自动构建并发布到 NuGet 仓库，方便其他微服务项目引用和使用。

4.2 Docker 镜像构建

在微服务架构中，Docker容器化是标准部署方式，通过GitHub Actions可以实现Docker镜像的自动构建和推送。以下是一个基本的Docker镜像构建工作流配置，它会在每次向main分支推送代码时自动触发：

name: Build and Push Docker Imageon:push:branches: [ main ]jobs:docker:runs-on: ubuntu-lateststeps:- uses: actions/checkout@v3- name: Build and pushuses: docker/build-push-action@v4with:context: .push: truetags: your-registry/your-image:latest

这段代码是一个 GitHub Actions 工作流配置文件，用于自动构建和推送 Docker 镜像。工作流名称为 “Build and Push Docker Image”，它会在每次向 main 分支推送代码时自动触发。工作流包含一个名为 “docker” 的作业，该作业在 ubuntu-latest 环境中运行。作业中的步骤包括：首先使用 actions/checkout@v3 检出代码，然后使用 docker/build-push-action@v4 动作来构建和推送 Docker 镜像。在构建和推送过程中，工作流指定了构建上下文为当前目录（context: .），启用了推送功能（push: true），并设置了镜像标签为 your-registry/your-image:latest。这种自动化 Docker 镜像构建和推送流程特别适合微服务架构中的容器化部署，可以确保每次代码更新都能自动构建最新的 Docker 镜像并推送到指定的镜像仓库，方便后续的部署和扩展。在实际应用中，我们需要将 your-registry/your-image:latest 替换为我们实际的镜像仓库地址和镜像名称，并可能需要配置 Docker 仓库的认证信息。

五、总结

GitHub Actions 作为 GitHub 提供的持续集成和持续部署(CI/CD)平台，在微服务架构中发挥着至关重要的作用。通过工作流(Workflow)、作业(Job)、步骤(Step)和动作(Action)等核心概念，我们可以构建出高效、可靠的自动化流程。在微服务架构中，GitHub Actions 能够为每个独立的服务定制专门的自动化流程，包括代码质量检查、单元测试、集成测试、容器镜像构建以及部署等步骤。通过环境变量、条件执行和矩阵构建等高级功能，我们可以实现更加灵活和智能的自动化流程。特别是在 NuGet 包发布和 Docker 镜像构建方面，GitHub Actions 提供了简单而强大的配置方式，使得微服务组件的共享和部署变得更加高效。通过合理配置 GitHub Actions，我们不仅确保了每个服务的质量，还大大减少了手动操作的工作量，使得整个微服务系统的维护和更新变得更加高效和可靠，为微服务架构的成功实施提供了坚实的技术支持。