Bash การรับอาร์กิวเมนต์และ options



./deploy.sh -v --env prod --dry-run web1 web2 — สคริปต์ต้องแยกแยะ flag, option ที่มีค่า, และ positional argument บทนี้ให้สองวิธีและบอกว่าใช้อันไหนเมื่อไหร่

แบบ manual: while + case + shift

ยืดหยุ่นสุด รองรับ flag ยาว (--verbose) ได้ — เป็นแบบที่แนะนำสำหรับสคริปต์ที่มี option หลากหลาย

#!/usr/bin/env bash
set -euo pipefail

# ค่าปริยาย
verbose=0
dry_run=0
env="dev"
output=""
declare -a targets=()

usage() {
    cat <<EOF
ใช้งาน: ${0##*/} [ตัวเลือก] <target>...
  -v, --verbose       แสดงรายละเอียด
  -n, --dry-run       ไม่ทำจริง แค่แสดงว่าจะทำอะไร
  -e, --env ENV       สภาพแวดล้อม (dev/staging/prod) ปริยาย: dev
  -o, --output FILE   เขียนผลไปที่ FILE
  -h, --help          แสดงความช่วยเหลือ
EOF
}

while [[ $# -gt 0 ]]; do
    case $1 in
        -v | --verbose)
            verbose=1
            shift
            ;;
        -n | --dry-run)
            dry_run=1
            shift
            ;;
        -e | --env)
            [[ -n "${2:-}" ]] || { echo "--env ต้องมีค่า" >&2; exit 2; }
            env=$2
            shift 2
            ;;
        --env=*)
            env=${1#*=}                    # รองรับ --env=prod
            shift
            ;;
        -o | --output)
            [[ -n "${2:-}" ]] || { echo "--output ต้องมีค่า" >&2; exit 2; }
            output=$2
            shift 2
            ;;
        -o=* | --output=*)
            output=${1#*=}
            shift
            ;;
        -h | --help)
            usage
            exit 0
            ;;
        --)
            shift
            targets+=("$@")                # ทุกอย่างหลัง -- คือ positional
            break
            ;;
        -*)
            echo "ตัวเลือกไม่รู้จัก: $1" >&2
            usage >&2
            exit 2
            ;;
        *)
            targets+=("$1")                # positional argument
            shift
            ;;
    esac
done

# ตรวจ
[[ ${#targets[@]} -ge 1 ]] || { echo "ต้องระบุ target อย่างน้อย 1" >&2; exit 2; }
case $env in
    dev | staging | prod) ;;
    *) echo "env ไม่ถูกต้อง: $env" >&2; exit 2 ;;
esac

# แสดงผลที่ parse ได้
echo "env=$env verbose=$verbose dry_run=$dry_run output=${output:-<stdout>}"
echo "targets: ${targets[*]}"
./deploy.sh -v --env=prod --dry-run web1 web2
env=prod verbose=1 dry_run=1 output=<stdout>
targets: web1 web2

รวม flag สั้น: -vn

ถ้าอยากรองรับ -vn (= -v -n) ต้องแตกเอง

while [[ $# -gt 0 ]]; do
    case $1 in
        -[a-z][a-z]*)                     # flag สั้นหลายตัวติดกัน
            # แตก -vn เป็น -v -n
            rest=${1#-}
            shift
            set -- $(printf ' -%s' $(echo "$rest" | grep -o .)) "$@"
            ;;
        -v) verbose=1; shift ;;
        -n) dry_run=1; shift ;;
        *)  break ;;
    esac
done

ยุ่งพอควร — ถ้าต้องการ flag รวมแบบ Unix จริง ๆ getopts ทำให้ฟรี

getopts — builtin สำหรับ flag สั้น

#!/usr/bin/env bash
set -euo pipefail

verbose=0
dry_run=0
env="dev"
output=""

while getopts ':vne:o:h' opt; do
    case $opt in
        v) verbose=1 ;;
        n) dry_run=1 ;;
        e) env=$OPTARG ;;
        o) output=$OPTARG ;;
        h) echo "ใช้งาน: ${0##*/} [-v] [-n] [-e env] [-o file] target..."; exit 0 ;;
        :) echo "ตัวเลือก -$OPTARG ต้องมีค่า" >&2; exit 2 ;;
        \?) echo "ตัวเลือกไม่รู้จัก: -$OPTARG" >&2; exit 2 ;;
    esac
