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

简介: 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脚本的用户体验!

相关文章
|
1月前
|
Shell
一个用于添加/删除定时任务的shell脚本
一个用于添加/删除定时任务的shell脚本
75 1
|
3天前
|
XML JSON 监控
Shell脚本要点和难点以及具体应用和优缺点介绍
Shell脚本在系统管理和自动化任务中扮演着重要角色。尽管存在调试困难、可读性差等问题,但其简洁高效、易于学习和强大的功能使其在许多场景中不可或缺。通过掌握Shell脚本的基本语法、常用命令和函数,并了解其优缺点,开发者可以编写出高效的脚本来完成各种任务,提高工作效率。希望本文能为您在Shell脚本编写和应用中提供有价值的参考和指导。
13 1
|
8天前
|
Ubuntu Shell 开发工具
ubuntu/debian shell 脚本自动配置 gitea git 仓库
这是一个自动配置 Gitea Git 仓库的 Shell 脚本,支持 Ubuntu 20+ 和 Debian 12+ 系统。脚本会创建必要的目录、下载并安装 Gitea,创建 Gitea 用户和服务,确保 Gitea 在系统启动时自动运行。用户可以选择从官方或小绿叶技术博客下载安装包。
22 2
|
22天前
|
监控 网络协议 Shell
ip和ip网段攻击拦截系统-绿叶结界防火墙系统shell脚本
这是一个名为“小绿叶技术博客扫段攻击拦截系统”的Bash脚本,用于监控和拦截TCP攻击。通过抓取网络数据包监控可疑IP,并利用iptables和firewalld防火墙规则对这些IP进行拦截。同时,该系统能够查询数据库中的白名单,确保合法IP不受影响。此外,它还具备日志记录功能,以便于后续分析和审计。
43 6
|
18天前
|
运维 监控 Shell
深入理解Linux系统下的Shell脚本编程
【10月更文挑战第24天】本文将深入浅出地介绍Linux系统中Shell脚本的基础知识和实用技巧,帮助读者从零开始学习编写Shell脚本。通过本文的学习,你将能够掌握Shell脚本的基本语法、变量使用、流程控制以及函数定义等核心概念,并学会如何将这些知识应用于实际问题解决中。文章还将展示几个实用的Shell脚本例子,以加深对知识点的理解和应用。无论你是运维人员还是软件开发者,这篇文章都将为你提供强大的Linux自动化工具。
|
1月前
|
监控 Unix Shell
shell脚本编程学习
【10月更文挑战第1天】shell脚本编程
65 12
|
1月前
|
存储 运维 监控
自动化运维:使用Shell脚本简化日常任务
【9月更文挑战第35天】在IT运维的日常工作中,重复性的任务往往消耗大量的时间。本文将介绍如何通过编写简单的Shell脚本来自动化这些日常任务,从而提升效率。我们将一起探索Shell脚本的基础语法,并通过实际案例展示如何应用这些知识来创建有用的自动化工具。无论你是新手还是有一定经验的运维人员,这篇文章都会为你提供新的视角和技巧,让你的工作更加轻松。
49 2
|
2月前
|
Shell
shell脚本变量 $name ${name}啥区别
shell脚本变量 $name ${name}啥区别
|
1月前
|
存储 Shell Linux
【Linux】shell基础,shell脚本
Shell脚本是Linux系统管理和自动化任务的重要工具,掌握其基础及进阶用法能显著提升工作效率。从简单的命令序列到复杂的逻辑控制和功能封装,Shell脚本展现了强大的灵活性和实用性。不断实践和探索,将使您更加熟练地运用Shell脚本解决各种实际问题
23 0
|
6月前
|
Shell 索引
shell脚本入门到实战(四)- 数组
shell脚本入门到实战(四)- 数组