Java命令行工具开发指南

本文深入解析了Java命令行工具开发的核心要点：从main方法必须严格遵循public static void签名以确保JVM正确识别入口，到采用Maven标准项目结构简化构建与依赖管理；强调使用Apache Commons CLI替代手工解析args以可靠处理复杂参数（如引号、连写短选项、带值长选项），并支持自动帮助生成与类型校验；同时指出需显式调用System.exit()控制退出码以保证脚本可预测性，避免隐式退出或finally中误用导致的逻辑失效——这些看似细微却极易在CI/容器环境中引发隐蔽故障的关键实践，共同构成了健壮、专业、可维护的CLI工具开发基石。

main 方法必须声明为 public static void

命令行工具的入口就是 main 方法，JVM 只认这个签名。写成 private static void main(String[] args) 或漏掉 static 都会报错 java.lang.NoSuchMethodError: main。

• 必须是 public：JVM 要从外部调用它
• 必须是 static：不依赖实例就能启动
• 参数名可以不是 args，但类型必须是 String[]（或 String...）
• 返回类型必须是 void；返回 int 不会被识别为入口

项目结构用 Maven 标准布局最省事

不用手动管理 classpath 或 jar 依赖，Maven 默认结构让编译、打包、运行一气呵成。

• src/main/java/ 放所有源码，比如 com.example.cli.CliApp
• src/main/resources/ 放配置文件、提示文案等非代码资源
• pom.xml 里加 maven-jar-plugin 并配置 Main-Class，才能用 java -jar xxx.jar 直接运行
• 如果跳过 Maven，手写 javac 和 java -cp 容易漏掉依赖路径，尤其用了 Apache Commons CLI 这类库时

解析命令行参数别硬写 if-else，用 Commons CLI 更可靠

自己用 args 数组做字符串切分，很快会遇到空格、引号、短选项连写（如 -abc）、长选项带值（--output=file.txt）等边界问题。

• 引入 commons-cli 依赖后，用 Options + DefaultParser + CommandLine 三步就搞定解析
• 支持自动打印帮助（parser.printHelp(...)），还能校验必填项、类型转换（如把 --port=8080 转成 int）
• 注意：DefaultParser 不处理 -- 之后的非选项参数，要透传给业务逻辑时得手动截取 cmd.getArgList()

退出状态码要用 System.exit(int) 显式控制

Java 程序默认成功退出是 0，但没显式调用 System.exit(1) 的异常崩溃，可能返回随机负数（如 -1 或 -6），导致 shell 脚本里 if [ $? -eq 1 ] 判断失效。

• 正常结束：不用写 System.exit(0)，main 返回即隐式成功
• 错误退出：捕获异常后，统一用 System.exit(1)（或按 POSIX 习惯，1–125 表示错误，126+ 留给系统保留）
• 避免在 finally 块里调用 System.exit，否则 try 中的 return 会被忽略
• 单元测试里不要真调 System.exit，可用 SecurityManager 拦截或改用 SystemExitSecurityManager 类模拟

命令行工具看似简单，但参数解析的健壮性、退出码语义、资源路径加载这些点，一旦在 CI 或 Docker 容器里出问题，排查起来比 Web 应用还隐蔽。

以上就是《Java命令行工具开发指南》的详细内容，更多关于的资料请关注golang学习网公众号！