Poprawne analizowanie zmiennych i cytowanie w Bash
Nieprawidłowe cytowanie w oryginalnym kodzie źródłowym może łatwo prowadzić do błędów, gdy dane wejściowe dostarczone przez użytkowników nie są zgodne z oczekiwaniami lub niejednolite. Z biegiem czasu, gdy skrypty Bash ulegają zmianie, nieprzewidziany efekt uboczny niepoprawnie cytowanej zmiennej może prowadzić do błędu nawet w nienaruszonym kodzie. Jest to jeszcze ważniejsze w przypadku aplikacji związanych z bezpieczeństwem, które mogą być podatne na próby włamań. Dowiedz się, jak prawidłowo cytować i analizować/walidować zmienne od samego początku i unikać wielu z tych problemów! Zacznijmy…
W tej serii samouczków dowiesz się:
Jak poprawnie cytować zmienne Bash
Zastrzeżenia i skutki nieprawidłowego cytowania
Jak zapewnić, że wartości zmiennych są takie, jakie powinny być
-
Jak sprawdzić wartości zmiennych pustych, liczbowych i tekstowych
Poprawne analizowanie zmiennych i cytowanie w Bash
Wymagania dotyczące oprogramowania i stosowane konwencje
Przykład 1: Zacytuj te zmienne!
O ile nie pracujesz z wartościami liczbowymi, a nawet w takim przypadku, mądrze jest zawsze cytować zmienne tekstowe podczas sprawdzania równości itp. Spójrzmy na przykład:
$ VAR1="a"; if [ ${VAR1} == "a" ]; then echo 'Yes!'; fi
Yes!
$ VAR1=; if [ ${VAR1} == "a" ]; then echo 'Yes!'; fi
bash: [: ==: unary operator expected
Najpierw ustawiamy VAR1 na wartość a, a następnie sprawdzamy, czy VAR1 równa się a. To zadziałało i możemy uznać, że nasz kod jest w porządku i pozostawić go w skrypcie bez zmian. Jednak jakiś czas później i po wielu zmianach w kodzie zaczynamy widzieć bash: [: ==: oczekiwano operatora jednoargumentowego – nieco tajemniczy komunikat informujący nas, że coś jest nie tak z naszym kodem.
Powód pokazano w drugim przykładzie. Jeśli w jakiś sposób nasza zmienna jest pusta, tj. nie została poprawnie ustawiona (lub została wymazana od czasu ustawienia), wówczas wyświetli się błąd, gdy Bash skutecznie to odczyta; if [ == "a" ], które jest instrukcją, która nie ma większego sensu i której nie można obliczyć.
Gdybyśmy poprawnie zacytowali naszą zmienną w cudzysłowie ("), nie doszłoby do takiej sytuacji:
$ VAR1=; if [ "${VAR1}" == "a" ]; then echo 'Yes!'; fi
$
Tym razem Bash odczytał tę instrukcję jako if [ "" == "a" ] – instrukcję łatwiejszą zarówno dla oczu, jak i dla kompilatora Bash. Żadne dane wyjściowe nie są generowane, ponieważ pusty ciąg znaków nie jest równy literze a.
Przykład 2: Cytując nieco dalej
Po pewnym czasie pracy z Bashem nauczysz się niektórych idiomów językowych. Jednym z takich idiomów jest – nazwijmy to przywilej (a to na pewno wygoda!) – możliwość cytowania zmiennych numerycznych, nawet jeśli wykonywana jest operacja numeryczna:
$ VAR1=13; if [ "${VAR1}" -eq 13 ]; then echo 'Yes!'; fi
Yes!
$ VAR1=7; if [ "${VAR1}" -eq 13 ]; then echo 'Yes!'; fi
Nawet jeśli VAR1 jest ustawiony na wartość liczbową, Bash zaakceptuje cytowanie " wokół VAR1 i poprawnie wygeneruje wynik instrukcji if przy użyciu is valid (tzn. -eq) operacja porównania.
Jednak nie osiągnęliśmy jeszcze pełnego koła, ponieważ następujące elementy nadal się nie sprawdzają;
$ VAR1=; if [ "${VAR1}" -eq 13 ]; then echo 'Yes!'; fi
bash: [: : integer expression expected
Tym razem oczekiwane jest wyrażenie całkowite, ale przekazana została pusta zmienna (tj. przekazano ""), która z pewnością nie jest liczbowa. Czy istnieje sposób, aby to naprawić? Jasne:
Przykład 3: Sprawdzanie długości zerowej
$ VAR1=; if [ -n "${VAR1}" ]; then if [ "${VAR1}" -eq 13 ]; then echo 'Yes!'; fi; fi
$ VAR1=13; if [ -n "${VAR1}" ]; then if [ "${VAR1}" -eq 13 ]; then echo 'Yes!'; fi; fi
Yes!
Tutaj dokonujemy wstępnego sprawdzenia, czy zmienna nie ma długości zero, używając instrukcji warunkowej -n, co oznacza, że ciąg nie ma długości zero. Można to również zamienić na odwrotność, używając ! -z gdzie -z oznacza, że łańcuch ma długość zero, a ! neguje to samo, tj. odwraca wynik:
$ VAR1=; if [ ! -z "${VAR1}" ]; then if [ "${VAR1}" -eq 13 ]; then echo 'Yes!'; fi; fi
$ VAR1=13; if [ ! -z "${VAR1}" ]; then if [ "${VAR1}" -eq 13 ]; then echo 'Yes!'; fi; fi
Yes!
$ VAR1=7; if [ ! -z "${VAR1}" ]; then if [ "${VAR1}" -eq 13 ]; then echo 'Yes!'; fi; fi
$
Dodaliśmy tutaj także przykład =7, aby pokazać, jak poprawnie działa instrukcja if. Zawsze testuj instrukcje i warunki if w różnych sytuacjach, przypadkach użycia i ogólnych wyjątkach (złe wartości, brak wartości, wartości nieparzyste itp.), jeśli chcesz mieć pewność, że Twój kod będzie bezpłatny błędów.
Przykład 4: Prawie całkowita kontrola
W ostatnim przykładzie nadal występuje niedociągnięcie. Podniosłeś to? Zasadniczo, jeśli przekażemy wartości tekstowe do ciągu znaków lub instrukcja if nadal nie powiedzie się:
$ VAR1='a'; if [ ! -z "${VAR1}" ]; then if [ "${VAR1}" -eq 13 ]; then echo 'Yes!'; fi; fi
bash: [: a: integer expression expected
Można temu zaradzić, używając podpowłoki, grep i niektórych wyrażeń regularnych. Aby uzyskać więcej informacji na temat wyrażeń regularnych, zobacz nasze artykuły dotyczące wyrażeń regularnych Bash dla początkujących z przykładami oraz zaawansowane artykuły dotyczące wyrażeń regularnych Bash z przykładami. Aby uzyskać więcej informacji na temat podpowłok Bash, zobacz nasze artykuły dotyczące podpowłok systemu Linux dla początkujących z przykładami i zaawansowanych powłok podpowłok systemu Linux z przykładami.
Składnia nie jest zbyt skomplikowana:
$ VAR1=7; if [ "$(echo "${VAR1}" | grep -o '[0-9]\+')" == "${VAR1}" ]; then if [ "${VAR1}" -eq 13 ]; then echo 'Yes!'; fi; fi
$ VAR1=13; if [ "$(echo "${VAR1}" | grep -o '[0-9]\+')" == "${VAR1}" ]; then if [ "${VAR1}" -eq 13 ]; then echo 'Yes!'; fi; fi
Yes!
$ VAR1='a'; if [ "$(echo "${VAR1}" | grep -o '[0-9]\+')" == "${VAR1}" ]; then if [ "${VAR1}" -eq 13 ]; then echo 'Yes!'; fi; fi
$
Świetnie. Tutaj sprawdzamy, czy zawartość VAR1 jest numeryczna, używając grep -o (tylko grep; tj. grep tylko część dopasowana przez wyszukiwany ciąg, czyli w tym przypadku wyrażenie regularne). Wybieramy dowolny znak liczby z zakresu 0-9 i jeden lub więcej razy (jak wskazuje kwalifikator \+ do [ 0-9] zakres wyboru). Następnie próbujemy dopasować ten tekst tylko dopasowana część grep do oryginalnej zmiennej. Czy to samo? Jeśli tak, to nasza zmienna składa się wyłącznie z liczb.
Kiedy rozszerzymy nieco naszą zewnętrzną instrukcję if, tak aby zawierała klauzulę else, która poinformuje nas, czy zmienna nie jest numeryczna, oraz kiedy spróbujemy przekazać ' a' jako dane wejściowe widzimy, że różne dane wejściowe są poprawnie analizowane;
$ VAR1=7; if [ "$(echo "${VAR1}" | grep -o '[0-9]\+')" == "${VAR1}" ]; then if [ "${VAR1}" -eq 13 ]; then echo 'Yes!'; fi; else echo 'Variable not numeric!'; fi
$ VAR1=13; if [ "$(echo "${VAR1}" | grep -o '[0-9]\+')" == "${VAR1}" ]; then if [ "${VAR1}" -eq 13 ]; then echo 'Yes!'; fi; else echo 'Variable not numeric!'; fi
Yes!
$ VAR1='a'; if [ "$(echo "${VAR1}" | grep -o '[0-9]\+')" == "${VAR1}" ]; then if [ "${VAR1}" -eq 13 ]; then echo 'Yes!'; fi; else echo 'Variable not numeric!'; fi
Variable not numeric!
Więc teraz mamy idealną linię dla naszego kodu, prawda? Nie… Wciąż czegoś nam brakuje… Widzisz co?
Przykład 5: Pełna kontrola
Czy widziałeś problem? Nie sprawdziliśmy jeszcze, czy zmienna jest pusta!
$ VAR1=''; if [ "$(echo "${VAR1}" | grep -o '[0-9]\+')" == "${VAR1}" ]; then if [ "${VAR1}" -eq 13 ]; then echo 'Yes!'; fi; else echo 'Variable not numeric!'; fi
bash: [: : integer expression expected
Auć. Mam nadzieję, że już rozumiesz, dlaczego regularnie wspominam w moich artykułach, aby zawsze w taki czy inny sposób sprawdzać tworzone przez siebie kody. Jasne, Bash umożliwia szybkie i łatwe pisanie skryptów, ale jeśli chcesz mieć pewność, że wszystko będzie działać poprawnie po zmianie skryptów lub dodaniu dodatkowego kodu, będziesz chciał się upewnić, że Twoje testy, dane wejściowe i wyjściowe są czyste i jasno zdefiniowane . Rozwiązanie jest łatwe:
$ VAR1=''; if [ ! -z "${VAR1}" -a "$(echo "${VAR1}" | grep -o '[0-9]\+')" == "${VAR1}" ]; then if [ "${VAR1}" -eq 13 ]; then echo 'Yes!'; fi; else echo 'Variable not numeric!'; fi
Variable not numeric!
Tutaj, używając pierwszej instrukcji if, dodajemy dodatkowy warunek dla zmiennej VAR1, aby (!) nie była zmienną o zerowej długości. Działa to dobrze, biorąc pod uwagę bieżącą konfigurację, ponieważ druga część pierwszej instrukcji if może nadal działać niezależnie od zawartości VAR1.
Wniosek
W tym artykule przyjrzeliśmy się, jak poprawnie cytować i analizować/oceniać zmienne, a także sprawdziliśmy, jak skomplikowane było napisanie idealnego fragmentu kodu Bash do sprawdzania zmiennych. Nauczenie się, jak robić te rzeczy poprawnie od samego początku, znacznie ograniczy liczbę możliwych błędów, które mogą zostać wprowadzone przez przypadek.
Ciesz się i cytuj podwójnie te zmienne! 🙂
