関数を定義する

同じ 3 行が、3 か所に貼られている

スクリプトが 50 行を超えるころ、まったく同じ数行があちこちに現れます。ディスクの使用率を取り出す 3 行、時刻を付けてログに書く 3 行。貼った直後は動きますが、df の見方を 1 か所だけ直して、残りを直し忘れた瞬間に、同じスクリプトの中で違う値が出るようになります。

まとめて名前を付けたものが関数です。

disk_used() {
  local target=$1
  df -h "$target" | tail -1 | awk '{print $5}'
}

名前のうしろに () を書き、{ から } までに中身を並べます。呼び出し方はコマンドと同じで、うしろに値を並べるだけです。関数の中では、その値を $1 $2 として受け取れます。スクリプト本体が受け取った引数とは別物なので、混同しないでください。

local は、その変数を関数の中だけのものにする指定です。付け忘れると、同じ名前の変数がスクリプト全体で共有され、呼んだあとに外の値が書き換わっている、という追いにくい不具合になります。

結果を受け取れず、画面に出るだけになる

関数の中で echo した内容は、そのまま画面に流れていきます。値として使いたいときは、呼び出す側で $( ... ) を使って受け止めます。

root=$(disk_used /)
home=$(disk_used /home)

echo "root ${root} / home ${home}"

同じ計算を 2 回書かずに、対象を変えて 2 回呼ぶだけで済みました。関数を直せば、両方の結果がそろって直ります。

成否だけを返したいのに、文字列が返ってくる

bash の関数は、文字列を return で返せません。return に書けるのは終了ステータス、つまり 0 か 1 以上の数だけです。

一見すると不便ですが、成否を判定する関数を書くときにはむしろ都合がよくなります。関数をそのまま if の条件に置けるからです。

backup_exists() {
  if [[ -f "/backup/$1.tar.gz" ]]; then
    return 0
  else
    return 1
  fi
}

if backup_exists app01; then
  echo "取得済みです"
else
  echo "まだありません"
fi

0 が成功で、1 以上が失敗です。数字の大小が意味と逆に見えますが、Unix では「異常の種類が何番か」を返す決まりなので、正常は 1 種類しかない 0 になります。

解説

関数の定義は、呼び出すより前に書いてください。シェルは上から読むので、まだ読んでいない名前は呼べません。スクリプトの上半分に関数を並べ、下半分で呼ぶ形にしておくと迷いません。

1. greet 関数を定義する
2. greet "Linux" を呼び出して Hello, Linux を出力