使用属性引用字典中的键值对的最佳方法

Question

这是一件相当微不足道的事情，但我很想听听人们对此的看法。

如果我有一个可以通过属性访问的字典，您更喜欢该属性中的哪种格式？

/// <summary>
/// This class's FirstProperty property
/// </summary>
[DefaultValue("myValue")]
public string FirstProperty {
    get {
        return Dictionary["myKey"];
    }
    set {
        Dictionary["myKey"] = value;
    }

这可能是典型的做法。 它相当高效，易于理解等。唯一的缺点是使用更长或更复杂的密钥，可能会拼写错误或仅更改一个实例或其他内容，这导致我想到这一点：

/// <summary>
/// This class's SecondProperty property
/// </summary>
[DefaultValue("myValue")]
private const string DICT_MYKEY = "myKey"
public string SecondProperty {
    get {
        return Dictionary[DICT_MYKEY];
    }
    set {
        Dictionary[DICT_MYKEY] = value;
    }

这稍微复杂一些，但似乎提供额外的安全性，并且更接近我所认为的“代码完整”解决方案。 缺点是，当属性上方还有 /// 块和 [DefaultValue()] 块时，它开始变得有点拥挤。

那么你更喜欢哪个，为什么？ 有人有更好的想法吗？

Answer 1

我同意@Glenn 纯粹挑剔的观点。 答案是任何对你有用的东西。 所有这些代码共 10 行（如果包含省略的最后一个大括号）。 没有人会迷路，而且输入错误的可能性非常小（不是不可能，但非常小）。 另一方面，如果您在其他地方使用了该密钥，那么一定要使用该常量。

就我个人而言，我会因为你的大括号风格而对你大发雷霆。 ：） 只是在开玩笑！ 这确实是一个风格问题。

Answer 2

我喜欢第二个纯粹是因为在代码中避免使用魔术字符串/数字是一件好事。 IMO 如果您需要在代码中多次引用数字或字符串文字，它应该是一个常量。 在大多数情况下，即使它只使用一次，它也应该是一个常量

Answer 3

@Joel你不想指望StackFrame。 内联可能会在您最意想不到的时候毁掉您的一天。

但对于问题：无论哪种方式都并不重要。

Answer 4

这没有回答您的问题，但我认为“DefaultValue”并不意味着您认为的含义。 它不会为您的属性设置默认值。

请参阅 MSDN 和 此问题了解更多详细信息。

Answer 5

很多人可能会认为第二个选项是“正确的”，因为任何多次使用的值都应该重构为常量。 我很可能会使用第一个选项。 通过将字典条目封装在强类型属性中，您已经接近“代码完成”解决方案。 这减少了在实现中检索错误字典条目时出错的可能性。
在 getter 和 setter 中，只有 2 个地方可能会搞乱输入“myKey”，而且这一点很容易被发现。

第二种选择会变得太混乱。

Answer 6

当你只在一种情况下使用魔法字符串时，就像你所做的那样，我认为这是可以的。
但如果您需要在类的其他部分使用该键，请使用const。

Answer 7

您可以将属性名称与键相匹配，并使用反射来获取查找的名称。

public string FirstProperty {
get {
    return Dictionary[PropertyName()];
}
set {
    Dictionary[PropertyName()] = value;
}

private string PropertyName()
{
    return new StackFrame(1).GetMethod().Name.Substring(4);
}

这样做的另一个好处是使所有属性实现都相同，因此如果需要，您可以在 Visual Studio 中将它们设置为代码片段。