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

我們的 App 最近要處理一個(gè)事情, 就是往里面添加 unity, 但是 unity 項(xiàng)目和 主項(xiàng)目又是分開的, 所以當(dāng)每次 unity 開發(fā)人員把導(dǎo)出的文件拋給我們的時(shí)候, 我們需要手動(dòng)的修改代碼層級(jí), 這是我自己不能忍受的, 所以我決定使用腳本來幫助我完成這件事情.

但是一直以來, 不依靠 XCode 來修改或者創(chuàng)建 iOS 工程一直是一個(gè)大問題, 一些解決方案是創(chuàng)建一個(gè)模板工程,然后在使用的時(shí)候再去下載這個(gè)工程, 之后只需要修改某幾個(gè)字段就好了.

但是,我又想到了 cocoapods, 想到了大神寫的 pbxprojHelper, 認(rèn)為肯定已經(jīng)存在輪子來幫助我完成這個(gè)任務(wù), 于是, 我最終找到了 Xcodeproj, 一個(gè) CocoaPods 官方提供的用于修改 xcode 工程文件的 ruby 類庫(kù)

那還費(fèi)什么話, 開搞 ! !

我做的腳本

由于之前發(fā)現(xiàn)了一篇博客, 解決的事情與我的類似, 所以我大規(guī)模的借鑒了他的代碼,然后根據(jù)自己的需求進(jìn)行了修改, 原文請(qǐng)查看參考資料的鏈接

首先, 如果我要更新 group, 那么我要做的第一件事情當(dāng)然是找到這個(gè) 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('<group>')
unityClassGroup.set_path('../../unity-ios-build/Classes')
  1. 通過路徑 project_path 獲取到了解析好的對(duì)象 project
  2. 然后 通過這個(gè) project 獲取到相應(yīng)的 target 和 unityClassGroup, 這里的 target 為了修改之后的工程配置而預(yù)備的, unityClassGroup 就是我們要操作的文件夾
  3. 之后我們給 unityClassGroup 設(shè)置兩個(gè)屬性, 其中 source_tree 代表 The directory to which the path is relative. 文件夾與路徑的關(guān)系, 而 path 則代表文件夾的具體路徑, 這里我們的 unity 代碼不在工程內(nèi)部所以我們引用了一個(gè)其他位置的路徑

這里是不同 source_tree 的一些具體含義
Note: The accepted values are:
<absolute> for absolute paths
<group> 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.
~~~
其實(shí)對(duì)應(yīng)到 Xcode 中, 就是下面這個(gè)位置

Paste_Image.png

那么之后我要做的事情就是清除之前的引用, 下面這段代碼是從別人那里直接拿過來用的,
主要視為了介紹的連貫性, 不得不如此, 請(qǐng)見諒.

...
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 提供的清除單個(gè)引用的方法, 但是每次只能清除一條, 還好 group 也提供了 clear 方法.
但是只是清除 group 的引用還是不夠的 我們還需要去掉 target 對(duì) group 內(nèi)原有資源的引用, 這個(gè)就對(duì)應(yīng)到了 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)
          # 如果不是頭文件則繼續(xù)增加到Build Phase中,PB文件需要加編譯標(biāo)志
          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

之后就我們要做的最后一步, 把之前的操作反過來再做一遍, 然后調(diào)用 save 方法保存 target
這里值得注意的是在處理多文件夾層級(jí)遞歸的時(shí)候, 我們需要生成新的對(duì)應(yīng)的 group ,這里用到了 group 對(duì)象的幾種不同的 path, 需要選擇合適的屬性加以利用.

到這里,我的所有腳本就全都說完了,很少,但是幫助了我很多.

xcodeproj 工程文件原理

但是我們不能僅僅限于使用別人的輪子, 也要學(xué)習(xí)原理, 我看了 使用代碼為 Xcode 工程添加文件, 學(xué)習(xí)很多
我打開了我們工程的配置文件, 就是一個(gè)超級(jí)大的 hash 字典, 根節(jié)點(diǎn)有五個(gè) archiveVersion, classes, objectVersion, objects, rootobject
其中 objects 是最重要的一個(gè), 里面的每個(gè)子節(jié)點(diǎn)對(duì)應(yīng)的就是一個(gè)個(gè)不同的配置文件, 他們每一個(gè)配置所對(duì)應(yīng)的 key, 都是一個(gè)唯一的 UUID, 而 rootobjects 指向的就是這么一個(gè) UUID
其中配置之前都有一段注釋來解釋配置的作用, 在配置內(nèi)部也同樣擁有一個(gè) isa 字段來表示這個(gè)配置的類型, 那么我就直接無恥的搬運(yùn)一下前輩們已經(jīng)總結(jié)好的類型, 不完全統(tǒng)計(jì),大概有如下一些類型

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

