fast-xml-parser 中文文档

fast-xml-parser

说明

项目中需要解析一次xml文件， 但是从百度中获取的一些解析方法似乎都有所缺陷， 并没办法很好的解析我需要解析的xml文件， 所以就上github里找到了这个插件， 速度似乎是该插件的优秀之处， 但是我选择该插件的原因主要是它能解析我所需解析的文件

下边是一些官方文档的说明， 这个插件似乎用的人并不多， 所以就记录一下， 也顺便给配置项都翻译一下， 我项目中如果有使用该配置的话就会加上我对应的一些说明

在我的项目中， 主要是解析一个模板文件的xml结构， 所以对应的是需要获取属性并且解析为JSON格式， 下方是我对应的一个demo

// 配置
var options = {
  attributeNamePrefix : "@_",
  ignoreAttributes: false,
};
// 使用
$.ajax({
  url: './1.tpl',
  success: res => {
    console.log(res);
    var jsonObj = parser.parse(res, options);
    console.log('json: ', jsonObj)
    document.write(JSON.stringify(jsonObj))
  }
})

使用

var jsonObj = parser.parse(xmlData [,options] );

var options = {
  attributeNamePrefix : "@_",
  attrNodeName: "attr", //default is 'false'
  textNodeName : "#text",
  ignoreAttributes : true,
  ignoreNameSpace : false,
  allowBooleanAttributes : false,
  parseNodeValue : true,
  parseAttributeValue : false,
  trimValues: true,
  cdataTagName: "__cdata", //default is 'false'
  cdataPositionChar: "\\c",
  localeRange: "", //To support non english character in tag/attribute values.
  parseTrueNumberOnly: false,
  attrValueProcessor: a => he.decode(a, {isAttributeValue: true}),//default is a=>a
  tagValueProcessor : a => he.decode(a) //default is a=>a
};

配置(OPTIONS)说明

OPTIONS

• attributeNamePrefix: 提供预定的字符串作为属性名称前缀, 比如@_， 这时假设解析的属性为name，那么在解析后的JSON中该属性将会解析为@_name
• attrNodeName: 将所有属性分组为给定名称的属性， 取代原本的属性名称， 修改为该名称
• ignoreAttributes: 忽略解析属性， 配置该项的时候不会解析标签内的属性， 默认为true
• ignoreNameSpace: 从标记和属性名称中移除命名空间字符串
• allowBooleanAttributes: 标记可以具有不带任何值的属性
• parseNodeValue : 将属性的值解析为float、integer或boolean
• parseAttributeValue: 将属性的值解析为float、integer或boolean
• trimValues: 修剪属性或节点的字符串值
• decodeHTMLchar: This options has been removed from 3.3.4. Instead, use - tagValueProcessor, and attrValueProcessor. See above example.
• cdataTagName: 如果指定，解析器会将CDATA解析为嵌套标记，而不是将其值添加到父标记中
• cdataPositionChar: 它将有助于将JSON转换回XML，而不会失去CData的位置。
• localeRange: 解析器将接受标记或属性名中的非英文字符
• parseTrueNumberOnly: 如果为真，则像“+123”或“0123”这样的值不会被解析为数字。
• tagValueProcessor: 转换期间处理标记值。如HTML解码、单词大写等，仅适用于字符串。
• attrValueProcessor: 转换期间处理属性值。如HTML解码、单词大写等，仅适用于字符串
• stopNodes: 不需要解析的标记名数组。相反，它们的值被解析为字符串。

GitHub地址

https://github.com/NaturalIntelligence/fast-xml-parser