6种方法打造出色的Shell脚本

数据科学工厂

1. 详尽的错误处理和输入验证

清晰的错误信息对于良好的用户体验至关重要。这就是为什么在脚本中实现了详尽的错误处理和输入验证。例如：

if [ -z "$1" ] 
  then 
    echo "Usage: evaluate.sh <fork name> (<fork name 2> ...)" 
    echo " for each fork, there must be a 'calculate_average_<fork name>.sh' script and an optional 'prepare_<fork name>.sh'." 
    exit 1 
fi

这种方法可以帮助用户快速识别和解决问题，从而节省时间并减少挫败感。

2. 明了且色彩鲜明的输出

为了让脚本输出更加清晰易读，采用了ANSI颜色代码来强调重要信息、警告和错误。比如：

BOLD_RED='\033[1;31m'
RESET='\033[0m'
echo -e "${BOLD_RED}ERROR${RESET}: ./calculate_average_$fork.sh does not exist." >&2

这种视觉上的区别可以帮助用户快速掌握每条消息的本质。

3. 详尽的进度报告

希望用户能够确切地了解脚本在每个步骤中正在做什么。为此，实现了一个函数，它在执行每个命令之前先打印该命令：

function print_and_execute() {
  echo "+ $@" >&2 
  "$@" 
}

这与内置的 set -x跟踪输出格式相匹配，但为脚本编写者提供了更细致的控制，以决定打印哪些内容。

这种透明度不仅让用户保持知情，而且在出现问题时也有助于调试。

4. 策略性地使用 "set -e" 和 "set +e"

进行错误处理 希望确保如果脚本本身出现错误，脚本会立即退出，但如果个别分支遇到问题，也允许它继续运行。为此，在脚本中策略性地使用了选项 "set -e" 和 "set +e"。以下是如何实现这种技术的：

# 在脚本开始处
set -eo pipefail

# 在为每个分支运行测试和基准测试之前
for fork in "$@"; do
  set +e # 们不希望prepare.sh、test.sh或hyperfine在1个分支失败时就退出脚本

  # 运行准备脚本（简化）
  print_and_execute source "./prepare_$fork.sh"

  # 运行测试套件（简化）
  print_and_execute $TIMEOUT ./test.sh $fork

  # ...（其他特定于分支的操作）
done
set -e  # 在特定于分支的操作后重新启用错误退出

这种方法为脚本编写者提供了细致的控制，以决定哪些错误会导致脚本退出，哪些可以用其他方式处理。

5. 平台特定的适配

知道用户可能会在不同的操作系统上运行此脚本，添加了逻辑来检测操作系统并相应地调整脚本的行为：

if [ "$(uname -s)" == "Linux" ]; then 
  TIMEOUT="timeout -v $RUN_TIME_LIMIT" 
else # 假设 MacOS 
  if [ -x "$(command -v gtimeout)" ]; then 
    TIMEOUT="gtimeout -v $RUN_TIME_LIMIT"
  else 
    echo -e "${BOLD_YELLOW}WARNING${RESET} gtimeout not available, install with `brew install coreutils` or benchmark runs may take indefinitely long." 
  fi
fi

这确保了在不同环境中的一致体验。许多#1BRC参与者在MacOS上开发，而评估机器运行linux。

6. 多次运行的带时间戳的文件输出

为了支持多次基准测试运行而不覆盖先前的结果，实现了一个系统，用于带时间戳的文件输出。这允许用户多次运行脚本并保留所有结果的历史记录。

filetimestamp=$(date +"%Y%m%d%H%M%S")

# ...（在每个分支的循环中）
HYPERFINE_OPTS="--warmup 0 --runs $RUNS --export-json $fork-$filetimestamp-timing.json --output ./$fork-$filetimestamp.out"

# ...（在基准测试之后）
echo "Raw results saved to file(s):"
for fork in "$@"; do
  if [ -f "$fork-$filetimestamp-timing.json" ]; then
      cat $fork-$filetimestamp-timing.json >> $fork-$filetimestamp.out
      rm $fork-$filetimestamp-timing.json
  fi

  if [ -f "$fork-$filetimestamp.out" ]; then
    echo "  $fork-$filetimestamp.out"
  fi
done

总结

本文通过实施这些技术，目标是创建一个用户友好、信息丰富且健壮的shell脚本，为用户提供运行和分析基准测试的极佳体验。希望这些想法能激发你提高你自己的shell脚本的用户体验！

微信扫一扫分享文章