Mac Launchd 介绍和使用

Fython 发布

Mac Launchd 介绍和使用

Linux 上如果想开机开机启动一个服务或者定时运行一个服务有很多的选择比如之前介绍过的Systemd或者用crontab也可以,而在 Mac 不同它有一个类似的叫 Launchd 的系统,对应使用launchctl命令控制

Daemons and Agents

Launchd 管理 Daemons 和 Agents 两种类型分别存放在不同的文件夹下,主要的区别是

  1. Agents 是用户登录后执行的
  2. Daemons 是开机后就执行,可以通过UserName指定用户比如root用户

配置文件

Launchd 配置文件以.plist结尾,本质上是xml格式的文件,Daemons 和 Agents 各存放的路径也不同

类型 路径 说明
User Agents ~/Library/LaunchAgents 用户 Agents 当前用户登录时运行
Global Agents /Library/LaunchAgents 全局 Agents 任何用户登录时都会运行
System Agents /System/Library/LaunchAgents 系统 Agents 任何用户登录时都会运行
Global Daemons /Library/LaunchDaemons 全局 Daemons 内核初始化加载完后就运行
System Daemons /System/Library/LaunchDaemons 系统 Daemons 内核初始化加载完后就运行

系统运行开机首先会加载内核启动kernel_tas(0),然后启动launchd(1)好后去启动指定好的 Daemons 最后用户登录再运行相应的 Agents 任务

一般文件名都以com.domain.programName.plist格式命名,不管是 Daemons 还是 Agents 格式都是一样的,只是存放位置不同。看下面一个 hello world 的例子 ~/Library/LaunchAgents/com.example.hello.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.example.hello</string>

    <key>ProgramArguments</key>
    <array>
        <string>/bin/echo</string>
        <string>hello world</string>
    </array>

</dict>
</plist>

上面定义了一个最简单的任务只使用了LabelProgramAgruments两个键

  • Label这是个必须的键,指定这个任务名
  • ProgramArguments是带参数的可执行文件上面等同于运行/bin/echo hello world命令,如果执行的程序不带参数可以使用Program键,但一个任务中必须包含这两个中的其中一个键

还有一些常用的键名,所有的键可参考man 5 launchd.plist或者这里

Keys Description
EnvironmentVariables 设置运行环境变量
StandardOutPath 标准输出到文件
StandardErrorPath 标准错误到文件
RunAtLoad 是否再加载的时候就运行
StartInterval 设置程序每隔多少秒运行一次
KeepAlive 是否设置程序是一直存活着 如果退出就重启
UserName 设置用户名只在 Daemons 可用
WorkingDirectory 设置工作目录

launchctl 命令

现在我们就加载和运行一个任务,上面定义了~/Library/LaunchAgents/com.example.hello.plist,我们修改一下增加一个键(StandardOutPath)用于标准输出

<?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.example.hello</string>

    <key>StandardOutPath</key>
    <string>/tmp/hello.log</string>

    <key>ProgramArguments</key>
    <array>
        <string>/bin/echo</string>
        <string>hello world</string>
    </array>

</dict>
</plist>

上面的配置把标准输出重定向到了/tmp/hello.log,我们运行测试下。检查配置文件是否写正确可以使用plutil命令

❯ plutil ~/Library/LaunchAgents/com.example.hello.plist
/Users/fython/Library/LaunchAgents/com.example.hello.plist: OK

❯ launchctl load ~/Library/LaunchAgents/com.example.hello.plist

❯ launchctl start com.example.hello

❯ cat /tmp/hello.log
hello world

❯ launchctl list | grep hello
-   0   com.example.hello

❯ launchctl remove com.example.hello  # remove jobs

一个任务首先需要被加载(load),然后启动(start)正常运行完退出,所以我们查看/tmp目录下会有日志输出

  1. 任务一般都要手动启动(start),如果设置了RunAtLoad或者KeepAlive则在launchctl load时就启动
  2. 使用launchctl list列出当前加载的任务,第一列代表进程id,因为上面的程序运行一次就退出了所以显示-,第二列是程序上次运行退出的code,0代表正常退出,如果是正数代表退出的时候是有错误的,负数代表是接收到信号被终止的
  3. launchctl stop <service_name>可以终止一个在运行中的任务,launchctl unload <path>指定路径卸载一个任务,launchctl remove <service_name>通过服务名卸载任务
  4. launchctl load <path>只会加载没有被disable的任务,可以加-w参数 launchctl load -w <path>覆盖如果设置了disable的,下次开机启动一定会起来。launchctl unload <path>只会停止和卸载这个任务,但下次启动还会加载,可以使用-w参数launchctl unload -w <path>停止任务,下次启动也不会起来,也就是标记了disable
  5. 调试一个任务可以配合使用plutil命令检查语法,设置StandardOutPathStandardErrorPathDebug键,也可以看看苹果自带的Console.app应用中的system.log

一些例子

以下是我一些使用过的配置文件

开机启动 clash 代理(TUN 模式)

文件路径:/Library/LaunchDaemons/com.fython.clash.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.fython.clash</string>

    <key>RunAtLoad</key>
    <true/>

    <key>UserName</key>
    <string>root</string>

    <key>StandardErrorPath</key>
    <string>/Users/fython/bin/clash/stderr.log</string>

    <key>StandardOutPath</key>
    <string>/Users/fython/bin/clash/stdout.log</string>

    <key>WorkingDirectory</key>
    <string>/Users/fython/bin/clash</string>

    <key>ProgramArguments</key>
    <array>
      <string>/Users/fython/bin/clash/clash</string>
      <string>-f</string>
      <string>config.yaml</string>
      <string>-d</string>
      <string>/Users/fython/bin/clash</string>
    </array>

    <key>KeepAlive</key>
    <true/>

  </dict>
</plist>

因为要监听53端口所以需要root用户启动,而且需要用户登录前就运行所以存放在/Library/LaunchDaemons/目录下,配置了KeepAliveUserName,也设置了工作目录WorkingDirectory,日志也存在这目录下。这个任务加载和其他操作都需要加sudo,sudo launchctl load /Library/LaunchDaemons/com.fython.clash.plist因为配置了RunAtLoad它会自动启动,不需要在 start 了

Reference

  1. https://www.launchd.info/
  2. https://developer.apple.com
分享

0 评论    Fython's Blog
  • 暂无评论

免登录入口