如何最好地在 C# 中实现可公开访问的常量

Question

在 C# 中实现可公开访问的常量似乎有三种选择。我很好奇是否有任何充分的理由选择其中之一，或者这只是个人喜好问题。

选择 1 - 私有字段加属性 getter

private const string _someConstant = "string that will never change";

public string SomeConstant
{
    get { return _someConstant; }
}

选择 2 - 仅属性 getter

public string SomeConstant
{
    get { return "string that will never change"; }
}

选择 3 - 仅公共字段

public const string SomeConstant = "string that will never change";

---

您推荐哪个？为什么？

---

更新

显然，这已经变成了使用const还是static readonly的讨论。这不完全是我的意图，但它确实告诉我选择 3 绝对是一个坏主意，因为如果 const 的值在未来版本中发生变化，则需要重新编译所有引用程序集。

然而，我认为还没有人真正讨论过选择 2。我仍然很好奇如果只返回一个值而没有其他任何吸气剂是否有任何缺点。

Answer 1

选择 1 和 2 确实是等效的。

在我看来，确实存在三种不同的情况：

• 您确信该字符串永远不会改变。在这种情况下，将其设置为 const 是合理的。 （例如，Math.PI 是 const。这不会很快改变。）使用 static readonly 执行此操作会产生一些微妙的内存影响，但它们不太可能影响你。如果值可能会发生变化，并且由于其他地方给出的原因，您不想在这种情况下重新编译所有调用者，则不应执行此操作。请注意，对于许多项目（特别是公司内部的项目）来说，重新编译所有调用者实际上并不是问题。

• 您认为该字符串将来可能会发生变化，但您知道它在任何一个版本中都将始终是一个常量。在这种情况下，public static readonly 字段就可以了。请记住，可以对字符串执行此操作，因为它们是不可变的，但不应该对任何可变类型（例如数组）执行此操作。 （公开不可变集合或使用属性并每次返回一个新副本。）

• 您认为字符串可能会更改，甚至可能在程序的生命周期内更改...例如，“当前日期，格式化”。在这种情况下，请使用公共静态只读属性（仅具有 getter 的属性）。请注意，从只读字段更改为只读属性是源代码兼容的更改，而不是二进制兼容的更改 - 所以如果您已经同意我的第二个项目符号，但随后需要更改为第三个，您需要重新编译所有内容。

Answer 2

考虑

public static readonly string myVar = "something";

原因：当您公开（然后在其他地方使用）const 时，const 会嵌入到使用类型的元数据中。

public static readonly 则不然，而且由于它是 static readonly，它只需要实例化一次，而且它像 const 一样是不可变的。 。

Answer 3

正确的选择是选择#4：

 public static readonly string SomeConstant = "string that might change in a new version";

使用只读字段而不是公共常量很重要。 const 的字面值被编译到 IL 中。如果您更改 const 值并重新编译使用它的一个程序集，那么您现在将与其他也使用该 const 的程序集不匹配。这些其他程序集仍将使用旧的 const 值运行。 非常很难诊断。

只读字段不会发生这种情况，其他程序集将始终读取更新的值。如果您使用 const，请确保始终将它们设为私有。

Answer 4

const 成员是类成员，而不是实例成员（换句话说，const 意味着static）。

Answer 5

如果我可以投票 - 我会投票赞成乔恩·斯基特的答案。添加到它，您的 #1 和 #2 完全相同，如 IL：

.method public hidebysig specialname instance string 
    get_SomeConstant() cil managed
{
  // Code size       11 (0xb)
  .maxstack  1
  .locals init ([0] string CS$1$0000)
  IL_0000:  nop
  IL_0001:  ldstr      "string that will never change"
  IL_0006:  stloc.0
  IL_0007:  br.s       IL_0009
  IL_0009:  ldloc.0
  IL_000a:  ret
} // end of method Class1::get_SomeConstant

选项 #2：

.method public hidebysig specialname instance string 
    get_SomeConstant() cil managed
{
  // Code size       11 (0xb)
  .maxstack  1
  .locals init ([0] string CS$1$0000)
  IL_0000:  nop
  IL_0001:  ldstr      "string that will never change"
  IL_0006:  stloc.0
  IL_0007:  br.s       IL_0009
  IL_0009:  ldloc.0
  IL_000a:  ret
} // end of method Class2::get_SomeConstant

现在查看选项 #3 中所示。 3 号与 1 号和 2 号有很大不同。其原因是，如前所述，#3 是静态的，因为 const 是静态的。现在真正的问题是比较苹果与苹果，如果 #1 和 #2 是静态访问器怎么办？那么它们将与#3 更具可比性。目前，您必须为选项 1 和 2 初始化一个类，但不必为选项 3 初始化。因此，在这种情况下，对对象进行了不必要的初始化，并且您总是希望尽可能使用静态，因为为了避免这种情况。

现在让我们看看 IL 中的数字 3：

.field public static literal string SomeConstant = "string that will never change"

因此，为了提高效率，我将使用 #3。这也是我多年来许多有才华的同龄人教导我的。

现在，来解决房间里的白象问题。 Readonly 和 const 的区别在于 cont 发生在编译时，而 readonly 发生在运行时。静态只读初始化一次，而非静态只读每个实例初始化一次。例如，如果您要求您的问题执行诸如为永远不会更改的错误消息创建一类 const 字符串之类的操作，则使用选项#3，而不是只读静态或其他方式。考虑尝试在运行时而不是在编译时初始化数百条错误消息，您将看到明显的性能差异。另外，由于您明确指出它是一个“永远不会改变的字符串”，在这种情况下甚至不应该考虑只读，因为“......它永远不会改变”。 Const 和 ReadOnly 都有它们的位置，但 readonly 不适用于永远不会改变且在编译时已知的项目。

Answer 6

属性似乎确实是更好的选择，因为返回的字符串不会嵌入到元数据中。 const 实际上是供内部使用的（例如，版本号可以制成 const，并且可以更改）或绝对不会更改的值作为引用它的代码。