xresloader文档
xresloader
是一组用于把Excel数据结构化并导出为程序可读的数据文件的导表工具集。它包含了一系列跨平台的工具、协议描述和数据读取代码。
主要功能特点:
跨平台(java 11 or upper)
Excel => protobuf/msgpack/lua/javascript/json/xml
完整支持协议结构,包括嵌套结构和数组嵌套
同时支持protobuf proto v2 和 proto v3
支持导出proto枚举值到lua/javascript代码和json/xml数据
支持导出proto描述信息值到lua/javascript代码和json/xml数据(支持自定义插件,方便用户根据proto描述自定义反射功能)
支持导出 UnrealEngine 支持的json或csv格式,支持自动生成和导出 UnrealEngine 的
DataTable
加载代码
支持别名表,用于给数据内容使用一个易读的名字
支持验证器,可以在数据里直接填写proto字段名或枚举名,或者验证填入数据的是否有效
支持通过protobuf协议插件控制部分输出
支持自动合表,把多个Excel数据表合并成一个输出文件
支持oneof,支持plain模式输入字符串转为数组或复杂结构,支持map
支持空数据压缩(裁剪)或保留定长数组
支持基于正则表达式分词的字段名映射转换规则
支持设置数据版本号
Lua输出支持全局导出或导出为
require
模块或导出为
module
模块。
Javascript输出支持全局导出或导出为
nodejs
模块或导出为
AMD
模块。
提供CLI批量转换工具(支持python 2.7/python 3 @ Windows、macOS、Linux)
提供GUI批量转换工具(支持Windows、macOS、Linux)
CLI/GUI批量转换工具支持include来实现配置复用
xresloader
Linux (OpenJDK 8):
xresconv-cli
直接下载发布包即可,无需构建打包
xresconv-gui
xres-code-generator
读表代码生成工具,直接下载即可,无需构建打包
xresloader-dump-bin
导出二进制转文本工具。
v2.11.0-rc2及以前版本更新迁移指引
由于 v2.11.0-rc3 版本变更了默认的索引器,导致对Excel一些内置的数据类型处理和先前有一些差异。比如对于日期时间类型、百分率等。
现在会先转出原始的文本,再根据protocol的目标类型做转换。如果需要回退到老的POI索引,可以使用
--enable-excel-formular
选项切换到老的索引器。
新版本开始使用JDK 11打包,如果仍然需要 JDK1.8打包请自行下载源码并修改
pom.xml
内
maven-compiler-plugin
的
source
和
target
后使用
mvn
package
命令打包。
xresloader
主要文档分为以下几个模块:
下载工具集
Step-1: 下载转表工具
Step-2: 配置结构化的protobuf协议并使用protoc
Step-3: 配置Excel数据源
Step-4: 配置批量转表配置文件
Step-5: 运行转表工具