其实Shell脚本可以更好

76次阅读

共计 2113 个字符，预计需要花费 6 分钟才能阅读完成。

今天介绍使用的两个方法，提高脚本的可读性和健壮性，帮助写出更好的脚本。
其实 Shell 脚本可以更好

一、vim 自动添加头部注释信息

使用 vim 的自动命令 (autocmd)，在新建 sh 文件时添加头部的注释信息。在.vimrc 中配置以后，使用 vim 操作文件的时候就会自动执行一些命令。

在用户 home 目录下新建.vimrc 文件，写入下面的内容，在使用 vim 新建.sh 文件时就会执行函数 SetTitle()，将头部注释信息写入到新建的.sh 文件，这在编写脚本时十分方便。

最后一行的：autocmd BufNewFile * normal G 的作用是自动将光标定位到末尾，也方便直接插入即可，不必移动光标来编写。autocmd 为所有新建文件都添加头部注释信息，但是对于.sh .py 程序会添加 #! 有引用解释器，当然你也可以根据你的程序来 elseif 其他的解释器。

autocmd BufNewFile * exec ":call SetTitle()"

func SetTitle()

if expand("%:e") == 'sh'

    call setline(1,"#!/usr/bin/bash")

elseif expand("%:e") == 'py'

    call setline(1,"#!/usr/bin/python")

endif

call setline(2,"#")

call setline(3,"#********************************************************************")

call setline(4,"#Author:            *")

call setline(5,"#Email：*@163.com")

call setline(6,"#Date：".strftime("%Y-%m-%d"))

call setline(7,"#FileName：".expand("%"))

call setline(8,"#Description：The purpose of the script")

call setline(9,"#Copyright (C)：".strftime("%Y")."All rights reserved")

call setline(10,"#********************************************************************")

call setline(11,"#")

call setline(12,"")

endfunc

autocmd BufNewFile * normal G

vim 的 autocmd 的功能十分强大。Vim 为 78 个不同的编辑事件提供通知，这些事件分为八大类：会话启动和清理事件、文件阅读事件、文件编写事件、缓冲更改事件、选项设置事件、窗口相关事件、用户 - 互动事件和异步通知。可以在命令行中输入 vim 后，输入:help autocmd-events 来查看 vim 中的 autocmd 的事件的帮助信息。

其实 Shell 脚本可以更好

二、ShellCheck 检查脚本

ShellCheck 是一款实用的 shell 脚本静态检查工具。可以使用在线的检查地址，https://www.shellcheck.net/，进入网址贴上你的脚本运行检查即可使用。也可以本地安装，推荐后者，命令行中调用 shellcheck yourscript 即可。

拿笔者以前犯错的脚本来测试一下，以前肉眼可找了好久的问题，缺少一个空格！

其实 Shell 脚本可以更好

修改后，再次运行，针对不够完善不够健壮的写法，提供建议。

1、Use $(..) instead of legacy `..`，使用 $() 代替 ` `；

2、Consider using pgrep instead of grepping ps output，直接使用 pgrep 来代替 ps 和 grep 的结合查找进程；

3、Double quote to prevent globbing and word splitting. Quote this to prevent word splitting. 加上引号或者双引号。

其实 Shell 脚本可以更好

可以在 VS Code 中安装插件 ShellCheck，直接在编辑器中查看 ShellCheck 建议，以最快速度发现并修复问题。在 VS Code 中可以实时检查脚本的错误和修改建议，特别是在 windows 下编写时可能换行符是 CRLF，ShellCheck 会提示换成 LF。

其实 Shell 脚本可以更好

同时，在 ShellCheck 安装方面遇到一个问题，在基于 debian 的系统直接 apt 可以搜索安装到，但是基于红帽的系统即使安装了第三方的 epel-release 以后仍然找不到 ShellCheck 的 rpm 包。在 koalaman/shellcheck: ShellCheck, a static analysis tool for shell scripts (github.com) 上有直接使用容器来操作，可以选择 shellcheck 或者带有 Alpine 系统的 shellcheck。但是笔者觉得下载 github 里面的预编二进制文件直接在本地使用比较好。

其实 Shell 脚本可以更好