Spire 天擎

外观

class ConfigurationBuilder ​

cangjie
public class ConfigurationBuilder <: IConfigurationBuilder

功能：提供配置根对象的构建能力。

父类型：

成员概览 ​

成员功能
prop sources返回当前已注册的配置源列表。
prop properties返回配置构建过程共享的属性集合。
func add(IConfigurationSource)添加一个配置源。
func build()构建配置根对象并加载所有配置源。

prop sources ​

cangjie
public prop sources: List<IConfigurationSource>

功能：返回当前已注册的配置源列表。

类型：List<IConfigurationSource>

prop properties ​

cangjie
public prop properties: Map<String, Any>

功能：返回配置构建过程共享的属性集合。

类型：Map<String, Any>

func add(IConfigurationSource) ​

cangjie
public func add(source: IConfigurationSource): IConfigurationBuilder

功能：添加一个配置源。

参数：

返回值：

func build() ​

cangjie
public func build(): IConfigurationRoot

功能：构建配置根对象并加载所有配置源。

返回值：

扩展成员 ​

成员功能
func addConfiguration(IConfiguration, Bool)将现有配置对象作为链式配置源添加到构建器。
func addCmdArgs(Array<String>, ?Map<String, String>)添加一个命令行参数配置源。
func addEnvVars()添加一个不带前缀过滤的环境变量配置源。
func addEnvVars(String)添加一个按前缀过滤的环境变量配置源。
func addJsonStream(IOStream)添加一个从输入流读取的 JSON 配置源。
func addJsonString(String)添加一个基于 JSON 字符串的配置源。
func addJsonFile(String, Bool)添加一个基于 JSON 文件的配置源。
func addMemory()添加一个空的内存配置源。
func addMemory(Collection<(String, String)>)添加一个基于键值集合的内存配置源。

func addConfiguration(IConfiguration, Bool) ​

cangjie
public func addConfiguration(configuration: IConfiguration, shouldDisposeConfiguration!: Bool = false): ConfigurationBuilder

功能：将现有配置对象作为链式配置源添加到构建器。

参数：

  • configuration: IConfiguration - 被链接的配置对象。
  • shouldDisposeConfiguration: Bool - 保留的兼容参数；当前运行时不执行释放动作。

返回值：

func addCmdArgs(Array<String>, ?Map<String, String>) ​

cangjie
public func addCmdArgs(args: Array<String>, switchMappings!: ?Map<String, String> = None): ConfigurationBuilder

功能：添加一个命令行参数配置源。

参数：

  • args: Array<String> - 命令行参数数组。
  • switchMappings: ?Map<String, String> - 可选的短开关到配置键映射。

返回值：

func addEnvVars() ​

cangjie
public func addEnvVars(): ConfigurationBuilder

功能：添加一个不带前缀过滤的环境变量配置源。

返回值：

func addEnvVars(String) ​

cangjie
public func addEnvVars(prefix: String): ConfigurationBuilder

功能：添加一个按前缀过滤的环境变量配置源。

参数：

  • prefix: String - 环境变量名前缀。

返回值：

func addJsonStream(IOStream) ​

cangjie
public func addJsonStream(stream: IOStream): ConfigurationBuilder

功能：添加一个从输入流读取的 JSON 配置源。

参数：

  • stream: IOStream - 提供 JSON 内容的输入流。

返回值：

func addJsonString(String) ​

cangjie
public func addJsonString(json: String): ConfigurationBuilder

功能：添加一个基于 JSON 字符串的配置源。

参数：

  • json: String - JSON 格式的配置内容。

返回值：

func addJsonFile(String, Bool) ​

cangjie
public func addJsonFile(path: String, optional!: Bool = true): ConfigurationBuilder

功能：添加一个基于 JSON 文件的配置源。

参数：

  • path: String - JSON 配置文件路径。
  • optional: Bool - 指示文件不存在时是否忽略。

返回值：

func addMemory() ​

cangjie
public func addMemory(): ConfigurationBuilder

功能：添加一个空的内存配置源。

返回值：

func addMemory(Collection<(String, String)>) ​

cangjie
public func addMemory(values: Collection<(String, String)>): ConfigurationBuilder

功能：添加一个基于键值集合的内存配置源。

参数：

  • values: Collection<(String, String)> - 初始化内存配置源的键值集合。

返回值：