C# 类型安全且开发人员友好的列表/集合技术

Question

我正在用 sp 调用的结果填充“字典”。键是字段名称，值是 sp 为该字段返回的任何值。这一切都很好，但出于安全和文档原因，我希望开发人员有一个预定义的密钥列表来访问此列表。我想做的是将枚举之类的东西作为字典的键，以便开发人员可以安全地访问列表，但仍然能够使用字符串键值访问字典。

我希望有一个可以使用枚举键和字符串键访问的字符串值列表。请确保任何建议都易于实施，这不是我愿意花费大量开销来实施的事情。

笔记： 我希望有一个键来驱动这个而不是一个枚举声明和一个列表声明，因为我将维护两个键列表，只是格式略有不同。

更新： 让我澄清一下我想要一个字符串键的原因，我在一次情况下使用这个列表来在具有类似 ##keyName## 的较大字符串中进行替换。所以我需要能够根据 #### 中的内容从我的字典中获取值。如果我使用枚举作为密钥，我不知道该怎么做。如果我可以将字符串“keyName”映射到 enum.keyName 那么我的问题就解决了。

Answer 1

我只想创建一个包含常量字符串而不是枚举的类。

class Keys
{
    public const string Key1 = "Key1";
    public const string Key2 = "Key2";
}

这样你就不必对字典做任何事情，但仍然拥有“建议的键”。

Answer 2

如果您不寻求大量开销，那么可以使用扩展方法。

Answer 3

听起来您正在尝试复制类型化数据集、LINQ to SQL 甚至普通旧 DTO 中已经存在的功能（也许需要 Automapper 的帮助）。开发人员会发现更容易使用已经熟悉的结构，如数据表或对象属性

Answer 4

任何枚举都可以使用 ToString 转换为字符串。因此，您可以编写一个索引器来接受任何对象并对其调用 ToString。对于字符串来说，这是一个空操作。

编辑

从 meiscooldude 窃取一个想法：

public static class EnumDictExt
{
    public static TValue Lookup<TValue, TEnum>(this IDictionary<string, TValue> dict, TEnum e)
            where TEnum : struct, IComparable, IFormattable, IConvertible
        { return dict[e.ToString()]; }
}

Answer 5

您可以尝试如下操作：

public enum MyKeys
{
    FirstKey,
    SecondKey,
    ThirdKey
}

然后在代码中的其他位置：

var dict = new Dictionary<MyKeys, string>();

dict.Add(MyKeys.FirstKey, "something");
dict.Add(MyKeys.SecondKey, "something else");
dict.Add(MyKeys.ThirdKey, "something else again");

// And then to access them, you can use
var stringVal = dict[MyKeys.FirstKey];
var secondVal = dict[(MyKeys)Enum.Parse(typeof(MyKeys), "secondkey", true)];

Answer 6

您可以将字典包装在自定义类中，并向该类添加两个索引器，一个用于字符串访问，另一个用于枚举访问

Answer 7

正如其他人所说，您可以创建两个索引器。但为了鼓励使用枚举并阻止使用字符串，请将枚举设为索引器并将字符串 api 命名为“GetTheValueOfThisElementWhichCanBeUnsafe”或类似名称（您明白了...）。

尽管我很懒，但如果两者都是索引器，我就不会在意，而是一直使用字符串版本。但如果 API 以某种方式向我咆哮，我至少会看到代码中的含义。

Answer 8

如果我理解正确的话，我最近对从服务器接收/发送到服务器的数据包做了类似的事情。数据包采用Key: Value\n 形式，并由表示其数据包类型的特殊键/值对定义（Action: Login，在本例中如下。请参阅< a href="http://www.voip-info.org/wiki/view/Asterisk+manager+API" rel="nofollow noreferrer">Asterisk API 以获取更多参考。）我解析了数据包类型，根据预期的键生成类，如下所示：

public abstract class Packet
{
    private Dictionary<string, string> _dictionary =
        new Dictionary<string, string>();

    public string this[string key]
    {
        get
        {
            if (_dictionary.ContainsKey(key))
            {
                return _dictionary[key];
            }
            else { return ""; }
        }
        set { _dictionary[key] = value; }
    }

    public abstract PacketType Type { get; }
}

public class LoginPacket : Packet
{
    public override PacketType Type
    { get { return PacketType.Action; } }

    public string Username
    {
        get { return this["Username"]; }
        set { this["Username"] = value; }
    }
    public string Password
    {
        get { return this["Password"]; }
        set { this["Password"] = value; }
    }
    public int Status // Example: Not an actual key in Login in the Asterisk API
    {
        get { return int.Parse(this["Status"]); }
        set { this["Status"] = value.ToString(); }
    }
}

这创建了一种强类型字典，您可以这样做：

LoginPacket packet = new LoginPacket
{
    Username = "User",
    Password = "user",
    Status = 123
};
Console.WriteLine(packet.Username); // Is equal to:
Console.WriteLine(packet["Username"]);

然后像任何其他类似字典的类一样处理packet，您可以扩展它，这样Packet 实现 IDictionary，或者走另一个方向并使 this[string key] get 或 set 受到保护，以便仅使用有效密钥。