Bash 零基础教程

Bash 函数返回值

函数是创建模块化、可重用和易于维护的 Bash 脚本的关键。在之前的学习中，我们了解了如何定义函数以及如何向它们传递参数，使其能够根据输入执行特定的任务。

然而，函数的用途通常不仅仅局限于“执行任务”；它经常需要将执行结果或状态反馈给脚本的调用方。这种函数提供输出的过程就被称为“返回值”。与某些其他编程语言中使用专门的 return 语句直接传递数据值不同，Bash 函数拥有自己独特的机制来传递信息，主要通过退出状态码 (exit status codes) 和标准输出 (standard output) 来实现。

1. 使用退出状态码返回值

在 Bash 中，函数内的 return 命令并不像传统编程语言那样返回一个字符串或整数等“数据值”。相反，它设置的是函数的退出状态（也称为退出码，exit code）。

退出状态是一个介于 0 到 255 之间的整数值。按照惯例，0 表示执行成功，而任何非零值（non-zero）都表示发生了某种形式的错误或失败。这种约定在绝大多数类 Unix 操作系统的命令和进程中都是通用的。

1.1 理解 return 命令与 $?

当函数执行到 return 命令时，它会立即退出该函数，并且提供给 return 的整数参数将成为该函数的退出状态。如果使用 return 时没有附带参数，那么函数内最后执行的那条命令的退出状态将成为该函数的退出状态。如果函数执行完毕而没有遇到显式的 return 语句，其退出状态同样是函数中最后一条执行命令的退出状态。

为了获取最近执行的命令或函数的退出状态，Bash 提供了特殊变量 $?。在函数调用结束后，紧接着检查 $?，它就会保存该函数返回的退出状态。

代码示例 1：返回成功或失败状态的函数

#!/bin/bash

check_file_exists() {
  local filename="$1" # 将 filename 声明为局部变量
  if [[ -f "$filename" ]]; then
    echo "文件 '$filename' 存在。"
    return 0 # 指示成功
  else
    echo "文件 '$filename' 不存在。"
    return 1 # 指示失败
  fi
}

# 调用函数并检查其退出状态
check_file_exists "non_existent_file.txt"
if [[ $? -eq 0 ]]; then
  echo "函数报告：成功。"
else
  echo "函数报告：失败。"
fi

echo "---"

# 创建一个用于下一次检查的测试文件
touch "existing_file.txt"
check_file_exists "existing_file.txt"
if [[ $? -eq 0 ]]; then
  echo "函数报告：成功。"
else
  echo "函数报告：失败。"
fi

rm "existing_file.txt" # 清理测试文件

在这个例子中，check_file_exists 使用 return 0 表示成功，return 1 表示失败。随后，调用脚本通过检查 $? 来根据函数的执行结果有条件地执行后续代码。

1.2 为不同错误类型使用特定的退出状态码

虽然 0 代表成功和 1 代表一般性失败是最常见的做法，但你可以使用不同的非零退出状态码来指示特定类型的错误，从而提供关于函数为何失败的更详细信息。这对于构建复杂的错误处理机制非常有用。

代码示例 2：返回特定错误码的函数

#!/bin/bash

validate_number_input() {
  local input="$1" # 将 input 声明为局部变量
  if [[ -z "$input" ]]; then
    echo "错误：输入不能为空。" >&2 # 将错误信息输出到标准错误 (stderr)
    return 1 # 退出码 1：输入为空
  elif ! [[ "$input" =~ ^[0-9]+$ ]]; then
    echo "错误：输入必须是正整数。" >&2 # 将错误信息输出到标准错误 (stderr)
    return 2 # 退出码 2：输入非数字
  else
    echo "输入 '$input' 是有效的。"
    return 0 # 退出码 0：成功
  fi
}

# 测试用例
validate_number_input ""
status_empty=$?
echo "空输入的返回状态：$status_empty"

echo "---"

validate_number_input "abc"
status_non_numeric=$?
echo "非数字输入的返回状态：$status_non_numeric"

echo "---"

validate_number_input "123"
status_valid=$?
echo "有效输入的返回状态：$status_valid"

echo "---"

