如何基于操作类型校验Bash脚本输入参数并实现帮助提示？

问题需求 #

需要编写一个Bash脚本，实现以下功能：

• 支持两种操作类型：I（对应insert）和U（对应update）
• 操作类型作为输入参数之一，insert操作需3个参数，update操作需4个参数
• 校验输入参数的合法性：
  1. 校验操作类型是否为合法的I/U值，非法值给出提示
  2. 根据操作类型校验参数数量是否符合要求
  3. 检查参数是否为空，为空则提示并显示帮助信息
• 提供帮助函数，展示对应操作的参数格式

参数格式示例：

• insert操作：<test_case_a> <test_value_a> I
• update操作：<test_case_a> <test_value_a> U <date_test_value_a>

原脚本问题分析 #

你提供的脚本存在以下逻辑错误：

1. 条件判断顺序错误：先判断$3是否为空，之后又判断$3是否为U/I，此时$3为空，后续判断永远不成立
2. 参数空值判断使用&&：只有当所有参数都为空时才触发提示，应该用||（只要有一个参数为空就提示）
3. 帮助函数命名不一致：helpFunction_U和help_Function_I的下划线位置混乱，易引发调用错误
4. exit命令未指定状态码：不符合脚本规范，建议使用exit 1表示错误退出
5. 非法操作类型的提示逻辑被错误嵌套，无法正确触发

修正后的脚本 #

#!/usr/bin/bash

# 统一帮助函数，根据操作类型显示对应帮助信息
show_help() {
    local action="$1"
    echo "Usage:"
    if [ "$action" = "I" ]; then
        echo "  $0 <test_case_a> <test_value_a> I"
        echo "  Param 1: test_case_a - 测试用例标识"
        echo "  Param 2: test_value_a - 测试值"
        echo "  Param 3: action - 操作类型，固定为I（insert）"
    elif [ "$action" = "U" ]; then
        echo "  $0 <test_case_a> <test_value_a> U <date_test_value_a>"
        echo "  Param 1: test_case_a - 测试用例标识"
        echo "  Param 2: test_value_a - 测试值"
        echo "  Param 3: action - 操作类型，固定为U（update）"
        echo "  Param 4: date_test_value_a - 日期测试值"
    else
        echo "  合法操作类型为I（insert）或U（update）"
        echo "  示例："
        echo "    insert操作：$0 case1 value1 I"
        echo "    update操作：$0 case1 value1 U 2024-05-20"
    fi
    exit 1
}

# 主逻辑开始
# 先检查操作类型是否存在
if [ -z "$3" ]; then
    echo "错误：未指定操作类型（I/U）"
    show_help
fi

ACTION="$3"

# 校验操作类型合法性
if [ "$ACTION" != "I" ] && [ "$ACTION" != "U" ]; then
    echo "错误：非法操作类型 '$ACTION'，仅支持I或U"
    show_help
fi

# 根据操作类型校验参数数量
if [ "$ACTION" = "I" ]; then
    if [ $# -ne 3 ]; then
        echo "错误：insert操作需要3个参数"
        show_help "I"
    fi
    # 检查参数是否为空
    if [ -z "$1" ] || [ -z "$2" ]; then
        echo "错误：部分参数为空"
        show_help "I"
    fi
    echo "执行insert操作，参数：test_case=$1, test_value=$2"
    # 这里添加insert操作的具体逻辑
elif [ "$ACTION" = "U" ]; then
    if [ $# -ne 4 ]; then
        echo "错误：update操作需要4个参数"
        show_help "U"
    fi
    # 检查参数是否为空
    if [ -z "$1" ] || [ -z "$2" ] || [ -z "$4" ]; then
        echo "错误：部分参数为空"
        show_help "U"
    fi
    echo "执行update操作，参数：test_case=$1, test_value=$2, date_value=$4"
    # 这里添加update操作的具体逻辑
fi

脚本说明 #

1. 统一帮助函数：show_help根据传入的操作类型展示对应格式，避免重复代码，同时支持非法操作类型的通用帮助提示
2. 逻辑顺序优化：
   • 先检查操作类型是否存在，不存在直接提示并显示帮助
   • 再校验操作类型是否为合法的I/U，非法则提示
   • 最后根据操作类型校验参数数量和参数空值
3. 参数校验改进：
   • 使用$#判断参数总数，确保符合操作类型的要求
   • 使用||判断参数空值，只要有一个参数为空就触发提示
4. 错误处理规范：所有错误场景都调用show_help并以exit 1退出，明确表示脚本执行失败

内容的提问来源于stack exchange，提问作者Mathew Linton