GF-11 配置表

E神
可以将游戏数据以表格（如 Microsoft Excel）的形式进行配置后，使用此模块使用这些数据表。数据表的格式是可以自定义的。

概念

因为使用表格编辑数据方便，且浏览数据方便，

所以在国内游戏开发行业，表格参加制作了相当一部分的功能....

理论上来说，任何功能都可以靠表格来配置数据

但是表格有个显而易见的缺点，就是逻辑的可读性差

你配置一个剧情，所有的话语都靠id跳转，或者你配置一个技能，所有的功能都靠id串联，这是很糟糕的

所以用表格要理性，有些功能非常适合使用表格，就比如配置装备的名称和属性，有些功能不适合，比如技能模块核心逻辑，这时最好不用强行使用表格。

使用前

因为要将表格内的数据读入内存进行使用，我们一般会设计和表格对应的数据模版类以此来方便的使用表格数据

但这实际上是一个重复率和重复次数都很高的工作，所以很多公司都会写一个表格数据模版类自动生成工具

GF也不例外，有着自己的表格模版数据类的自动生成流程，而且构思比较巧妙让我们来梳理一下其中的设计逻辑

GF表格模版类生成和制作流程

创建一个excel表格

starforce示例项目的表格存放路径是Assets/GameMain/DataTables

关键路径定义

从starforce表格随便复制了一个换了个名字并放在同一文件夹下

点击生成

生成结果

可以看到占用空间更小的.bytes文件和脚本都被很方便的生成出来了

生成流程这里就不详细梳理了

扩展自动生成脚本支持的变量类型

GF自带的生成脚本并没有支持List类型

那我们就来在starForce内扩展一个自动生成List<int>变量的方法吧

支持类

private sealed class ListProcessor : GenericDataProcessor<List<int>>
        {
            public override bool IsSystem
            {
                get
                {
                    return true;
                }
            }

            public override bool IsList
            {
                get
                {
                    return true;
                }
            }


            public override string LanguageKeyword
            {
                get
                {
                    return "List<int>";
                }
            }

            public override string[] GetTypeStrings()
            {
                return new string[]
                {
                    "List",
                    "unityengine.List"
                };
            }

            public override int GetListCount()
            {
                // return base.GetListCount();

                return 0;
            }


            public override List<int> Parse(string value)
            {
                string[] splitedValue = value.Split('#');
                List<int> intList = new List<int>();
                for (int i = 0; i < splitedValue.Length; i++)
                {
                    intList.Add(int.Parse(splitedValue[i]));
                }

                return intList;
            }

            public override void WriteToStream(DataTableProcessor dataTableProcessor, BinaryWriter binaryWriter, string value)
            {
                List<int> intList = Parse(value);

                //binaryWriter.Write("#");

                for (int i = 0; i < intList.Count; i++)
                {
                    binaryWriter.Write(intList[i].ToString());
                }

                binaryWriter.Write("#");
            }
        }
    }

因为list比较特殊

在底层加一个变量支持

在DataTableExtension增加扩展方法

 public static List<int> ParseList(string value)
        {
            string[] splitedValue = value.Split(',');
            List<int> intList = new List<int>();
            for (int i = 0; i < splitedValue.Length; i++)
            {
                intList.Add(int.Parse(splitedValue[i]));
            }
            return intList;
        }

写一个支持特定格式的List的 BinaryReader 扩展方法

 public static List<int> ReadList(this BinaryReader binaryReader)
        {
            List<int> intList = new List<int>();
  
            string s = "";

            bool isBreak=true;

            while (isBreak)
            {
                s = binaryReader.ReadString();

                if (s != "#")
                {
                    intList.Add(int.Parse(s));
                }
                else
                {
                    isBreak = false;
                }
            }
  
            return intList;
        }

在DataTableProcessor中增加一个辅助判定是否是列表变量的函数

