DevOps-bootcamp · Oppitunti

Komentosarjojen parhaat käytännöt ja linting

Oppikaa koodauskäytännöistä, kommentoinnista ja ShellCheckin kaltaisten työkalujen käytöstä siistin, luettavan ja virheettömän Bash-koodin kirjoittamiseksi.

Oppitunti 3/411 vaihetta

Komentosarjojen parhaat käytännöt ja linting on ilmainen DevOps-bootcamp-oppitunti CoddyKitissä. Tämä on oppitunti 3/4. Voit lukea tästä oppimispolusta kokonaan mitkä tahansa 3 oppituntia ilmaiseksi — sen jälkeen CoddyKit PRO avaa kaikki oppitunnit sekä käytännön harjoittelun sisäänrakennetulla koodieditorilla ja ympäri vuorokauden toimivalla tekoälytuutorilla. Oppitunti kuuluu DevOps-bootcamp-oppimispolkuun, ja edistymisesi synkronoituu verkon ja CoddyKit-sovelluksen välillä. DevOps-bootcamp-kurssilla on yhteensä 4 oppituntia.

Miksi komentosarjojen parhaat käytännöt ovat tärkeitä?

Bash-komentosarjojen kirjoittaminen on tehokasta, mutta ilman hyviä käytäntöjä komentosarjoista voi tulla vaikeita ymmärtää, ylläpitää ja virheenkorjata.

Parhaat käytännöt ovat ohjeita, joiden avulla voitte kirjoittaa siistiä, toimintavarmaa ja luettavaa koodia. Ne tekevät komentosarjoistanne:

Helppolukuisempia: Sekä itsellenne että muille.
Helpommin ylläpidettäviä: Päivittäminen ja korjaaminen on yksinkertaisempaa.
Vähemmän virhealttiita: Yleiset virheet voidaan ehkäistä.
Sopivampia yhteistyöhön: Koodin ulkoasu ja toiminta yhdenmukaistuvat.

Selkeyttä kommenteilla

Kommentit ovat tärkeitä, koska ne selittävät, miksi koodi tekee jotakin, eivät vain sitä, mitä se tekee. Ne toimivat muistiinpanoina tulevalle itsellenne tai muille kehittäjille.

Käyttäkää kommentteja seuraaviin tarkoituksiin:

Kuvatkaa komentosarjan yleinen tarkoitus alussa.
Selittäkää monimutkainen logiikka tai hankalat osat.
Dokumentoikaa funktiot: niiden tarkoitus, argumentit ja paluuarvot.

Aloittakaa kommentti #-symbolilla (risumerkillä).

#!/bin/bash
# This script demonstrates commenting best practices.
# Author: CoddyKit
# Date: 2023-10-27

# Function: greet_user
# Description: Prints a greeting message to the console.
# Arguments:
#   $1 - The name of the user to greet.
greet_user() {
  local name="$1" # Store the first argument in a local variable.
  echo "Hello, ${name}!" # Output the greeting message.
}

# Main script execution starts here.
echo "Script execution started."
greet_user "CoddyKit Learner" # Call the function with a specific name.
echo "Script execution finished."

Selkeät nimeämiskäytännöt

Merkitykselliset nimet helpottavat komentosarjan seuraamista. Välttäkää yksikirjaimisia muuttujia, elleivät ne ole yleisiä silmukkalaskureita (kuten i tai j).

Yleisiä käytäntöjä:

Muuttujat: Käyttäkää kuvaavia nimiä (esimerkiksi user_name ja log_file). Käyttäkää ympäristömuuttujissa tai globaaleissa vakioissa UPPERCASE-muotoa. Käyttäkää paikallisissa komentosarjamuuttujissa lowercase_with_underscores-muotoa.
Funktiot: Käyttäkää lowercase_with_underscores-muotoa ja aloittakaa nimi usein verbillä (esimerkiksi process_data ja check_status).
Komentosarjat: Käyttäkää lowercase_with_hyphens-muotoa (esimerkiksi backup-script.sh).

Yhdenmukainen muotoilu ja sisennys

Yhdenmukainen muotoilu, kuten sisennykset ja välilyönnit, parantaa luettavuutta huomattavasti. Kuvitelkaa lukevanne kirjaa, jonka kappaleiden sisennykset vaihtelevat!

Keskeiset kohdat:

Käyttäkää sisennykseen 2 tai 4 välilyöntiä (sarkaimia ei yleensä suositella).
Pidättehän rivit lyhyinä (alle 80 merkkiä on hyvä nyrkkisääntö päätelaitteissa).
Erottakaa koodin loogiset osat toisistaan tyhjillä riveillä.
Tasaa toisiinsa liittyvät elementit, kun se on järkevää.

Yhdenmukaisuus on tärkeämpää kuin valitsemanne tietty tyyli.

