您将如何在 C# 项目中存储表格常量数据？

Question

我目前正在为 CAD 风格软件编写插件。 该插件根据从 CAD 模型读取的数据和大量表格查找（想想计算指南中的打印表格）进行计算。 我继承了这个插件，当前的解决方案定义了一个类 Constant ，它有一堆静态结构成员和二维数组。 然后在运行时通过枚举值对这些数组进行索引以查找适当的数据。

我对这个解决方案不太满意，因为 Constant 类中的表示有点难以阅读 - 检索数据时使用的枚举值在编辑时当然不可见 em> 数据（尽管这只发生在手动且很少的情况下）。

我不想将数据库（和引擎）与小插件捆绑在一起，但想要类似的语义，例如使用 LINQ 选择某些字段匹配的值等。

您对此问题的首选解决方案是什么？

• 您是否使用一堆 XML 文件并在运行时解析它们？
• 您是否使用模板引擎（t4？）在编译时从 XML 文件生成类？
• 您是否在资源中存储数据集的 XML 版本（在运行时读取它们，LINQ to dataset...）
• 您是否只保留 Constants 类，也许向成员添加一些文档（不'不要让我开始了解遗留代码，没有任何评论......）

Answer 1

我目前正在为性能关键型应用程序执行此操作。 我的方法是序列化平面文件中的数据（作为发布过程的一部分），然后（在启动时）将其反序列化为类模型，从而允许 LINQ 到对象查询。

在大多数情况下，xml 是合理的，但我优先使用自己的二进制序列化器 - 主要是为了速度。

由于常量数据不会更改，因此通常可以将其缓存在您手边的实例中并多次重复使用（而不是每次使用时反序列化）。

澄清一下：要使用的数据存储在标准数据库中（他们擅长此类事情，并且存在许多用于导入/编辑/查询/等的工具）。 作为发布过程的一部分，我将数据从数据库加载到对象模型中（使用相同的类），并将其序列化：

// during release
MyDataModel data = new MyDataModel(); // wraps multiple data lists
data.Load(); // from database tables, using ORM
data.Save("data.bin"); // serialization

然后我将 data.bin 与应用程序一起发送（好吧，实际上它是单独存储的，但这是旁白……）； 在运行时：

MyDataModel data = new MyDataModel();
data.Load("data.bin"); // deserialization
data.Freeze(); // make immutable

请注意，在这种情况下，数据是“冰棒不可变” - 即为了保留“恒定”性质（但同时让它在加载期间编辑数据），我有一个级联 Freeze在项目上设置标志的方法； 一旦设置此标志，所有编辑（对项目或列表）都会引发异常。 这对运行代码的性能影响为零：因为您希望将其视为常量数据，所以它只进行读取！

Answer 2

除非性能是一个限制，否则我会采用 XML-dataset-in-resources 方法。 它相当明显（因此无论将来谁从您这里获取代码都不会对其外观感到困惑），编辑和访问都很容易，并且不需要以表格 XML 的自定义解析器的形式重新发明轮子数据。

Answer 3

如果部署是一个问题，您始终可以在程序集中嵌入一个 XML 文件。 这使您能够保持相同水平的恒定性，因为用户将无法处理数据。

任何文件都可以使用VS作为资源嵌入，只需将文件添加到项目中并选择：Build Action => 来自属性的嵌入资源。

然后在启动时您可以调用：

// name is the name of the embedded resource
Assembly.GetExecutingAssembly().GetManifestResourceStream(name); 

获取嵌入数据的流。

这种方法的优点是您可以以任何您想要的格式保存常量数据，这将使维护变得更加容易。 启动时，您可以进行所有索引和组织，以便数据具有适当的 API。

Answer 4

您可以生成 Constant 类。
这样您就可以以更方便的方法存储数据，例如 MDB (MS Access) 或 MDF (SQL Express) 文件。 编辑这些文件是用户友好的。

我建议您有一个额外的项目来生成主项目的 Constant 类，并将所有需要的数据作为常量。 额外的项目可以是控制台应用程序。 在主项目中使用预构建事件来执行此控制台应用程序，然后您就拥有了生成的类。

Answer 5

我赞同使用 XML 的建议（无论是否是资源库），但想详细说明一下解析/编辑/处理此场景的问题。

---

首先，关于与 Pavels 回答是否可以通过 Visual Studio (VS) 中的表编辑器进行可视化编辑 XML：事实上，它曾经在 VS 2003 中使用（参见“图 6.28. XML 文档：数据视图”此处了解其外观），在 VS 2005 中，该功能有所降级（参见例如 Visual Studio 2005 中的 XML 外观与 Visual Studio 2003）和 VS 2008 中最终被删除（参见例如 Visual Studio 2008 中缺少 XML 数据编辑器），这是非常不幸的，因为它有它的用途，并且可能对你也有帮助。 同样的（可能相关的）命运也适用于 XML 模式设计器，它至少会在 VS 2010 中得到替代，但还不知道新的 XML 数据视图。

---

回到您原来的问题：根据您的要求，您可以提供专用的 XML 记事本 2007。

然而，拥有 XML 模式最重要的好处是，它允许通过工具自动使用，特别是您可以生成两者，普通的旧 .NET 类和/或 >通过 Microsoft 的 XML 架构定义工具 (Xsd) 获取支持 LINQ 的数据集 .exe）。 （对于众所周知的结构化数据，即由 XML 模式支持，这确实比使用基于 t4 的繁琐的自定义解决方案要好得多。）

当然，首先获取模式并在实践中正确使用它们可能需要一些努力，但这些是值得的恕我直言，对于任何严肃的 XML 相关开发来说，这都是大好时光。

对于手头的任务，您实际上可能已经做得更好了，并且能够从现有类 Constant 中推断 XML 架构，请参阅<的“/t”开关a href="http://msdn.microsoft.com/en-us/library/x6c1kb0s.aspx" rel="nofollow noreferrer">Xsd.exe。 最初的结果可能不完整或不完全足够，但是通过一些预先的重构和/或手动调整，您应该能够很快地得出一个不错的模式。

因此，您应该能够像现在一样（大概）使用您的代码库，即您将拥有强类型枚举等，或者您可以根据需要通过启用 LINQ 的数据集切换使用 XML 数据（事实上​​，你可以同时进行这两项操作）。