核心内容摘要
老司机漫画下载：打开二次元世界的大门，精彩永不停歇！
CommandLineParser 完全指南让命令行参数解析变得简单优雅
· 8分钟阅读作为.NET开发者我们经常需要开发命令行工具。
无论是构建脚本、实用工具还是控制台应用优雅地处理命令行参数都是必备技能。
今天我要介绍的是.NET生态中最强大的命令行解析库——CommandLineParser。
为什么选择CommandLineParser在开始教程之前先说说为什么选择这个库✅强类型绑定- 将参数直接映射到类的属性✅自动验证- 内置丰富的验证机制✅智能帮助- 自动生成美观的帮助文档✅多命令支持- 类似git的子命令模式✅活跃生态- 持续维护社区支持好安装与基础使用首先通过NuGet安装dotnetaddpackage CommandLineParser或者使用Package ManagerInstall-PackageCommandLineParser基础示例创建一个简单的命令行工具让我们从一个文件处理工具开始usingCommandLine;usingSystem;usingSystem.IO;namespaceFileProcessor{classProgram{staticvoidMain(string[]args){Parser.Default.ParseArgumentsOptions(args).WithParsed(Run).WithNotParsed(HandleErrors);}staticvoidRun(Optionsopts){Console.WriteLine($处理文件:{opts.InputFile});Console.WriteLine($输出到:{opts.OutputFile});Console.WriteLine($详细模式:{opts.Verbose});// 你的业务逻辑在这里ProcessFile(opts);}staticvoidHandleErrors(IEnumerableErrorerrors){// 错误处理逻辑foreach(varerrorinerrors){Console.WriteLine($错误:{error});}}staticvoidProcessFile(Optionsopts){if(!File.Exists(opts.InputFile)){Console.WriteLine($文件不存在:{opts.InputFile});return;}// 模拟文件处理varcontentFile.ReadAllText(opts.InputFile);File.WriteAllText(opts.OutputFile,content.ToUpper());Console.WriteLine(文件处理完成!);}}publicclassOptions{[Option(i,input,Requiredtrue,HelpText输入文件路径)]publicstringInputFile{get;set;}[Option(o,output,Requiredtrue,HelpText输出文件路径)]publicstringOutputFile{get;set;}[Option(v,verbose,Defaultfalse,HelpText显示详细输出)]publicboolVerbose{get;set;}}}使用示例# 基本用法FileProcessor.exe -i input.txt -o output.txt# 使用长参数名FileProcessor.exe --input input.txt --output output.txt --verbose# 混合使用FileProcessor.exe -i input.txt --output output.txt -v高级特性详解
多命令支持Verb模式类似git的git commit、git push这样的子命令classProgram{staticintMain(string[]args){returnParser.Default.ParseArgumentsAddOptions,CommitOptions,PushOptions(args).MapResult((AddOptionsopts)RunAdd(opts),(CommitOptionsopts)RunCommit(opts),(PushOptionsopts)RunPush(opts),errs
;}staticintRunAdd(AddOptionsopts){Console.WriteLine($添加文件:{string.Join(, ,opts.Files)});if(opts.Verbose)Console.WriteLine(详细模式开启);return0;}staticintRunCommit(CommitOptionsopts){Console.WriteLine($提交信息:{opts.Message});if(opts.Amend)Console.WriteLine(修正上次提交);return0;}staticintRunPush(PushOptionsopts){Console.WriteLine($推送到:{opts.Remote??origin});if(opts.Force)Console.WriteLine(强制推送);return0;}}[Verb(add,HelpText添加文件到暂存区)]publicclassAddOptions{[Value(0,MetaNamefiles,HelpText要添加的文件,Requiredtrue)]publicIEnumerablestringFiles{get;set;}[Option(v,verbose,HelpText详细输出)]publicboolVerbose{get;set;}}[Verb(commit,HelpText提交更改)]publicclassCommitOptions{[Option(m,message,HelpText提交信息,Requiredtrue)]publicstringMessage{get;set;}[Option(amend,HelpText修正上次提交)]publicboolAmend{get;set;}}[Verb(push,HelpText推送到远程仓库)]publicclassPushOptions{[Option(r,remote,HelpText远程仓库名称,Defaultorigin)]publicstringRemote{get;set;}[Option(f,force,HelpText强制推送)]publicboolForce{get;set;}}使用示例# 添加文件tool.exeaddfile
txt file
txt -v# 提交更改tool.exe commit -m修复bug# 推送代码tool.exe push --remote upstream --force
复杂验证规则CommandLineParser支持丰富的验证机制publicclassAdvancedOptions{[Option(n,number,Requiredtrue,HelpText必须是一个正数)][Range(1,100,ErrorMessage数字必须在
之间)]publicintNumber{get;set;}[Option(e,email,HelpText邮箱地址)][RegularExpression(^[^\s][^\s]\.[^\s]$,ErrorMessage邮箱格式不正确)]publicstringEmail{get;set;}[Option(f,file,HelpText文件路径)][FileExists(ErrorMessage文件不存在)]publicstringFilePath{get;set;}[Option(d,directory,HelpText目录路径)][DirectoryExists(ErrorMessage目录不存在)]publicstringDirectoryPath{get;set;}[Option(url,HelpText网站URL)][Url(ErrorMessageURL格式不正确)]publicstringUrl{get;set;}}// 自定义验证属性publicclassFileExistsAttribute:ValidationAttribute{publicoverrideboolIsValid(objectvalue){if(valueisstringpath){returnFile.Exists(path);}returnfalse;}}
异步处理支持对于需要异步操作的情况classProgram{staticasyncTaskMain(string[]args){awaitParser.Default.ParseArgumentsOptions(args).WithParsedAsync(asyncoptsawaitProcessAsync(opts)).WithNotParsedAsync(asyncerrsawaitHandleErrorsAsync(errs));}staticasyncTaskProcessAsync(Optionsopts){Console.WriteLine(开始异步处理...);awaitTask.Delay(
;// 模拟异步操作Console.WriteLine(处理完成!);}staticasyncTaskHandleErrorsAsync(IEnumerableErrorerrors){foreach(varerrorinerrors){awaitConsole.Out.WriteLineAsync($错误:{error});}}}实用技巧和最佳实践
配置解析选项varparsernewParser(with{with.CaseInsensitiveEnumValuestrue;with.CaseSensitivefalse;with.EnableDashDashtrue;with.HelpWriterConsole.Out;with.IgnoreUnknownArgumentsfalse;with.AutoHelptrue;with.AutoVersiontrue;});parser.ParseArgumentsOptions(args);
自定义帮助文本[Usage(ApplicationAliasmyapp)]publicclassOptions{[Option(c,config,HelpText配置文件路径,MetaValueFILE,Group常用选项)]publicstringConfigFile{get;set;}[Option(threads,HelpText线程数量,Default4,MetaValueNUM,MetaName数量)]publicintThreadCount{get;set;}}
集成到ASP.NET CorepublicclassProgram{publicstaticasyncTaskintMain(string[]args){if(args.Length0args[0]cli){// 命令行模式returnawaitParser.Default.ParseArgumentsCliOptions(args.Skip(
.ToArray()).MapResult((CliOptionsopts)RunCliMode(opts),errsTask.FromResult(
);}else{// Web模式CreateHostBuilder(args).Build().Run();return0;}}staticasyncTaskintRunCliMode(CliOptionsopts){// 命令行逻辑return0;}publicstaticIHostBuilderCreateHostBuilder(string[]args)Host.CreateDefaultBuilder(args).ConfigureWebHostDefaults(webBuilder{webBuilder.UseStartupStartup();});}
常见问题解答Q: 如何处理未知参数A: 设置IgnoreUnknownArguments true或者使用[UnknownOption]特性处理。
Q: 如何支持响应式模式A: 结合System.CommandLine使用或者实现自定义的交互逻辑。
Q: 如何生成Bash自动补全A: CommandLineParser本身不支持但可以通过扩展实现。
总结CommandLineParser是.NET命令行开发的神器它让参数解析变得简单而强大。
通过本教程你应该能够✅ 掌握基础的单命令用法✅ 实现复杂的多命令应用✅ 使用验证规则确保参数正确性✅ 集成到各种应用场景中无论是简单的工具脚本还是复杂的企业级应用CommandLineParser都能满足你的需求。
开始使用它让你的命令行工具更加专业和易用吧进一步学习资源https://github.com/commandlineparser/commandlinehttps://github.com/commandlineparser/commandline/wikihttps://www.nuget.org/packages/CommandLineParser/希望这篇教程对你有帮助如果有任何问题欢迎在评论区讨论。