Xcodeproj: 使用 ruby 自由的修改Xcode 工程文件

我们的 App 最近要处理一个事情, 就是往里面添加 unity, 但是 unity 项目和 主项目又是分开的, 所以当每次 unity 开发人员把导出的文件抛给我们的时候, 我们需要手动的修改代码层级, 这是我自己不能忍受的, 所以我决定使用脚本来帮助我完成这件事情.

但是一直以来, 不依靠 XCode 来修改或者创建 iOS 工程一直是一个大问题, 一些解决方案是创建一个模板工程,然后在使用的时候再去下载这个工程, 之后只需要修改某几个字段就好了.

但是,我又想到了 cocoapods, 想到了大神写的 pbxprojHelper, 认为肯定已经存在轮子来帮助我完成这个任务, 于是, 我最终找到了 Xcodeproj, 一个 CocoaPods 官方提供的用于修改 xcode 工程文件的 ruby 类库

那还费什么话, 开搞 ! !

我做的脚本

由于之前发现了一篇博客, 解决的事情与我的类似, 所以我大规模的借鉴了他的代码,然后根据自己的需求进行了修改, 原文请查看参考资料的链接

首先, 如果我要更新 group, 那么我要做的第一件事情当然是找到这个 group

require 'xcodeproj'

project_path = File.join(File.dirname(__FILE__), "./GiftAR.xcodeproj")
project = Xcodeproj::Project.open(project_path)
target = project.targets.first

unityClassGroup = project.main_group.find_subpath(File.join('GiftAR', 'Unity', 'Classes'), true)
unityClassGroup.set_source_tree('')
unityClassGroup.set_path('../../unity-ios-build/Classes')

1. 通过路径 project_path 获取到了解析好的对象 project
2. 然后 通过这个 project 获取到相应的 target 和 unityClassGroup, 这里的 target 为了修改之后的工程配置而预备的, unityClassGroup 就是我们要操作的文件夹
3. 之后我们给 unityClassGroup 设置两个属性, 其中 source_tree 代表 The directory to which the path is relative. 文件夹与路径的关系, 而 path 则代表文件夹的具体路径, 这里我们的 unity 代码不在工程内部所以我们引用了一个其他位置的路径

这里是不同 source_tree 的一些具体含义
Note: The accepted values are:
for absolute paths
for paths relative to the group
SOURCE_ROOT for paths relative to the project
DEVELOPER_DIR for paths relative to the developer directory.
BUILT_PRODUCTS_DIR for paths relative to the build products directory.
SDKROOT for paths relative to the SDK directory.
~~~
其实对应到 Xcode 中, 就是下面这个位置

Paste_Image.png

那么之后我要做的事情就是清除之前的引用, 下面这段代码是从别人那里直接拿过来用的,
主要视为了介绍的连贯性, 不得不如此, 请见谅.

...
if !unityClassGroup.empty? then
    removeBuildPhaseFilesRecursively(target, unityClassGroup)
    unityClassGroup.clear()
end
...
def removeBuildPhaseFilesRecursively(aTarget, aGroup)
  aGroup.files.each do |file|
      if file.real_path.to_s.end_with?(".m", ".mm", ".cpp") then
          aTarget.source_build_phase.remove_file_reference(file)
      elsif file.real_path.to_s.end_with?(".plist") then
          aTarget.resources_build_phase.remove_file_reference(file)
      end
  end
  
  aGroup.groups.each do |group|
      removeBuildPhaseFilesRecursively(aTarget, group)
  end
end

这一段的意思是, 去清空原有 group 的所有引用, group 提供的清除单个引用的方法, 但是每次只能清除一条, 还好 group 也提供了 clear 方法.
但是只是清除 group 的引用还是不够的 我们还需要去掉 target 对 group 内原有资源的引用, 这个就对应到了 removeBuildPhaseFilesRecursively 方法上

...
addFilesToGroup(project, target, unityClassGroup)
project.save
...
def addFilesToGroup(project, aTarget, aGroup)
  Dir.foreach(aGroup.real_path) do |entry|
      filePath = File.join(aGroup.real_path, entry)

      # 过滤目录和.DS_Store文件
      if !File.directory?(filePath) && entry != ".DS_Store" then

          # 特殊逻辑
          ...

          # 向group中增加文件引用
          fileReference = aGroup.new_reference(filePath)
          # 如果不是头文件则继续增加到Build Phase中，PB文件需要加编译标志
          if filePath.to_s.end_with?("pbobjc.m", "pbobjc.mm") then
              aTarget.add_file_references([fileReference], '-fno-objc-arc')
          elsif filePath.to_s.end_with?(".m", ".mm", ".cpp") then
              aTarget.source_build_phase.add_file_reference(fileReference, true)
          elsif filePath.to_s.end_with?(".plist") then
              aTarget.resources_build_phase.add_file_reference(fileReference, true)
          end
      # 目录情况下, 递归添加
      elsif File.directory?(filePath) && entry != '.' && entry != '..' then
        hierarchy_path = aGroup.hierarchy_path[1, aGroup.hierarchy_path.length] 
        subGroup = project.main_group.find_subpath(hierarchy_path + '/' + entry, true)
        subGroup.set_source_tree(aGroup.source_tree)
        subGroup.set_path(aGroup.real_path + entry)
        addFilesToGroup(project, aTarget, subGroup)
      end
  end
end

之后就我们要做的最后一步, 把之前的操作反过来再做一遍, 然后调用 save 方法保存 target
这里值得注意的是在处理多文件夹层级递归的时候, 我们需要生成新的对应的 group ,这里用到了 group 对象的几种不同的 path, 需要选择合适的属性加以利用.

到这里,我的所有脚本就全都说完了,很少,但是帮助了我很多.

xcodeproj 工程文件原理

但是我们不能仅仅限于使用别人的轮子, 也要学习原理, 我看了 使用代码为 Xcode 工程添加文件, 学习很多
我打开了我们工程的配置文件, 就是一个超级大的 hash 字典, 根节点有五个 archiveVersion, classes, objectVersion, objects, rootobject
其中 objects 是最重要的一个, 里面的每个子节点对应的就是一个个不同的配置文件, 他们每一个配置所对应的 key, 都是一个唯一的 UUID, 而 rootobjects 指向的就是这么一个 UUID
其中配置之前都有一段注释来解释配置的作用, 在配置内部也同样拥有一个 isa 字段来表示这个配置的类型, 那么我就直接无耻的搬运一下前辈们已经总结好的类型, 不完全统计,大概有如下一些类型

PBXBuildFile
PBXBuildPhase
PBXAppleScriptBuildPhase
PBXCopyFilesBuildPhase
PBXFrameworksBuildPhase
PBXHeadersBuildPhase
PBXResourcesBuildPhase
PBXShellScriptBuildPhase
PBXSourcesBuildPhase
PBXContainerItemProxy
PBXFileElement
PBXFileReference
PBXGroup
PBXVariantGroup
PBXTarget
PBXAggregateTarget
PBXLegacyTarget
PBXNativeTarget
PBXProject
PBXTargetDependency
XCBuildConfiguration
XCConfigurationList

参考资料

2. xcodeproj 文档
3. 懒人福利：用脚本来修改Xcode工程
4. Let's Talk About project.pbxproj
5. Rake: 一种使用 Ruby 编写的构建语言(类似 Make)