设计防止魔术数字和字符串

Question

我正在构建一个从第三方检索并提交给第三方的服务。第三方提供了一个复杂的数据模型，其中包括三种不同的状态类型，它们都是带有模糊数字序列的整数。下面提供了一个示例（键：值）：

HandlerStatus客户状态存档状态---------activeUnallocated:40草稿打开：0打开打开：0activeAllocated：26提交：2关闭：1活跃推广人数：102批准人数：100已拒绝：2已拒绝：1。。。

组合的数量有限，每个组合都有一个术语（提交、委托给另一个用户、等待确认等）。例如：

名为"已提交"的组合：HandlerStatus必须为"activeUnallocated"（40）必须"提交"CustomerStatus（2）ArchiveStatus必须为"openOpen"（0）

我们可以期望添加额外的值，并且用户友好的名称可能会随着时间的推移而更改
此外，还有一些操作，如提交和委派给其他用户，不需要用户选择新值，这意味着服务需要知道在这些操作发生时必须设置的一组组合。

• 我必须能够为每个状态类型中的每个状态值定义用户友好的显示名称
• 我必须能够从用户那里接收新的状态值，并将其映射为正确的状态类型
• 我必须能够查找已定义组合的值
• 我必须能够根据一组状态值查找定义的组合

我想到了三种不同的解决方案，有不同的优点和缺点

1.为每种状态类型定义枚举

优点：

• 强类型
• 维护仅限于一个文件

缺点：

• 枚举
• UI演示文稿的字符串格式

2.在外部JSON文件中定义键/值对

优点：

• 添加不需要更改代码
• 可以在运行时更新

缺点：

• 具有关联组合的操作需要魔术字符串/数字（无需用户输入的操作）
• 频繁读取文件系统

3.为不同的可用状态组合创建代理类

优点：

• 强类型
• 灵活

缺点：

• 在第三方系统中发生更改时需要代码维护

我试着研究最佳实践和模式，看看哪种解决方案最适合维护性和良好的代码设计，但我没有取得任何进展（与此同时，我在开发过程中严重依赖魔术串和数字）。

Answer 1

首先：避免幻数和字符串是正确的。

经验法则是，如果它是一个不变的整数（经常），那么枚举就很好。如果它是一个不经常更改的字符串，那么一个包含字符串的静态（共享）类就很好了。在这些情况下，您的目标是集中定义。这为您提供了一些优势，例如避免（字符串中的）拼写错误，使代码更可读（使用枚举名称而不是数字），并且您可以跟踪使用情况（查找用法）。请注意，您可能不想使用const关键字，除非您的值是固定不变的。

对于经常更改的值，您需要考虑用程序逻辑来处理这些值。没有人硬编码客户名称和地址（希望如此），所以如果你的状态经常更改，你想像处理任何其他数据一样处理它们。如果它们与程序逻辑绑定，那么您需要定义需要什么程序逻辑，并以某种方式连接状态。

对于更改频率较低的值，您可以在硬编码（enum/string）和从配置文件读取之间进行选择。硬编码显然需要重新编译，然后您应该考虑长期成本。今天花5分钟做的事情将来可能需要几天时间。2年后，另一位被指派更新其中一个值的开发人员可能会花上几天时间来设置正确的开发环境、编译和测试。看到从文件中读取值是多么容易，我的建议通常是使用配置文件。

对于您的特定问题，您似乎需要一个翻译表。您的应用程序有特定的任务要执行。答案似乎是使应用程序通用，并将翻译保存在文件中。您希望在文件（或sql表）中保留对状态更新（什么将把什么状态转换为什么）和友好显示（对用户）的约束。简而言之，使应用程序对状态字段所经历的转换不可知。

不用担心文件IO。它很容易实现缓存。

private static TranslationObject _translationObject = null;
public static TranslationObject GetTranslationObject() {
    if (_translationObject == null)
       lock (_translationObject)
           _translationObject = JsonConvert.DeserializeObject<TranslationObject>(File.ReadAllTextt("TranslationTable.json"));
    return _translationObject;
}

即使在网络应用程序中，该应用程序也会保持一段时间，因此这会在请求之间缓存文件。无论如何，操作系统应该有足够的内存来缓存磁盘IO中的几千字节数据。

为了说明实现的多种方法之一，我添加了一个示例，其中结构与Dictionary结合使用，用于在友好状态和其他状态的组合之间进行快速双向查找。我不确定这是否正是你所要求的，但希望这能有所帮助。

