ConsoleAppFramework 参数验证与允许值限制的实现方法

ConsoleAppFramework 是一个功能强大的 .NET 命令行应用程序框架，它提供了多种方式来验证和处理命令行参数。本文将重点介绍如何在该框架中实现参数值的限制和验证。

参数验证基础

ConsoleAppFramework 内置支持 ValidationAttribute 验证机制，这意味着开发者可以直接使用 .NET 提供的各种数据验证特性来约束参数输入。这种验证方式简单直观，与 ASP.NET Core 中的模型验证机制类似。

使用 AllowedValuesAttribute 限制参数值

AllowedValuesAttribute 是 .NET 提供的一个数据注解特性，专门用于限制参数只能接受特定的值。在 ConsoleAppFramework 中，我们可以这样使用它：

public static void Main(string[] args)
{
    ConsoleApp.Run(args, RootCommand);

    static void RootCommand(
        [AllowedValues("AAA", "BBB", "CCC", ErrorMessage = "参数必须为 AAA, BBB 或 CCC 之一")]
        string type,
        string message)
    {
        Console.WriteLine($"{type}: {message}");
    }
}

当用户输入的值不在允许范围内时，框架会自动显示错误信息并阻止程序继续执行。

增强用户体验

虽然 AllowedValuesAttribute 提供了基本的验证功能，但为了更好的用户体验，建议在参数说明中明确列出允许的值：

/// <summary>根命令示例</summary>
/// <param name="type">消息类型，可选值: AAA, BBB, CCC</param>
/// <param name="message">要显示的消息内容</param>

这种双重保障（代码验证+文档说明）可以显著提高命令行工具的易用性。

高级应用场景

对于更复杂的验证需求，开发者可以：

1. 创建自定义验证特性
2. 实现 IValidatableObject 接口
3. 在方法内部添加额外的验证逻辑

这些方法可以与 AllowedValuesAttribute 结合使用，构建出强大的参数验证系统。

最佳实践建议

1. 始终为受限参数提供清晰的错误信息
2. 在帮助文本中明确列出允许的值
3. 考虑使用枚举类型代替字符串参数，获得更好的类型安全性
4. 对于复杂的验证逻辑，考虑创建专门的验证类

通过合理运用这些技术，开发者可以创建出既安全又用户友好的命令行应用程序。