c# - 序列化 c# 使用 switch 序列化自述文件

Question

我开发了一个应用程序，它在内部为我组织内的其他开发人员提供回归测试功能，他们通过应用程序前端进行交互的主要方式是通过与代码中的 switch case 结构相对应的硬编码字符串像这样:

           case "BUILDTEST":
                //Build the test with the supplied designator as 'arg_designator'
                returnVal = BuildDesignator();
                break;

            case "CHANGEROLE":
                //Changes the user's role
                returnVal = ChangeRole();
                break;

            case "CHECKOUTDATA":
                //Check out the data you wish to test
                returnVal = CheckoutRoute();
                break;

序列化案例下方的名称和注释以在每次构建时生成某种自述文件的最佳方法是什么？在此示例中，我想生成一个如下所示的文件:

FUNCTIONALITY

BUILDTEST: Build the test with the supplied designator as 'arg_designator'

CHANGEROLE: Changes the user's role

CHECKOUTDATA: Check out the data you wish to test

感谢您提供的任何帮助

Answer 1

如果您不介意进行一些重组，这里有一个比序列化 switch 语句的内容更好的解决方案。我非常怀疑您是否想对该源运行正则表达式查找/替换操作，或者想通过添加文件来帮助推导开关内容。

首先，确保您的每个构建操作类都继承自基类。在执行此操作时，为每个构建操作类提供一个描述以使事情变得更容易:

public abstract class BuildAction
{
    public string Description { get; set; }

    protected BuildAction(string description)
    {
        Description = description;
    }

    public abstract void PerformBuildAction();
}

public class BuildTest : BuildAction
{
    public BuildTest() : base("Build the test with the supplied designator as 'arg_designator'") { }

    public override void PerformBuildAction() 
    {
        // do stuff here
    }
}

public class ChangeRole : BuildAction
{
    public ChangeRole() : base("Change the user's role") { }

    public override void PerformBuildAction()
    {
        // do stuff here
    }
}

public class CheckoutData : BuildAction
{
    public CheckoutData : base("Check out the data you wish to test") { }

    public override void PerformBuildAction()
    {
        // do stuff here
    }
}

之后，您可以删除 switch 语句并将其替换为通用工厂。根据您创建工厂的方式，您可以利用它来生成自述文件，方法是首先构建一个目录以遍历自述文件并简化命令路由的查找:

public class BuildActionFactory
{
    private static IDictionary<string, BuildAction> _buildActions =
        new Dictionary<string, BuildAction>()
        {
            {"BUILDTEST", typeof(BuildTest)},
            {"CHANGEROLE", typeof(ChangeRole)},
            {"CHECKOUTDATA", typeof(CheckoutData)}
        };

    public static BuildAction CreateBuildAction(string directive)
    {
        return _buildActions.ContainsKey(directive) ?
            Activator.CreateInstance(_buildActions[directive]) :
            null;
    }

    public static string BuildReadme()
    {
        return string.Join(Environment.NewLine + Environment.NewLine,
            new [] {"FUNCTIONALITY"}.Union(_buildActions.Select(pair => pair.Key + ": " + pair.Value.Description));
    }
}

如果您像那样创建工厂，则可以通过简单地调用 BuildActionFactory.CreateBuildAction("BUILDTEST/CHANGEROLE/CHECKOUTDATA/etc whatever you got from the user").PerformBuildAction() 然后您的自述文件内容可以由 BuildActionFactory.BuildReadme() 生成。当然，如果您希望在构建解决方案时构建自述文件，则需要添加一个从包装器控制台应用程序项目调用 BuildActionFactory.BuildReadme() 的构建后任务，但这比重构更简单在配置文件中，您可以从中生成自述文件。

免责声明:以上所有代码均使用 Sublime 编写。它们都没有经过编译或测试，但如果您采用这种方法，它应该可以让您了解该怎么做。