Skip to content

class ConfigurationBinder

cangjie
public class ConfigurationBinder

功能:提供将配置数据绑定到对象实例的工具方法。

成员概览

成员功能
func get(IConfiguration)按泛型目标类型从配置中获取绑定结果。
func get(IConfiguration, TypeInfo)按指定类型信息从配置中获取绑定结果。
func getValue(IConfiguration, String)获取指定配置键并按泛型目标类型转换其值。
func getValue(IConfiguration, TypeInfo, String)获取指定配置键并按目标类型转换其值。
func bind(Any, IConfiguration)将配置中的值递归绑定到对象实例。

func get(IConfiguration)

cangjie
public static func get<T>(configuration: IConfiguration): ?T

功能:按泛型目标类型从配置中获取绑定结果。

参数:

返回值:

  • ?T - 与泛型目标类型匹配的绑定结果;如果无法绑定则返回空。

func get(IConfiguration, TypeInfo)

cangjie
public static func get(configuration: IConfiguration, typeInfo: TypeInfo): ?Any

功能:按指定类型信息从配置中获取绑定结果。

参数:

  • configuration: IConfiguration - 提供配置数据的配置对象。
  • typeInfo: TypeInfo - 目标结果的类型信息。

返回值:

  • ?Any - 与目标类型匹配的绑定结果;如果无法绑定则返回空。

func getValue(IConfiguration, String)

cangjie
public static func getValue<T>(configuration: IConfiguration, name: String): ?T

功能:获取指定配置键并按泛型目标类型转换其值。

参数:

  • configuration: IConfiguration - 提供配置数据的配置对象。
  • name: String - 要读取的配置键名。

返回值:

  • ?T - 转换后的配置值;如果配置键不存在或无法转换则返回空。

func getValue(IConfiguration, TypeInfo, String)

cangjie
public static func getValue(configuration: IConfiguration, typeInfo: TypeInfo, name: String): ?Any

功能:获取指定配置键并按目标类型转换其值。

参数:

  • configuration: IConfiguration - 提供配置数据的配置对象。
  • typeInfo: TypeInfo - 配置值要转换成的目标类型信息。
  • name: String - 要读取的配置键名。

返回值:

  • ?Any - 转换后的配置值;如果配置键不存在则返回空。

func bind(Any, IConfiguration)

cangjie
public static func bind(instance: Any, configuration: IConfiguration): Unit

功能:将配置中的值递归绑定到对象实例。

参数:

  • instance: Any - 要接收绑定结果的对象实例。
  • configuration: IConfiguration - 提供绑定数据的配置对象。

返回值:

  • Unit