Java利用Picocli開發(fā)一個簡化命令行工具
1、簡述
Picocli 是一個強(qiáng)大、易用且功能豐富的 Java 庫，用于開發(fā)命令行工具。它支持多級子命令、類型安全的參數(shù)解析和自動生成幫助信息，同時(shí)具有較低的學(xué)習(xí)曲線，是現(xiàn)代 CLI 應(yīng)用開發(fā)的理想選擇。
2、為什么選擇 Picocli
簡單易用：通過注解定義參數(shù)，減少手動解析邏輯。
強(qiáng)大功能：支持多種參數(shù)類型、子命令和多線程執(zhí)行。
自動化：內(nèi)置幫助信息和自動補(bǔ)全功能。
活躍社區(qū)：有詳細(xì)的文檔和大量實(shí)踐案例。
Picocli 的核心功能：
- 命令行參數(shù)解析：支持選項(xiàng)、位置參數(shù)、標(biāo)志。
- 多級子命令：輕松實(shí)現(xiàn)復(fù)雜的命令行結(jié)構(gòu)。
- 自動生成幫助信息：無需手動編寫幫助文檔。
- 多線程支持：通過 @CommandLine.Command 中的 ExecutionStrategy 輕松實(shí)現(xiàn)并發(fā)任務(wù)。
3、實(shí)踐樣例
以下是一個實(shí)踐案例，展示如何使用 Picocli 開發(fā) CLI 工具，構(gòu)建一個簡單的文件操作命令行工具：
3.1 添加依賴
在 Maven 項(xiàng)目中添加 Picocli 的依賴：
<dependency>
<groupId>info.picocli</groupId>
<artifactId>picocli</artifactId>
<version>4.7.4</version>
</dependency>
3.2 構(gòu)建一個基本命令
下面創(chuàng)建一個簡單的命令，支持對文件進(jìn)行讀取和統(tǒng)計(jì)操作。
import picocli.CommandLine;
import picocli.CommandLine.Command;
import picocli.CommandLine.Option;
import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Paths;
import java.util.concurrent.Callable;
@Command(name = "filetool", version = "FileTool 1.0",
description = "一個用于文件操作的命令行工具",
mixinStandardHelpOptions = true)
public class FileTool implements Callable<Integer> {
@Option(names = {"-p", "--path"}, description = "文件路徑", required = true)
private String filePath;
@Option(names = {"-c", "--count-lines"}, description = "統(tǒng)計(jì)文件行數(shù)")
private boolean countLines;
@Option(names = {"-r", "--read-content"}, description = "讀取并輸出文件內(nèi)容")
private boolean readContent;
@Override
public Integer call() throws Exception {
if (countLines) {
long lineCount = Files.lines(Paths.get(filePath)).count();
System.out.println("文件行數(shù): " + lineCount);
}
if (readContent) {
String content = new String(Files.readAllBytes(Paths.get(filePath)));
System.out.println("文件內(nèi)容:\n" + content);
}
return 0;
}
public static void main(String[] args) {
int exitCode = new CommandLine(new FileTool()).execute(args);
System.exit(exitCode);
}
}
3.3 使用說明
編譯并運(yùn)行程序后，可以通過以下方式使用該工具：
查看幫助信息：
java -jar filetool.jar --help
輸出示例：
用法: filetool [-hV] [-c] [-r] -p=<filePath>
一個用于文件操作的命令行工具
-c, --count-lines 統(tǒng)計(jì)文件行數(shù)
-h, --help 顯示幫助信息
-p, --path=<filePath> 文件路徑
-r, --read-content 讀取并輸出文件內(nèi)容
-V, --version 打印版本信息
統(tǒng)計(jì)文件行數(shù)：
java -jar filetool.jar -p sample.txt -c
輸出示例：
文件行數(shù): 10
讀取文件內(nèi)容：
java -jar filetool.jar -p sample.txt -r
輸出示例：
文件內(nèi)容:
Hello World!
This is a test file.
4、高級功能示例
Picocli 支持子命令，可以用于實(shí)現(xiàn)復(fù)雜的 CLI 工具。以下是一個示例，構(gòu)建一個多功能工具，包含子命令 read 和 count：
@Command(name = "filetool", description = "文件工具", mixinStandardHelpOptions = true, subcommands = {
FileReadCommand.class,
FileCountCommand.class
})
public class FileTool {
public static void main(String[] args) {
int exitCode = new CommandLine(new FileTool()).execute(args);
System.exit(exitCode);
}
}
@Command(name = "read", description = "讀取文件內(nèi)容")
class FileReadCommand implements Callable<Integer> {
@Option(names = {"-p", "--path"}, description = "文件路徑", required = true)
private String filePath;
@Override
public Integer call() throws Exception {
String content = new String(Files.readAllBytes(Paths.get(filePath)));
System.out.println("文件內(nèi)容:\n" + content);
return 0;
}
}
@Command(name = "count", description = "統(tǒng)計(jì)文件行數(shù)")
class FileCountCommand implements Callable<Integer> {
@Option(names = {"-p", "--path"}, description = "文件路徑", required = true)
private String filePath;
@Override
public Integer call() throws Exception {
long lineCount = Files.lines(Paths.get(filePath)).count();
System.out.println("文件行數(shù): " + lineCount);
return 0;
}
}
運(yùn)行示例：
查看幫助信息：
java -jar filetool.jar --help
使用子命令 read：
java -jar filetool.jar read -p sample.txt
使用子命令 count：
java -jar filetool.jar count -p sample.txt
5、總結(jié)
Picocli 是一個現(xiàn)代化的 Java 命令行工具開發(fā)庫，通過簡單的注解和直觀的 API 提供強(qiáng)大的功能。無論是實(shí)現(xiàn)單一命令，還是構(gòu)建多級子命令的復(fù)雜工具，Picocli 都能快速滿足需求。
推薦的使用場景：
開發(fā)運(yùn)維工具：如文件管理工具、數(shù)據(jù)處理工具。
數(shù)據(jù)分析腳本：支持多線程處理。
多子命令的框架型 CLI 工具。
到此這篇關(guān)于Java利用Picocli開發(fā)一個簡化命令行工具的文章就介紹到這了,更多相關(guān)Java Picocli簡化命令行內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！
相關(guān)文章
Springboot @Transactional使用時(shí)需注意的幾個問題記錄
本文詳細(xì)介紹了Spring Boot中使用`@Transactional`注解進(jìn)行事務(wù)管理的多個方面,包括事務(wù)的隔離級別（如REPEATABLE_READ）和傳播行為（如REQUIRES_NEW）,并指出了在同一個類中調(diào)用事務(wù)方法時(shí)可能遇到的問題以及解決方案,感興趣的朋友跟隨小編一起看看吧2025-01-01
Java動態(tài)獲取實(shí)現(xiàn)類的方式詳解
這篇文章主要介紹了Java動態(tài)獲取實(shí)現(xiàn)類的方式詳解,文中通過示例代碼介紹的非常詳細(xì),對大家的學(xué)習(xí)或工作有一定的參考價(jià)值,需要的朋友們下面隨著小編來一起學(xué)習(xí)吧2024-01-01
IDEA 項(xiàng)目創(chuàng)建Mapper的xml文件的方法
這篇文章主要介紹了IDEA 項(xiàng)目創(chuàng)建Mapper的xml文件的方法，本文給大家介紹的非常詳細(xì)，對大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2020-11-11
Spring Boot MyBatis 操作數(shù)據(jù)庫的實(shí)戰(zhàn)指南
本文詳細(xì)介紹了SpringBoot環(huán)境下MyBatis的集成與應(yīng)用,從傳統(tǒng)JDBC的局限性出發(fā),展示了MyBatis的日志配置、CRUD操作、自增主鍵返回、多表查詢等功能,感興趣的朋友跟隨小編一起看看吧2026-05-05
java寫卷積神經(jīng)網(wǎng)絡(luò)(CupCnn簡介)
這篇文章主要介紹了java寫卷積神經(jīng)網(wǎng)絡(luò)(CupCnn簡介)，小編覺得挺不錯的，現(xiàn)在分享給大家，也給大家做個參考。一起跟隨小編過來看看吧2018-04-04
這篇文章主要介紹了使用SpringSecurity處理CSRF攻擊的方法步驟，小編覺得挺不錯的，現(xiàn)在分享給大家，也給大家做個參考。一起跟隨小編過來看看吧2019-03-03
這篇文章主要介紹了Java基礎(chǔ)之方法重寫詳解,文中有非常詳細(xì)的代碼示例,對正在學(xué)習(xí)java的小伙伴們有非常好的幫助,需要的朋友可以參考下2021-05-05
Java中各類日期和時(shí)間轉(zhuǎn)換超詳析總結(jié)(Date和LocalDateTime相互轉(zhuǎn)換等)
這篇文章主要介紹了Java中日期和時(shí)間處理的幾個階段,包括java.util.Date、java.sql.Date、java.sql.Time、java.sql.Timestamp、java.util.Calendar和java.util.GregorianCalendar等類,文中通過代碼介紹的非常詳細(xì),需要的朋友可以參考下2025-01-01
這篇文章主要介紹了淺談Strut2如何對請求參數(shù)的封裝，具有一定借鑒價(jià)值,需要的朋友可以參考下2017-12-12
這篇文章主要介紹了Java的Object類九個方法技巧，Java的Object?類的完整路徑是java.lang.Object?，是所有類的父類編譯，下文相關(guān)資料,需要的朋友可以參考一下2022-04-04