done
shift $(( OPTIND - 1 ))                    # ทิ้ง options ที่ parse แล้ว

targets=("$@")                             # ที่เหลือคือ positional
echo "env=$env targets: ${targets[*]}"

อธิบาย option string ':vne:o:h'

  • ขึ้นต้นด้วย : → silent error mode (จัดการ error เอง ผ่าน : และ \? — แนะนำ)
  • v n h → flag ไม่มีค่า
  • e: o: → option มีค่าตาม (colon ต่อท้าย) — ค่าอยู่ใน $OPTARG
  • OPTIND → index ของอาร์กิวเมนต์ถัดไปที่ยังไม่ parse

getopts รองรับ -vne prod (รวม flag + option สุดท้ายมีค่า) และ -e prod / -eprod ให้ฟรี

ข้อจำกัดของ getopts: ทำ flag ยาว (--verbose) ไม่ได้ — ถ้าต้องการต้องใช้ manual loop หรือ getopt (โปรแกรมภายนอก คนละตัวกับ getopts)

getopts ใน loop / ฟังก์ชัน — reset OPTIND

parse_subcommand_args() {
    local OPTIND=1                         # local + reset สำคัญ!
    while getopts ':f:v' opt; do
        case $opt in
            f) file=$OPTARG ;;
            v) verbose=1 ;;
        esac
    done
    shift $(( OPTIND - 1 ))
    remaining=("$@")
}

OPTIND เป็น global — ถ้าเรียก getopts หลายรอบ (subcommand ต่าง ๆ) ต้อง local OPTIND=1 ทุกครั้ง

แนวทางเลือก

สถานการณ์ใช้
สคริปต์ส่วนตัว flag สั้นไม่กี่ตัวgetopts
ต้องการ --long-optionsmanual while/case
CLI tool จริงจัง มี subcommandmanual loop + case dispatch
ต้องการ --opt=val, --, รวม flagmanual (คุมได้ทุกอย่าง) หรือ getopt (util)
สคริปต์ซับซ้อนมากพิจารณา Python argparse

-- — จบ options

ธรรมเนียม Unix: -- บอกว่า “ที่เหลือไม่ใช่ option แม้จะขึ้นต้นด้วย -“

grep -- -v file.txt          # ค้นหาสตริง "-v" (ไม่ใช่ option -v)
rm -- -rf                    # ลบไฟล์ชื่อ "-rf"
./myscript --verbose -- --this-is-a-target

manual loop ข้างบนจัดการ -- แล้ว — ควรรองรับเสมอ

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

  • ลืม shift ใน manual loop — วนไม่จบ (infinite loop)
  • shift 2 แต่ $2 ไม่มี — [[ -n "${2:-}" ]] เช็กก่อน ไม่งั้น set -u error
  • getopts ไม่ reset OPTIND ในฟังก์ชัน — parse รอบสองเริ่มผิดจุด local OPTIND=1
  • getopts option string ไม่ขึ้นต้นด้วย : — ได้ error message ปนเปจาก bash เอง ใส่ : แล้วจัดการเอง
  • คาดว่า getopts ทำ --long — ไม่ได้ ใช้ manual loop
  • ไม่รองรับ -- — ผู้ใช้ส่ง filename ที่ขึ้นต้นด้วย - ไม่ได้
  • parse args กระจายทั่วสคริปต์ — รวมไว้ในฟังก์ชัน parse_args เดียว (บทที่ 32)

สรุป

  • manual while [[ $# -gt 0 ]]; case $1 in ... esac; shift — ยืดหยุ่นสุด รองรับ --long, --opt=val, --
  • flag: -v|--verbose) x=1; shift
  • option มีค่า: -e|--env) val=$2; shift 2
  • --env=*) val=${1#*=}; shift
  • --) shift; rest+=("$@"); break
  • getopts ':vne:o:h' — builtin, flag สั้น + option มีค่า (OPTARG) + รวม flag ให้ฟรี
  • : นำหน้า = silent mode (จัดการ : และ \? เอง)
  • shift $(( OPTIND - 1 )) หลัง loop
  • ในฟังก์ชัน: local OPTIND=1
  • ทำ --long ไม่ได้
  • รองรับ -- (จบ options) เสมอ
  • ซับซ้อนมาก → พิจารณา Python argparse

บทถัดไปว่าด้วยสคริปต์แบบโต้ตอบ — select menu, ยืนยัน y/n, สี, และตรวจว่ารันแบบ interactive ไหม