README.md

xlsx2json

English Document

作用

让excel表达复杂的json格式,将xlsx文件转成json。

感谢

某些想法也是借鉴了一个clojure的excel转json的开源项目 excel-to-json 。

使用说明

目前只支持.xlsx格式，不支持.xls格式。

首次使用需要配置config.json

{
    "xlsx": {
        "head": 2,// 表头所在的行，第一行可以是注释，第二行是表头。
        "src": "./excel/**/[^~$]*.xlsx", // xlsx文件 glob配置风格
        "dest": "./json",    // 导出的json存放的位置
        "arraySeparator":"," // 数组的分隔符
    }
}

注：

• 为了做成portable的，export.bat用的命令用的是.\bin\node.exe。node版本是0.10.26。
• 查看帮助：执行node index.js -h 查看使用帮助；
• excel导出json：双击export.bat 即可将 ./excel/*.xlsx 文件导出到 ./json 下。
• 还支持命令行传参导入导出特定excel，具体使用 node index.js --help 查看。

示例1 test.xlsx

输出如下：

[{
    "id": 123,
    "desc": "description",
    "flag": true,
    "otherid": [1, 2],
    "words": ["哈哈", "呵呵"],
    "map": [true, true],
    "data": {
        "a": 123,
        "b": 45
    },
    "hero": [
      {"id": 2,"level": 30},
      {"id": 3,"level": 80}
    ]
}, {
    "id": 456,
    "desc": "描述",
    "flag": false,
    "otherid": [3, 5, 8],
    "words": ["shit", "my god"],
    "map": [false, true],
    "data": {
        "a": 11,
        "b": 22
    },
    "hero": [
      {"id": 9, "level": 38 },
      {"id": 17,"level": 100}
    ]
}]

支持以下数据类型

• number 数字类型
• boolean 布尔
• string 字符串
• object 对象 // 不支持对象内有数组以及对象嵌套对象，防止表格过度复杂。
• number-array 数字数组
• boolean-array 布尔数组
• string-array 字符串数组
• object-array 对象数组

表头规则

• 字段是基本数据类型(string,number,bool)时候，一般不需要设置会自动判断，但是也可以明确声明数据类型。
• 字段是字符串类型：此列表头的命名形式 列名#string 。
• 字段是数字类型：此列表头的命名形式 列名#number 。
• 字段是布尔类型：此列表头的命名形式 列名#bool 。
• 字段是基本类型数组：此列表头的命名形式 列名#[] 。
• 字段是对象：此列表头的命名形式 列名#{} 。
• 字段是对象数组：此列表头的命名形式列名#[{}] 。

数据规则

• 关键符号都是半角符号。
• 数组使用逗号,分割。
• 对象属性使用分号;分割。
• 列格式如果是日期，导出来的是格林尼治时间不是当时时区的时间，列设置成字符串可解决此问题。

原理说明

• 依赖 node-xlsx 这个项目解析xlsx文件。
• xlsx就是个zip文件，解压出来都是xml。有一个xml存的string，有相应个xml存的sheet。通过解析xml解析出excel数据(json格式)，这个就是node-xlsx 做的工作。
• 本项目只需利用 node-xlsx 解析xlsx文件，然后拼装自己的json数据格式。

补充

• 实验环境：win7_x64 + nodejs_v0.10.25(可在linux上执行)
• 项目地址 xlsx2json master
• 如有问题可以到QQ群内讨论：223460081
• 项目中的某些工具函数测试用例请参见我的gist js:validate & js:convert。