Nuget 多平台多目标如何快速自动打包

引言

在现代软件开发中，跨平台开发已经成为一种趋势。无论是桌面应用、移动应用还是Web应用，开发者都希望能够将代码复用到多个平台上。为了实现这一目标，Nuget 包管理工具成为了.NET生态系统中不可或缺的一部分。Nuget 不仅可以帮助开发者管理和共享代码库，还可以通过多平台多目标（Multi-Targeting）的方式，将代码打包成适用于不同平台的库。

本文将详细介绍如何使用 Nuget 进行多平台多目标的快速自动打包，涵盖从项目配置到自动化构建的完整流程。

1. 理解多平台多目标

1.1 什么是多平台多目标？

多平台多目标（Multi-Targeting）是指在一个项目中同时支持多个目标框架（Target Frameworks），例如 .NET Core、.NET Standard、.NET Framework、Xamarin 等。通过多目标，开发者可以在一个项目中编写适用于多个平台的代码，而不需要为每个平台单独创建项目。

1.2 为什么需要多平台多目标？

• 代码复用：通过多目标，开发者可以在一个项目中编写适用于多个平台的代码，减少重复劳动。
• 维护简便：只需要维护一个项目，而不是多个项目，降低了维护成本。
• 兼容性：通过多目标，可以确保代码在不同平台上的兼容性，减少因平台差异导致的bug。

2. 配置多平台多目标项目

2.1 创建多目标项目

首先，创建一个新的 .NET 类库项目。可以使用 Visual Studio 或者命令行工具 dotnet new 来创建项目。

dotnet new classlib -n MultiTargetLibrary

2.2 修改项目文件

在项目文件中，通过 <TargetFrameworks> 标签来指定多个目标框架。例如，以下配置表示该项目将同时支持 .NET Core 3.1、.NET 5.0 和 .NET Standard 2.0。

<Project Sdk="Microsoft.NET.Sdk">

  <PropertyGroup>
    <TargetFrameworks>netcoreapp3.1;net5.0;netstandard2.0</TargetFrameworks>
  </PropertyGroup>

</Project>

2.3 条件编译

在多目标项目中，可能需要根据不同的目标框架编写不同的代码。可以使用条件编译符号来实现这一点。

#if NETCOREAPP3_1
    // .NET Core 3.1 特定的代码
#elif NET5_0
    // .NET 5.0 特定的代码
#elif NETSTANDARD2_0
    // .NET Standard 2.0 特定的代码
#endif

3. 配置 Nuget 打包

3.1 添加 Nuget 元数据

在项目文件中，添加 Nuget 包的元数据信息，例如包ID、版本、作者、描述等。

<PropertyGroup>
  <PackageId>MultiTargetLibrary</PackageId>
  <Version>1.0.0</Version>
  <Authors>Your Name</Authors>
  <Description>A multi-targeting library for .NET</Description>
  <PackageTags>multi-targeting, .NET, cross-platform</PackageTags>
</PropertyGroup>

3.2 添加依赖项

如果项目依赖于其他 Nuget 包，可以在项目文件中添加依赖项。注意，不同目标框架可能需要不同的依赖项。

<ItemGroup Condition="'$(TargetFramework)' == 'netcoreapp3.1'">
  <PackageReference Include="SomePackage" Version="1.0.0" />
</ItemGroup>

<ItemGroup Condition="'$(TargetFramework)' == 'net5.0'">
  <PackageReference Include="AnotherPackage" Version="2.0.0" />
</ItemGroup>

3.3 生成 Nuget 包

在项目文件中，设置 <GeneratePackageOnBuild> 为 true，这样在构建项目时会自动生成 Nuget 包。

<PropertyGroup>
  <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
</PropertyGroup>

4. 自动化构建与打包

4.1 使用 Azure Pipelines 进行自动化构建

Azure Pipelines 是微软提供的持续集成和持续交付（CI/CD）服务，可以帮助开发者自动化构建、测试和发布流程。

