args4j 是一个用于解析命令行参数的 Java 库,它提供了简单而强大的方式来处理命令行参数。通过 args4j,你可以轻松地定义和解析命令行选项,并将其映射到 Java 对象的字段或方法参数上。
主要特性
- 简单易用:args4j 提供了简单直观的 API,使得定义和解析命令行参数变得非常容易。
- 基于注解:args4j 使用注解来定义命令行选项,使得代码清晰易读。
- 类型安全:args4j 提供了类型安全的解析器,可以确保命令行参数正确地转换为目标类型。
- 自动帮助信息生成:args4j 可以自动生成帮助信息,包括命令行选项的使用说明、默认值等。
- 支持属性文件配置:args4j 支持从属性文件中加载配置,使得参数的默认值可以从属性文件中读取。
- 国际化支持:args4j 支持国际化,可以轻松地为帮助信息和错误消息添加多语言支持。
主要类和注解
CmdLineParser
- 用于解析命令行参数的核心类。
- 构造方法接受一个包含
Option
注解的对象实例。
Option
注解- 用于定义命令行参数和选项。
- 可以附加到字段或方法上,指定参数的名称、用法说明、是否必需等属性。
CmdLineException
- 表示在解析命令行参数时发生的异常。
- 通常用于捕获并处理解析错误。
以下是Eclipse项目中手动添加args4j库解析命令行参数的操作过程和示例代码:
1. 新建Eclipse java项目
注: 不要选择 Create module-info.java file 选项
2. 在项目文件夹下建立libs文件夹,下载 args4j-2.33.jar文件到此文件夹。
https://mvnrepository.com/artifact/args4j/args4j
3. 将 JAR 文件添加到项目:
- 右键点击项目名称,选择
Build Path -> Configure Build Path
。 - 在打开的对话框中,选择
Libraries
标签页。 - 选择Classpath,点击
Add JARs...
,然后浏览并选择你下载的 JAR 文件。 - 点击
Apply and Close
以保存配置。
4. 建立 AragsParser.java 类 和 包含主函数的类Main.java
AragsParser.java 类
package test;
import org.kohsuke.args4j.Option;
import org.kohsuke.args4j.CmdLineException;
import org.kohsuke.args4j.CmdLineParser;
public class ArgsParser {
@Option(name="-input", usage="Input file")
private String inputFile;
@Option(name="-output", usage="Output file")
private String outputFile;
public ArgsParser() {};
public void parseArgs(String[] args) {
CmdLineParser parser = new CmdLineParser(this);
try {
// 解析命令行参数
parser.parseArgument(args);
// 在这里进行后续操作,使用解析得到的参数
// ...
} catch (CmdLineException e) {
System.err.println(e.getMessage());
System.err.println("java CommandLineParserExample [options...]");
parser.printUsage(System.err);
}
}
public String getInput() {
return this.inputFile;
}
public String getOutput() {
return this.outputFile;
}
}
Main.java类
package test;
public class Main {
public static void main(String[] args) {
ArgsParser parser = new ArgsParser();
parser.parseArgs(args);
System.out.println("Input file: " + parser.getInput());
System.out.println("Output file: " + parser.getOutput());
}
}
5. Eclipse中设置命令行参数:
- 在 Eclipse 中,选择你要运行的 Java 程序的项目。
- 然后点击菜单栏中的 "Run" -> "Run Configurations..."。
6. 运行项目
右键点击项目,选择 Run As
-> Java Application
。