public bool IsList(int rawColumn)
        {
            if (rawColumn < 0 || rawColumn >= RawColumnCount)
            {
                throw new GameFrameworkException(Utility.Text.Format("Raw column '{0}' is out of range.", rawColumn.ToString()));
            }

            return m_DataProcessor[rawColumn].IsList;
        }

更改一下写入模版方法加入对特定list的支持

 private static string GenerateDataTableParser(DataTableProcessor dataTableProcessor)
        {
            StringBuilder stringBuilder = new StringBuilder();
            stringBuilder
                .AppendLine("        public override bool ParseDataRow(string dataRowString, object userData)")
                .AppendLine("        {")
                .AppendLine("            string[] columnStrings = dataRowString.Split(DataTableExtension.DataSplitSeparators);")
                .AppendLine("            for (int i = 0; i < columnStrings.Length; i++)")
                .AppendLine("            {")
                .AppendLine("                columnStrings[i] = columnStrings[i].Trim(DataTableExtension.DataTrimSeparators);")
                .AppendLine("            }")
                .AppendLine()
                .AppendLine("            int index = 0;");

            for (int i = 0; i < dataTableProcessor.RawColumnCount; i++)
            {
                if (dataTableProcessor.IsCommentColumn(i))
                {
                    // 注释列
                    stringBuilder.AppendLine("            index++;");
                    continue;
                }

                if (dataTableProcessor.IsIdColumn(i))
                {
                    // 编号列
                    stringBuilder.AppendLine("            m_Id = int.Parse(columnStrings[index++]);");
                    continue;
                }

                if (dataTableProcessor.IsSystem(i))
                {
                    string languageKeyword = dataTableProcessor.GetLanguageKeyword(i);
                    if (languageKeyword == "string")
                    {
                        stringBuilder.AppendFormat("            {0} = columnStrings[index++];", dataTableProcessor.GetName(i)).AppendLine();
                    }
                    else if (dataTableProcessor.IsList(i))
                    {
                        stringBuilder.AppendFormat("            {0} =  DataTableExtension.ParseList(columnStrings[index++]);", dataTableProcessor.GetName(i)).AppendLine();
                    }
                    else
                    {
                        stringBuilder.AppendFormat("            {0} = {1}.Parse(columnStrings[index++]);", dataTableProcessor.GetName(i), languageKeyword).AppendLine();
                    }
                }
                else
                {
                    stringBuilder.AppendFormat("            {0} = DataTableExtension.Parse{1}(columnStrings[index++]);", dataTableProcessor.GetName(i), dataTableProcessor.GetType(i).Name).AppendLine();
                }
            }

            stringBuilder.AppendLine()
                .AppendLine("            GeneratePropertyArray();")
                .AppendLine("            return true;")
                .AppendLine("        }")
                .AppendLine()
                .AppendLine("        public override bool ParseDataRow(byte[] dataRowBytes, int startIndex, int length, object userData)")
                .AppendLine("        {")
                .AppendLine("            using (MemoryStream memoryStream = new MemoryStream(dataRowBytes, startIndex, length, false))")
                .AppendLine("            {")
                .AppendLine("                using (BinaryReader binaryReader = new BinaryReader(memoryStream, Encoding.UTF8))")
                .AppendLine("                {");

            for (int i = 0; i < dataTableProcessor.RawColumnCount; i++)
            {
                if (dataTableProcessor.IsCommentColumn(i))
                {
                    // 注释列
                    continue;
                }

                if (dataTableProcessor.IsIdColumn(i))
                {
                    // 编号列
                    stringBuilder.AppendLine("                    m_Id = binaryReader.Read7BitEncodedInt32();");
                    continue;
                }

                

                string languageKeyword = dataTableProcessor.GetLanguageKeyword(i);

                if (dataTableProcessor.IsList(i))
                {
                    stringBuilder.AppendFormat("                    {0} = binaryReader.ReadList();", dataTableProcessor.GetName(i)).AppendLine();
                    continue;
                }


                if (languageKeyword == "int" || languageKeyword == "uint" || languageKeyword == "long" || languageKeyword == "ulong")
                {
                    stringBuilder.AppendFormat("                    {0} = binaryReader.Read7BitEncoded{1}();", dataTableProcessor.GetName(i), dataTableProcessor.GetType(i).Name).AppendLine();
                }
                else
                {
                    stringBuilder.AppendFormat("                    {0} = binaryReader.Read{1}();", dataTableProcessor.GetName(i), dataTableProcessor.GetType(i).Name).AppendLine();
                }
            }

            stringBuilder
                .AppendLine("                }")
                .AppendLine("            }")
                .AppendLine()
                .AppendLine("            GeneratePropertyArray();")
                .AppendLine("            return true;")
                .Append("        }");

            return stringBuilder.ToString();
        }