4.1.1 创建 Azure Pipelines 配置文件

在项目根目录下创建一个 azure-pipelines.yml 文件，配置构建和打包任务。

trigger:
- main

pool:
  vmImage: 'windows-latest'

variables:
  buildConfiguration: 'Release'

steps:
- task: UseDotNet@2
  inputs:
    packageType: 'sdk'
    version: '5.x'
    installationPath: $(Agent.ToolsDirectory)/dotnet

- task: DotNetCoreCLI@2
  inputs:
    command: 'build'
    projects: '**/*.csproj'
    arguments: '--configuration $(buildConfiguration)'

- task: DotNetCoreCLI@2
  inputs:
    command: 'pack'
    projects: '**/*.csproj'
    arguments: '--configuration $(buildConfiguration) --output $(Build.ArtifactStagingDirectory)'

- task: PublishBuildArtifacts@1
  inputs:
    PathtoPublish: '$(Build.ArtifactStagingDirectory)'
    ArtifactName: 'drop'
    publishLocation: 'Container'

4.1.2 提交代码并触发构建

将代码提交到版本控制系统（如 GitHub），Azure Pipelines 会自动触发构建任务，并生成 Nuget 包。

4.2 使用 GitHub Actions 进行自动化构建

GitHub Actions 是 GitHub 提供的 CI/CD 服务，可以帮助开发者在 GitHub 仓库中自动化构建和发布流程。

4.2.1 创建 GitHub Actions 配置文件

在项目根目录下创建一个 .github/workflows/build.yml 文件，配置构建和打包任务。

name: Build and Pack

on:
  push:
    branches:
      - main

jobs:
  build:
    runs-on: windows-latest

    steps:
    - uses: actions/checkout@v2

    - name: Setup .NET
      uses: actions/setup-dotnet@v1
      with:
        dotnet-version: '5.x'

    - name: Build
      run: dotnet build --configuration Release

    - name: Pack
      run: dotnet pack --configuration Release --output ./artifacts

    - name: Upload Artifacts
      uses: actions/upload-artifact@v2
      with:
        name: nuget-packages
        path: ./artifacts

4.2.2 提交代码并触发构建

将代码提交到 GitHub 仓库，GitHub Actions 会自动触发构建任务，并生成 Nuget 包。

5. 发布 Nuget 包

5.1 发布到 Nuget.org

生成 Nuget 包后，可以将其发布到 Nuget.org 供其他开发者使用。

5.1.1 获取 API Key

首先，在 Nuget.org 上注册账号并获取 API Key。

5.1.2 使用命令行发布

使用 dotnet nuget push 命令将 Nuget 包发布到 Nuget.org。

dotnet nuget push ./artifacts/MultiTargetLibrary.1.0.0.nupkg -k YOUR_API_KEY -s https://api.nuget.org/v3/index.json

5.2 发布到私有 Nuget 服务器

如果不想将包发布到公共的 Nuget.org，可以发布到私有的 Nuget 服务器。

5.2.1 配置私有 Nuget 源

在项目文件中，添加私有 Nuget 源的配置。

<PropertyGroup>
  <PackageSources>https://your-private-nuget-server/v3/index.json</PackageSources>
</PropertyGroup>

5.2.2 使用命令行发布

使用 dotnet nuget push 命令将 Nuget 包发布到私有 Nuget 服务器。

dotnet nuget push ./artifacts/MultiTargetLibrary.1.0.0.nupkg -k YOUR_PRIVATE_API_KEY -s https://your-private-nuget-server/v3/index.json

6. 总结

通过本文的介绍，我们了解了如何使用 Nuget 进行多平台多目标的快速自动打包。从项目配置到自动化构建，再到发布 Nuget 包，整个过程都可以通过简单的配置和命令行工具来实现。希望本文能够帮助开发者在跨平台开发中更加高效地管理和共享代码库。