跳到主要内容
版本：Next

excel格式（初级）

基础规则​

支持的excel文件族​

支持 xls、 xlsx、 xlm、 xlmx、csv 。基本上excel能打开的都可以读取。

excel文件 读取规则​

  • 如果未指定sheet，则默认会读取所有sheet
  • 可以用 sheet@xxx.xlsx 指定只读入这个sheet数据
  • 如果A1单元格数据不以##开头，则会被当作非数据sheet，被忽略

读取除GKB和UTF8以外编码的csv文件​

luban会智能猜测出它的编码，正确处理。

灵活的文件组织形式​

  • 可以几个表都放到一个xlsx中，每个表占一个sheet。 只需要为每个表的input指定为该单元薄即可，如xxx@item/test/abs.xlsx
  • 可以一个表拆分为几个xlsx。 如 item/a.xlsx,bag/b.xlsx,c.xlsx
  • 可以一个读入一个目录下的所有xlsx。 如 xlsx_files 。

标题头行格式​

一个典型的配置表示例：

excel

  • 第1列单元格为 ##var 表示这行是字段定义行
  • 第1列单元格为 ##type 表示这行是 类型定义行
  • 第1列单元格为 ##group 表示这行是 导出分组行。此行可选。另外，单元格留空表示对所有分组导出。
  • 第1列单元格以##开头 表示这是注释行，如果有多个##行，默认以第一个行作为代码中字段的注释，你可以通过##comment 显式指定某行为代码注释行。
  • 填写多级字段名行时，以##var表示这是次级字段行
  • 你可以随意调整以##<name>开头的行的顺序。例如##var行与##group行调换顺序，完全不影响最终结果

注释行或列​

当标题行字段名为空或者以'#'开头时，这个列会被当作注释列而忽略。当数据行的第一列以##开头时，这一行会被当作注释行而被忽略。

excel

以上示例中，D列和E列被注释而忽略，第7行由于以##开头，也被注释而不会导出。

基础数据格式​

如下图所示，数据填法基本与常识相符。

primitive_type

特殊说明：

  • bool： true、false、0、1、是、否 都是有效值。另外大小写不敏感，如True也是合法bool值。填其他值如abc、4则会发生解析错误
  • string：单元格留空即为长度为0的字符串。但读取流式格式时，空白单元格也会被当作无用单元格而被忽略，此时可以用""表示长度为0的字符串。string默认不处理转义， 如果希望将字符串中\n替换为换行符，则需要添加上escape=1tag，如string#escape=1。
  • datetime支持以下几种格式
    • excel中的内置日期格式
    • yyyy-mm-dd hh:mm:ss 字符串格式
    • yyyy-mm-dd hh:mm 字符串格式。此时秒自动取0
    • yyyy-mm-dd hh 字符串格式。此时分与秒取0
    • yyyy-mm-dd 字符串格式。此时时分秒都取0

除了datetime以外的基础数据格式都可以留空，自动取默认值，如第10行所示。

enum 数据格式​

可以填写枚举项的变量名、别名或者对应的整数。如果是flags类型枚举，还可以填'A|B'这样的或形式枚举。flags类型enum还支持列限定模式， 让每个枚举值占一列，然后将包含的标志位列标为1，表示最终的枚举值包含此项。

enum

如果enum中有值为0的枚举项，则可以留空，自动取该枚举项，否则会解析出错。

bean数据格式​

假设 Item是包含int id; int count; string desc 这三个字段的bean，item字段类型为Item。合并C1-E1为一个单元格，作为item字段范围。在item字段的列范围内， 按顺序填写Item结构的每个字段。如下图所示。

bean

如果该bean字段为多态类型，则须先填写多态类型名，再顺序填写多态类型的字段。多态类型名可以填bean的别名。如下图。

bean

容器类型​

与bean类型，通过合并单元格作为字段的列范围，在范围内填写数据即可。空白单元格会被忽略。

collection

map以key、value为键值对，依次填写。

可空类型​

除了容器以外的类型都可以是可空类型。所有可空类型都可以用null表达空值。

  • 对于只包含一个数据的原子数据类型（如int），单元格留空也表达null
  • 对于string?类型，单元格留空表达null而不是长度为0的字符串。如果你想表达空白字符串请用""
  • 对于非多态的bean类型的可空类型，如果非空，需要以{}开头表示非空，接着顺序填写bean的值
  • 对于多态bean，填法不变

nullable

无主键表​

有时候只想得到一个记录列表，无主键。mode="list"并且index为空，表示无主键表。

定义表

<table name="TbNotKeyList" value="NotKeyList" mode="list" input="not_key_list.xlsx"/>

table_list_not_key

多主键表（联合索引）​

多个key构成联合唯一主键。使用"+"分割key，表示联合关系。

定义表

<table name="TbUnionMultiKey" value="UnionMultiKey" index="key1+key2+key3" input="union_multi_key.xlsx"/>

table_list_union_key

多主键表（独立索引）​

多个key，各自独立唯一索引。与联合索引写法区别在于使用 ","来划分key，表示独立关系。

定义表

<table name="TbMultiKey" value="MultiKey" index="key1,key2,key3" input="multi_key.xlsx"/>

table_list_indep_key

单例表​

有一些配置全局只有一份，比如 公会模块的开启等级，背包初始大小，背包上限。此时使用单例表来配置这些数据比较合适。

singleton

纵表​

大多数表都是横表，即一行一个记录。有些表，比如单例表，如果纵着填，一行一个字段，会比较舒服。A1为##column表示使用纵表模式。 上面的单例表，以纵表模式填如下。

singleton