launchctl :MAC 下的定时任务

launchctl 是一个统一的服务管理框架,可以启动、停止和管理进程、应用程序、脚本等。
launchctl 可以通过 plist 文件来指定执行周期性任务。

查看已存在的任务

  • ~/Library/LaunchAgents :由用户自己定义的任务项
  • /Library/LaunchAgents :由管理员为用户定义的任务项
  • /Library/LaunchDaemons :由管理员定义的守护进程任务项
  • /System/Library/LaunchAgents :由Mac OS X为用户定义的任务项
  • /System/Library/LaunchDaemons :由Mac OS X定义的守护进程任务项

看下电脑中一些应用任务:


image.png
image.png

上面这些就是目前系统中,一些程序的服务。

我们随便点看查看一些其中的任务配置:

<?xml version="1.0" encoding="UTF-8"?>
    <!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN"
        "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
    <plist version="1.0">
    <dict>
        <key>Label</key>
        <string>org.getlantern</string>
        <key>ProgramArguments</key>
        <array>
        <string>/Applications/Lantern.app/Contents/MacOS/lantern</string>
        <string>-startup</string>
        </array>
        <key>RunAtLoad</key>
        <true/>
    </dict>
    </plist>

解读:

Label 对应的 org.getlantern 表示任务名称,必须唯一。
ProgramArguments 表示程序参数,数组的形式,第一个为 需要执行的程序或者脚本等,这里的 /Applications/Lantern.app/Contents/MacOS/lantern-startup 意味着打开程序 lantern
RunAtLoad 是个布尔值,表示开启自启项。

因此,该任务配置表示:设置 lantern 应用为开机自起项。

实例

下面我们举个简单的例子演示一下,这里执行一份 python 脚本,保存当前执行的时间。

首先我们需要准备需要执行的脚本任务。

#!/usr/bin/env python
# -*- coding:utf-8 -*-

import datetime

def add(path, content):
    with open(path,'a') as f:
        f.write(content + '\n')

path = '/Users/luoliang/Documents/项目/PythonProject/Test/content.txt'

now_time = "{}".format(datetime.datetime.now())
add(path, now_time)

然后我们编写 任务配置 plist 文件。

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
    <!-- 名称,要全局唯一 -->
    <key>Label</key>
    <string>com.test.task</string>
    <!-- 脚本任务 -->
    <key>Program</key>
    <string>/Users/luoliang/Documents/项目/PythonProject/Test/task.py</string>
    <!-- 运行间隔,与StartCalenderInterval使用其一,单位为秒 -->
    <key>StartInterval</key>
    <integer>30</integer>
    <!-- 错误输出 -->
    <key>StandardErrorPath</key>
    <string>/Users/luoliang/Desktop/errorlog</string>
</dict>
</plist>

最后,我们需要将任务配置放到任务目录中,(这里建议在:~/Library/LaunchAgents )然后启动任务。

开启终端,进入到对应任务配置目录:

// 加载任务
$ launchctl load com.test.task.plist   // 进入该目录后执行

查看任务是否添加:

// 查看任务列表
$ launchctl list 
image.png

这样,我们的脚本就可以按照指定时刻被系统执行了。

我们检查一下脚本输出目录文件:

image.png

上图可以看出,脚本正在以每30秒的间隔不断的被执行。两次执行的时间在1秒内。

launchctl 的一些命令:

// 加载任务
$ launchctl load com.test.task.plist

// 删除任务
$ launchctl unload com.test.task.plist

// 查看任务列表, 使用 grep '任务部分名字' 过滤
$ launchctl list | grep 'com.test.task.plist'

// 开始
$ launchctl start com.test.task.plist

// 停止
$ launchctl stop com.test.task.plist

plist 文件的字段说明

<?xml version="1.0" encoding="UTF-8"?>  
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">  
<plist version="1.0">  
  <dict>
    <!-- 名称,要全局唯一 -->
    <key>Label</key>
    <string>com.uniflor.notifier</string>

    <!-- 要运行的程序, 如果省略这个选项,会把ProgramArguments的第一个
    元素作为要运行的程序 -->
    <key>Program</key>
    <string>/Users/uniflor/script.sh</string>

    <!-- 命令, 第一个为命令,其它为参数-->
    <key>ProgramArguments</key>
    <array>
      <string>/Users/uniflor/script.sh</string>
    </array>

    <!-- 运行时间 -->
    <key>StartCalendarInterval</key>
    <dict>

      <key>Minute</key>
      <integer>30</integer>

      <key>Hour</key>
      <integer>9</integer>

      <key>Day</key>
      <integer>1</integer>

      <key>Month</key>
      <integer>5</integer>

      <!-- 0和7都指星期天 -->
      <key>Weekday</key>
      <integer>0</integer>

    </dict>

    <!-- 运行间隔,与StartCalenderInterval使用其一,单位为秒 -->
    <key>StartInterval</key>
    <integer>30</integer>

    <!-- 标准输入文件 -->
    <key>StandardInPath</key>
    <string>/Users/uniflor/run-in.log</string>

    <!-- 标准输出文件 -->
    <key>StandardOutPath</key>
    <string>/Users/uniflor/Bin/run-out.log</string>

    <!-- 标准错误输出文件 -->
    <key>StandardErrorPath</key>
    <string>/Users/uniflor/Bin/run-err.log</string>

  </dict>  
</plist>

1、Label:对应的需要保证全局唯一性;
2、Program:要运行的程序;
3、ProgramArguments:命令语句
4、StartCalendarInterval:运行的时间,单个时间点使用dict,多个时间点使用 array <dict>
5、StartInterval:时间间隔,与StartCalendarInterval使用其一,单位为秒

6、StandardInPath、StandardOutPath、StandardErrorPath:标准的输入输出错误文件,这里建议不要使用 .log 作为后缀,会打不开里面的信息。

补充说明

1、权限问题。

有时候,脚本需要改成可执行的权限,例如:

$ chmod 777 task.py

2、脚本需正常编译

在上述的例子中,python脚本文件最开始的部分有两行说明:

#!/usr/bin/env python           // 声明编译环境,即指定编译器
# -*- coding:utf-8 -*-              // 编码问题

如果你的脚本本身就无法编译通过,更不要说系统去执行了。

如果你的也是python脚本,并且脚本文件本身在项目中,有时候爆出找不到自身目录的错误,那么请保证上面的声明之后,将你的目录移至到 site-packages 中去。

另外,如果你的电脑中存在多个版本的编译器,请将 #!/usr/bin/env python 替换为脚本对应的编译器的绝对路径,否则会出现因编译器版本产生的语法错误。

3、验证脚本的正确性

你可以将执行时间设置为较近的时间,也可以使用下面语句直接执行一次脚本:

// 开始
$ launchctl start com.test.task.plist

参考

1、Mac中的定时任务利器:launchctl

2、Mac使用Launchd命令行lauchctl操作服务的简单用法

3、mac使用launchctl定时运行程序

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 158,233评论 4 360
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,013评论 1 291
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 108,030评论 0 241
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,827评论 0 204
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,221评论 3 286
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,542评论 1 216
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,814评论 2 312
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,513评论 0 198
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,225评论 1 241
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,497评论 2 244
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,998评论 1 258
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,342评论 2 253
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,986评论 3 235
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,055评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,812评论 0 194
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,560评论 2 271
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,461评论 2 266

推荐阅读更多精彩内容