Toimintavarmuus: 'set -u' (nounset)

set -u-vaihtoehto (tai set -o nounset) auttaa tehokkaasti ehkäisemään kirjoitusvirheiden tai vahingossa asettamatta jääneiden muuttujien aiheuttamia virheitä. Jos komentosarja yrittää käyttää muuttujaa, jolle ei ole määritetty arvoa, set -u lopettaa komentosarjan välittömästi ja ilmoittaa virheestä.

Tämä auttaa havaitsemaan virheet varhain ja ehkäisee odottamatonta toimintaa komentosarjan myöhemmissä vaiheissa.

Kokeilkaa alla olevan koodin suorittamista. Se on suunniteltu lopettamaan aikaisin, koska UNSET_NAME-muuttujaa ei ole määritetty.

#!/bin/bash
# Demonstrating 'set -u' (nounset)

set -u # Exit if an unset variable is used

MY_GREETING="Hello"
echo "${MY_GREETING}, CoddyKit!"

# This variable is NOT set. With 'set -u', the script will exit here.
echo "Your name is: ${UNSET_NAME}" 

echo "This line will NOT be reached if 'set -u' is active and UNSET_NAME is indeed unset."

Toimintavarmuus: 'set -o pipefail'

Kun putkitatte komentoja (esimerkiksi cmd1 | cmd2 | cmd3), Bash ilmoittaa normaalisti vain putken viimeisen komennon lopetustilan. Jos siis cmd1 epäonnistuu mutta cmd2 ja cmd3 onnistuvat, putki saattaa silti ilmoittaa onnistumisesta!

set -o pipefail muuttaa tätä toimintaa. Jos mikä tahansa putken komento epäonnistuu (palauttaa nollasta poikkeavan lopetustilan), koko putken lopetustilaksi tulee kyseinen nollasta poikkeava tila.

Tämä tekee putkista luotettavampia ilmoittamalla heti, jos jokin aikaisempi komento epäonnistui.

#!/bin/bash
# Demonstrating 'set -o pipefail'

set -o pipefail # Ensures pipe's exit status is the last non-zero command

echo "Running a failing command in a pipe:"
echo "---"

# 'false' command always fails (exit status 1).
# 'cat /dev/null' always succeeds (exit status 0).
# With 'set -o pipefail', the pipe's overall exit status will be 1 from 'false'.
false | cat /dev/null

# This line will only be reached if the pipe above succeeds.
echo "---"
echo "Script finished successfully (this line won't show if pipe failed with set -o pipefail)."

ShellCheckin esittely

Hyvistä käytännöistä huolimatta pieniä syntaksivirheitä tai yleisiä sudenkuoppia on helppo olla huomaamatta. Tässä ShellCheck auttaa!

ShellCheck on komentotulkkikomentosarjojen staattisen analyysin työkalu (”linter”). Se lukee komentosarjan ja ilmoittaa seuraavista:

Syntaksivirheet.
Yleiset aloittelijoiden virheet.
Hienovaraiset semanttiset ongelmat.
Eri komentotulkkien väliset siirrettävyysongelmat.

Se antaa hyödyllisiä ehdotuksia ja usein myös linkkejä yksityiskohtaisempiin selityksiin.

ShellCheck käytännössä: virheellinen komentosarja

Tarkastellaan komentosarjaa, jossa on muutamia yleisiä ongelmia. Ne eivät välttämättä kaada komentosarjaa heti, mutta ne ovat huonoja käytäntöjä tai mahdollisia virheitä.

Oletetaan, että tämä komentosarja on tallennettu nimellä bad_script.sh. Suorittaaksenne ShellCheckin sille kirjoittaisitte: shellcheck bad_script.sh

Yrittäkää havaita ongelmat ennen ShellCheckin suorittamista!

#!/bin/bash
# A script with some common issues

MY_NAME=coddykit # Variable assignment needs no space, but quoting is good for values
echo "Hello $MY_NAME!" # Missing quotes around variable expansion

if [ $1 = "admin" ]; then # Missing quotes around $1
  echo "Welcome, administrator."
fi

# A simple loop with potential issues
for file in *.txt; do # Unquoted glob could expand to multiple arguments
  echo File: $file # Missing quotes around $file
done

ShellCheck-varoitusten korjaaminen

ShellCheck tuottaisi esimerkiksi seuraavanlaisen tulosteen: SC2086: Double quotes missing around "$MY_NAME". Se antaa usein tietyn koodin (kuten SC2086), jonka avulla voit etsiä lisätietoja.

Tässä on edellinen komentosarja korjattuna ShellCheckin suositusten ja yleisten parhaiden käytäntöjen mukaisesti:

Huomaa muuttujien laajennusten ja komentojen korvausten ympärillä käytetyt lainausmerkit "". Niillä estetään sanojen jakaminen ja jokerimerkkien tulkinta, jotka ovat yleisiä virhelähteitä.

