streamalism.org

Ako sme práve videli, pre možnosti bez argumentov sa ich prítomnosť alebo neprítomnosť vždy hodnotí na a boolovský hodnotu.

Je však možné zaregistrovať možnosti, ktoré berú argumenty. Môžeme to urobiť jednoducho vyhlásením nášho poľa za iný typ. Pridajme a správa možnosť k nášmu spáchať príkaz:

@Option (names = {"-m", "--message"}) súkromná reťazcová správa; @Override public void run () {System.out.println ("Spúšťanie súborov v pracovnej oblasti, aké úžasné?"); if (message! = null) {System.out.println ("Správa o potvrdení je" + správa); }}

Nie je prekvapením, že keď je dané správa Táto možnosť zobrazí príkaz na konzole. Ďalej v článku sa budeme zaoberať tým, ktoré typy spracováva knižnica a ako zaobchádzať s inými typmi.

5.3. Možnosť s viacerými argumentmi

Ale teraz, čo keď chceme, aby náš príkaz prijímal viac správ, ako je to v skutočnosti git spáchať velenie? Žiaden strach, urobme z nášho poľa pole alebo a Zbierka, a sme dosť hotoví:

@Option (names = {"-m", "--message"}) súkromné ​​správy []; @Override public void run () {System.out.println ("Spúšťanie súborov v pracovnej oblasti, aké úžasné?"); if (messages! = null) {System.out.println ("Správa o potvrdení je"); pre (String message: messages) {System.out.println (správa); }}}

Teraz môžeme použiť správa možnosť viackrát:

potvrdiť -m "Moje potvrdenie je skvelé" -m "Moje potvrdenie je krásne"

Možno by sme však chceli dať možnosť iba raz a oddeliť rôzne parametre oddeľovačom regulárneho výrazu. Preto môžeme použiť rozdeliť parameter parametra @Možnosť anotácia:

@Option (names = {"-m", "--message"}, split = ",") súkromné ​​správy [];

Teraz môžeme prejsť -m „Môj záväzok je skvelý“, „Môj záväzok je krásny“ dosiahnuť rovnaký výsledok ako vyššie.

5.4. Požadovaná možnosť

Niekedy môžeme mať požadovanú možnosť. The požadovaný argument, ktorý je predvolene nastavený na nepravdivé, umožňuje nám to:

@ Voľba (names = {"-m", "--message"}, required = true) súkromné ​​správy [];

Teraz je nemožné zavolať spáchať príkaz bez zadania správa možnosť. Ak sa o to pokúsime, picocli vytlačí chybu:

Chýba požadovaná možnosť '--message =' Použitie: git commit -m = [-m =] ... -m, --message =

6. Správa pozičných parametrov

6.1. Zachyťte pozičné parametre

Teraz sa zamerajme na naše pridať príkaz, pretože to ešte nie je veľmi silné. Môžeme sa rozhodnúť iba pridať všetky súbory, ale čo keby sme chceli pridať konkrétne súbory?

Mohli by sme na to použiť inú možnosť, ale lepšou voľbou by tu bolo použitie pozičných parametrov. Naozaj, pozičné parametre sú určené na zachytenie argumentov príkazov, ktoré zaberajú konkrétne pozície a nie sú ani čiastkovými príkazmi, ani voľbami.

V našom príklade by nám to umožnilo robiť niečo ako:

pridať súbor1 súbor2

Na zachytenie pozičných parametrov využijeme @Parametre anotácia:

@Parameters súkromné ​​súbory zoznamu; @Override public void run () {if (allFiles) {System.out.println ("Pridanie všetkých súborov do pracovnej oblasti"); } if (súbory! = null) {files.forEach (cesta -> System.out.println ("Pridanie" + cesta + "do pracovnej oblasti")); }}

Teraz by náš príkaz z predchádzajúcej verzie vytlačil:

Pridanie súboru1 do pracovnej oblasti Pridanie súboru2 do pracovnej oblasti

6.2. Zachyťte podmnožinu polohových parametrov

Vďaka tomu je možné dosiahnuť jemnejšie podrobnosti o tom, ktoré pozičné parametre sa majú zachytiť index parameter anotácie. Index je založený na nule. Ak teda definujeme:

@Parameters (index = "2 .. *")

To by zachytilo argumenty, ktoré sa nezhodujú s možnosťami alebo čiastkovými príkazmi, od tretieho po koniec.

Index môže byť buď rozsah, alebo jedno číslo predstavujúce jednu pozíciu.

7. Slovo o prepočte typov

Ako sme už videli v tomto tutoriále, picocli niektoré konverzie typov zvláda sám. Napríklad mapuje viac hodnôt na polia alebo Zbierky, ale môže tiež mapovať argumenty na konkrétne typy, ako keď použijeme Cesta trieda pre pridať príkaz.

V skutočnosti picocli prichádza s hromadou vopred spracovaných typov. To znamená, že tieto typy môžeme použiť priamo bez toho, aby sme museli premýšľať o ich prevedení sami.

Možno však budeme musieť namapovať naše argumenty príkazov na iné typy, ako sú tie, ktoré sú už spracované. Našťastie pre nás, je to možné vďaka ITypeConverter rozhranie a CommandLine # registerConverter metóda, ktorá spája typ s prevodníkom.

