Bash โครงสร้างสคริปต์ที่ดี



สคริปต์ 20 บรรทัดเขียนมั่ว ๆ ได้ แต่พอโตเป็น 100+ บรรทัด โครงสร้างที่ดีคือความต่างระหว่าง “แก้ได้” กับ “เขียนใหม่” บทนี้ให้ template ที่ใช้ได้จริงและอธิบายทุกส่วน

Template มาตรฐาน

#!/usr/bin/env bash
#
# backup.sh — สำรองโฟลเดอร์เป็น tar.gz พร้อม timestamp และหมุนไฟล์เก่า
#
# ใช้งาน: backup.sh [-v] [-k COUNT] <source_dir> <dest_dir>

set -euo pipefail
IFS=$'\n\t'

# ---- ค่าคงที่ ----
readonly SCRIPT_NAME=${0##*/}
readonly SCRIPT_DIR=$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)
readonly VERSION="1.2.0"
readonly DEFAULT_KEEP=7

# ---- ตัวแปร global (ตั้งค่าโดย parse_args) ----
verbose=0
keep=$DEFAULT_KEEP
src=""
dst=""

# ---- ฟังก์ชันช่วย ----
log()  { printf '%s [%s] %s\n' "$(date '+%F %T')" "$SCRIPT_NAME" "$*" >&2; }
warn() { printf 'WARNING: %s\n' "$*" >&2; }
die()  { printf 'ERROR: %s\n' "$*" >&2; exit 1; }

usage() {
    cat <<EOF
$SCRIPT_NAME v$VERSION — สำรองโฟลเดอร์

ใช้งาน: $SCRIPT_NAME [ตัวเลือก] <source_dir> <dest_dir>

ตัวเลือก:
  -v          แสดงรายละเอียด
  -k COUNT    เก็บไฟล์สำรองล่าสุด COUNT ไฟล์ (ปริยาย: $DEFAULT_KEEP)
  -h          แสดงความช่วยเหลือนี้

ตัวอย่าง:
  $SCRIPT_NAME /home/somchai/projects /mnt/backup
  $SCRIPT_NAME -v -k 30 /var/www /mnt/backup
EOF
}