參考資料

  1. xcodeproj 文檔
  2. 懶人福利:用腳本來修改Xcode工程
  3. Let's Talk About project.pbxproj
  4. Rake: 一種使用 Ruby 編寫的構(gòu)建語(yǔ)言(類似 Make)
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子德绿,更是在濱河造成了極大的恐慌,老刑警劉巖王浴,帶你破解...
    沈念sama閱讀 217,406評(píng)論 6 503
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件脆炎,死亡現(xiàn)場(chǎng)離奇詭異,居然都是意外死亡氓辣,警方通過查閱死者的電腦和手機(jī)秒裕,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,732評(píng)論 3 393
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來钞啸,“玉大人几蜻,你說我怎么就攤上這事喇潘。” “怎么了梭稚?”我有些...
    開封第一講書人閱讀 163,711評(píng)論 0 353
  • 文/不壞的土叔 我叫張陵颖低,是天一觀的道長(zhǎng)。 經(jīng)常有香客問我弧烤,道長(zhǎng)忱屑,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 58,380評(píng)論 1 293
  • 正文 為了忘掉前任暇昂,我火速辦了婚禮莺戒,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘急波。我一直安慰自己从铲,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,432評(píng)論 6 392
  • 文/花漫 我一把揭開白布澄暮。 她就那樣靜靜地躺著名段,像睡著了一般。 火紅的嫁衣襯著肌膚如雪泣懊。 梳的紋絲不亂的頭發(fā)上伸辟,一...
    開封第一講書人閱讀 51,301評(píng)論 1 301
  • 那天,我揣著相機(jī)與錄音嗅定,去河邊找鬼自娩。 笑死,一個(gè)胖子當(dāng)著我的面吹牛渠退,可吹牛的內(nèi)容都是我干的忙迁。 我是一名探鬼主播,決...
    沈念sama閱讀 40,145評(píng)論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼碎乃,長(zhǎng)吁一口氣:“原來是場(chǎng)噩夢(mèng)啊……” “哼姊扔!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起梅誓,我...
    開封第一講書人閱讀 39,008評(píng)論 0 276
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤恰梢,失蹤者是張志新(化名)和其女友劉穎,沒想到半個(gè)月后梗掰,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體嵌言,經(jīng)...
    沈念sama閱讀 45,443評(píng)論 1 314
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,649評(píng)論 3 334
  • 正文 我和宋清朗相戀三年及穗,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了摧茴。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 39,795評(píng)論 1 347
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡埂陆,死狀恐怖苛白,靈堂內(nèi)的尸體忽然破棺而出娃豹,到底是詐尸還是另有隱情,我是刑警寧澤购裙,帶...
    沈念sama閱讀 35,501評(píng)論 5 345
  • 正文 年R本政府宣布懂版,位于F島的核電站,受9級(jí)特大地震影響躏率,放射性物質(zhì)發(fā)生泄漏躯畴。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,119評(píng)論 3 328
  • 文/蒙蒙 一薇芝、第九天 我趴在偏房一處隱蔽的房頂上張望私股。 院中可真熱鬧,春花似錦恩掷、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,731評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)。三九已至克滴,卻和暖如春逼争,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背劝赔。 一陣腳步聲響...
    開封第一講書人閱讀 32,865評(píng)論 1 269
  • 我被黑心中介騙來泰國(guó)打工誓焦, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人着帽。 一個(gè)月前我還...
    沈念sama閱讀 47,899評(píng)論 2 370
  • 正文 我出身青樓杂伟,卻偏偏與公主長(zhǎng)得像,于是被迫代替她去往敵國(guó)和親仍翰。 傳聞我的和親對(duì)象是個(gè)殘疾皇子赫粥,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,724評(píng)論 2 354

推薦閱讀更多精彩內(nèi)容

  • Spring Cloud為開發(fā)人員提供了快速構(gòu)建分布式系統(tǒng)中一些常見模式的工具(例如配置管理,服務(wù)發(fā)現(xiàn)予借,斷路器越平,智...
    卡卡羅2017閱讀 134,654評(píng)論 18 139
  • 【轉(zhuǎn)載】曾夢(mèng)想仗劍走天涯 1.Xcode IDE概覽 說明:從左到右,依次是“導(dǎo)航窗格(Navigator)->邊...
    06a6a973d7ab閱讀 3,831評(píng)論 2 20
  • 1.Xcode IDE概覽 說明:從左到右灵迫,依次是“導(dǎo)航窗格(Navigator)->邊列(Gutter)->焦點(diǎn)...
    小地閱讀 5,363評(píng)論 0 9
  • 歡迎到我的 個(gè)人博客 http://liumh.com 瀏覽此文 與公司 QA 聊天秦叛,已不止一次被吐槽說移動(dòng)端從開...
    CaryaLiu閱讀 4,592評(píng)論 0 16
  • 提示:2017年7月13日更新 相關(guān)文章:1>. Unity中文社區(qū)2>. IL2CPP 構(gòu)建大小優(yōu)化 前言:項(xiàng)目...
    小熊翻譯App閱讀 7,370評(píng)論 24 23