CommandLineConfigurationExtensions.AddCommandLine 方法
定义
重要
一些信息与预发行产品相关，相应产品在发行之前可能会进行重大修改。 对于此处提供的信息，Microsoft 不作任何明示或暗示的担保。
重载
AddCommandLine(IConfigurationBuilder, Action<CommandLineConfigurationSource>)
添加一个 IConfigurationProvider 从命令行读取配置值。
public:
[System::Runtime::CompilerServices::Extension]
static Microsoft::Extensions::Configuration::IConfigurationBuilder ^ AddCommandLine(Microsoft::Extensions::Configuration::IConfigurationBuilder ^ builder, Action<Microsoft::Extensions::Configuration::CommandLine::CommandLineConfigurationSource ^> ^ configureSource);public static Microsoft.Extensions.Configuration.IConfigurationBuilder AddCommandLine(this Microsoft.Extensions.Configuration.IConfigurationBuilder builder, Action<Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationSource>? configureSource);static member AddCommandLine : Microsoft.Extensions.Configuration.IConfigurationBuilder * Action<Microsoft.Extensions.Configuration.CommandLine.CommandLineConfigurationSource> -> Microsoft.Extensions.Configuration.IConfigurationBuilder<Extension()>
Public Function AddCommandLine (builder As IConfigurationBuilder, configureSource As Action(Of CommandLineConfigurationSource)) As IConfigurationBuilder参数
- builder
- IConfigurationBuilder
要添加到的 IConfigurationBuilder 。
- configureSource
- Action<CommandLineConfigurationSource>
配置源。
返回
适用于
AddCommandLine(IConfigurationBuilder, String[])
添加一个 CommandLineConfigurationProviderIConfigurationProvider 从命令行读取配置值。
public:
[System::Runtime::CompilerServices::Extension]
static Microsoft::Extensions::Configuration::IConfigurationBuilder ^ AddCommandLine(Microsoft::Extensions::Configuration::IConfigurationBuilder ^ configurationBuilder, cli::array <System::String ^> ^ args);public static Microsoft.Extensions.Configuration.IConfigurationBuilder AddCommandLine(this Microsoft.Extensions.Configuration.IConfigurationBuilder configurationBuilder, string[] args);static member AddCommandLine : Microsoft.Extensions.Configuration.IConfigurationBuilder * string[] -> Microsoft.Extensions.Configuration.IConfigurationBuilder<Extension()>
Public Function AddCommandLine (configurationBuilder As IConfigurationBuilder, args As String()) As IConfigurationBuilder参数
- configurationBuilder
- IConfigurationBuilder
要添加到的 IConfigurationBuilder 。
- args
- String[]
命令行参数。
返回
示例
一个具有五个值的简单控制台应用程序。
// dotnet run key1=value1 --key2=value2 /key3=value3 --key4 value4 /key5 value5
using Microsoft.Extensions.Configuration;
using System;
namespace CommandLineSample
{
public class Program
{
public static void Main(string[] args)
{
var builder = new ConfigurationBuilder();
builder.AddCommandLine(args);
var config = builder.Build();
Console.WriteLine($"Key1: '{config["Key1"]}'");
Console.WriteLine($"Key2: '{config["Key2"]}'");
Console.WriteLine($"Key3: '{config["Key3"]}'");
Console.WriteLine($"Key4: '{config["Key4"]}'");
Console.WriteLine($"Key5: '{config["Key5"]}'");
}
}
}
注解
在字符串数组中 args ，在命令行上传递的值应该是一组以两条短划线（“--”）为前缀的键，然后用等号（“=”）或空格（“）分隔。
正斜杠（“/”）可以用作替代前缀（等于或空格），使用等号时，前缀可以完全排除。
参数有五种基本替代格式： key1=value1 --key2=value2 /key3=value3 --key4 value4 /key5 value5。
适用于
AddCommandLine(IConfigurationBuilder, String[], IDictionary<String,String>)
添加使用 CommandLineConfigurationProviderIConfigurationProvider 指定的交换机映射从命令行读取配置值。
public:
[System::Runtime::CompilerServices::Extension]
static Microsoft::Extensions::Configuration::IConfigurationBuilder ^ AddCommandLine(Microsoft::Extensions::Configuration::IConfigurationBuilder ^ configurationBuilder, cli::array <System::String ^> ^ args, System::Collections::Generic::IDictionary<System::String ^, System::String ^> ^ switchMappings);public static Microsoft.Extensions.Configuration.IConfigurationBuilder AddCommandLine(this Microsoft.Extensions.Configuration.IConfigurationBuilder configurationBuilder, string[] args, System.Collections.Generic.IDictionary<string,string>? switchMappings);static member AddCommandLine : Microsoft.Extensions.Configuration.IConfigurationBuilder * string[] * System.Collections.Generic.IDictionary<string, string> -> Microsoft.Extensions.Configuration.IConfigurationBuilder<Extension()>
Public Function AddCommandLine (configurationBuilder As IConfigurationBuilder, args As String(), switchMappings As IDictionary(Of String, String)) As IConfigurationBuilder参数
- configurationBuilder
- IConfigurationBuilder
要添加到的 IConfigurationBuilder 。
- args
- String[]
命令行参数。
- switchMappings
- IDictionary<String,String>
开关映射。 短（前缀为“-”）和别名键（前缀为“--”）的字典，映射到配置键（无前缀）。
返回
示例
一个简单的控制台应用程序，定义了两个短和四个别名交换机映射。
// dotnet run -k1=value1 -k2 value2 --alt3=value2 /alt4=value3 --alt5 value5 /alt6 value6
using Microsoft.Extensions.Configuration;
using System;
using System.Collections.Generic;
namespace CommandLineSample
{
public class Program
{
public static void Main(string[] args)
{
var switchMappings = new Dictionary<string, string>()
{
{ "-k1", "key1" },
{ "-k2", "key2" },
{ "--alt3", "key3" },
{ "--alt4", "key4" },
{ "--alt5", "key5" },
{ "--alt6", "key6" },
};
var builder = new ConfigurationBuilder();
builder.AddCommandLine(args, switchMappings);
var config = builder.Build();
Console.WriteLine($"Key1: '{config["Key1"]}'");
Console.WriteLine($"Key2: '{config["Key2"]}'");
Console.WriteLine($"Key3: '{config["Key3"]}'");
Console.WriteLine($"Key4: '{config["Key4"]}'");
Console.WriteLine($"Key5: '{config["Key5"]}'");
Console.WriteLine($"Key6: '{config["Key6"]}'");
}
}
}
注解
允许 switchMappings 从命令行使用备用短键和别名键的其他格式。 另请参阅支持的标准格式的基本版本 AddCommandLine 。
短键以单个短划线（“-”）开头，映射到主键名称（不含前缀），可用于等于或空格。 单个短划线映射旨在用于更短的备用开关。
请注意，无法直接访问单个短划线开关，但必须使用完整键定义和访问交换机映射。 传递未定义的单个短划线参数将导致为 FormatException.
短参数有两种格式： -k1=value1 -k2 value2
别名键定义以两条短划线（“--”）开头，映射到主键名称（不含前缀），并可用于代替普通键。 在命令行中使用正斜杠前缀（但不具有前缀等于格式）时，它们也起作用。
别名参数只有四种格式： --alt3=value3 /alt4=value4 --alt5 value5 /alt6 value6。
