XML 阅读器属性 - C#

XML 是一种常用的数据交互格式，而 C# 中的 XML 阅读器则是一种能够解析 XML 文档的工具，可以让程序员轻松地访问和操作 XML 数据。本文将介绍 C# 中 XML 阅读器的属性，帮助开发者更好地理解和应用它们。

XML 阅读器属性的概述

XML 阅读器属性是阅读器对象中的一些重要元素，可以通过这些属性来获取或设置阅读器的一些状态或属性。C# 中的 XML 阅读器提供了许多属性，包括以下几个方面：

• 基础属性：提供了基础的阅读器状态信息，例如当前节点的属性、深度、类型等。
• 名称和命名空间属性：提供了节点名称和命名空间的信息。
• 值属性：提供了节点值的信息。
• 属性集合属性：提供了节点的属性集合信息。
• 深度和路径属性：提供了节点深度、路径等信息。

接下来将逐个介绍这些属性的具体内容及使用方式。

基础属性

NodeType 属性

| 属性类型 | 属性名 | |:---:|:---:| |数据类型 | XmlNodeType| |读写说明 |只读| |说明 |获取当前节点的类型|

NodeType 属性是一个只读属性，用于获取当前节点的类型，其返回值为 XmlNodeType 枚举类型的值。XmlNodeType 枚举包括了 XML 中可能出现的所有节点类型，例如元素节点、文本节点等。

using (XmlReader reader = XmlReader.Create("example.xml"))
{
    while(reader.Read())
    {
        if (reader.NodeType == XmlNodeType.Element) //判断节点类型是否为元素节点
        {
            Console.WriteLine("元素节点：{0}", reader.Name);
        }
        else if (reader.NodeType == XmlNodeType.Text) //判断节点类型是否为文本节点
        {
            Console.WriteLine("文本节点：{0}", reader.Value);
        }
        //其他节点类型的处理方式...
    }
}

Depth 属性

| 属性类型 | 属性名 | |:---:|:---:| |数据类型 | int| |读写说明 |只读| |说明 |获取当前节点相对于根节点的深度|

Depth 属性是一个只读属性，用于获取当前节点相对于根节点的深度，其返回值为整型。

using (XmlReader reader = XmlReader.Create("example.xml"))
{
    while (reader.Read())
    {
        Console.WriteLine("当前节点深度：{0}", reader.Depth);
    }
}

Name 和 LocalName 属性

| 属性类型 | 属性名 | |:---:|:---:| |数据类型 | string| |读写说明 |只读| |说明 |获取当前节点的名称（包含命名空间前缀）和名称（不包含命名空间前缀）|

Name 属性是一个只读属性，用于获取当前节点的名称，其返回值包括命名空间前缀。如果需要获取不包含命名空间前缀的名称，可以使用 LocalName 属性。

using (XmlReader reader = XmlReader.Create("example.xml"))
{
    while(reader.Read())
    {
        if (reader.NodeType == XmlNodeType.Element)
        {
            Console.WriteLine("元素名称（包含命名空间前缀）：{0}", reader.Name);
            Console.WriteLine("元素名称（不包含命名空间前缀）：{0}", reader.LocalName);
        }
    }
}

HasAttributes 和 HasValue 属性

| 属性类型 | 属性名 | |:---:|:---:| |数据类型 | bool| |读写说明 |只读| |说明 |判断当前节点是否包含属性和节点值|

HasAttributes 和 HasValue 属性均是只读属性，分别用于判断当前节点是否包含属性和节点值，其返回值为布尔类型。

using (XmlReader reader = XmlReader.Create("example.xml"))
{
    while(reader.Read())
    {
        if (reader.NodeType == XmlNodeType.Element)
        {
            Console.WriteLine("该元素节点是否包含属性：{0}", reader.HasAttributes);
        }
        else if (reader.NodeType == XmlNodeType.Text)
        {
            Console.WriteLine("该文本节点是否包含节点值：{0}", reader.HasValue);
        }
        //其他节点类型的处理方式...
    }
}

名称和命名空间属性

Prefix 和 NamespaceURI 属性

| 属性类型 | 属性名 | |:---:|:---:| |数据类型 | string| |读写说明 |只读| |说明 |获取当前节点的命名空间前缀和命名空间 URI|

Prefix 和 NamespaceURI 属性均是只读属性，用于获取当前节点的命名空间前缀和命名空间 URI。

需要注意的是，只有当读取到元素节点时，这两个属性才有意义。