在表中加入list字段

给表格加上list字段

将表格名字加入生成列表

public static readonly string[] DataTableNames = new string[]
        {
            "Aircraft",
            "Armor",
            "Asteroid",
            "Entity",
            "Music",
            "Scene",
            "Sound",
            "Thruster",
            "UIForm",
            "UISound",
            "Weapon",
            "ExcelTest"
        };

点击生成

可以看到自动生成了我们配置的List字段

public List<int> DeadSoundId
        {
            get;
            private set;
        }

        public override bool ParseDataRow(string dataRowString, object userData)
        {
            string[] columnStrings = dataRowString.Split(DataTableExtension.DataSplitSeparators);
            for (int i = 0; i < columnStrings.Length; i++)
            {
                columnStrings[i] = columnStrings[i].Trim(DataTableExtension.DataTrimSeparators);
            }

            int index = 0;
            index++;
            m_Id = int.Parse(columnStrings[index++]);
            index++;
            ThrusterId = int.Parse(columnStrings[index++]);
            WeaponId0 = int.Parse(columnStrings[index++]);
            WeaponId1 = int.Parse(columnStrings[index++]);
            WeaponId2 = int.Parse(columnStrings[index++]);
            ArmorId0 = int.Parse(columnStrings[index++]);
            ArmorId1 = int.Parse(columnStrings[index++]);
            ArmorId2 = int.Parse(columnStrings[index++]);
            DeadEffectId = int.Parse(columnStrings[index++]);
            DeadSoundId =  DataTableExtension.ParseList(columnStrings[index++]);

            GeneratePropertyArray();
            return true;
        }

        public override bool ParseDataRow(byte[] dataRowBytes, int startIndex, int length, object userData)
        {
            using (MemoryStream memoryStream = new MemoryStream(dataRowBytes, startIndex, length, false))
            {
                using (BinaryReader binaryReader = new BinaryReader(memoryStream, Encoding.UTF8))
                {
                    m_Id = binaryReader.Read7BitEncodedInt32();
                    ThrusterId = binaryReader.Read7BitEncodedInt32();
                    WeaponId0 = binaryReader.Read7BitEncodedInt32();
                    WeaponId1 = binaryReader.Read7BitEncodedInt32();
                    WeaponId2 = binaryReader.Read7BitEncodedInt32();
                    ArmorId0 = binaryReader.Read7BitEncodedInt32();
                    ArmorId1 = binaryReader.Read7BitEncodedInt32();
                    ArmorId2 = binaryReader.Read7BitEncodedInt32();
                    DeadEffectId = binaryReader.Read7BitEncodedInt32();
                    DeadSoundId = binaryReader.ReadList();
                }
            }

            GeneratePropertyArray();
            return true;
        }

写一个简单的方法使用一下配置的表格

if (Input.GetKeyDown(KeyCode.A))
        {
            IDataTable<StarForce.DRExcelTest> ExcelTest = StarForce.GameEntry.DataTable.GetDataTable<StarForce.DRExcelTest>();
            StarForce.DRExcelTest drExcelTest = ExcelTest.GetDataRow(10000);
            for (int i = 0; i < drExcelTest.DeadSoundId.Count; i++)
            {
                Debug.LogError($"----{i}-----{drExcelTest.DeadSoundId[i]}---------");
            }
        }

