快捷導(dǎo)航

Java命令行參數(shù)解析工具jcommander詳解

更新時(shí)間：2023年09月08日 11:26:30 作者：追風(fēng)的電腦桌_XPdvn

這篇文章主要為大家介紹了Java命令行參數(shù)解析工具jcommander命令詳解，有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步,早日升職加薪

前言

如果你想構(gòu)建一個(gè)支持命令行參數(shù)的程序，那么 jcommander 非常適合你，jcommander 是一個(gè)只有幾十 kb 的 Java 命令行參數(shù)解析工具，可以通過注解的方式快速實(shí)現(xiàn)命令行參數(shù)解析。這篇教程會(huì)通過介紹 jcommadner ，快速的創(chuàng)建一個(gè)命令行程序，最后支持的命令參數(shù)功能如下圖。

這個(gè)命令行工具仿照 git 操作命令，主要提供了如下功能命令：git-app.jar -help 查看命令幫助信息。git-app.jar -version 查看當(dāng)前版本號。git-app.jar clone http://xxxx 通過 URL 克隆一個(gè)倉庫。git-app.jar add file1 file2 暫存 file1 文件 file2 文件。git-app.jar commit -m "注釋" 提交并添加注釋。

jcommander 引入截止文章編寫時(shí)間，最新版本如下：
<dependency>

<groupId>com.beust</groupId>
<artifactId>jcommander</artifactId>
<version>1.82</version>

</dependency>
這個(gè)命令行工具仿照 git 操作命令，主要提供了如下功能命令：

git-app.jar -help 查看命令幫助信息。
git-app.jar -version 查看當(dāng)前版本號。
git-app.jar clone http://xxxx 通過 URL 克隆一個(gè)倉庫。
git-app.jar add file1 file2 暫存 file1 文件 file2 文件。
git-app.jar commit -m "注釋" 提交并添加注釋。

jcommander 引入

截止文章編寫時(shí)間，最新版本如下：

<!-- https://mvnrepository.com/artifact/com.beust/jcommander -->
<dependency>
    <groupId>com.beust</groupId>
    <artifactId>jcommander</artifactId>
    <version>1.82</version>
</dependency>

commander 參數(shù)綁定

命令行解析中，參數(shù)解析與綁定是最實(shí)用的一個(gè)場景，jcommander 使用 Parameter 注解進(jìn)行參數(shù)綁定。我們定義一個(gè) GitCommandOptions.java 類來測試參數(shù)綁定。

package com.wdbyte.jcommander.v1;
    import com.beust.jcommander.Parameter;
    /**
     * @author https://www.wdbyte.com
     */
    public class GitCommandOptions {
        @Parameter(names = {"clone"},
            description = "克隆遠(yuǎn)程倉庫數(shù)據(jù)")
        private String cloneUrl;
        public String getCloneUrl() {
            return cloneUrl;
        }
    }

使用 jcommander 結(jié)合 GitCommandOptions 來解析參數(shù)。

package com.wdbyte.jcommander.v1;
import com.beust.jcommander.JCommander;
/**
 * @author https://www.wdbyte.com
 */
public class GitApp {
    public static void main(String[] args) {
            // args = new String[]{"clone","http://www.wdbyte.com/test.git"};
        GitCommandOptions gitCommandOptions = new GitCommandOptions();
        JCommander commander = JCommander.newBuilder()
            .addObject(gitCommandOptions)
            .build();
        commander.parse(args);
        System.out.println("clone " + gitCommandOptions.getCloneUrl());
    }
}

打包后可以執(zhí)行命令參數(shù)：