如何构建模块化的Shell脚本库以提高复用性

一、为什么需要模块化Shell脚本库

在日常运维和开发中，我们经常会遇到重复编写相似Shell脚本的情况。比如，每次部署项目都要写日志记录、错误处理、文件校验等代码。如果把这些功能拆分成独立的模块，就能像搭积木一样快速组装出完整的脚本，不仅省时省力，还能减少错误。

举个例子，假设你经常需要检查服务器磁盘空间，原始做法可能是每个脚本都写一遍df -h命令。而模块化的思路是：

#!/bin/bash
# 技术栈：Bash Shell
# 功能：磁盘检查模块

check_disk_usage() {
  local threshold=$1
  local usage=$(df -h | awk '{print $5}' | grep -v Use | sed 's/%//')
  
  for percent in $usage; do
    if [ $percent -ge $threshold ]; then
      echo "[ERROR] 磁盘使用率超过 ${threshold}%: 当前 ${percent}%"
      return 1
    fi
  done
  echo "[INFO] 磁盘检查通过"
  return 0
}

这样，其他脚本只需要source这个模块，调用check_disk_usage 90就能完成检查。

二、模块化设计的核心原则

1. 单一职责

每个模块只做一件事。比如日志模块只负责输出日志，配置模块只处理参数读取。

2. 接口标准化

定义清晰的输入输出。下面是一个日志模块的示例：

#!/bin/bash
# 技术栈：Bash Shell
# 功能：标准化日志模块

log() {
  local level=$1
  local message=$2
  local timestamp=$(date "+%Y-%m-%d %H:%M:%S")
  
  case $level in
    "INFO")  echo -e "\033[32m[${timestamp}] INFO: ${message}\033[0m" ;;
    "WARN")  echo -e "\033[33m[${timestamp}] WARN: ${message}\033[0m" ;;
    "ERROR") echo -e "\033[31m[${timestamp}] ERROR: ${message}\033[0m" >&2 ;;
    *)       echo "[${timestamp}] DEBUG: ${message}" ;;
  esac
}

3. 依赖隔离

模块之间尽量减少耦合。比如通过环境变量传递配置：

#!/bin/bash
# 技术栈：Bash Shell
# 功能：配置加载模块

load_config() {
  # 默认值
  export LOG_LEVEL=${LOG_LEVEL:-"INFO"}
  export MAX_RETRY=${MAX_RETRY:-3}
}

三、实战：构建一个脚本库

假设我们要管理一个包含以下功能的库：

1. 日志模块（如上）
2. 网络检测模块
3. 文件锁模块（防止脚本重复执行）

示例：网络检测模块

#!/bin/bash
# 技术栈：Bash Shell
# 功能：网络连通性检查

check_connectivity() {
  local host=$1
  local port=$2
  local timeout=${3:-5}
  
  if nc -z -w $timeout $host $port; then
    log "INFO" "连接到 ${host}:${port} 成功"
    return 0
  else
    log "ERROR" "无法连接 ${host}:${port}"
    return 1
  fi
}

示例：文件锁模块

#!/bin/bash
# 技术栈：Bash Shell
# 功能：基于文件锁的互斥控制

acquire_lock() {
  local lockfile="/tmp/${0##*/}.lock"
  exec 200>$lockfile
  
  if flock -n 200; then
    log "INFO" "获取锁成功"
    return 0
  else
    log "WARN" "脚本已在运行中"
    exit 1
  fi
}

release_lock() {
  flock -u 200
  rm -f $lockfile
}

四、高级技巧与注意事项

1. 动态加载模块

通过source命令按需加载：

#!/bin/bash
# 加载模块库
MODULES=("log.sh" "network.sh" "lock.sh")

for module in "${MODULES[@]}"; do
  source "${LIB_DIR}/${module}" || exit 1
done

2. 版本兼容性处理

在模块开头声明版本：

#!/bin/bash
# 模块版本：v1.2
# 最低要求：Bash 4.0+

3. 错误传播机制

使用返回值链式处理：

check_disk_usage 90 || {
  log "ERROR" "磁盘检查失败"
  exit 1
}

五、应用场景与技术对比

典型应用场景

• 自动化部署流程
• 定时监控任务
• 批量数据处理

技术优缺点

注意事项

1. 避免使用exit直接退出模块
2. 所有函数使用local定义变量
3. 为关键操作添加日志记录

六、总结

通过将Shell脚本拆分为功能模块，配合清晰的接口规范，可以显著提升脚本的可维护性。建议从小的功能点开始实践，逐步积累自己的脚本库。记住：好的模块化设计应该像乐高积木——每个零件简单可靠，组合起来却能构建无限可能。