fast-xml-parser 中文文档

fast-xml-parser

说明

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

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

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

<script src="https://cdn.bootcss.com/jquery/3.4.1/jquery.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/fast-xml-parser/3.12.16/parser.min.js"></script>
// 配置
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

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,163评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,301评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,089评论 0 352
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,093评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,110评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,079评论 1 295
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,005评论 3 417
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,840评论 0 273
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,278评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,497评论 2 332
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,667评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,394评论 5 343
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,980评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,628评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,796评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,649评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,548评论 2 352

推荐阅读更多精彩内容

  • 第3章 基本概念 3.1 语法 3.2 关键字和保留字 3.3 变量 3.4 数据类型 5种简单数据类型:Unde...
    RickCole阅读 5,122评论 0 21
  • XML 指可扩展标记语言。标记指计算机所能理解的信息符号,通过此种标记,计算机之间可以处理包含各种信息的文章等。 ...
    神齐阅读 774评论 0 3
  • http://liuxing.info/2017/06/30/Spring%20AMQP%E4%B8%AD%E6%...
    sherlock_6981阅读 15,906评论 2 11
  • Swift1> Swift和OC的区别1.1> Swift没有地址/指针的概念1.2> 泛型1.3> 类型严谨 对...
    cosWriter阅读 11,096评论 1 32
  • xml经典总结 XML(eXtensible Markup Language)是万维网联盟(World Wide ...
    java日记阅读 950评论 0 2