# 在条件块中使用特定的状态码
handle_input_validation() {
  local value="$1"
  validate_number_input "$value"
  local validation_status=$?
  
  case $validation_status in
    0) echo "校验成功，值为：$value" ;;
    1) echo "校验失败：输入为空。" ;;
    2) echo "校验失败：输入不是正整数。" ;;
    *) echo "校验失败：未知错误 ($validation_status)。" ;;
  esac
}

handle_input_validation "456"
echo "---"
handle_input_validation ""
echo "---"
handle_input_validation "test"

在这个例子中，validate_number_input 提供了特定的错误码（1 代表空，2 代表非数字）。然后，handle_input_validation 函数使用 case 语句来解析这些具体的返回状态，从而实现更精准的错误提示或恢复操作。将错误消息重定向到标准错误 (>&2) 可以保持标准输出的纯净，这对于主要负责返回状态或数据的函数来说是一个好习惯。

2. 使用标准输出返回数据

对于 Bash 函数来说，"返回" 实际数据（比如字符串、数字或项目列表）最常见、最灵活的方法就是将其打印到标准输出 (stdout)。

函数中使用 echo 或 printf 打印的任何文本（只要没有在函数内部被重定向到其他地方），都会被发送到标准输出。然后，调用脚本就可以使用命令替换 (command substitution) 将这些输出捕获到一个变量中。

2.1 理解命令替换

命令替换允许将一个命令（或行为类似命令的函数）的输出作为变量的值，或者作为另一个命令的参数。命令替换的语法是 $(command_or_function_call)。

代码示例 3：返回格式化字符串的函数

#!/bin/bash

format_log_entry() {
  local level="$1"
  local message="$2"
  local timestamp=$(date +"%Y-%m-%d %H:%M:%S") # 获取当前时间戳
  echo "[$timestamp] [$level] $message" # 将格式化的字符串打印到标准输出
}

# 调用函数并捕获其输出
log_message=$(format_log_entry "INFO" "系统初始化完成。")
echo "捕获到的日志：$log_message"

echo "---"

critical_event=$(format_log_entry "CRITICAL" "磁盘空间警告：已使用 95%。")
echo "警报：$critical_event"

在这里，format_log_entry 构建了一个格式化的字符串并使用 echo 打印。随后，log_message 变量通过 $(...) 捕获了这整个字符串。对于旨在生成特定数据片段的函数，这是 Bash 脚本中极其强大且频繁使用的模式。

2.2 返回数值数据

同样地，函数可以执行计算并通过标准输出返回数值结果。

代码示例 4：计算并返回数值的函数

#!/bin/bash

calculate_percentage() {
  local part="$1"
  local total="$2"
  
  # 对数字输入进行基础验证
  if ! [[ "$part" =~ ^[0-9]+$ ]] || ! [[ "$total" =~ ^[0-9]+$ ]] || [[ "$total" -eq 0 ]]; then
    echo "错误：无效的数字输入或总数为零。" >&2
    return 1 # 使用退出状态表示错误，但仍可 echo 一个值（或不 echo）
  fi
  
  # 使用 bash 算术扩展进行计算
  # 先乘以 100 得到百分比，再除以总数
  # Bash 算术只能处理整数，如果需要浮点结果，我们可以使用 'bc'
  local percentage_raw=$(( (part * 100) / total ))
  echo "$percentage_raw" # 将计算出的百分比打印到标准输出
  return 0
}

# 使用该函数获取磁盘使用百分比（假设场景）
# 想象 'disk_total_blocks' 和 'disk_used_blocks' 是从系统命令获取的
disk_total_blocks=1000000
disk_used_blocks=250000

usage_percent=$(calculate_percentage "$disk_used_blocks" "$disk_total_blocks")

if [[ $? -eq 0 ]]; then
  echo "磁盘使用率：$usage_percent%"
else
  echo "计算磁盘使用率失败。"
fi

echo "---"

# 使用 'bc' 进行浮点数算术的示例
calculate_float_percentage() {
  local part="$1"
  local total="$2"
  
  if ! [[ "$part" =~ ^[0-9]+(\.[0-9]+)?$ ]] || ! [[ "$total" =~ ^[0-9]+(\.[0-9]+)?$ ]] || (( $(echo "$total == 0" | bc -l) )); then
    echo "错误：无效的数字输入或总数为零。" >&2
    return 1
  fi
  
  # 使用 'bc' 进行浮点算术计算
  local float_percent=$(echo "scale=2; ($part / $total) * 100" | bc)
  echo "$float_percent"
  return 0
}

