对于一个好的bash/ksh脚本模板作为所有新创建的脚本的标准,您有什么建议?
我通常(在#!行之后)以注释掉的标题开头,其中包含文件名、摘要、用法、返回值、作者、changelog,并且可以容纳在80个字符的行中。
所有文档行都以双散列符号##开头,这样我就可以很容易地对它们进行grep,并且本地变量名称会以"__“作为前缀。
还有其他的最佳实践吗?小贴士?命名约定?那么返回代码呢?
关于版本控制的评论:我们可以使用SVN,但是企业中的另一个部门有一个单独的repo,这是他们的脚本。如果没有@author的信息,我怎么知道联系Q的人?即使在shell上下文中,使用类似于javadoc的条目也有一些优点,但我可能错了。
发布于 2009-01-10 06:43:26
我将Norman的答案扩展到6行,其中最后一行是空白的:
#!/bin/ksh
#
# @(#)$Id$
#
# Purpose第三行是一个版本控制标识字符串-它实际上是一个具有SCCS标记‘RCS’的混合体,它可以由(SCCS)程序what识别,以及一个RCS版本字符串,当文件被放入RCS下时,RCS版本字符串会被展开。RCS程序ident选择$Id$的扩展形式,它可能看起来像$Id: mkscript.sh,v 2.3 2005/05/20 21:06:35 jleffler Exp $。第五行提醒我,脚本应该在顶部有其用途的描述;我用脚本的实际描述替换了这个词(这就是为什么后面没有冒号的原因,例如)。
在此之后,shell脚本基本上没有任何标准。出现了标准片段,但没有标准片段出现在每个脚本中。(我的讨论假设脚本是用Bourne、Korn或POSIX (Bash) shell表示法编写的。有一个完整的单独的讨论,为什么任何人在#!符号之后添加C Shell派生程序都是在罪过中生活。)
例如,每当脚本创建中间(临时)文件时,此代码就会以某种形状或形式出现:
tmp=${TMPDIR:-/tmp}/prog.$$
trap "rm -f $tmp.?; exit 1" 0 1 2 3 13 15
...real work that creates temp files $tmp.1, $tmp.2, ...
rm -f $tmp.?
trap 0
exit 0第一行选择一个临时目录,如果用户没有指定替代目录,则缺省为/tmp ($TMPDIR被广泛识别并由POSIX标准化)。然后,它创建一个包含进程ID的文件名前缀。这不是一种安全措施;它是一种简单的并发措施,可防止脚本的多个实例相互践踏彼此的数据。(为安全起见,请在非公共目录中使用不可预测的文件名。)第二行确保在外壳程序接收到任何信号SIGHUP (1)、SIGINT (2)、SIGQUIT (3)、SIGPIPE (13)或SIGTERM (15)时执行'rm‘和'exit’命令。'rm‘命令删除与模板匹配的任何中间文件;exit命令确保状态为非零,表示存在某种错误。值为0的“trap”表示,如果shell出于任何原因退出,代码也会执行-它涵盖了标记为“实际工作”的部分中的疏忽。然后,最后的代码删除所有幸存的临时文件,然后在退出时解除陷阱,最后以零(成功)状态退出。显然,如果您想以另一种状态退出,只需确保在运行rm和trap行之前在变量中设置了它,然后使用exit $exitval即可。
我通常使用以下代码从脚本中删除路径和后缀,以便在报告错误时可以使用$arg0:
arg0=$(basename $0 .sh)我经常使用shell函数来报告错误:
error()
{
echo "$arg0: $*" 1>&2
exit 1
}如果只有一个或两个错误出口,我就不会为这个函数操心;如果还有更多的错误出口,我会这么做,因为它简化了编码。我还创建了或多或少复杂的名为usage的函数来总结如何使用该命令-同样,只有在不止一个地方使用该命令的情况下才会使用。
另一个相当标准的片段是一个选项解析循环,它使用内置的getopts外壳:
vflag=0
out=
file=
Dflag=
while getopts hvVf:o:D: flag
do
case "$flag" in
(h) help; exit 0;;
(V) echo "$arg0: version $Revision$ ($Date$)"; exit 0;;
(v) vflag=1;;
(f) file="$OPTARG";;
(o) out="$OPTARG";;
(D) Dflag="$Dflag $OPTARG";;
(*) usage;;
esac
done
shift $(expr $OPTIND - 1)或者:
shift $(($OPTIND - 1))"$OPTARG“两边的引号处理参数中的空格。Dflag是累积性的,但是这里使用的表示法没有跟踪参数中的空格。也有(非标准的)方法来解决这个问题。
第一个移位符号适用于任何shell (或者如果我使用反划线而不是'$(...)‘也可以。第二种方法适用于现代shell;甚至可能有一种用方括号代替圆括号的替代方法,但是这种方法很有效,所以我没有费心去弄清楚它是什么。
现在的最后一个技巧是,我经常同时拥有GNU和非GNU版本的程序,并且我希望能够选择使用哪一个。因此,我的许多脚本都使用以下变量:
: ${PERL:=perl}
: ${SED:=sed}然后,当我需要调用Perl或sed时,脚本使用$PERL或$SED。这有助于我在某些行为不同时(我可以选择可操作的版本),或者在开发脚本时(我可以在不修改脚本的情况下向命令添加额外的仅调试选项)。(有关${VAR:=value}和相关符号的信息,请参见Shell parameter expansion。)
发布于 2011-10-13 22:19:02
我使用第一组##行编写用法文档。我现在不记得我是在哪里第一次看到这个的。
#!/bin/sh
## Usage: myscript [options] ARG1
##
## Options:
## -h, --help Display this message.
## -n Dry-run; only show what would be done.
##
usage() {
[ "$*" ] && echo "$0: $*"
sed -n '/^##/,/^$/s/^## \{0,1\}//p' "$0"
exit 2
} 2>/dev/null
main() {
while [ $# -gt 0 ]; do
case $1 in
(-n) DRY_RUN=1;;
(-h|--help) usage 2>&1;;
(--) shift; break;;
(-*) usage "$1: unknown option";;
(*) break;;
esac
done
: do stuff.
}发布于 2009-01-10 07:39:39
任何要在野外发布的代码都应该有以下简短的标题:
# Script to turn lead into gold
# Copyright (C) 2009 Ima Hacker (i.m.hacker@foo.org)
# Permission to copy and modify is granted under the foo license
# Last revised 1/1/2009在代码头中保留更改日志是版本控制系统非常不方便时的倒退。最后一次修改日期会向用户显示脚本的旧版本。
如果您打算依赖bashism,请使用#!/bin/bash,而不是/bin/ sh,因为sh是任何shell的POSIX调用。即使/bin/sh指向bash,如果您通过/bin/sh运行它,许多特性也会被关闭。大多数Linux发行版都不会使用依赖于bashism的脚本,尽量做到可移植。
当涉及到继承别人的脚本时,我发现人们倾向于在不需要的地方进行大量的注释(例如# loop over $var),在需要注释的地方非常零星地进行注释(例如超长的Perl一行程序或者带有几十个参数的JVM执行)。这并不是shell脚本所独有的,这在许多已建立的代码库中都是一个问题,但在脚本中尤其令人沮丧。从表面上看,我不知道/bin/foo -- {mile long list of arguments}做了什么,但我知道编写脚本的结构。当你正在做一些表面上看起来有点疯狂的事情时,评论也是非常受欢迎的。
有些shell不喜欢输入类型为“local”的变量。我相信到今天为止,Busybox (一种常见的救援外壳)就是其中之一。改为使用GLOBALS_OBVIOUS,它更易于阅读,尤其是通过/bin/sh script.sh./ -x进行调试时。
我个人的偏好是让逻辑自己说话,尽量减少解析器的工作。例如,许多人可能会写道:
if [ $i = 1 ]; then
... some code
fi我只想说:
[ $i = 1 ] && {
... some code
}同样,有人可能会写道:
if [ $i -ne 1 ]; then
... some code
fi..。在那里我会:
[ $i = 1 ] || {
... some code
}我唯一一次使用传统的if / then / else是因为有一个else-if可以混用。
可以通过查看大多数使用autoconf的自由软件包中的'configure‘脚本来研究非常好的可移植shell代码的一个非常疯狂的示例。我之所以说“疯狂”,是因为它有6300行代码,适用于人类已知的每一个具有类UNIX外壳的系统。您不会想要这种臃肿,但研究内部的一些不同的可移植性hack是很有趣的。例如,对那些可能将/bin/sh指向zsh :)的用户友好一些。)
我唯一能给出的另一个建议是在这里观察你的扩展,即
cat << EOF > foo.sh
printf "%s was here" "$name"
EOF..。将扩展$name,而您可能希望保留该变量不变。通过以下方式解决此问题:
printf "%s was here" "\$name"这将使$name成为一个变量,而不是展开它。
我还强烈建议您学习如何使用陷阱来捕获信号。并将这些处理程序用作样板代码。用一个简单的SIGUSR1告诉正在运行的脚本放慢速度非常方便:)
我编写的大多数新程序(面向工具/命令行)都是从shell脚本开始的,这是制作UNIX工具原型的好方法。
您可能还喜欢SHC shell脚本编译器check it out here。
https://stackoverflow.com/questions/430078
复制相似问题