using (XmlReader reader = XmlReader.Create("example.xml"))
{
    while(reader.Read())
    {
        if (reader.NodeType == XmlNodeType.Element)
        {
            Console.WriteLine("元素节点名称（包含命名空间）：{0}", reader.Name);
            Console.WriteLine("元素节点名称（不包含命名空间）：{0}", reader.LocalName);
            Console.WriteLine("元素节点命名空间前缀：{0}", reader.Prefix);
            Console.WriteLine("元素节点命名空间 URI：{0}", reader.NamespaceURI);
        }
    }
}

值属性

Value 属性

| 属性类型 | 属性名 | |:---:|:---:| |数据类型 | string| |读写说明 |只读| |说明 |获取当前节点的节点值|

Value 属性是只读属性，用于获取当前节点的节点值，其返回值为字符串类型。

using (XmlReader reader = XmlReader.Create("example.xml"))
{
    while(reader.Read())
    {
        if (reader.NodeType == XmlNodeType.Text)
        {
            Console.WriteLine("文本节点的值：{0}", reader.Value);
        }
    }
}

属性集合属性

HasAttributes 属性

| 属性类型 | 属性名 | |:---:|:---:| |数据类型 | bool| |读写说明 |只读| |说明 |判断当前节点是否包含属性|

HasAttributes 属性是只读属性，用于判断当前节点是否包含属性，其返回值为布尔类型。

using (XmlReader reader = XmlReader.Create("example.xml"))
{
    while(reader.Read())
    {
        if (reader.NodeType == XmlNodeType.Element)
        {
            if (reader.HasAttributes)
            {
                Console.WriteLine("该元素节点包含以下属性：");
                while (reader.MoveToNextAttribute())
                {
                    Console.WriteLine("{0} = {1}", reader.Name, reader.Value);
                }
            }
        }
    }
}

AttributeCount 属性

| 属性类型 | 属性名 | |:---:|:---:| |数据类型 | int| |读写说明 |只读| |说明 |获取当前节点属性的数量|

AttributeCount 属性是只读属性，用于获取当前节点属性的数量，其返回值为整型。

using (XmlReader reader = XmlReader.Create("example.xml"))
{
    while(reader.Read())
    {
        if (reader.NodeType == XmlNodeType.Element)
        {
            Console.WriteLine("该元素节点包含 {0} 个属性", reader.AttributeCount);
        }
    }
}

this[string] 属性

| 属性类型 | 属性名 | |:---:|:---:| |数据类型 | string| |读写说明 |只读| |说明 |获取当前节点中指定名称的属性值|

this[string] 属性是只读属性，用于获取当前节点中指定名称的属性值，其返回值为字符串类型。

using (XmlReader reader = XmlReader.Create("example.xml"))
{
    while(reader.Read())
    {
        if (reader.NodeType == XmlNodeType.Element)
        {
            if (reader.HasAttributes)
            {
                Console.WriteLine("该元素节点的 id 属性值为 {0}", reader["id"]);
            }
        }
    }
}

GetAttribute(string) 方法

| 方法签名 | |:---:| |public virtual string GetAttribute(string name);| |public abstract string GetAttribute(int i);|

GetAttribute(string) 方法是用于获取节点中指定名称的属性值，其返回值为字符串类型。如果节点中不存在指定名称的属性，则返回 null。

using (XmlReader reader = XmlReader.Create("example.xml"))
{
    while(reader.Read())
    {
        if (reader.NodeType == XmlNodeType.Element)
        {
            if (reader.HasAttributes)
            {
                Console.WriteLine("该元素节点的 id 属性值为 {0}", reader.GetAttribute("id"));
            }
        }
    }
}

深度和路径属性

Depth 属性

Depth 属性已在前文介绍，这里不再赘述。

Path 属性

| 属性类型 | 属性名 | |:---:|:---:| |数据类型 | string| |读写说明 |只读| |说明 |获取当前节点的路径|

Path 属性是只读属性，用于获取当前节点的路径，其返回值为字符串类型。路径信息是以 / 作为分隔符的，类似于文件路径。

using (XmlReader reader = XmlReader.Create("example.xml"))
{
    while(reader.Read())
    {
        Console.WriteLine("当前节点路径：{0}", reader.Path);
    }
}

总结

XML 阅读器属性可以让开发者更好地掌握 XML 文档的信息和结构，并进行针对性的操作。本文介绍了一些常用的属性，可根据实际情况选择使用。需要注意的是，XML 阅读器属性大多数都是只读属性，不能直接设置其值。如果需要设置属性，则需要使用其他方法。