cpu_usage_part=15.7
cpu_total_part=100.0

cpu_percent=$(calculate_float_percentage "$cpu_usage_part" "$cpu_total_part")

if [[ $? -eq 0 ]]; then
  echo "CPU 使用率：$cpu_percent%"
else
  echo "计算 CPU 使用率失败。"
fi

在 calculate_percentage 中，算术运算的结果被 echo 出来。调用脚本随后将这个数字字符串捕获到 usage_percent 中。请注意 bc 的使用，因为 Bash 原生的算术扩展 $((...)) 只能处理整数。

重要提示： 当通过标准输出返回数据时，除了 echo 数据外，仍然建议使用 return 命令来指示操作的状态（成功或失败），这是一个优秀的编程习惯。

3. 使用全局变量返回数据（不推荐）

在 Bash 中，变量默认具有全局作用域。这意味着如果你在函数内部声明一个变量而没有使用 local 关键字，它就会变成一个全局变量，可以在脚本的任何地方（包括函数外部）被访问和修改。因此，函数只需将值赋给全局变量即可实现“返回”值的效果。

代码示例 5：修改全局变量的函数

#!/bin/bash

SCRIPT_VERSION="1.0" # 全局变量

update_version() {
  local new_major=$1
  local new_minor=$2
  
  # 直接将新值赋给全局变量 SCRIPT_VERSION
  SCRIPT_VERSION="${new_major}.${new_minor}"
  echo "版本已在内部更新为 $SCRIPT_VERSION"
}

echo "初始脚本版本：$SCRIPT_VERSION"
update_version "1" "1"
echo "调用函数后的新脚本版本：$SCRIPT_VERSION"

在这个例子中，update_version 直接修改了全局变量 SCRIPT_VERSION。函数调用后，函数外部的 SCRIPT_VERSION 变量反映了内部所做的更改。

3.1 为什么通常不推荐使用全局变量？

虽然这种方法行得通，但在现代脚本编写实践中（尤其是对于复杂的脚本），通常认为这不是返回值的理想方式，原因如下：

  • 副作用 (Side Effects)： 理想情况下，函数应该尽量减少副作用，这意味着它们不应该意外地改变其自身作用域之外的变量。修改全局变量会使函数难以理解、测试和调试，因为它们的行为依赖于脚本的全局状态。
  • 可重用性降低： 依赖或修改全局变量的函数重用性较差，因为它们与脚本特定的全局状态紧密耦合。如果你想在另一个脚本中使用该函数，你可能需要设置完全相同的全局变量。
  • 命名冲突： 如果多个函数修改全局变量，或者某个函数修改了一个恰好在其他地方也用到的全局变量，可能会导致意外的覆盖和难以排查的 Bug。

出于这些原因，通常建议：优先使用退出状态码来传递成功/失败信号，使用标准输出结合命令替换来返回实际数据。 全局变量最好保留给配置设置或那些真正打算在脚本范围内全局访问的值，且在函数内修改它们时应当极其谨慎并做好注释文档。

4. 综合实战：增强系统管理脚本

让我们将这些概念整合到我们的系统管理脚本中。我们一直致力于构建一个自动化脚本，现在，我们将创建能返回值的函数，以帮助我们更高效地收集信息和记录事件。

场景：监控磁盘使用情况并记录事件

我们的脚本需要：

  1. 获取特定挂载点的磁盘使用百分比。
  2. 为各种事件生成标准化的日志消息。
  3. 检查系统服务的状态。
#!/bin/bash