void Main()
{
    // Get translation
    var translationObject = GetTranslationObject();
    // Find friendly status based on combo
    var friendly1 = translationObject.ComboStatusToFriendlyStatus[new StatusCombo(0, 30, 5)];
    // Find combo based on friendly status
    var combo1 = translationObject.FriendlyStatusToComboStatus[0];
}
public struct StatusCombo
{
    // Please note that fields are readonly for immutability.
    // This is particularly important since the GetHashCode() value is used in dictionaries.
    // Note that status fields can also be strings (because we use .GetHashCode() in GetHashCode()).
    public readonly int Status1;
    public readonly int Status2;
    public readonly int Status3;
    [JsonConstructor]
    public StatusCombo(int status1, int status2, int status3)
    {
        Status1 = status1;
        Status2 = status2;
        Status3 = status3;
    }
    public override int GetHashCode()
    {
        unchecked
        {
            int hashCode = Status1.GetHashCode();
            hashCode = (hashCode * 397) ^ Status2.GetHashCode();
            hashCode = (hashCode * 397) ^ Status3.GetHashCode();
            // ... Repeat for every extra statuscode you add
            return hashCode;
        }
    }
}
public class TranslationObject
{
    public Dictionary<int, string> Status1Mapping;
    public Dictionary<int, string> Status2Mapping;
    public Dictionary<int, string> Status3Mapping;
    public Dictionary<int, string> FriendlyStatus;
    public Dictionary<int, StatusCombo> FriendlyStatusToComboStatus;
    [JsonIgnore]
    public Dictionary<StatusCombo, int> ComboStatusToFriendlyStatus;
}
private static TranslationObject _translationObject = null;
public static TranslationObject GetTranslationObject()
{
    if (_translationObject == null)
        lock ("Reading _translationObject")
        {
            _translationObject = JsonConvert.DeserializeObject<TranslationObject>(File.ReadAllText(@"TranslationTables.json"));
            // Populate reverse lookup
            _translationObject.ComboStatusToFriendlyStatus=new Dictionary<UserQuery.StatusCombo, int>();
            foreach (var t in _translationObject.FriendlyStatusToComboStatus)
                _translationObject.ComboStatusToFriendlyStatus.Add(t.Value, t.Key);
        }
    return _translationObject;
}

示例JSON文件：

{"状态映射"：{"0"："Status1_0"，"10"："状态_1"}，"状态映射"：{"30"："Status2_0"，"55"："状态2_1"}，"状态映射"：{"5"："Status3_0"，"2"："Status3_1"}，"FriendlyStatus"：{"0"："已提交"，"1"："已接收"}，"FriendlyStatusToComboStatus"：{"0"：{"状态1"：10，"状态2"：55，"状态3"：2}，"1"：{"Status1"：0，"状态2"：30，"状态3"：5}}}

我用来填充示例JSON:的代码

var tro = new TranslationObject();
tro.Status1Mapping = new Dictionary<int, string>();
tro.Status2Mapping = new Dictionary<int, string>();
tro.Status3Mapping = new Dictionary<int, string>();
tro.Status1Mapping.Add(0, "Status1_0");
tro.Status1Mapping.Add(10, "Status1_1");
tro.Status2Mapping.Add(30, "Status2_0");
tro.Status2Mapping.Add(55, "Status2_1");
tro.Status3Mapping.Add(5, "Status3_0");
tro.Status3Mapping.Add(2, "Status3_1");
tro.FriendlyStatus = new Dictionary<int, string>();
tro.FriendlyStatus.Add(0, "Submitted");
tro.FriendlyStatus.Add(1, "Received");
tro.FriendlyStatusToComboStatus = new Dictionary<int, UserQuery.StatusCombo>();
tro.FriendlyStatusToComboStatus.Add(0, new StatusCombo(10, 55, 2));
tro.FriendlyStatusToComboStatus.Add(1, new StatusCombo(0, 30, 5));
File.WriteAllText(@"TranslationTables.json", JsonConvert.SerializeObject(tro));

Answer 2

您可以用json、xml、resx、纯文本、sql或任何您想要的方式定义键值对。将三个状态字段组合为字符串键：

key               value
A2|B3|            Submitted
A2|B3|X           Submitted with error
A1|B1|            Started
etc...

然后在应用程序启动时，读取此文件并将其存储在字典中。

Dictionary<string, string> StatusTypes = new Dictionary<string, string>();

那么除了专业人士什么都没有：

• 在单独的文件中定义的灵活性
• 新状态不需要更改代码
• 速度快，在内存中，因此没有持续的磁盘访问