我应该尽可能避免使用魔法弦吗？

Question

我有下一段代码:

    internal static string GetNetBiosDomainFromMember(string memberName)
    {
        int indexOf = memberName.IndexOf("DC=", StringComparison.InvariantCultureIgnoreCase);
        indexOf += "DC=".Length;
        string domaninName = memberName.Substring(indexOf, memberName.Length - indexOf);

         if (domaninName.Contains(","))
         {
             domaninName = domaninName.Split(new[] { "," }, StringSplitOptions.None)[0];
         }

         return domaninName;
     }

我正在为AD做一些解析,所以我有一些字符串,如"DC =","objectCategory =","LDAP://",",","." 谁谁.我发现上面的代码比下面的代码更具可读性:(你可能会发现反对,让我知道.)

    private const string DcString = "DC=";
    private const string Comma = ",";

    internal static string GetNetBiosDomainFromMember(string memberName)
    {
        int indexOf = memberName.IndexOf(DcString, StringComparison.InvariantCultureIgnoreCase);
        indexOf += DcString.Length;
        string domaninName = memberName.Substring(indexOf, memberName.Length - indexOf);

         if (domaninName.Contains(CommaString))
         {
             domaninName = domaninName.Split(new[] { CommaString }, StringSplitOptions.None)[0];
         }

         return domaninName;
     }

即使我可能有"DC"和"DC =",我应该在这些变量的名称中考虑或将它们分成两部分:(.然后我的问题: 我应该尽可能避免使用魔术字符串吗？

更新.

一些结论:

• 有一些方法可以避免使用字符串,这可能会更好.要实现它可以使用:静态类,枚举器,数字常量,IOC容器甚至反射.
• 常量字符串可帮助您确保没有任何拼写错误(在对字符串的所有引用中).
• 标点符号的常量字符串没有任何全局语义.使用它们会更具可读性,因为它们是",".使用常数这种情况下,可以认为如果该常数可能在将来改变,像变""由"" (有一个常数可以帮助你进行重构,虽然现代工具作为resharper这样做而不需要常量或变量).
• 如果你只需要使用它一旦你不需要将它变成一个常量.但是请考虑一个常量可以记录并显示在文档中(如Javadocs).这对于非平凡的字符串值可能很重要.

Answer 1

我当然会为“DC”和“objectCategory”等实际名称设置常量，但不会为标点符号设置常量。这样做的目的是确保您没有任何拼写错误等，并且您可以轻松找到使用该魔术字符串的位置的所有参考。标点符号实际上并不是其中的一部分。

需要明确的是，我假设魔术字符串是您必须处理的事情，您无法选择将它们设置为由常量定义的数字。正如对您的问题的评论中一样，如果可能的话，这总是更好的选择。但有时，如果您必须与需要字符串的其他系统进行交互，则必须使用字符串。