安装

本页介绍如何安装 Apq.Cfg 及其扩展包。

系统要求

• .NET 6.0 或更高版本
• 或 .NET Standard 2.0/2.1 兼容的运行时

核心包安装

使用 .NET CLI

dotnet add package Apq.Cfg

使用 Package Manager

Install-Package Apq.Cfg

使用 PackageReference

<PackageReference Include="Apq.Cfg" Version="1.0.*" />

扩展包安装

根据需要安装对应的扩展包：

本地配置源

YAML

dotnet add package Apq.Cfg.Yaml

XML

dotnet add package Apq.Cfg.Xml

INI

dotnet add package Apq.Cfg.Ini

TOML

dotnet add package Apq.Cfg.Toml

Env

dotnet add package Apq.Cfg.Env

远程配置源

Consul

dotnet add package Apq.Cfg.Consul

Redis

dotnet add package Apq.Cfg.Redis

Apollo

dotnet add package Apq.Cfg.Apollo

Vault

dotnet add package Apq.Cfg.Vault

Etcd

dotnet add package Apq.Cfg.Etcd

Zookeeper

dotnet add package Apq.Cfg.Zookeeper

Nacos

dotnet add package Apq.Cfg.Nacos

源生成器

dotnet add package Apq.Cfg.SourceGenerator

完整安装示例

一个典型的企业应用可能需要以下包：

<ItemGroup>
  <!-- 核心包 -->
  <PackageReference Include="Apq.Cfg" Version="1.0.*" />
  
  <!-- 本地配置格式 -->
  <PackageReference Include="Apq.Cfg.Yaml" Version="1.0.*" />
  <PackageReference Include="Apq.Cfg.Toml" Version="1.0.*" />
  
  <!-- 远程配置中心 -->
  <PackageReference Include="Apq.Cfg.Consul" Version="1.0.*" />
  <PackageReference Include="Apq.Cfg.Vault" Version="1.0.*" />
  
  <!-- 源生成器 -->
  <PackageReference Include="Apq.Cfg.SourceGenerator" Version="1.0.*" />
</ItemGroup>

验证安装

创建一个简单的测试程序验证安装：

using Apq.Cfg;

// 创建一个简单的 JSON 配置文件 test.json
// { "Test": { "Key": "Hello, Apq.Cfg!" } }

var cfg = new CfgBuilder()
    .AddJson("test.json", level: 0, writeable: false)
    .Build();

Console.WriteLine(cfg.Get("Test:Key"));
// 输出: Hello, Apq.Cfg!

或者使用环境变量测试：

using Apq.Cfg;

// 设置环境变量 TEST_KEY=Hello, Apq.Cfg!
Environment.SetEnvironmentVariable("TEST_KEY", "Hello, Apq.Cfg!");

var cfg = new CfgBuilder()
    .AddEnvironmentVariables(level: 0, prefix: "TEST_")
    .Build();

Console.WriteLine(cfg.Get("KEY"));
// 输出: Hello, Apq.Cfg!

下一步

• 快速开始 - 学习基本用法
• 基础用法 - 深入了解配置读取