C# 防止数字和字符串变魔术的设计

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

HandlerStatus客户档案状态 --- --- --- activeUnallocated:40 draftOpen:0 openOpen:0 活动分配：26已提交：2已关闭：1 实际推广：102批准：100 谢绝：2谢绝：1 ... ... 组合数量有限，每个组合都有一个术语（提交、委托给另一个用户、等待确认等）。例如：

Combination called "Submitted": HandlerStatus has to be "activeUnallocated" (40) CustomerStatus has to be "submitted" (2) ArchiveStatus has to be "openOpen" (0) 称为“已提交”的组合： HandlerStatus必须为“活动未分配”（40） CustomerStatus必须“提交”（2） ArchiveStatus必须是“开放的”（0） 我们可以期望添加额外的值，并且用户友好的名称可能会随着时间的推移而改变。
此外，还有一些操作，如提交和委托给其他用户，这些操作不需要用户选择新值，这意味着服务需要知道在这些操作发生时必须设置的一组组合

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

我想到了三种不同的解决方案，各有利弊。

1.为每个状态类型定义en枚举 优点：

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

缺点：

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

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

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

缺点：

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

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

• 强类型
• 灵活的

缺点：

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

---

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

您可以用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>();

Dictionary StatusTypes=newdictionary（）；

那就只有优点了：

• 在单独的文件中定义的灵活性
• 新状态无需更改代码
• 快速，在内存中，因此无需经常访问磁盘

---

首先也是最重要的一点：避免使用幻数和字符串是正确的

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

<>对于经常更改的值，您需要考虑程序逻辑来处理这些值。没有人硬编码客户姓名和地址（希望如此），因此如果您的状态经常变化，您希望像处理任何其他数据一样处理它们。如果它们与程序逻辑相关联，则需要定义所需的程序逻辑，并以某种方式连接状态

对于更改频率较低的值，您可以选择硬编码（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;
}

private static TranslationObject\u TranslationObject=null；
公共静态TranslationObject GetTranslationObject（）{
if（_translationObject==null）
锁定（_translationObject）
_translationObject=JsonConvert.DeserializeObject（File.ReadAllTextt（“TranslationTable.json”）；
返回_translationObject；
}

即使在web应用程序中，该应用程序也会保持活动状态一段时间，因此这将在请求之间缓存文件。无论如何，操作系统应该有足够的内存

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

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;
}

{ "Status1Mapping": { "0": "Status1_0", "10": "Status1_1" }, "Status2Mapping": { "30": "Status2_0", "55": "Status2_1" }, "Status3Mapping": { "5": "Status3_0", "2": "Status3_1" }, "FriendlyStatus": { "0": "Submitted", "1": "Received" }, "FriendlyStatusToComboStatus": { "0": { "Status1": 10, "Status2": 55, "Status3": 2 }, "1": { "Status1": 0, "Status2": 30, "Status3": 5 } } }

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));