具有空默认值的配置字符串

Question

我有以下配置属性作为元素的一部分：

[ConfigurationProperty("example", IsRequired = false, DefaultValue = null)]
public string Example { 
get { return (string)base["example"]; }
set { base["example"] = value; }
}

如果我按如下方式设置它，它会占用"Hello"字符串并正常工作：

<myElement example="Hello"/>

如果它不存在，我会遇到问题：

<myElement/>

它不是采用上面指定的默认值null，而是采用String.Empty。为什么会这样，我怎样才能让它采用默认值null？

更新

这肯定是因为base["example"]返回String.Empty，其中base是一个ConfigurationElement(索引器在这里定义：https://msdn.microsoft.com/en-us/library/c8693ks1(v=vs.110).aspx)，但我仍然不确定为什么它不取null的值。

更新

即使DefaultValue = default(string)也将字符串设置为String.Empty.

更新

即使base.Properties.Contains("example")在配置中不存在该属性，也会返回true。

Answer 1

从ConfigurationProperty类的参考来源来看，这可能不是一个错误，而是一个功能。

这是相关的内部方法，InitDefaultValueFromTypeInfo(我进行了一些小的格式修改)：

private void InitDefaultValueFromTypeInfo(ConfigurationPropertyAttribute attribProperty,
DefaultValueAttribute attribStdDefault) {
object defaultValue = attribProperty.DefaultValue;
// If there is no default value there - try the other attribute ( the clr standard one )
if ((defaultValue == null || defaultValue == ConfigurationElement.s_nullPropertyValue) &&
(attribStdDefault != null)) {
defaultValue = attribStdDefault.Value;
}
// If there was a default value in the prop attribute - check if we need to convert it from string
if ((defaultValue != null) && (defaultValue is string) && (_type != typeof(string))) {
// Use the converter to parse this property default value
try {
defaultValue = Converter.ConvertFromInvariantString((string)defaultValue);
}
catch (Exception ex) {
throw new ConfigurationErrorsException(SR.GetString(SR.Default_value_conversion_error_from_string, _name, ex.Message));
}
}
if (defaultValue == null || defaultValue == ConfigurationElement.s_nullPropertyValue) {
if (_type == typeof(string)) {
defaultValue = String.Empty;
}
else if (_type.IsValueType) {
defaultValue = TypeUtil.CreateInstanceWithReflectionPermission(_type);
}
}
SetDefaultValue(defaultValue);
}

最后一个if块很有趣：如果你的属性有类型string，并且默认值是null，则默认值将更改为string.Empty。

第一个if块暗示了这种特殊行为的可能解释。[ConfigurationProperty]属性的DefaultValue属性是可选的。如果程序员未设置DefaultValue，则默认null自身。第一个if块使用该默认null来检查是否指定了DefaultValue。如果没有，它将回退到从[DefaultValue]属性中获取默认值(如果存在)。

这一切都意味着：指定DefaultValue = null与根本不指定具有相同的效果，在这种情况下，配置子系统为字符串选择一个"理智"的默认值：空字符串。

解决方法：

这里有一个有点麻烦的解决方法：不要将配置属性声明为string，而是声明为字符串周围的薄包装器类型;然后声明合适的类型转换器：

[ConfigurationProperty("name", IsRequired = false)]
[TypeConverter(typeof(IncognitoStringConverter))]  // note: additional attribute!
public IncognitoString Name                        // note: different property type
{
get
{
return (IncognitoString)base["name"];
}
set
{
base["name"] = value;
}
}

以下是IncognitoString和IncognitoStringConverter的实现：

public struct IncognitoString
{
private IncognitoString(string value)
{
this.value = value;
}
private readonly string value;
public static implicit operator IncognitoString(string value)
{
return new IncognitoString(value);
}
public static implicit operator string(IncognitoString incognitoString)
{
return incognitoString.value;
}
… // perhaps override ToString, GetHashCode, and Equals as well.
}
public sealed class IncognitoStringConverter : TypeConverter
{
public override bool CanConvertFrom(ITypeDescriptorContext context, Type sourceType)
{
return sourceType == typeof(string);
}
public override object ConvertFrom(ITypeDescriptorContext context, CultureInfo culture, object value)
{
return (IncognitoString)(string)value;
}
}

因为IncognitoString可以隐式转换为string，所以可以将属性值分配给任何字符串变量。我知道，仅仅为了获得可为空的属性，这很笨拙且非常复杂。也许只是忍受空字符串。

Answer 2

另一种解决方法是进行如下调用：

[ConfigurationProperty("Prompt")]
public string Prompt
{
get { return this.GetNullableStringValue("Prompt"); }
}
private string GetNullableStringValue(string propertyName)
{
return (string)this[new ConfigurationProperty(propertyName, typeof(string), null)];
}

像这样调用GetNullableString会绕过配置属性属性并停止它，将默认值默认为 null。您也可以将该方法放在基类中，以使其更整洁。

您只需要记住，如果要更改默认值，请调用它。

如果您想提升可能在属性上定义的一些其他内容，您也可以调用this.ElementInformation.Properties[propertyName]- 只是不要使用它来填充DefaultValue

Answer 3

无需检查null的属性值，您可以轻松检查是否已在配置文件中设置该属性或是否已返回默认值。这可以通过查看ConfigurationElementElementInformation中的ValueOrigin来完成。

// if not the default value...    
if (MyConfigurationElement.ElementInformation.Properties["example"].ValueOrigin!=
PropertyValueOrigin.Default)
{
...
}

另请参阅 PropertyValueOrigin 枚举的值的文档。

Answer 4

ConfigurationElement类型具有ElementInformation属性，而 属性又具有IsPresent属性。

因此，与其尝试返回空ConfigurationElement，不如检查IsPresent属性以查看"关联的 ConfigurationElement 对象是否在配置文件中"。1

例如：

if (Configuration.Example.ElementInformation.IsPresent)
{
...
}

Answer 5

我选择使用更具可读性和可重用性的扩展方法ToNullIfEmpty().我保留了默认值，以防将空字符串转换为 String.Empty 的非直观行为发生变化。

[ConfigurationProperty("dataCenterRegion", DefaultValue = null)]
public string DataCenterRegion
{
get { return ((string)this["dataCenterRegion"]).ToNullIfEmpty(); }
set { this["dataCenterRegion"] = value; }
}
public static partial class ExtensionMethods
{        
/// <summary>
/// Return null if the string is empty or is already null.
/// Otherwise, return the original string.
/// </summary>
public static string ToNullIfEmpty(this string str)
{
return String.IsNullOrEmpty(str) ? null : str;
}
/// <summary>
/// Return null if the string is white space, empty or is already null.
/// Otherwise, return the original string.
/// </summary>
public static string ToNullIfWhiteSpaceOrEmpty(this string str)
{
return String.IsNullOrWhiteSpace(str) ? null : str;
}
}