Poďme si predstaviť, že chceme pridať konfigur čiastkový príkaz k nášmu git príkaz, ale nechceme, aby používatelia zmenili konfiguračný prvok, ktorý neexistuje. Takže sa rozhodneme tieto prvky namapovať na enum:

public enum ConfigElement {USERNAME ("user.name"), EMAIL ("user.email"); súkromná konečná hodnota reťazca; ConfigElement (hodnota reťazca) {this.value = hodnota; } public String value () {návratová hodnota; } public static ConfigElement from (String value) {return Arrays.stream (values ​​()) .filter (element -> element.value.equals (value)) .findFirst () .orElseThrow (() -> new IllegalArgumentException ("The argument "+ hodnota +" sa nezhoduje so žiadnym parametrom ConfigElement ")); }}

Navyše v našej novovytvorenej GitConfigCommand triedy, pridajme dva pozičné parametre:

@Parameters (index = "0") súkromný prvok ConfigElement; @Parameters (index = "1") súkromná hodnota reťazca; @Override public void run () {System.out.println ("Nastavenie" + element.value () + "na" + hodnotu); }

Týmto spôsobom zabezpečíme, že používatelia nebudú môcť meniť neexistujúce konfiguračné prvky.

Nakoniec musíme náš prevodník zaregistrovať. Krásne je, že ak používame Java 8 alebo vyššiu, nemusíme ani vytvárať triedu implementujúcu ITypeConverter rozhranie. Môžeme len odovzdať lambdu alebo odkaz na metódu k registerConverter () metóda:

CommandLine commandLine = nový CommandLine (nový GitCommand ()); commandLine.registerConverter (ConfigElement.class, ConfigElement :: from); commandLine.parseWithHandler (nový RunLast (), args);

To sa deje v GitCommand hlavný() metóda. Upozorňujeme, že sme museli pohodlie pustiť CommandLine.run () metóda.

Ak sa použije s nespracovaným konfiguračným prvkom, príkaz zobrazí pomocnú správu spolu s informáciami, ktoré nám hovoria, že nebolo možné previesť parameter na ConfigElement:

Neplatná hodnota pozičného parametra na indexe 0 (): nemožno konvertovať „user.phone“ na ConfigElement (java.lang.IllegalArgumentException: Argument user.phone sa nezhoduje so žiadnym ConfigElement) Použitie: git config 

8. Integrácia s Spring Boot

Na záver sa pozrime, ako to všetko vylepšiť!

V skutočnosti možno pracujeme v prostredí Spring Boot a chceme z toho ťažiť v našom programe príkazového riadku. Za týmto účelom musíme vytvoriť SpringBootApplicationimplementácia CommandLineRunner rozhranie:

@SpringBootApplication verejná trieda Aplikácia implementuje CommandLineRunner {public static void main (String [] args) {SpringApplication.run (Application.class, args); } @Override public void run (String ... args) {}}

Plus, poďme anotovať všetky naše príkazy a čiastkové príkazy pomocou pružiny @ Komponent anotácia a autowire to všetko v našom Aplikácia:

súkromný GitCommand gitCommand; súkromný GitAddCommand addCommand; súkromný GitCommitCommand commitCommand; súkromný GitConfigCommand configCommand; verejná aplikácia (GitCommand gitCommand, GitAddCommand addCommand, GitCommitCommand commitCommand, GitConfigCommand configCommand) {this.gitCommand = gitCommand; this.addCommand = addCommand; this.commitCommand = commitCommand; this.configCommand = configCommand; }

Upozorňujeme, že každý čiastkový príkaz sme museli autowire. Je to bohužiaľ preto, lebo nateraz picocli zatiaľ nie je schopný načítať čiastkové príkazy z jarného kontextu, keď je deklarovaný deklaratívne (s anotáciami). Preto si toto zapojenie budeme musieť urobiť sami, programovo:

@Override public void run (String ... args) {CommandLine commandLine = nový CommandLine (gitCommand); commandLine.addSubcommand ("add", addCommand); commandLine.addSubcommand ("commit", commitCommand); commandLine.addSubcommand ("config", configCommand); commandLine.parseWithHandler (nový CommandLine.RunLast (), args); }

A teraz náš program príkazového riadku funguje ako kúzlo s komponentami Spring. Preto by sme mohli vytvoriť niektoré triedy služieb a použiť ich v našich príkazoch a nechať Spring, aby sa postaral o vloženie závislosti.

9. Záver

V tomto článku sme videli niektoré kľúčové vlastnosti picocli knižnica. Naučili sme sa, ako vytvoriť nový príkaz a pridať k nemu niekoľko čiastkových príkazov. Už sme videli veľa spôsobov, ako sa vysporiadať s možnosťami a pozičnými parametrami. Navyše sme sa naučili, ako implementovať vlastné prevádzače typov, aby boli naše príkazy silne zadané. Konečne sme videli, ako vložiť Spring Boot do našich príkazov.

Existuje samozrejme veľa ďalších vecí, ktoré môžete objaviť. Knižnica poskytuje kompletnú dokumentáciu.

Celý kód tohto článku nájdete na našom serveri GitHub.