游戏中的导表工具是指的将Excel表导入到游戏中的工具，全称为DataConverter，以下简称DCT。

DCT是什么?

DCT是使用CSharp语言编写的一套可用于游戏中的数据表导入工具，其中主要的工作流为Excel->Json->C# Class/Struct。 其中Excel的解析是基于SpreadsheetLight库实现的，而Json的部分则是基于Newtonsoft.Json来搞的，Bson的部分是基于MongoDB.bson搞的，我只做了一点微小的工作。

如何使用？

DCT的核心内容也编译为了DLL库（DataConverter.Core），可以通过将该文件导入项目中来调用。同时，该项目也支持了一个CLI工具，任何人都可以下载编译好的CLI工具来使用。

有什么用？

DCT的主要工作流程是将Excel表导出为json/bson，并且可以自动生成对应的C#结构体或类，从而实现数据加载。

有何规范？

DCT规定了一些excel的规范以用于解析，其主要内容如下（以下内容如非特殊提醒，“表”均指代“Excel数据表”，“数据”均指代“json数据”，“结构体”指代C#中的结构体）:

• 数据的最小单位为一张表，一张表指excel文件中一个sheet
• 表中的有效行指的是存在数据的非注释行，有效列指的是存在数据的非注释列
• 以‘#’开头的行/列为注释行/列，注释行/列不会参与解析
• 表中可以存在任意多个注释行/列
• 表中的第一个有效行中的数据必须为该表格的配置定义，以json格式表示，支持的配置如下：

  • is_template：定义该表是否为模板表，默认为false

    • 模板表是指此表不包含数据，只定义该文件中的类型，故其不应被转为json数据

    • 如果有枚举等需要完整定义的类型应该在模板表中存在完整定义

    • 模板表的作用范围为单个excel文件，无法跨文件生效

    • 模板表的配置定义中至少应包含format

  • template_name：定义该表套用的模板，值为模板表的表名（sheet name)，不套用模板时配置不应该包含此项

    • 套用模板的表不应被转为C#数据结构

    • 配置此项的表将忽略format，obj_type，obj_name，gen_enum等配置项

  • format：定义了该表格的格式，又可分为以下类型

    • { "format": "array" }：该表格按行导出为数组
    • { "format": "map", "key": row_name }：该表格按照字典导出，键为某一行的名字，当指定导出格式为字典时，必须同时指定合法的键
    • 默认为none

  • obj_type：定义了该表格导出为cs文件时的类型，可配置为class或者struct（不区分大小写），默认情况下为struct

  • obj_name：定义了该表格导出为cs文件时的对象名，默认为子表的名称（sheet name）

  • gen_enum: 定义了该表格导出为cs文件时是否自动生成枚举类型，默认为true

• 表中的第二个有效行必须为类型定义行，支持的类型如下：
  • bool：布尔值，也可写作boolean
  • int：整数
  • float：浮点数/小数
  • string：字符串，也可写作str
  • enum:name: 名称为name的枚举
  • array:type：类型为type的数组，也可写作arr或者list
  • map:value_type：键类型为string（键类型不可更改），值类型为value_type的字典，也可以写作dict、pairs、hash
  • object:object_type：类型为object_type的对象，此对象类型必须被DCT所识别，也可写作obj
  • 类型支持嵌套，即可存在多维数组如arr:arr:float、map:map:int这样的类型定义
  • 由于C#是强类型语言，当类型为数组、字典或对象这些引用类型时，必须指定其类型
• 表中的第三个有效行必须为变量名
  • 变量名要求和C#中起名要求一致，当名字与关键字冲突时，DCT会在生成的代码中自动添加'@'符号
• 变量名存在特殊的前后缀
  • #前缀：表示此数据列注释，该列所有数据均不会被DCT识别并导出
  • *后缀：表示此列不得为空值，当出现空值时DCT将会抛出异常
• 数据将从第四个有效行开始被导出，其中数据填写规范如下：
  • bool：填写true(不区分大小写)或者1会被识别为true，其他所有识别为false
  • int：填写整数，如1
  • float：填写单精度小数，如1.0
  • string：填写任意长度字符串，如hello, world!
  • enum: 填写枚举名称或者对应的索引，在未定义模板的表中索引规则将以解析顺序为准，非法索引将被解析为0，空值将自动添加None=0的枚举项
  • array：以[]包裹的对应类型的数据，如[1, 2, 3]、[ [1,2,3], [4,5,6] ]
  • map：以{"key":value, }包裹的对应类型的数据，如{ "1": 1, "2":2 }
  • object：填写可被反序列化为对应对象的json字符串，如{"num":145647163,"percent":0.588,"text":"0.54244547387638576486438546"}

示例代码

以下代码演示了如何将数据表导出为json数据

using DataConvert.Core;

void Example()
{
    ExcelConverter convert = new ExcelConverter();
    string json = convert.ToJson("example.xlsx", "sheet1");
    // string json = convert.ToJson("example.xlsx", 2);
    Console.Print(json);
}

以下代码演示了如何将数据表格式导出为CSharp结构体

using DataConvert.Core;

void Example()
{
    ExcelConvert convert = new ExcelConvert();
    var sheetNames = ExcelHelper.GetWorksheetNames("example.xlsx");

    int id = 0;
    foreach (var name in sheetNames)
    {
        string csContext = convert.ToCSharp("example.xlsx", id++, name);
        if (string.IsNullOrEmpty(csContext))
            continue;

        Console.Print(csContext);        
    }
}

更多的示例代码可以查看CLI源码中的函数。