介绍

PlistBuddy是Apple提供的一个工具，用于使用bash命令在plist文件上执行操作。开发者可以在plist中添加，编辑和删除任何值。路径为/usr/libexec/PlistBuddy。

在本文中，将看到如何PlistBuddy使用，并提供了一个Xcode项目的例子。
本文译自：https://marcosantadev.com/manage-plist-files-plistbuddy/

目录

• 命令
  • 例子
• 选项
• 交互式Shell
• 与Xcode一起使用
• 结论

命令

PlistBuddy 提供了几个命令在plist文件上执行操作：

帮助

它列出了可用的命令列表，支持的值类型以及常见用法的一些示例。

退出

开发者可以使用它从Interactive Shell中退出。这些更改不会保存在plist文件中。

保存

它保存plist文件中的当前更改。

还原

它放弃当前未保存的更改并重新加载上次保存的plist文件版本。

清除[type]

它删除文件的内容，并用参数中指定的类型创建一个新的根。

打印[条目]

它打印的值entry。如果开发者不指定条目，它会打印整个文件。

设置[条目] [值]

它更新entry设置参数中指定的值。

添加[条目] [类型] [值]

它添加了具有指定类型和值的新条目。

复制[entrySrc] [entryDst]

它复制的条目entrySrc在entryDst。不能覆盖现有的entryDst值。

删除条目]

它从plist文件中删除条目。

合并[文件] [条目]

它将plist文件的内容添加到条目中。如果开发者省略参数entry，内容将被添加到文件的根目录。

导入[条目] [文件]

它设置或创建分配内容的条目file。例如，开发者可以将一个txt文件的内容复制到一个类型的条目中string。

关于类型的说明

由上我们看到一些命令有一个参数type。PlistBuddy支持以下类型：

• 字符串
• 数组
• 字典
• 布尔
• 双精度浮点型
• 整形
• 日期
• 数据

例子

• 向字典中添加mydict一个test值为整数的元素1：

     Add :mydict:test integer 1
  

• 在0数组的索引处添加myarray一个值为字符串的值Hello：

     Add :myarray:0 string Hello
  

• 删除整个数组：

     Delete :myarray
  

• 导入文件的内容并将其设置为条目myfile：

      Import  :myfile test.txt
  

选项

当运行该命令时/usr/libexec/PlistBuddy，可以使用以下选项：

-c [command]

可以使用它来运行内联命令，如：

    /usr/libexec/PlistBuddy  -c  "Add :test integer 20"  ~/Desktop/test.plist

该命令执行后将自动保存该文件。

-X

可以使用它以xml plist的形式打印plist内容：

  /usr/libexec/PlistBuddy  -x  -c  "Print"  ~/Desktop/test.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>test</key>

      <integer>20</integer>

    </dict>

    </plist>

-H

它打印完整的帮助信息。

交互式Shell

开发者可以开始学习PlistBuddy使用它的交互式shell来测试命令。

可以像这样打开交互式shell：

  /usr/libexec/PlistBuddy  ~/Desktop/test.plist

使用上面的命令，我们要求在桌面PlistBuddy上打开文件test.plist。如果文件不存在，则PlistBuddy创建它打印以下输出消息：

  File Doesn't  Exist,  Will Create:  /Users/MyUser/Desktop/test.plist

在这个例子中，~/Desktop/只是为了解释而使用路径。开发者可以使用任何有写权限的路径。

一旦打开交互式shell，应该有这样的输出：

  Command:

此时，开发者可以编写一个命令PlistBuddy并按回车来执行它。

可以用命令从交互式shell中退出exit。

与Xcode一起使用

如果有一个包含两个target的Xcode项目：

image

每个目标都有其信息plist文件（AppFree.plist和AppFull.plist）。这两个文件具有许多常用信息，例如支持的方向，启动屏幕名称等。这些plist文件的维护可能会很痛苦。如果必须添加一个新的公共值，应该将其添加到两个文件中。

有了PlistBuddy，就可以解决这个问题。开发者可以在一个新的plist文件中移动所有常见的值Base.plist：

image

然后，在Build Phases，可以添加一个新的Run Script Phase并将其移动到下面Target Dependencies：

image

这样，脚本将在编译应用程序之前执行。

在新的脚本阶段，可以将Base.plist与目标plist 合并：

  INFO_PLIST="${SRCROOT}/Plist/AppFull.plist"

  BASE_PLIST="${SRCROOT}/Plist/Base.plist"

  /usr/libexec/PlistBuddy  -c  "Merge $BASE_PLIST"  "$INFO_PLIST"

上面的例子是针对的目标plist文件是AppFull。对于AppFree，我们可以使用相同的脚本并重命名plist文件INFO_PLIST。

结论

有几个目标的项目的维护有时比较痛苦的。拥有了PlistBuddy，开发者可以减少工作量。

PlistBuddy是一个非常强大的工具，使用了这个工具也许会给开发者带来不一样的惊喜。