检查 XElement 是否全局为空

Question

我有一个班级负责读取和保存 XML 文件。 现在它的一个简单版本如下所示：

public class EstEIDPersoConfig
{
    public bool LaunchDebugger { get ; set; }
    public string Password { get; set; }
    public int Slot { get; set; }
    public string Reader { get; set; }
    public string TestInput { get; set; }
    public bool Logging { get; set; }

    public EstEIDPersoConfig()
    {
        XElement xml = XElement.Load(myxml.xml);
        XElement Configuration = xml.Element("Configuration");

        LaunchDebugger = Convert.ToBoolean(Configuration.Element("LaunchDebugger").Value);
        Password = Configuration.Element("Password").Value;
        Slot = Convert.ToInt32(Configuration.Element("Slot").Value);
        Reader = Configuration.Element("Reader").Value;
        TestInput = Configuration.Element("TestInput").Value;
        Logging = Convert.ToBoolean(Configuration.Element("Logging").Value);
     }
 }

以后还会有更多。所以问题是如果xml中不存在某些元素，我会得到System.NullReferenceException。所以我需要检查元素是否为null。这是一种方法：

var value = Configuration.Element("LaunchDebugger").Value;
if (value != null)
    LaunchDebugger = Convert.ToBoolean(value);
else
    throw new Exception("LaunchDebugger element missing from xml!");

但是对每个元素都这样做就太过分了。所以我需要一些好的想法来简化这个系统，这样它就不会变成 1000 行代码。

编辑：编辑最后一个代码sn-p，想法不是设置默认值，想法是通知用户xml中缺少此元素whats null。

Answer 1

这里的想法直接来自 abatischev 的回答，因此他值得称赞。

按照 Microsoft here 的规定，您可以将 XElement 强制转换为您想要的类型。

LaunchDebugger = (bool?)Configuration.Element("LaunchDebugger");

如果你想处理null 的情况，我想你可以做到

LaunchDebugger = (bool)(Configuration.Element("LaunchDebugger") ?? true);

或许

LaunchDebugger = (bool)(Configuration.Element("LaunchDebugger") ?? false);

取决于您的业务逻辑。如果您为特定类型执行相同的合并场景，则可能适合将这一衬里包装在方法、扩展或其他方式中，但我不确定它会增加多少。

Answer 2

(bool)Configuration.Element("LaunchDebugger")

或

(bool?)Configuration.Element("LaunchDebugger")

不应抛出异常。

参见 MSDN：

• XElement Explicit Conversion (XElement to Boolean)
• XElement Explicit Conversion (XElement to Nullable<Boolean>)

Answer 3

我有一个扩展方法，只用于这种事情：

    public static T GetValue<T>(
            this XElement @this,
            XName name, 
            Func<XElement, T> cast, 
            Func<T> @default)
    {
        var e = @this.Element(name);
        return (e != null) ? cast(e) : @default();
    }

它为您提供所需的强制转换以及默认值工厂。

以下是您的使用方法：

LaunchDebugger = Configuration.GetValue("LaunchDebugger",
    x => Convert.ToBoolean(x), () => false);
Password = Configuration.GetValue("CMKPassword", x => (string)x, () => "");
Slot = Configuration.GetValue("CMKSlot", x => (int)x, () => -1);
Reader = Configuration.GetValue("Reader", x => (string)x, () => "");
TestInput = Configuration.GetValue("TestInput", x => (string)x, () => "");
Logging = Configuration.GetValue("Logging",
    x => Convert.ToBoolean(x), () => false);

Answer 4

将逻辑提取到方法中，并为Int32、boolean和其他数据类型转换提供重载方法。

public static void GetElementValue(XElement xElement, string parameter, out bool value)
    {
        var stringValue = xElement.Element(parameter).Value;
        value = false;
        if (value != null)
            value = Convert.ToBoolean(stringValue);
    }

Answer 5

您可以定义一种方法来为您提取值并在那里对 null 进行一些检查。因此，将值检索包装在您自己的方法中，如下所示：

public string GetXMLValue(XElement config, string elementName){
    var element = Configuration.Element(elementName);

    if(element == null)
        return String.Empty;

    return element.Value;
}

当然，您可以扩展它以正确解析为布尔值等。

Answer 6

外部方法怎么样：

public static class XElementExtensions
{
    public static bool AsBoolean(this XElement self, bool defaultValue)
    {
        if (self == null)
        {
            return defaultValue;
        }
        if (!string.IsNullOrEmpty(self.Value))
        {           
            try
            {
                return XmlConvert.ToBoolean(self.Value);
            }
            catch
            {
                return defaultValue;
            }
        }
        return defaultValue;
    }
}

我已经用 SnippetCompiler 对此进行了测试：

XElement test = new XElement("test", 
    new XElement("child1"),
    new XElement("child2", new XText("true")),
    new XElement("child3", new XText("false")),
    new XElement("child4", new XText("rubbish")));

WL(test.Element("child1").AsBoolean(false)); // note, "child1" has no value (or is `""`)
WL(test.Element("child2").AsBoolean(false));
WL(test.Element("child3").AsBoolean(false));
WL(test.Element("child4").AsBoolean(false));
WL(test.Element("child5").AsBoolean(false)); // note, "child5" doesn't exist        

要产生这个结果：

False
True
False
False
False

为其他类型添加更多此类方法并添加AsBoolean(defaultValue)，因为当您想默认为true时，它可以派上用场！

正如其他人所说，您可以使用?? 运算符为null 提供值。不过，这不会嵌套，所以：

LaunchDebugger = XmlConvert.ToBoolean(Configuration.Element("LaunchDebugger").Value) ?? false;

如果 XML 文件中没有这样的元素，将通过 NullReferenceException。