Mac中的定时任务利器：launchctl

缺乏、安全感 2023-06-16 10:52 1阅读 0赞

# Mac中的定时任务利器：launchctl #

> 本文转载自[Mac中的定时任务利器：launchctl][Mac_launchctl]

## 简介 ##

> `launchctl`是一个统一的服务管理框架，可以启动、停止和管理守护进程、应用程序、进程和脚本等。  
> `launchctl`是通过配置文件来指定执行周期和任务的。  
> 当然`mac`也可以像`linux`系统一样，使用`crontab`命令来添加定时任务，这里就不赘述，具体可参见：[OS X 添加定时任务][OS X]  
> 下面将手把手教你在`mac`上创建定时任务。（任务目标：每天晚上十点定时执行/Users/demo/helloworld.py的python程序）

## 1. 创建run.sh脚本 ##

#### 进入 `helloworld.py`程序所在目录 ####

cd /User/demo

#### 创建run.sh脚本 ####

vi run.sh

#### 添加执行`helloworld.py`的命令 ####

#!/bin/sh
    ### 记录一下开始时间
    echo `date` >> /Users/demo/log &&
    ### 进入helloworld.py程序所在目录
    cd /Users/demo &&
    ### 执行python脚本（注意前面要指定python运行环境/usr/bin/python，根据自己的情况改变）
    /usr/bin/python helloworld.py
    ### 运行完成
    echo 'finish' >> /Users/demo/log

`:wq`保存退出~~~~  
注意，脚本要改成可执行的权限

chmod 777 run.sh

## 2. 编写`plist`文件 ##

`launchctl` 将根据`plist`文件的信息来启动任务。

### plist脚本一般存放在以下目录： ###

*  /Library/LaunchDaemons -->只要系统启动了，哪怕用户不登陆系统也会被执行
 *  /Library/LaunchAgents -->当用户登陆系统后才会被执行

### 更多的plist存放目录： ###

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

### 进入~/Library/LaunchAgents，创建一个plist文件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>
      
      <key>Label</key>
      <string>com.demo.plist</string>
      
      <key>ProgramArguments</key>
      <array>
        <string>/Users/demo/run.sh</string>
      </array>
      
      <key>StartCalendarInterval</key>
      <dict>
            <key>Minute</key>
            <integer>00</integer>
            <key>Hour</key>
            <integer>22</integer>
      </dict>
    
    <key>StandardOutPath</key>
    <string>/Users/demo/run.log</string>
    
    <key>StandardErrorPath</key>
    <string>/Users/demo/run.err</string>
    </dict>
    </plist>

## 3. 加载命令 ##

launchctl load -w com.demo.plist

这样任务就加载成功了。

### 更多的命令： ###

加载任务, -w选项会将plist文件中无效的key覆盖掉，建议加上

$ launchctl load -w com.demo.plist

#### 删除任务 ####

$ launchctl unload -w com.demo.plist

#### 查看任务列表, 使用 grep ‘任务部分名字’ 过滤 ####

$ launchctl list | grep 'com.demo'

#### 开始任务 ####

$ launchctl start  com.demo.plist

#### 结束任务 ####

$ launchctl stop   com.demo.plist

> 如果任务呗修改了，那么必须先unload，然后重新load  
> start可以测试任务，这个是立即执行，不管时间到了没有  
> 执行start和unload前，任务必须先load过，否则报错  
> stop可以停止任务

## 番外篇 ##

`plist`支持两种方式配置执行时间：

*  `StartInterval`: 指定脚本每间隔多长时间（单位：秒）执行一次；
 *  `StartCalendarInterval`: 可以指定脚本在多少分钟、小时、天、星期几、月时间上执行，类似如crontab的中的设置，包含下面的 key:
 *  `Minute <integer>` : The minute on which this job will be run.
 *  `Hour <integer>`: The hour on which this job will be run.
 *  `Day <integer>`: The day on which this job will be run.
 *  `Weekday <integer>`: The weekday on which this job will be run (0 and 7 are Sunday).
 *  `Month <integer>`: The month on which this job will be run.

### plist部分参数说明： ###

1.  `Label`：对应的需要保证全局唯一性；
2.  `Program`：要运行的程序；
3.  `ProgramArguments`：命令语句
4.  `StartCalendarInterval`：运行的时间，单个时间点使用dict，多个时间点使用 `array <dict>`
5.  `StartInterval`：时间间隔，与`StartCalendarInterval`使用其一，单位为秒
6.  `StandardInPath`、`StandardOutPath`、`StandardErrorPath`：标准的输入输出错误文件，这里建议不要使用 `.log` 作为后缀，会打不开里面的信息。
7.  定时启动任务时，如果涉及到网络，但是电脑处于睡眠状态，是执行不了的，这个时候，可以定时的启动屏幕就好了。

[Mac_launchctl]: https://www.jianshu.com/p/4addd9b455f2
[OS X]: http://codingpub.github.io/2016/10/27/OS-X-%E6%B7%BB%E5%8A%A0%E5%AE%9A%E6%97%B6%E4%BB%BB%E5%8A%A1/