结果符合预期

扩展方法小结

此扩展写法性能可以继续优化

也可以在此之上想办法写成宏定义支持的列表类型

其实这种模版自动生成脚本的方法，是完全可以根据项目的特定需求去编写特定的逻辑的。

GF在starforce中抛砖引玉给了我们一个实现思路，本质就是对文件的读和写的应用。

表格模版代码结构

DataTableManager

m_DataTables 就是所有表格的合集

显然我们加载表格需要资源加载支援

同时也需要数据解析支援

 internal sealed partial class DataTableManager : GameFrameworkModule, IDataTableManager
    {
        private readonly Dictionary<TypeNamePair, DataTableBase> m_DataTables;
        private IResourceManager m_ResourceManager;
        private IDataProviderHelper<DataTableBase> m_DataProviderHelper;
        private IDataTableHelper m_DataTableHelper;
   ｝

DataTable

单张表的所有数据集合

这里巧妙的用行数据类型来标定表格的类型

 private sealed class DataTable<T> : DataTableBase, IDataTable<T> where T : class, IDataRow, new()
        {
            private readonly Dictionary<int, T> m_DataSet;
        ｝

DataRowBase

行数据类型基类

也是我们定义表格数据模版类的基类

这里有一个细节，可能无关紧要，可能是出于前后端适配的考量

E神把行数据基类定义写在了UGF层，数据基类写在GF层

  public abstract class DataRowBase : IDataRow
    {
        /// <summary>
        /// 获取数据表行的编号。
        /// </summary>
        public abstract int Id
        {
            get;
        }

        /// <summary>
        /// 解析数据表行。
        /// </summary>
        /// <param name="dataRowString">要解析的数据表行字符串。</param>
        /// <param name="userData">用户自定义数据。</param>
        /// <returns>是否解析数据表行成功。</returns>
        public virtual bool ParseDataRow(string dataRowString, object userData)
        {
            Log.Warning("Not implemented ParseDataRow(string dataRowString, object userData).");
            return false;
        }

        /// <summary>
        /// 解析数据表行。
        /// </summary>
        /// <param name="dataRowBytes">要解析的数据表行二进制流。</param>
        /// <param name="startIndex">数据表行二进制流的起始位置。</param>
        /// <param name="length">数据表行二进制流的长度。</param>
        /// <param name="userData">用户自定义数据。</param>
        /// <returns>是否解析数据表行成功。</returns>
        public virtual bool ParseDataRow(byte[] dataRowBytes, int startIndex, int length, object userData)
        {
            Log.Warning("Not implemented ParseDataRow(byte[] dataRowBytes, int startIndex, int length, object userData).");
            return false;
        }
    }

表格加载流程-StarForce项目示例（实际使用可根据具体需求去定制流程）

1.走ProcedurePreload中的LoadDataTable

2.创建表格，dataTableComponent.CreateDataTable(dataRowType, name);

3.在创建流程中，初始化表格，将没有数据填充的空表加入表格管理

4.读取数据，dataTable.ReadData(dataTableAssetName, Constant.AssetPriority.DataTableAsset, userData);

5.先通过资源加载流程加载好数据，如果已经加载或者加载成功则走回调中解析数据并将数据填入表格。

至此表格加载完成。

GF-11 配置表

概念

使用前

GF表格模版类生成和制作流程

创建一个excel表格

扩展自动生成脚本支持的变量类型

扩展方法小结

表格模版代码结构

DataTableManager

DataTable

DataRowBase

表格加载流程-StarForce项目示例（实际使用可根据具体需求去定制流程）

GF-10 场景

GF-12 有限状态机

maodaodao

Comments | NOTHING

取消回复

心界