#!/bin/bash
# A script with issues fixed by ShellCheck

MY_NAME="CoddyKit" # Quote variable assignment values
echo "Hello ${MY_NAME}!" # Always quote variable expansions

if [ "$1" = "admin" ]; then # Quote positional parameters like $1
  echo "Welcome, administrator."
fi

# A simple loop with corrected quoting
for file in *.txt; do 
  echo "File: ${file}" # Quote variable expansions, especially in loops
done

Parhaiden käytäntöjen tarkistus

Mitkä seuraavista ovat hyviä käytäntöjä Bash-komentosarjoja kirjoitettaessa?

Vastaa interaktiivisessa oppitunnissa

Kertaus: ammattimainen komentosarjojen kirjoittaminen

Onnittelut! Olet oppinut, miten Bash-komentosarjat voidaan kehittää toimivista ammattimaisiksi.

Käsittelimme seuraavat aiheet:

Parhaiden käytäntöjen merkitys luettavuudelle ja ylläpidettävyydelle.
Kommenttien ja nimeämiskäytäntöjen käyttäminen selkeyden lisäämiseksi.
Komentosarjojen tekeminen vikasietoisiksi komennoilla set -u ja set -o pipefail.
ShellCheckin hyödyntäminen ongelmien automaattiseen etsimiseen ja koodin parantamiseen.

Näitä periaatteita soveltamalla kirjoitat luotettavampia, ymmärrettävämpiä ja yhteistyöhön sopivia Bash-komentosarjoja. Jatka harjoittelua!

Aloita maksutta

Opi DevOps-bootcamp tekoälytuutorin avulla — ilmaiseksi

Kirjoita ja suorita oikeaa koodia selaimessa, saa välitöntä apua tekoälytuutorilta ympäri vuorokauden ja jatka siitä, mihin jäit, verkossa tai sovelluksessa.

Kurssit: 142
Oppitunnit: 568

Aloita opiskelu maksutta Näytä koko kurssi

Usein kysytyt kysymykset

Onko oppitunti ”Komentosarjojen parhaat käytännöt ja linting” ilmainen?

Kyllä — voit lukea täällä verkossa kokonaan ilmaiseksi mitkä tahansa DevOps-bootcamp-oppimispolun 3 oppituntia, myös oppitunnin “Komentosarjojen parhaat käytännöt ja linting”. Sen jälkeen CoddyKit PRO avaa kaikki oppitunnit sekä interaktiiviset harjoitukset sisäänrakennetulla koodieditorilla ja ympäri vuorokauden toimivalla tekoälytuutorilla. DevOps-bootcamp-kurssilla on yhteensä 4 oppituntia.

Mitä opin oppitunnilla ”Komentosarjojen parhaat käytännöt ja linting”?

Oppikaa koodauskäytännöistä, kommentoinnista ja ShellCheckin kaltaisten työkalujen käytöstä siistin, luettavan ja virheettömän Bash-koodin kirjoittamiseksi. Harjoittelet DevOps-bootcamp-aihetta koodilla, jonka suoritat suoraan selaimessa. Ympäri vuorokauden käytettävissä oleva tekoälytuutori vastaa kysymyksiisi oppitunnin aikana.

Tarvitsenko kokemusta aloittaakseni DevOps-bootcamp-opiskelun?

Aiempi kokemus ei ole tarpeen. CoddyKitin DevOps-bootcamp-oppimispolku sopii vasta-alkajista edistyneisiin, joten voit aloittaa tästä tai alusta ja edetä omaan tahtiisi. Tämä on oppitunti 3/4.

Kuinka kauan ”Komentosarjojen parhaat käytännöt ja linting”-oppitunnin suorittaminen kestää?

Useimmat CoddyKitin oppitunnit kestävät noin 5–10 minuuttia. Jokainen oppitunti on lyhyt ja interaktiivinen, joten edistyt tasaisesti ja voit jatkaa siitä, mihin jäit – sekä verkossa että sovelluksessa.

Voinko kirjoittaa ja suorittaa koodia tällä DevOps-bootcamp-oppitunnilla?

Kyllä. Jokainen DevOps-bootcamp-oppitunti sisältää sisäänrakennetun koodieditorin, joten voit kirjoittaa ja suorittaa oikeaa koodia suoraan selaimessa ja saada välitöntä palautetta tekoälyltä – paikallista asennusta ei tarvita.

Kaikki tämän kurssin oppitunnit

Bash-komentosarjojen virheenkorjaus (set -x, trap)
Virheenkäsittely ja lopetustila
Komentosarjojen parhaat käytännöt ja linting
Bash-komentosarjojen testaaminen Batsilla

← Takaisin: DevOps-bootcamp