如何读懂和编辑 Plist 文件
最后更新:
所谓读懂和编辑 plist 文件,就是在和苹果的配置格式打交道——那些安静地驱动着 macOS 与 iOS 的键值文件。每个应用都带一个 Info.plist,每个定时后台任务都是一个 launchd plist,每个 provisioning profile 和每个 .mobileconfig 设备描述文件,底下都是 plist。格式本身很简单:字典、数组、字符串、数字、布尔值、日期和二进制数据,可以任意嵌套。麻烦出在同一个格式有两种外衣——人类可读的 XML,和在文本编辑器里看起来像乱码的紧凑二进制——还出在一个错误的类型就能悄悄让任务永远不运行。你可以把任何 plist 粘贴进Plist 工作台,在浏览器里读取、编辑、转换和校验——什么都不上传——但本文教你自己读这些文件,这样那棵树对你来说就永远不是黑盒。
什么是 plist——以及它穿的四套衣服
Property list(属性列表,简称 plist)是苹果存储结构化配置的方式:一棵由字典和数组组成的树,叶子是字符串、整数、实数、布尔值、日期和二进制数据块。它和 JSON 对象或 YAML 文件是同一个思路,只不过在苹果平台上出现得更早,而且已经 baked into 操作系统——macOS 和 iOS 无时无刻不在读 plist,从来不用问你。如果你曾经好奇某个应用把 bundle ID、版本号或它申请的权限存在哪里,答案就是 plist,而且它一直明摆在那里。
同一个格式出现在四个看似无关的地方,诀窍一旦点破就很清楚。每个应用包里面,Info.plist 声明应用的身份:bundle ID、版本号、支持的文档类型、申请的权限。在 ~/Library/LaunchAgents 和 /Library/LaunchDaemons 里,launchd 任务文件描述后台任务——运行什么、什么时候运行、在什么条件下运行。一个 .mobileprovision 描述文件是一个 plist(外面裹着一层 CMS 签名),列出应用可以用哪些设备和权限。而一个 .mobileconfig 设备描述文件也是一个 plist,描述要装到设备上的 Wi-Fi、VPN、证书和限制。同一个格式,四套衣服——学会读一种,四种都会读。
二进制 vs XML:bplist00 魔数,以及为什么绝不能手工编辑二进制 plist
Plist 有两种序列化形式。XML 形式以 <?xml 和 <plist version="1.0"> 开头,在任何文本编辑器里都能读:键在 <key> 标签里,值在 <string>、<integer>、<true/>、<array> 和 <dict> 里。二进制形式是一种紧凑编码,以 8 个魔数字节 bplist00 开头,后面跟着对象表、偏移表和记录所有内容位置的尾部。二进制 plist 更小、系统加载更快,所以一台真 Mac 上的大多数 plist 都是二进制的——这也是在文本编辑器里打开它只会看到乱码的原因。
怎么分辨手里的是哪一种:看文件开头的字节。bplist00 是二进制;<?xml 或 <plist 是 XML。而下面这条规则能救你的文件:永远不要手工编辑二进制字节。二进制 plist 是一张偏移量的网——把一个字符串改长一点,它后面的所有偏移量就全错了,尾部再也对不上表,文件就此损坏,尽管你改的那段文字看起来没问题。安全路径永远是同一条:把二进制转成 XML、编辑 XML、再转回二进制,然后重新解析一次结果,证明它仍然有效。在 Mac 上就是 plutil -convert xml1 和 plutil -convert binary1;在浏览器里,Plist 工作台替你做同样的往返转换。
手工读一个 launchd 任务:Label、ProgramArguments、RunAtLoad、KeepAlive、StartCalendarInterval
一个 launchd 任务就是一个词汇量很小的 plist,认得那几个键,一分钟就能读完。Label 是任务的唯一名字,按惯例是反向域名,比如 com.example.backup——launchd 靠它识别任务,两个同名任务会冲突。ProgramArguments 是一个字符串数组:要运行的程序,后面跟它的参数,所以 ["/usr/local/bin/backup.sh"] 就是不带参数运行那个脚本。RunAtLoad 是布尔值:true 表示任务一加载就运行一次。KeepAlive 同样是布尔值:表示它一退出就重启。这四个键描述了你会遇到的大多数任务。
调度用的键是 StartCalendarInterval,一个由日历字段组成的字典——Minute、Hour、Day、Weekday、Month,哪个都可以省略,所以 {Hour: 3, Minute: 30} 就是每天 03:30 运行。它的简单版 StartInterval 是一个整数:每 N 秒运行一次。下面代码块里的示例就是一个这种形态的完整可用任务——Label、ProgramArguments、RunAtLoad、StartCalendarInterval——值得逐行读一遍,因为你遇到的每个 launchd 任务都是它的变体:同样的键,不同的值,偶尔多个 WorkingDirectory 或 StandardOutPath 之类的附加项,说明输出写到哪里。
弄坏东西的键:类型错误、容器用错、数字越界
大多数坏掉的 launchd 任务不是被拼写错误弄坏的,而是被类型弄坏的。launchd 要求 ProgramArguments 是一个字符串数组;给它一个单独的字符串,任务就加载失败,而报错信息少得可怜。KeepAlive、RunAtLoad 和 Disabled 必须是布尔值,而不是拼成 "true" 和 "false" 的字符串——一个拼出 "true" 的字符串不是 true,launchd 会把它当作类型错误。StartInterval 必须是正整数;0 或负数毫无意义,会被拒绝。这些错误文本编辑器永远发现不了,因为 XML 本身格式完美——错的只是含义。
第二类损坏是数字超出范围。在 StartCalendarInterval 里,Minute 必须是 0–59,Hour 0–23,Weekday 0–7,Day 1–31,Month 1–12——Hour 写成 25 不是“明天凌晨 1 点”,而是这个任务永远不运行,而且 launchd 未必告诉你为什么。第三类是不能同时出现的成对键:Program 和 ProgramArguments 是两种说法说同一件事,同时给就是含糊不清——选一个,优先用苹果文档里的 ProgramArguments。一个能检查类型、范围和这类冲突的校验器,能在任务到达 launchd 之前就抓住这三类错误,而这正是工作台的 launchd 检查所做的事。
安全编辑:备份、转换、编辑、转回去、验证
安全的 plist 编辑是一套五步仪式,而且顺序很重要。第一步,备份原文件——动手之前先把它复制到别处,因为 launchd 任务或设备描述文件没有撤销按钮。第二步,如果文件是二进制的,把它转成 XML;绝不要直接编辑二进制字节,原因见上文。第三步,在 XML 里做编辑:改一个值、重命名一个键、加一个数组项——并且保持类型正确,字符串待在字符串的位置,数组待在数组的位置。第四步,如果原来是二进制的,再转回二进制,让文件以系统期望的形态回去。
第五步,也是最常被跳过的一步:重新解析验证。对结果跑一遍 plutil -lint,或者粘贴进工作台看它干净地解析出来——如果文件能重新解析,而且解析出来的值就是你想要的值,编辑就成功了。如果解析失败,第一步的备份还在,而且磁盘上的文件从一开始就没被编辑器碰过:工作台在内存里的副本上编辑,只有当你明确导出时才会写文件。最后这一点正是浏览器内编辑的全部意义——在你确认新版本没问题之前,原文件保持完好。
Plist 工作台能做什么——以及不能做什么
工作台能解析两种形态的 plist——二进制 bplist00 和 XML——解析成一棵可以展开的树,你可以按路径搜索(比如 StartCalendarInterval.Hour),还可以就地编辑:改一个标量、重命名键、增删键和数组项,以及在含义明确时改一个值的类型。每种导出——XML plist、二进制 plist、JSON,或展平后的路径表 CSV——反映的都是编辑后的模型,而不是原文件。当 plist 看起来像个 launchd 任务时,它会跑上一节说的语义检查:Label 在不在、Program 和 ProgramArguments 是不是恰好出现一个、日历字段在不在范围内、布尔值是不是真的布尔值。全部工作就是这些,而且全在你的浏览器里发生:文件永远不离开你的设备。
它不能做什么,同样重要。它不安装任何东西——不会把你的任务加载进 launchd,不会在设备上安装 .mobileconfig,也不会给应用做 provisioning;那些是系统动作,一个网页不该替你执行。它不对照苹果校验代码签名或 provisioning 权限,所以一个编辑过的 .mobileprovision 可能解析得完美无缺,却因为签名对不上而被系统拒绝——能解析不等于可信任。它也不运行 plist 里的任何东西:一个指向脚本的 launchd 任务,在 launchd 执行它之前只是数据,工作台也只把它当作数据对待。安卓的对应物——APK 里的清单——请用APK 分析器;launchd 在 Linux 上的表亲 systemd unit,请用systemd 单元审计器。
自己试试:一个可以读、可以转换、可以验证的 launchd 任务
# A minimal launchd job, as XML — the form you can read and edit safely
<?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.backup</string>
<key>ProgramArguments</key>
<array>
<string>/usr/local/bin/backup.sh</string>
</array>
<key>RunAtLoad</key>
<true/>
<key>StartCalendarInterval</key>
<dict>
<key>Hour</key>
<integer>3</integer>
<key>Minute</key>
<integer>30</integer>
</dict>
</dict>
</plist>
# Convert between the two forms on a Mac — never edit the binary bytes:
$ plutil -convert xml1 job.plist # binary -> readable XML
$ plutil -convert binary1 job.plist # XML -> compact binary, for shipping
$ plutil -lint job.plist # re-parse to verify it is still valid