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

相关文章
|
2月前
|
存储 安全 Unix
七、Linux Shell 与脚本基础
别再一遍遍地敲重复的命令了,把它们写进Shell脚本,就能一键搞定。脚本本质上就是个存着一堆命令的文本文件,但要让它“活”起来,有几个关键点:文件开头最好用#!/usr/bin/env bash来指定解释器,并用chmod +x给它执行权限。执行时也有讲究:./script.sh是在一个新“房间”(子Shell)里跑,不影响你;而source script.sh是在当前“房间”里跑,适合用来加载环境变量和配置文件。
408 9
|
2月前
|
存储 Shell Linux
八、Linux Shell 脚本:变量与字符串
Shell脚本里的变量就像一个个贴着标签的“箱子”。装东西(赋值)时,=两边千万不能有空格。用单引号''装进去的东西会原封不动,用双引号""则会让里面的$变量先“变身”再装箱。默认箱子只能在当前“房间”(Shell进程)用,想让隔壁房间(子进程)也能看到,就得给箱子盖个export的“出口”戳。此外,Shell还自带了$?(上条命令的成绩单)和$1(别人递进来的第一个包裹)等许多特殊箱子,非常有用。
291 2
|
5月前
|
Shell
Shell脚本循环控制:shift、continue、break、exit指令
使用这些命令可以让你的Shell脚本像有生命一样动起来。正确使用它们,你的脚本就能像一场精心编排的舞蹈剧目,既有旋律的起伏,也有节奏的跳跃,最终以一场惊艳的表演结束。每一个动作、每一个转折点,都准确、优雅地完成所需要表达的逻辑。如此,你的脚本不只是冰冷的代码,它透过终端的界面,跳着有节奏的舞蹈,走进观众——使用者的心中。
263 60
|
2月前
|
数据采集 监控 Shell
无需Python:Shell脚本如何成为你的自动化爬虫引擎?
Shell脚本利用curl/wget发起请求,结合文本处理工具构建轻量级爬虫,支持并行加速、定时任务、增量抓取及分布式部署。通过随机UA、异常重试等优化提升稳定性,适用于日志监控、价格追踪等场景。相比Python,具备启动快、资源占用低的优势,适合嵌入式或老旧服务器环境,复杂任务可结合Python实现混合编程。
|
8月前
|
关系型数据库 MySQL Shell
MySQL 备份 Shell 脚本:支持远程同步与阿里云 OSS 备份
一款自动化 MySQL 备份 Shell 脚本,支持本地存储、远程服务器同步(SSH+rsync)、阿里云 OSS 备份,并自动清理过期备份。适用于数据库管理员和开发者,帮助确保数据安全。
|
4月前
|
Web App开发 缓存 安全
Linux一键清理系统垃圾:释放30GB空间的Shell脚本实战​
这篇博客介绍了一个实用的Linux系统盘清理脚本,主要功能包括: 安全权限检查和旧内核清理,保留当前使用内核 7天以上日志文件清理和系统日志压缩 浏览器缓存(Chrome/Firefox)、APT缓存、临时文件清理 智能清理Snap旧版本和Docker无用数据 提供磁盘空间使用前后对比和大文件查找功能 脚本采用交互式设计确保安全性,适合定期维护开发环境、服务器和个人电脑。文章详细解析了脚本的关键功能代码,并给出了使用建议。完整脚本已开源,用户可根据需求自定义调整清理策略。
510 1
|
6月前
|
存储 Unix Shell
确定Shell脚本在操作系统中的具体位置方法。
这对于掌握Linux的文件系统组织结构和路径方面的理解很有帮助,是我们日常工作和学习中都可能使用到的知识。以上讲解详细清晰,应用简便,是每一个想要精通操作系统的计算机爱好者必备的实用技能。
178 17
|
6月前
|
Linux Shell
Centos或Linux编写一键式Shell脚本删除用户、组指导手册
Centos或Linux编写一键式Shell脚本删除用户、组指导手册
193 4
|
6月前
|
Linux Shell 数据安全/隐私保护
Centos或Linux编写一键式Shell脚本创建用户、组、目录分配权限指导手册
Centos或Linux编写一键式Shell脚本创建用户、组、目录分配权限指导手册
392 3
|
7月前
|
Linux Shell
在Linux、CentOS7中设置shell脚本开机自启动服务
以上就是在CentOS 7中设置shell脚本开机自启动服务的全部步骤。希望这个指南能帮助你更好地管理你的Linux系统。
607 25