基于C#实现XML文件读取工具类

内容摘要
本文实例讲述了基于C#实现XML文件读取工具类。分享给大家供大家参考。具体如下:
这是我去年写的一个XML文件读取工具类,现在做了一些调整

基本能满足一般的XML文件读取需求
文章正文

本文实例讲述了基于C#实现XML文件读取工具类。分享给大家供大家参考。具体如下:

这是我去年写的一个XML文件读取工具类,现在做了一些调整
基本能满足一般的XML文件读取需求。
更新:
2013年6月26日19:37 Fix了几个Bug,为所有方法添加单元测试,并运行通过;同时调整了几个方法的位置。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
/// <summary>
/// Author: jiangxiaoqiang
/// </summary>
public class XmlReader
{
  //========================================================= //
  #region 获取XmlDocument对象
  /// <summary>
  /// 根据XML文件内容获取XmlDocument对象
  /// </summary>
  /// <param name="xmlFileContent"></param>
  /// <returns></returns>
  public static XmlDocument GetXmlDocByXmlContent(string xmlFileContent)
  {
    if (string.IsNullOrEmpty(xmlFileContent))
    {
      return null;
    }
    var xDoc = new XmlDocument();
    try
    {
      xDoc.LoadXml(xmlFileContent);
    }
    catch
    {
      xDoc = null;
    }
    return xDoc;
  }
  /// <summary>
  /// 根据XML文件路径获取XmlDocument对象
  /// </summary>
  /// <param name="xmlFilePath"></param>
  /// <returns></returns>
  public static XmlDocument GetXmlDocByFilePath(string xmlFilePath)
  {
    if (string.IsNullOrEmpty(xmlFilePath) || !File.Exists(xmlFilePath))
    {
      return null;
    }
    var xDoc = new XmlDocument();
    try
    {
      xDoc.Load(xmlFilePath);
    }
    catch
    {
      throw new Exception(string.Format("请确认该XML文件格式正确,路径为:{0}", xmlFilePath));
    }
    return xDoc;
  }
  #endregion
  //========================================================= //
  //========================================================= //
  #region 获取XML节点(或节点列表)
  /// <summary>
  /// 获取父节点下指定节点名称的第一个子节点
  /// </summary>
  /// <param name="parentXmlNode"></param>
  /// <param name="childNodeName"></param>
  /// <returns></returns>
  public static XmlNode GetFirstChildNodeByName(XmlNode parentXmlNode, string childNodeName)
  {
    var childXmlNodes = GetChildNodesByName(parentXmlNode, childNodeName);
    if (childXmlNodes != null && childXmlNodes.Count > 0)
    {
      return childXmlNodes[0];
    }
    return null;
  }
  /// <summary>
  /// 获取父节点下指定节点名称的子节点列表
  /// </summary>
  /// <param name="parentXmlNode">父节点</param>
  /// <param name="nodeName">节点名称</param>
  /// <returns></returns>
  public static XmlNodeList GetChildNodesByName(XmlNode parentXmlNode, string nodeName)
  {
    if (parentXmlNode == null || string.IsNullOrEmpty(nodeName))
    {
      return null;
    }
    return GetChildNodesByXPathExpr(parentXmlNode, string.Format(".//{0}", nodeName));
  }
  /// <summary>
  /// 获取父节点下满足xpathExpr表达式的XML子节点列表
  /// </summary>
  /// <param name="parentXmlNode">父节点</param>
  /// <param name="xpathExpr"></param>
  /// <returns></returns> 
  public static XmlNodeList GetChildNodesByXPathExpr(XmlNode parentXmlNode, string xpathExpr)
  {
    if (parentXmlNode == null || string.IsNullOrEmpty(xpathExpr))
    {
      return null;
    }
    return parentXmlNode.SelectNodes(xpathExpr);
  }
  /// <summary>
  /// 获取父节点下的第一个子节点
  /// </summary>
  /// <param name="parentXmlNode"></param>
  /// <returns></returns>
  public static XmlNode GetFirstChildNode(XmlNode parentXmlNode)
  {
    var childXmlNodes = GetChildNodes(parentXmlNode);
    if (childXmlNodes != null && childXmlNodes.Count > 0)
    {
      return childXmlNodes[0];
    }
    return null;
  }
  /// <summary>
  /// 获取父节点的子节点列表
  /// </summary>
  /// <param name="parentXmlNode">父节点</param>
  /// <returns></returns>
  public static XmlNodeList GetChildNodes(XmlNode parentXmlNode)
  {
    return parentXmlNode == null ? null : parentXmlNode.ChildNodes;
  }
  #endregion
  //========================================================= //
  //========================================================= //
  #region 读取节点属性值
  /// <summary>
  /// 读取某个XML节点的属性值(根据属性名)
  /// </summary>
  /// <param name="xmlNode"></param>
  /// <param name="attrName"></param>
  /// <returns></returns>
  public static string ReadAttrValue(XmlNode xmlNode, string attrName)
  {
    var xmlElement = xmlNode as XmlElement;
    return xmlElement == null ? null : xmlElement.GetAttribute(attrName);
  }
  /// <summary>
  /// 读取父节点下指定节点名和属性名的第一个子节点的属性值
  /// </summary>
  /// <param name="parentXmlNode">XML父节点</param>
  /// <param name="childNodeName">节点名称</param>
  /// <param name="attrName">属性名</param>
  /// <returns></returns>
  public static string ReadFirstAttrValue(XmlNode parentXmlNode, string childNodeName, string attrName)
  {
    var attrVals = ReadAttrValues(parentXmlNode, childNodeName, attrName);
    return (attrVals == null || attrVals.Length == 0) ? null : attrVals[0];
  }
  /// <summary>
  /// 读取父节点下指定节点名和属性名的所有子节点的该属性值的数组
  /// </summary>
  /// <param name="parentXmlNode">XML文档</param>
  /// <param name="childNodeName">节点名称</param>
  /// <param name="attrName">属性名</param>
  /// <returns></returns>
  public static string[] ReadAttrValues(XmlNode parentXmlNode, string childNodeName, string attrName)
  {
    if (parentXmlNode == null || string.IsNullOrEmpty(childNodeName) || string.IsNullOrEmpty(attrName))
    {
      return null;
    }
    var xpathExpr = string.Format("//{0}[@{1}]", childNodeName, attrName);
    var nodes = GetChildNodesByXPathExpr(parentXmlNode, xpathExpr);
    if (nodes != null && nodes.Count > 0)
    {
      var nodeCount = nodes.Count;
      var attrVals = new string[nodeCount];
      for (var i = 0; i < nodeCount; i++)
      {
        attrVals[i] = ((XmlElement)nodes[i]).GetAttribute(attrName);
      }
      return attrVals;
    }
    return null;
  }
  #endregion
  //========================================================= //
  //========================================================= //
  #region 读取父节点下的子节点的文本内容
  /// <summary>
  /// 读取父节点下指定节点名的第一个子节点的文本
  /// </summary>
  /// <param name="parentXmlNode"></param>
  /// <param name="childNodeName"></param>
  /// <returns></returns>
  public static string ReadFirstChildNodeTextByName(XmlNode parentXmlNode, string childNodeName)
  {
    var childNodeTexts = ReadChildNodeTextsByName(parentXmlNode, childNodeName);
    if (childNodeTexts != null && childNodeTexts.Length > 0)
    {
      return childNodeTexts[0];
    }
    return null;
  }
  /// <summary>
  /// 读取父节点下指定节点名的所有子节点的文本数组
  /// </summary>
  /// <param name="parentXmlNode"></param>
  /// <param name="childNodeName"></param>
  /// <returns></returns>
  public static string[] ReadChildNodeTextsByName(XmlNode parentXmlNode, string childNodeName)
  {
    if (parentXmlNode == null || string.IsNullOrEmpty(childNodeName))
    {
      return null;
    }
    var xpathExpr = string.Format(".//{0}", childNodeName);
    var childNodes = GetChildNodesByXPathExpr(parentXmlNode, xpathExpr);
    if (childNodes != null && childNodes.Count > 0)
    {
      var nodeCount = childNodes.Count;
      var nodeTexts = new string[nodeCount];
      for (var i = 0; i < nodeCount; i++)
      {
        nodeTexts[i] = childNodes[i].InnerText;
      }
      return nodeTexts;
    }
    return null;
  }
  /// <summary>
  /// 读取父节点下的第一个子节点的文本
  /// </summary>
  /// <param name="parentXmlNode"></param>
  /// <returns></returns>
  public static string ReadFirstChildNodeText(XmlNode parentXmlNode)
  {
    var childNodeTexts = ReadChildNodeTexts(parentXmlNode);
    if (childNodeTexts != null && childNodeTexts.Length > 0)
    {
      return childNodeTexts[0];
    }
    return null;
  }
  /// <summary>
  /// 读取父节点下的所有子节点的文本数组
  /// </summary>
  /// <param name="parentXmlNode"></param>
  /// <returns></returns>
  public static string[] ReadChildNodeTexts(XmlNode parentXmlNode)
  {
    if (parentXmlNode == null)
    {
      return null;
    }
    var childNodes = GetChildNodes(parentXmlNode);
    if (childNodes != null && childNodes.Count > 0)
    {
      var nodeCount = childNodes.Count;
      var nodeTexts = new string[nodeCount];
      for (var i = 0; i < nodeCount; i++)
      {
        nodeTexts[i] = childNodes[i].InnerText;
      }
      return nodeTexts;
    }
    return null;
  }
  /// <summary>
  /// 读取XML节点文本
  /// </summary>
  /// <param name="xmlNode"></param>
  /// <returns></returns>
  public static string ReadNodeText(XmlNode xmlNode)
  {
    if (xmlNode == null)
    {
      return null;
    }
    return xmlNode.InnerText;
  }
  #endregion
  //========================================================= //
}

希望本文所述对大家的C#程序设计有所帮助。


代码注释

作者:喵哥笔记

IDC笔记

学的不仅是技术,更是梦想!