怎么正经的实现shell脚本单例运行?

系统 Linux
假设你的一个脚本已经在运行了,如果避免再次被执行呢?也就是如何实现单例运行?

假设你的一个脚本已经在运行了,如果避免再次被执行呢?也就是如何实现单例运行?

[[327604]]

看起来可行的方法

一个非常简单的思路就是,新的脚本被执行时,先检测当前脚本是否有其他实例正在运行,如果有则直接退出。

  1. runCount=$(ps -ef|grep test.sh | grep -v grep -c) 
  2. if [ "${runCount}" -ge 1 ] 
  3. then 
  4.     echo -e "test.sh already running,num:${runCount}" 
  5.     exit 1; 
  6. fi 
  7. while true 
  8. do 
  9.     echo "test.sh run" 
  10.     sleep 1 
  11. done 

这里通过ps获取到当前在运行的test.sh脚本数,如果大于1,说明已经有在运行的了。

但是你运行会发现,其程序数量不只是一个。

  1. $ ./test.sh 
  2. test.sh already running,num:2 

惊不惊喜?为什么为这样呢?原因在于,shell脚本中一个命令执行相当于fork了一个进程执行,这里执行的是查找tesh.sh并grep的程序,另外还有一个就是当前运行的脚本程序,这样的方式自然就会出现每次都有两个了。

当然判断条件这里你可以换一下,例如数量大于2,但终归不太好。

文件锁

实际上这种方法你已经在《如何让你的程序同时只有一个在运行》介绍过了,只不过之前是用于编写C/C++程序,而这里是用于shell脚本。

我们来回顾一下,这是一个怎样的过程:

  • 运行前检查是否有该锁文件,并且文件中的进程正在运行
  • 如果有并且程序正在运行,则已经有实例在运行
  • 否则,无实例,创建锁文件,写入进程id
  • 退出时,删除锁文件

解释一下第一条,为什么一定要确定锁文件中的进程正在运行,因为,有些情况下如果运行的时候退出没有删除该文件,则会导致新的实例永远无法运行。

  1. #!/usr/bin/env bash 
  2. LOCKFILE=/tmp/test.lock 
  3. if [ -e ${LOCKFILE} ] && kill -0 `cat ${LOCKFILE}`; then 
  4.     echo " $0 already running" 
  5.     exit 
  6. fi 
  7.  
  8. # 确保退出时,锁文件被删除 
  9. trap "rm -f ${LOCKFILE}; exit" INT TERM EXIT 
  10. #将当前程序进程id写入锁文件 
  11. echo $$ > ${LOCKFILE} 
  12.  
  13. # 做你需要的事情 
  14. sleep 1000 
  15.  
  16. # 删除锁文件 
  17. rm -f ${LOCKFILE} 

我们试着运行其中一个,然后另外一个窗口尝试运行:

  1. $ ./test.sh 
  2.  ./test.sh already running 

由于已经有实例在运行,发现新的程序无法运行了。而等旧的脚本运行完之后,新的就可以运行了。

实际上这里面有几个点非常巧妙:

  • kill -0 `cat \${LOCKFILE}` 这里用于检测该进程是否存在,避免进程不在了,但是锁文件还在,导致后面的脚本无法运行。
  • trap "rm -f \${LOCKFILE}; exit" INT TERM EXIT 用于确保脚本退出时,锁文件会被删除。
  • rm -f {LOCKFILE} 脚本最后需要删除锁文件

flock

说到锁文件,这里就不得不提flock命令了。没有前面的一些巧妙处理,我们很多时候会很难删除原先创建的锁文件,比如:

  • 脚本被意外中断,没来得及执行删除
  • 多个脚本产生竞争,导致判断异常,比如前面有一个脚本运行,判断没有锁文件,下一步准备创建,但是另外一个脚本又先创建了,就会导致异常了。

因此我们可以考虑使用flock:

  1. #!/usr/bin/env bash 
  2. LOCK_FILE=/tmp/test.lock 
  3. exec 99>"$LOCK_FILE" 
  4. flock -n 99 
  5. if [ "$?" != 0 ]; then 
  6.     echo "$0 already running" 
  7.     exit 1 
  8. fi 
  9. #脚本要做的其他事情 
  10. sleep 1024 

解释一下:

  • exec 99>"$LOCK_FILE" 表示创建文件描述符99,指向锁文件,为何是99?110其实也是可以的,只是为了和当前脚本可能打开的文件描述符冲突(例如和0,1,2冲突)。
  • flock -n 99 尝试对该文件描述符加锁,由操作系统保证原子性
  • 一旦flock失败了,我们这里可以退出
  • 而即使锁定了,脚本退出后,也会自动释放

因此这里避免了锁没有释放的情况。

另一种做法

查看flock的man手册,我们发现它还有一个例子是这么做的:

  1. [ "${FLOCKER}" != "$0" ] && exec env FLOCKER="$0" flock -en  "$0"  "$0"  "$@" || : 

在脚本开头加上上面这么一行就可以了。例如:

  1. #!/usr/bin/env bash 
  2. [ "${FLOCKER}" != "$0" ] && exec env FLOCKER="$0" flock -en  "$0"  "$0"  "$@" || : 
  3. #脚本要做的其他事情 
  4. sleep 1024 

解释一下:如果${FLOCKER}环境变量没有设置,则尝试将脚本本身加锁,如果加锁成功,则运行当前脚本,(并且带上原有的参数),否则的话静默退出。

总结

单例运行本身思路是很简单的,就是探测当前是否有实例在运行,如果有,则退出,但是这里如何判断,却并不是那么容易。

最后,总结一下本文出现的一些该掌握的信息:

  • $0 脚本名称
  • $@ 脚本参数
  • $$ 当前脚本进程id
  • $? 上一条命令执行结果
  • 描述符0 标准输入
  • 描述符1 标准输出
  • 描述符2 标准错误
  • > 重定向

 

责任编辑:赵宁宁 来源: 编程珠玑
相关推荐

2020-05-26 08:04:24

Shell脚本单例

2015-10-27 09:19:24

2014-08-13 14:48:01

LinuxShell脚本

2011-06-28 15:18:45

Qt 单例模式

2022-08-10 11:02:56

Python单例模式

2013-03-26 10:35:47

Objective-C单例实现

2024-03-06 13:19:19

工厂模式Python函数

2018-04-03 15:38:07

Java单例模式模式设计

2010-02-03 09:43:16

C++单例模式

2021-09-07 10:44:35

异步单例模式

2020-09-23 06:00:04

ShellLinux邮件监控

2022-08-15 08:49:06

Go版本单例模式

2024-11-06 11:38:59

C#单例模式

2024-11-06 16:13:00

Python单例模式

2023-07-31 08:45:10

Shell脚本

2017-03-13 09:42:02

彩虹合唱团戴尔造梦系列

2017-08-30 17:21:05

LinuxShell超时现象

2022-09-29 08:39:37

架构

2022-01-14 14:32:19

Shell脚本Js

2021-11-02 22:04:58

模式
点赞
收藏

51CTO技术栈公众号