/xlsx2json

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

Primary LanguageJavaScriptMIT LicenseMIT

xlsx2json (English Document)

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

日志

  • 2017-10-31 v0.3.1

    • 修复: 对象类型列，对象值里面有冒号值解析错误。
    • 功能: 增加#id类型，主键索引(json格式以map形式输出，无id的表以数组格式输出)。
    • 功能: 输出的json是否压缩可以在config.json里面配置。

  • 2017-10-26 v0.3.0

    • 修复中文自动追加拼音问题。
    • 修复日期解析错误。
    • 去掉主外键功能(以后再追加)。
    • 增加代码静态检查，核心代码重写并改成ES6语法。
    • 更新依赖插件的版本。

npm相关

  • 如需当做npm模块引用请切换到npm分支。

使用说明

  • 目前只支持.xlsx格式，不支持.xls格式。
  • 本项目是基于nodejs的，所以需要先安装nodejs环境。
  • 执行命令
# Clone this repository
git clone https://github.com/koalaylj/xlsx2json.git
# Go into the repository
cd xlsx2json
# Install dependencies
npm install
  • 配置config.json
{
    "xlsx": {
        /**
         * 表头所在的行，第一行可以是注释，第二行是表头
         */
        "head": 2,

        /**
         * xlsx文件所在的目录
         * glob配置风格
         */
        "src": "./excel/**/[^~$]*.xlsx",

        /**
         * 导出的json存放的位置
         */
        "dest": "./json",

        /**
         * 数组的分隔符
         * 有时候特殊需要，在excel单元格中里面逗号被当做他用。
         * 已过时，将在v0.5.x移除。参考列类型是数组类型时候表头设置。
         */
        "arraySeparator":","
    },
    "json": {
      /**
       * 导出的json是否需要压缩
       * true:压缩，false:不压缩(便于阅读的格式)
       */
      "uglify": false
    }
}

  • 执行export.sh|export.bat即可将./excel/*.xlsx 文件导成json并存放到 ./json 下。json名字以excel的sheet名字命名。

  • 补充(一般用不上)：

    • 执行node index.js -h 查看使用帮助。
    • 命令行传参方式使用：执行 node index.js --help 查看。

示例1 test.xlsx

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

输出如下：

[{
    "id": 123,
    "desc": "description",
    "flag": true,
    "nums": [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,
    "nums": [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 字符串。
  • date 日期类型。
  • object 简单对象，暂时不支持对象里面有对象或数组这种。
  • number-array 数字数组。
  • boolean-array 布尔数组。
  • string-array 字符串数组。
  • object-array 对象数组。
  • id 主键类型(当表中有这个类型的时候，json会以map格式输出，否则以数组格式输出)。

表头规则

  • 基本数据类型(string,number,bool)时候，一般不需要设置会自动判断，但是也可以明确声明数据类型。
  • 字符串类型：命名形式 列名#string 。
  • 数字类型：命名形式 列名#number 。
  • 日期类型：列名#date 。日期格式要符合标准日期格式。比如YYYY/M/D H:m:s or YYYY/M/D 等等。
  • 布尔类型：命名形式 列名#bool 。
  • 基本类型数组：命名形式 列名#[]，数组元素默认用逗号分隔(a,b,c),自定义数组元素分隔符列名#[]/(a/b/c)。
  • 对象：命名形式 列名#{} 。
  • 对象数组：命名形式列名#[{}] 。
  • 主键：命名形式列名#id 。

数据规则

  • 关键符号都是半角符号。
  • 对象属性使用分号;分割。

TODO

  • 列为数组类型时候，嵌套复杂类型。
  • 列为对象类型时候，嵌套复杂类型。
  • 外键支持。
  • 将主分支的代码合并到npm分支。
  • 数组分隔符的设置放到表头，默认用逗号。

感谢

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

补充

  • windows/mac/linux都支持。
  • 项目地址 xlsx2json master
  • 如有问题可以到QQ群内讨论：223460081
  • 招募协作开发者，有时间帮助一起维护下这个项目，可以发issue或者到qq群里把你github邮箱告诉我。