Przeanalizuj opcje wiersza poleceń w Groovy
Dowiedz się, jak dodawać opcje do aplikacji Groovy.
Niedawny artykuł zawiera wprowadzenie do analizowania opcji wiersza poleceń w Javie. Ponieważ naprawdę lubię Groovy i ponieważ Groovy dobrze nadaje się do pisania skryptów, a także dlatego, że porównywanie rozwiązań Java i Groovy jest fajne, zdecydowałem się sparafrazować artykuł Setha, ale używając Groovy.
Zainstaluj Groovy'ego
Groovy jest oparty na Javie, więc wymaga instalacji Java. Zarówno najnowsza, jak i przyzwoita wersja Java i Groovy mogą znajdować się w repozytoriach Twojej dystrybucji Linuksa. Alternatywnie możesz zainstalować Groovy, postępując zgodnie z instrukcjami na stronie groovy-lang.org.
Dobrą alternatywą dla użytkowników Linuksa jest SDKMan, którego można użyć do uzyskania wielu wersji Java, Groovy i wielu innych powiązanych narzędzi. W tym artykule używam wersji OpenJDK11 mojej dystrybucji i najnowszej wersji Groovy SDKMan.
Analizowanie opcji wiersza poleceń w Groovy
Kiedy tworzymy skrypt — rodzaj krótkiego, często nieformalnego programu — do uruchomienia z wiersza poleceń, zwykle kierujemy się praktyką przekazywania argumentów do skryptu w wierszu poleceń. Dobrym tego przykładem jest polecenie ls, używane do wyświetlenia listy wszystkich plików i podfolderów w danym folderze, być może pokazując atrybuty i posortowane w odwrotnej kolejności od daty ostatniej modyfikacji, jak w:
$ ls -lt /home/me
Aby wyświetlić zawartość mojego folderu domowego w następujący sposób:
total 252
drwxr-xr-x 5 me me 4096 Aug 10 12:23 Downloads
drwx------ 11 me me 4096 Aug 10 08:59 Dropbox
drwxr-xr-x 27 me me 12288 Aug 9 11:58 Pictures
-rw-rw-r-- 1 me me 235 Jul 28 16:22 wb.groovy
drwxr-xr-x 2 me me 4096 Jul 20 22:04 Desktop
drwxrwxr-x 2 me me 4096 Jul 20 15:16 Fixed
drwxr-xr-x 2 me me 16384 Jul 19 08:49 Music
-rw-rw-r-- 1 me me 433 Jul 7 13:24 foo
drwxr-xr-x 6 me me 4096 Jun 29 10:25 Documents
drwxr-xr-x 2 me me 4096 Jun 14 22:15 Templates
-rw-rw-r-- 1 me me 803 Jun 14 11:33 barOczywiście argumenty poleceń można rozwiązać, sprawdzając je i decydując, co zrobić w każdym przypadku; ale kończy się to powielaniem wysiłków, którego można uniknąć, korzystając z biblioteki zaprojektowanej do tego celu.
Artykuł Setha w języku Java przedstawia bibliotekę Apache Commons CLI, świetne API do obsługi opcji wiersza poleceń. W rzeczywistości ta biblioteka jest tak wspaniała, że dobrzy ludzie, którzy opracowują Groovy, udostępniają ją domyślnie w instalacji Groovy. Dlatego po zainstalowaniu Groovy będziesz mieć dostęp do tej biblioteki poprzez groovy.cli.picocli.CliBuilder, który jest już domyślnie zaimportowany.
Oto skrypt Groovy, który wykorzystuje ten kreator CLI, aby osiągnąć takie same wyniki, jak program Java Setha:
1 def cli = new CliBuilder(usage: 'ho.groovy [-a] -c')
2 cli.with {
3 a longOpt: 'alpha', 'Activate feature alpha'
4 c longOpt: 'config', args:1, argName: 'config', required: true, 'Set config file'
5 }
6 def options = cli.parse(args)
7 if (!options) {
8 return
9 }
10 if (options.a) {
11 println' Alpha activated'
12 }
13 if (options.c) {
14 println "Config set to ${options.c}"
15 }Aby ułatwić dyskusję, podałem tutaj numery wierszy. Zapisz ten skrypt bez numerów linii w pliku o nazwie ho.groovy.
W linii 1 definiujemy zmienną cli i ustawiamy ją na nową instancję CliBuilder ze zdefiniowanym atrybutem usage. Jest to ciąg znaków, który zostanie wydrukowany po wywołaniu metody usage().
W liniach 2-5 używamy metody with(), którą Groovy dodaje do obiektów wraz z DSL zdefiniowanym przez CliBuilder, aby skonfigurować definicje opcji.
W linii 3 definiujemy opcję „a”, ustawiając jej pole longOpt na „alfa” i opis na „Aktywuj funkcja alfa”.
Podobnie w linii 4 definiujemy opcję „c”, ustawiając jej pole longOpt na „config” i określając, że ta opcja przyjmuje jedną argument o nazwie „config”. Co więcej, jest to opcja wymagana (wiem, brzmi zabawnie), a jej opis to „Ustaw plik konfiguracyjny”.
Zatrzymaj się tutaj na chwilę, aby zapoznać się z tłem. Możesz przeczytać wszystko o tych różnych opcjach, korzystając z linku CliBuilder powyżej. Mówiąc bardziej ogólnie, rzeczy zapisane w formie longOpt: „alpha” to notacja Groovy dla wpisów klucz-wartość, które należy umieścić w instancji Map, o czym możesz przeczytać tutaj. W tym przypadku każdy klucz odpowiada metodzie o tej samej nazwie dostarczonej przez CliBuilder. Jeśli zastanawiasz się, co się dzieje z linią taką jak:
a longOpt: 'alpha', 'Activate feature alpha'
wtedy warto wspomnieć, że Groovy pozwala nam w pewnych okolicznościach pominąć nawiasy; więc powyższe jest równoważne:
a(longOpt: 'alpha', 'Activate feature alpha')tj. jest to wywołanie metody. Co więcej, Groovy umożliwia zarówno parametry pozycyjne, jak i nazwane, przy czym ten ostatni używa tego klucza: składni wartości.
Naprzód! W liniach 6-9 wywołujemy metodę parse() instancji CliBuilder cli, przekazując args— >tablica wartości String utworzona przez środowisko wykonawcze Groovy i zawierająca argumenty z wiersza poleceń. Ta metoda zwraca Mapę opcji, gdzie klucze są skrótami predefiniowanych opcji — w tym przypadku „a” i „c”. Jeśli parsowanie nie powiedzie się, funkcja parse() wygeneruje komunikat użycie, rozsądny komunikat o błędzie, i zwróci wartość null, więc nie musimy używać funkcji try- catch block (którego nie widuje się tak często w Groovy). Zatem tutaj – wiersz 8 – po prostu wracamy, ponieważ cała nasza praca została wykonana za nas.
W liniach 10-12 sprawdzamy, czy w wierszu poleceń została uwzględniona opcja „a” i jeśli tak, wypisujemy odpowiedni komunikat.
Podobnie w liniach 13-15 sprawdzamy, czy w linii poleceń została uwzględniona opcja 'c' i jeśli tak, wypisujemy komunikat zawierający podany argument.
Uruchomienie polecenia
Uruchommy skrypt kilka razy; najpierw bez argumentów:
$ groovy ho.groovy
error: Missing required option: c
usage: ho.groovy [-a] -c
-a,--alpha Activate feature alpha
-c,--config <config> Set config file
$Zwróć uwagę na skargę dotyczącą braku wymaganej opcji „c”.
Następnie z opcją „c”, ale bez argumentu:
$ groovy ho.groovy -c
error: Missing argument for option: c
usage: ho.groovy [-a] -c
-a,--alpha
Activate feature alpha
-c,--config <config> Set config file
$Świetnie, metoda instancji CliBuilder parse() zauważyła, że do „c” nie podano żadnego argumentu.
Na koniec spróbujmy obu opcji i argumentu „c” w ich długiej formie:
$ groovy ho.groovy --alpha --config bar
Alpha activated
Config set to bar
$
Wygląda dobrze!
Ponieważ ideą opcji „c” jest udostępnienie pliku konfiguracyjnego, moglibyśmy również poinformować instancję CliBuilder, że typem tego argumentu jest Plik, a funkcja zwróci to zamiast ciągu. Ale zostawmy to na inny dzień.
A więc gotowe — parsowanie opcji wiersza poleceń w Groovy.
Świetne zasoby
Witryna Groovy zawiera wiele świetnej dokumentacji. Kolejnym świetnym źródłem Groovy jest Mr. Haki, a konkretnie ten piękny artykuł na temat CliBuilder.
Kolejnym doskonałym powodem, aby nauczyć się Groovy, jest Grails, cudownie produktywna platforma internetowa z pełnym stosem, zbudowana na doskonałych komponentach, takich jak Hibernate, Spring Boot i Micronaut.