Visual Studio Code Metrics 和 switch case 的可维护性指数

Question

作为一个喜欢遵循最佳实践的人，

如果我运行代码指标（在解决方案资源管理器中右键单击项目名称并选择“计算代码指标”- Visual Studio 2010）：

    public static string GetFormFactor(int number)
    {
        string formFactor = string.Empty;
        switch (number)
        {
            case 1:
                formFactor = "Other";
                break;

            case 2:
                formFactor = "SIP";
                break;

            case 3:
                formFactor = "DIP";
                break;

            case 4:
                formFactor = "ZIP";
                break;

            case 5:
                formFactor = "SOJ";
                break;
        }

        return formFactor;
    }

它给我的可维护性指数为 61

（当然，如果你只有这个，那么这是微不足道的，但是如果你使用像类这样的实用程序，其哲学就是做类似的事情，那么你的实用程序类的可维护性指数将更差..）

这个问题的解决方案是什么？

Answer 1

首先：61被认为是可维护的代码。对于可维护性指数来说，100 表示代码非常容易维护，而 0 则表示很难维护。

• 0-9 = 难以维护
• 10-19 = 中等维护
• 20-100 = 良好维护

可维护性指数基于三个代码指标：即 Halstead Volumen、循环复杂度和代码行数，并基于 以下公式：

MAX(0,(171 - 5.2 * ln(霍尔斯特德
体积) - 0.23 * (循环
复杂度） - 16.2 * ln（行数
代码））*100 / 171）

事实上，在您的示例中，可维护性指数低值的根本原因是循环复杂度。该指标是根据代码中的各种执行路径计算的。不幸的是，该指标不一定与代码的“人类可读性”一致。

示例代码会导致索引值非常低（请记住，较低意味着更难维护），但实际上它们非常容易阅读。当使用循环复杂度来评估代码时，这种情况很常见。

想象一下代码，有一个为期几天（周一至周日）的开关块和一个为期几个月（一月至十二月）的开关块。该代码将非常具有可读性和可维护性，但会导致巨大的循环复杂性，从而导致 Visual Studio 2010 中的可维护性指数非常低。

这是有关该指标的众所周知的事实，如果根据数字来判断代码，则应考虑这一点。不应查看绝对数字，而应随着时间的推移监控这些数字，以将其理解为代码更改的指标。例如，如果可维护性指数始终为 100，然后突然下降到 10，您应该检查导致此情况的更改。

Answer 2

由于您为解决方案选择的方法缺乏可扩展性，因此可维护性指数可能会更高。

正确的解决方案（Mark Simpson 上面提到的）是可以扩展以使用新的形式因素而无需重新构建代码的解决方案 - 代码中的 switch / case 语句始终是 OO 设计已被遗忘的标志，应该始终被看到作为一种糟糕的代码味道。

就我个人而言，我会实现...

interface IFormFactor
{
    // some methods
}

class SipFormFactor : IFormFactor...

class DipFormFactor : IFormFactor...

Etc.

...并让接口上的方法提供所需的功能 - 您可以将其视为[我猜]类似于 GoF 命令模式。

这样，您的更高级别的方法就可以...

MyMethod(IFormFactor factor)
{
    // some logic...

    factor.DoSomething();

    // some more logic...
}

...您可以在以后引入新的形式因素，而不必像使用硬编码的 switch 子句那样更改此代码。您还会发现这种方法也很容易适用于 TDD（如果您正确地进行 TDD，您应该最终会采用这种方法），因为它很容易进行模拟。

Answer 3

我会这样做，并忘记可维护性指数：

public static string GetFormFactor(int number)
{
    switch (number)
    {
        case 1: return "Other";
        case 2: return "SIP";
        case 3: return "DIP";
        case 4: return "ZIP";
        case 5: return "SOJ";
    }

    return number.ToString();
}

恕我直言，易于阅读且易于更改。

Answer 4

我知道这个答案已经很晚了，但我感兴趣的是还没有人提出字典解决方案。我发现，在处理像这样面向数据的巨大 switch 语句时，将 switch-case 折叠到字典中通常更具可读性。

public static readonly IDictionary<int, string> Factors = new Dictionary<int, string> {
   { 1, "Other" },
   { 2, "SIP" },
   { 3, "DIP" },
   { 4, "ZIP" },
   { 5, "SOJ" }
};

public static string GetFormFactor2(int number)
{
   string formFactor = string.Empty;
   if (Factors.ContainsKey(number)) formFactor = Factors[number];
   return formFactor;
}

这为您提供了 74 的可维护性指数 - 由于类与字典的耦合而略低于数组解决方案，但我觉得它更通用，因为它适用于您通常会打开的任何数量的类型。与数组解决方案一样，它的扩展性非常好，并删除了大量重复代码。

一般来说，使用数据驱动的方法可以帮助您的代码更加清晰，因为它将重要部分（在本例中为条件和结果）与琐碎部分（在本例中为 switch-case）分开。

Answer 5

我想到两件事：

使用枚举将描述和值结合起来

public enum FormFactor
{
    Other = 1,
    SIP = 2,
    etc.
}

使用类或结构来表示每个外形规格

public class FormFactor 
{
    public int Index { get; private set; }
    public string Description { get; private set; }

    public FormFactor(int index, string description)
    {
        // do validation and assign properties
    }
}

Answer 6

我不知道这有多重要，但以下内容得到了 76 分：

private static string[] _formFactors = new[] { null, "Other","SIP","DIP", "ZIP", "SOJ"};
public static string GetFormFactor2(int number)
{
    if (number < 1 || number > _formFactors.Length)
    {
        throw new ArgumentOutOfRangeException("number");
    }

    return _formFactors[number];
}

Answer 7

显然，对我来说，Enum 方法是最易于维护的，因为它不涉及硬编码字符串，因此不存在拼写错误问题和编译时语法检查。
唯一的限制是命名规则。