launchctl定时任务

最近做个一个定时任务的golang程序，需要每10分钟运行一次，使用了launchctl，整理了一篇文章方便记忆。

一、plist文件

launchctl是根据plist文件的内容来执行任务的。

plist又根据存放的目录不同而启动的时机不同，如下：

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

以/Library/LaunchAgents为例，在/Library/LaunchAgents目录下创建com.demo.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>
  <!-- Label唯一的标识 -->
  <key>Label</key>
  <string>com.demo.plist</string>
  <!-- <key>Program</key>
  <string>/Users/xxx/go/bin/pachong</string> -->
  <!-- 指定要运行的脚本 -->
  <key>ProgramArguments</key>
  <array>
    <string>/Users/xxx/go/bin/pachong</string>
  </array>
  <!-- 指定要运行的时间 -->
  <!-- <key>StartCalendarInterval</key>
        <dict>
            <key>Minute</key>
            <integer>00</integer>

            <key>Hour</key>
            <integer>8</integer>

            <key>Day</key>
            <integer>1</integer>
        </dict> -->
  <!-- 指定要运行的时间 -->
  <key>StartInterval</key>
  <integer>600</integer>
<!-- 标准输出文件 -->
<key>StandardOutPath</key>
<string>/Users/x x x/go/src/pachong/run.log</string>
<!-- 标准错误输出文件，错误日志 -->
<key>StandardErrorPath</key>
<string>/Users/xxx/go/src/pachong/run.err</string>
</dict>
</plist>

• Label: 任务的唯一标识
• ProgramArguments： 命令语句， 第一个
• Program： 要运行的程序, 如果省略该参数，ProgramArguments的第一个数据作为运行程序
• StartInterval: 时间隔间，单位秒
• StartCalendarInterval: 运行的时间，与StartInterval只能使用其中一个
• StandardOutPath： 标准输出文件
• StandardErrorPath: 错误输出文件

启动命令

plist文件编写好之后，先加载plist文件，

launchctl load -w com.demo.plist

-w会覆盖掉plist文件中无效的部分

删除任务

launchctl unload -w com.demo.plist

开始任务

立即执行任务，即使时间没到

launchctl start  com.demo.plist

结束任务

launchctl stop   com.demo.plist

工具

推荐一款launchctl边界工具LaunchControl

• 左边可以看到脚本的状态
• 有错误时可以点击修复脚本
• 可视化编辑plist文件