# ---- parse อาร์กิวเมนต์ ----
parse_args() {
    while getopts ':vk:h' opt; do
        case $opt in
            v) verbose=1 ;;
            k) keep=$OPTARG ;;
            h) usage; exit 0 ;;
            :) die "ตัวเลือก -$OPTARG ต้องมีค่า" ;;
            \?) die "ตัวเลือกไม่รู้จัก: -$OPTARG" ;;
        esac
    done
    shift $(( OPTIND - 1 ))

    [[ $# -eq 2 ]] || { usage >&2; die "ต้องระบุ source และ dest"; }
    src=$1
    dst=$2

    [[ "$keep" =~ ^[0-9]+$ ]] || die "-k ต้องเป็นตัวเลข"
    [[ -d "$src" ]] || die "ไม่พบโฟลเดอร์ source: $src"
    [[ -d "$dst" ]] || die "ไม่พบโฟลเดอร์ dest: $dst"
}

# ---- งานหลักแต่ละส่วน ----
create_backup() {
    local ts name archive
    ts=$(date '+%Y%m%d-%H%M%S')
    name=${src##*/}
    archive="$dst/${name}-${ts}.tar.gz"

    (( verbose )) && log "กำลังสร้าง $archive"
    tar -czf "$archive" -C "$(dirname "$src")" "$name"
    log "สร้างเสร็จ: $archive ($(du -h "$archive" | cut -f1))"
}

rotate_old() {
    local name=${src##*/}
    local -a backups
    mapfile -t backups < <(ls -1t "$dst/${name}-"*.tar.gz 2>/dev/null || true)

    if (( ${#backups[@]} > keep )); then
        local old
        for old in "${backups[@]:keep}"; do
            (( verbose )) && log "ลบไฟล์เก่า: $old"
            rm -f "$old"
        done
    fi
}

# ---- main ----
main() {
    parse_args "$@"
    log "เริ่มสำรอง $src → $dst (เก็บ $keep ไฟล์)"
    create_backup
    rotate_old
    log "เสร็จสมบูรณ์"
}

main "$@"

ทำไมต้องห่อด้วย main()

# ... นิยามฟังก์ชันทั้งหมด ...

main() {
    # ตรรกะทั้งหมดอยู่ในนี้
}

main "$@"        # บรรทัดสุดท้าย

ข้อดี

  1. อ่านจากบนลงล่างได้ — เห็น main() ปุ๊บรู้ flow ทั้งหมด รายละเอียดอยู่ในฟังก์ชันแยก
  2. ตัวแปรใน main เป็น local ได้ — ลดการรั่วของ global
  3. สคริปต์ถูก source เพื่อเทสได้ — source script.sh โหลดฟังก์ชันโดยไม่รัน (ถ้าเช็ค — ดูข้างล่าง)
  4. ฟังก์ชันถูกนิยามครบก่อน main รัน — ไม่มีปัญหา “เรียกก่อนนิยาม”

รองรับการ source เพื่อเทส

# รัน main เฉพาะเมื่อสคริปต์ถูกรันตรง ๆ ไม่ใช่ถูก source
if [[ "${BASH_SOURCE[0]}" == "${0}" ]]; then
    main "$@"
fi

หาโฟลเดอร์ของสคริปต์

readonly SCRIPT_DIR=$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)

source "$SCRIPT_DIR/lib/common.sh"
config_file="$SCRIPT_DIR/config/default.conf"

${BASH_SOURCE[0]} แม่นกว่า $0 (ทำงานถูกแม้ถูก source) cd ... && pwd ให้ absolute path ที่ resolve .. และ symlink ชั้นเดียวแล้ว

ถ้าต้อง resolve symlink หลายชั้น ใช้ realpath

readonly SCRIPT_PATH=$(realpath "${BASH_SOURCE[0]}")
readonly SCRIPT_DIR=${SCRIPT_PATH%/*}

ลำดับส่วนในไฟล์

1. shebang
2. คอมเมนต์อธิบาย (สคริปต์ทำอะไร ใช้ยังไง ตัวอย่าง)
3. set -euo pipefail + IFS
4. readonly constants (SCRIPT_NAME, VERSION, ค่าปริยาย, path)
5. ตัวแปร global ที่ parse_args จะเซ็ต (ประกาศไว้ให้เห็น)
6. ฟังก์ชัน utility (log, die, usage)
7. ฟังก์ชัน parse_args
8. ฟังก์ชันงานแต่ละส่วน
9. main()
10. main "$@"

แยกเป็นหลายไฟล์เมื่อโตขึ้น

mytool/
├── mytool                 # entry point (parse args, เรียก lib)
├── lib/
│   ├── common.sh          # log, die, utility
│   ├── config.sh          # โหลด/ตรวจ config
│   └── commands.sh        # ฟังก์ชันของแต่ละ subcommand
└── config/
    └── default.conf
# ใน mytool
readonly LIB_DIR="$SCRIPT_DIR/lib"
# shellcheck source=lib/common.sh
source "$LIB_DIR/common.sh"
source "$LIB_DIR/config.sh"
source "$LIB_DIR/commands.sh"

ไฟล์ lib ไม่ต้องมี shebang ที่รันได้ แต่ควรมี # shellcheck shell=bash บนสุด และ ไม่ควร set -e ในไฟล์ lib (ให้ entry point ตั้ง)

การตั้งชื่อ

  • สคริปต์: ตัวพิมพ์เล็ก - คั่น ไม่มี .sh ถ้าเป็นเครื่องมือที่ผู้ใช้พิมพ์ (deploy-web)
  • ฟังก์ชัน: snake_case กริยานำ (create_backup, parse_args, check_deps)
  • ตัวแปร local: snake_case ตัวเล็ก
  • constants / globals: UPPER_SNAKE + readonly
  • ฟังก์ชัน private ใน lib: นำหน้า _ (_internal_helper)

เรื่องที่คนมักพลาด

  • ไม่ห่อ main() — โค้ด 200 บรรทัดไหลยาว ตัวแปรทั้งหมดเป็น global แก้ยาก
  • main "$@" เขียนเป็น main — ลืมส่งอาร์กิวเมนต์ต่อ
  • ใช้ $0 แทน ${BASH_SOURCE[0]} — พังเมื่อถูก source หรือ symlink
  • SCRIPT_DIR=$(dirname "$0") — ได้ relative path ต้อง cd ... && pwd
  • set -e ในไฟล์ lib ที่ถูก source — กระทบ shell ที่ source มัน
  • globals กระจายทั้งไฟล์ — รวมประกาศไว้ที่เดียวใต้ constants
  • usage() เขียนไป stdout ตอน error — ตอน error ให้ usage >&2

สรุป

  • Template: shebang → คอมเมนต์ → set -euo pipefail + IFS → readonly constants → globals → utility funcs (log/die/usage) → parse_args → งานแต่ละส่วน → main() → main "$@"
  • ห่อตรรกะทั้งหมดใน main() — อ่าน flow ได้จากที่เดียว, ตัวแปร local ได้, source เพื่อเทสได้
  • main "$@" บรรทัดสุดท้าย — หรือ if [[ "${BASH_SOURCE[0]}" == "${0}" ]]; then main "$@"; fi
  • SCRIPT_DIR=$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd) — absolute path ของโฟลเดอร์สคริปต์
  • แยก lib/*.sh เมื่อโต — ไม่มี shebang, ไม่ set -e, มี # shellcheck shell=bash
  • ตั้งชื่อ: ฟังก์ชัน snake_case กริยานำ, constants UPPER_SNAKE + readonly

จบเฟส 4 — บทถัดไปเข้าเฟส 5 เรื่องสคริปต์ระดับใช้งานจริง เริ่มจากการ parse อาร์กิวเมนต์และ options