# 函数：获取给定挂载点的磁盘使用百分比
# 将百分比（整数）返回到标准输出。
# 如果挂载点无效或 df 命令失败，则返回非零退出状态。
get_disk_usage_percent() {
  local mount_point="$1"
  
  if [[ -z "$mount_point" ]]; then
    echo "错误：未提供挂载点。" >&2
    return 1
  fi
  
  # 使用 'df -h' 获取磁盘空间，'grep' 虽然被省略，这里依靠 awk 和 tail 提取
  # 'tail -1' 用于处理挂载点名称是其他名称子集的情况
  local usage_line=$(df -h "$mount_point" 2>/dev/null | tail -1)
  
  if [[ -z "$usage_line" ]]; then
    echo "错误：找不到 '$mount_point' 的磁盘使用情况。" >&2
    return 2
  fi
  
  # 提取百分比数值（例如 "75%"）并移除 '%' 符号
  local percentage=$(echo "$usage_line" | awk '{print $5}' | sed 's/%//')
  
  # 基本校验：百分比是否为数字
  if ! [[ "$percentage" =~ ^[0-9]+$ ]]; then
    echo "错误：解析 '$mount_point' 的百分比失败。" >&2
    return 3
  fi
  
  echo "$percentage" # 通过标准输出返回百分比
  return 0
}

# 函数：生成格式化的日志消息
# 将格式化的字符串返回到标准输出。
log_message() {
  local level="$1" # 例如：INFO, WARN, ERROR
  local message="$2"
  local timestamp=$(date +"%Y-%m-%d %H:%M:%S")
  
  echo "[$timestamp] [$level] $message" # 通过标准输出返回格式化字符串
  return 0
}

# 函数：检查系统服务的状态
# 返回 0 表示处于 active 状态，1 表示 inactive/failed。
check_service_status() {
  local service_name="$1"
  
  if [[ -z "$service_name" ]]; then
    echo "错误：未提供服务名称。" >&2
    return 1
  fi
  
  # 'systemctl is-active' 如果活跃则返回 0，非活跃/失败返回非零
  systemctl is-active --quiet "$service_name"
  local status_code=$? # 捕获 systemctl 的退出状态
  
  if [[ $status_code -eq 0 ]]; then
    echo "服务 '$service_name' 正在运行 (active)。" >&2 # 发送到错误流防止污染 stdout
  else
    echo "服务 '$service_name' 未运行或已失败。" >&2
  fi
  
  return "$status_code" # 直接返回 systemctl 的状态码
}

# --- 主脚本逻辑 ---

# 1. 检查根文件系统的磁盘使用情况
MOUNT_POINT="/"
disk_percent=$(get_disk_usage_percent "$MOUNT_POINT")
disk_check_status=$?

if [[ $disk_check_status -eq 0 ]]; then
  echo "根文件系统使用率：$disk_percent%"
  if [[ "$disk_percent" -gt 80 ]]; then
    log_entry=$(log_message "WARNING" "$MOUNT_POINT 磁盘使用率过高：$disk_percent%。")
    echo "$log_entry" # 目前只打印到控制台，未来可以重定向到日志文件
  else
    log_entry=$(log_message "INFO" "$MOUNT_POINT 磁盘使用率正常：$disk_percent%。")
    echo "$log_entry"
  fi
else
  log_entry=$(log_message "ERROR" "获取 $MOUNT_POINT 磁盘使用率失败。状态码：$disk_check_status")
  echo "$log_entry"
fi

echo "---"

# 2. 检查假设的 'webserver' 服务状态
SERVICE_NAME="apache2" # 根据你的系统，也可能是 "nginx", "httpd" 等
check_service_status "$SERVICE_NAME"
service_status_code=$?

if [[ $service_status_code -eq 0 ]]; then
  log_entry=$(log_message "INFO" "服务 '$SERVICE_NAME' 正在运行。")
  echo "$log_entry"
else
  log_entry=$(log_message "CRITICAL" "服务 '$SERVICE_NAME' 未运行或遭遇失败！")
  echo "$log_entry"
fi

在这个实战案例中：

  • get_disk_usage_percent 通过标准输出 (echo "$percentage") 返回一个整数百分比，被捕获到 disk_percent 中。它同时使用 return 处理错误状态。
  • log_message 通过标准输出返回一个完整格式化的日志字符串，被捕获到 log_entry 中。
  • check_service_status 直接利用 systemctl is-active 的退出状态作为自己的返回状态，随后在主逻辑中将其捕获到 service_status_code 以进行条件判断。

这完美展示了如何结合退出状态（用于错误处理）和标准输出（用于数据传输），构建一个强大、灵活且模块化的脚本系统。