using System; using System.Collections; using System.Collections.Generic; using System.Linq; using System.Text; using System.Threading.Tasks; using System.Xml; namespace MqttMsgServer.Tools { public class XmlHelper { #region 公共变量 XmlDocument xmldoc; XmlNode xmlnode; XmlElement xmlelem; #endregion #region 创建Xml文档 /// /// 创建一个带有根节点的Xml文件 /// /// Xml文件名称 /// 根节点名称 /// 编码方式:gb2312,UTF-8等常见的 /// 保存的目录路径 /// public bool CreateXmlDocument(string fileName, string rootName, string encode) { try { xmldoc = new XmlDocument(); XmlDeclaration xmldecl; xmldecl = xmldoc.CreateXmlDeclaration("1.0", encode, null); xmldoc.AppendChild(xmldecl); xmlelem = xmldoc.CreateElement("", rootName, ""); xmldoc.AppendChild(xmlelem); xmldoc.Save(fileName); return true; } catch (Exception e) { return false; throw new Exception(e.Message); } } #endregion #region 常用操作方法(增删改) /// /// 插入一个节点和它的若干子节点 /// /// Xml文件路径 /// 插入的节点名称 /// 此节点是否具有属性,True为有,False为无 /// 此插入节点的父节点,要匹配的XPath表达式(例如:"//节点名//子节点名) /// 此节点的属性,Key为属性名,Value为属性值 /// 子节点的属性,Key为Name,Value为InnerText /// 返回真为更新成功,否则失败 public bool InsertNode(string XmlFile, string NewNodeName, bool HasAttributes, string fatherNode, Hashtable htAtt, Hashtable htSubNode) { try { xmldoc = new XmlDocument(); xmldoc.Load(XmlFile); XmlNode root = xmldoc.SelectSingleNode(fatherNode); xmlelem = xmldoc.CreateElement(NewNodeName); if (htAtt != null && HasAttributes)//若此节点有属性,则先添加属性 { SetAttributes(xmlelem, htAtt); SetNodes(xmlelem.Name, xmldoc, xmlelem, htSubNode);//添加完此节点属性后,再添加它的子节点和它们的InnerText } else { SetNodes(xmlelem.Name, xmldoc, xmlelem, htSubNode);//若此节点无属性,那么直接添加它的子节点 } root?.AppendChild(xmlelem); xmldoc.Save(XmlFile); return true; } catch (Exception e) { throw new Exception(e.Message); } } /// /// 更新节点 /// /// Xml文件路径 /// 需要更新节点的上级节点,要匹配的XPath表达式(例如:"//节点名//子节点名) /// 需要更新的属性表,Key代表需要更新的属性,Value代表更新后的值 /// 需要更新的子节点的属性表,Key代表需要更新的子节点名字Name,Value代表更新后的值InnerText /// 返回真为更新成功,否则失败 public bool UpdateNode(string XmlFile, string fatherNode, Hashtable htAtt, Hashtable htSubNode) { try { xmldoc = new XmlDocument(); xmldoc.Load(XmlFile); XmlNodeList root = xmldoc.SelectSingleNode(fatherNode).ChildNodes; UpdateNodes(root, htAtt, htSubNode); xmldoc.Save(XmlFile); return true; } catch (Exception e) { throw new Exception(e.Message); } } /// /// 删除指定节点下的子节点 /// /// Xml文件路径 /// 制定节点,要匹配的XPath表达式(例如:"//节点名//子节点名) /// 返回真为更新成功,否则失败 public bool DeleteNodes(string XmlFile, string fatherNode) { try { xmldoc = new XmlDocument(); xmldoc.Load(XmlFile); xmlnode = xmldoc.SelectSingleNode(fatherNode); xmlnode.RemoveAll(); xmldoc.Save(XmlFile); return true; } catch (XmlException xe) { throw new XmlException(xe.Message); } } /// /// 删除匹配XPath表达式的第一个节点(节点中的子元素同时会被删除) /// /// XML文档完全文件名(包含物理路径) /// 要匹配的XPath表达式(例如:"//节点名//子节点名 /// 成功返回true,失败返回false public bool DeleteXmlNodeByXPath(string xmlFileName, string xpath) { xmldoc = new XmlDocument(); xmldoc.Load(xmlFileName); //加载XML文档 XmlNode xmlNode = xmldoc.SelectSingleNode(xpath); if (xmlNode != null) { //删除节点 xmldoc?.ParentNode?.RemoveChild(xmlNode); } xmldoc.Save(xmlFileName); //保存到XML文档 return true; } /// /// 删除匹配XPath表达式的第一个节点中的匹配参数xmlAttributeName的属性 /// /// XML文档完全文件名(包含物理路径) /// 要匹配的XPath表达式(例如:"//节点名//子节点名 /// 要删除的xmlAttributeName的属性名称 /// 成功返回true,失败返回false public bool DeleteXmlAttributeByXPath(string xmlFileName, string xpath, string xmlAttributeName) { bool isSuccess = false; bool isExistsAttribute = false; xmldoc = new XmlDocument(); try { xmldoc.Load(xmlFileName); //加载XML文档 XmlNode xmlNode = xmldoc.SelectSingleNode(xpath); XmlAttribute xmlAttribute = null; if (xmlNode != null) { //遍历xpath节点中的所有属性 if (xmlNode?.Attributes != null) { foreach (XmlAttribute attribute in xmlNode.Attributes) { if (attribute.Name.ToLower() == xmlAttributeName.ToLower()) { //节点中存在此属性 xmlAttribute = attribute; isExistsAttribute = true; break; } } if (isExistsAttribute) { //删除节点中的属性 xmlNode.Attributes.Remove(xmlAttribute); } } } xmldoc.Save(xmlFileName); //保存到XML文档 isSuccess = true; } catch (Exception ex) { throw ex; //这里可以定义你自己的异常处理 } return isSuccess; } /// /// 删除匹配XPath表达式的第一个节点中的所有属性 /// /// XML文档完全文件名(包含物理路径) /// 要匹配的XPath表达式(例如:"//节点名//子节点名 /// 成功返回true,失败返回false public bool DeleteAllXmlAttributeByXPath(string xmlFileName, string xpath) { bool isSuccess = false; xmldoc = new XmlDocument(); try { xmldoc.Load(xmlFileName); //加载XML文档 XmlNode xmlNode = xmldoc.SelectSingleNode(xpath); if (xmlNode != null) { //遍历xpath节点中的所有属性 xmlNode.Attributes?.RemoveAll(); } xmldoc.Save(xmlFileName); //保存到XML文档 isSuccess = true; } catch (Exception ex) { throw ex; //这里可以定义你自己的异常处理 } return isSuccess; } #endregion #region 私有方法 /// /// 设置节点属性 /// /// 节点所处的Element /// 节点属性,Key代表属性名称,Value代表属性值 private void SetAttributes(XmlElement xe, Hashtable htAttribute) { foreach (DictionaryEntry de in htAttribute) { xe.SetAttribute(de.Key.ToString(), de.Value.ToString()); } } /// /// 增加子节点到根节点下 /// /// 上级节点名称 /// Xml文档 /// 父根节点所属的Element /// 子节点属性,Key为Name值,Value为InnerText值 private void SetNodes(string rootNode, XmlDocument XmlDoc, XmlElement rootXe, Hashtable SubNodes) { if (SubNodes == null) return; foreach (DictionaryEntry de in SubNodes) { xmlnode = XmlDoc.SelectSingleNode(rootNode); XmlElement subNode = XmlDoc.CreateElement(de.Key.ToString()); subNode.InnerText = de.Value.ToString(); rootXe.AppendChild(subNode); } } /// /// 更新节点属性和子节点InnerText值。 /// /// 根节点名字 /// 需要更改的属性名称和值 /// 需要更改InnerText的子节点名字和值 private void UpdateNodes(XmlNodeList root, Hashtable htAtt, Hashtable htSubNode) { foreach (XmlNode xn in root) { xmlelem = (XmlElement)xn; if (xmlelem.HasAttributes)//如果节点如属性,则先更改它的属性 { foreach (DictionaryEntry de in htAtt)//遍历属性哈希表 { if (xmlelem.HasAttribute(de.Key.ToString()))//如果节点有需要更改的属性 { xmlelem.SetAttribute(de.Key.ToString(), de.Value.ToString());//则把哈希表中相应的值Value赋给此属性Key } } } if (xmlelem.HasChildNodes)//如果有子节点,则修改其子节点的InnerText { XmlNodeList xnl = xmlelem.ChildNodes; foreach (XmlNode xn1 in xnl) { XmlElement xe = (XmlElement)xn1; foreach (DictionaryEntry de in htSubNode) { if (xe.Name == de.Key.ToString())//htSubNode中的key存储了需要更改的节点名称, { xe.InnerText = de.Value.ToString();//htSubNode中的Value存储了Key节点更新后的数据 } } } } } } #endregion #region XML文档节点查询和读取 /// /// 选择匹配XPath表达式的第一个节点XmlNode. /// /// XML文档完全文件名(包含物理路径) /// 要匹配的XPath表达式(例如:"//节点名//子节点名") /// 返回XmlNode public XmlNode GetXmlNodeByXpath(string xmlFileName, string xpath) { xmldoc = new XmlDocument(); try { xmldoc.Load(xmlFileName); //加载XML文档 XmlNode xmlNode = xmldoc.SelectSingleNode(xpath); return xmlNode; } catch (Exception ex) { return null; //throw ex; //这里可以定义你自己的异常处理 } } /**/ /// /// 选择匹配XPath表达式的节点列表XmlNodeList. /// /// XML文档完全文件名(包含物理路径) /// 要匹配的XPath表达式(例如:"//节点名//子节点名") /// 返回XmlNodeList public XmlNodeList GetXmlNodeListByXpath(string xmlFileName, string xpath) { xmldoc = new XmlDocument(); try { xmldoc.Load(xmlFileName); //加载XML文档 XmlNodeList xmlNodeList = xmldoc.SelectNodes(xpath); return xmlNodeList; } catch (Exception ex) { return null; //throw ex; //这里可以定义你自己的异常处理 } } /**/ /// /// 选择匹配XPath表达式的第一个节点的匹配xmlAttributeName的属性XmlAttribute. /// /// XML文档完全文件名(包含物理路径) /// 要匹配的XPath表达式(例如:"//节点名//子节点名 /// 要匹配xmlAttributeName的属性名称 /// 返回xmlAttributeName public XmlAttribute GetXmlAttribute(string xmlFileName, string xpath, string xmlAttributeName) { string content = string.Empty; xmldoc = new XmlDocument(); XmlAttribute xmlAttribute = null; try { xmldoc.Load(xmlFileName); //加载XML文档 XmlNode xmlNode = xmldoc.SelectSingleNode(xpath); if (xmlNode != null) { if (xmlNode.Attributes.Count > 0) { xmlAttribute = xmlNode.Attributes[xmlAttributeName]; } } } catch (Exception ex) { throw ex; //这里可以定义你自己的异常处理 } return xmlAttribute; } #endregion } }