深入理解Objective-C:Category

發表於2016-03-25

摘要

無論一個類設計的多麼完美,在未來的需求演進中,都有可能會碰到一些無法預測的情況。那怎麼擴充套件已有的類呢?一般而言,繼承和組合是不錯的選擇。但是在Objective-C 2.0中,又提供了category這個語言特性,可以動態地為已有類新增新行為。如今category已經遍佈於Objective-C程式碼的各個角落,從Apple官方的framework到各個開源框架,從功能繁複的大型APP到簡單的應用,catagory無處不在。本文對category做了比較全面的整理,希望對讀者有所裨益。

簡介

本文作者來自美團酒店旅遊事業群iOS研發組。我們致力於創造價值、提升效率、追求卓越。歡迎大家加入我們(簡歷請傳送到郵箱majia03@meituan.com)。
本文系學習Objective-C的runtime原始碼時整理所成,主要剖析了category在runtime層的實現原理以及和category相關的方方面面,內容包括:

  • 初入寶地-category簡介
  • 連類比事-category和extension
  • 挑燈細覽-category真面目
  • 追本溯源-category如何載入
  • 旁枝末葉-category和+load方法
  • 觸類旁通-category和方法覆蓋
  • 更上一層-category和關聯物件

1、初入寶地-category簡介

category是Objective-C 2.0之後新增的語言特性,category的主要作用是為已經存在的類新增方法。除此之外,apple還推薦了category的另外兩個使用場景1

  • 可以把類的實現分開在幾個不同的檔案裡面。這樣做有幾個顯而易見的好處,a)可以減少單個檔案的體積 b)可以把不同的功能組織到不同的category裡 c)可以由多個開發者共同完成一個類 d)可以按需載入想要的category 等等。
  • 宣告私有方法

不過除了apple推薦的使用場景,廣大開發者腦洞大開,還衍生出了category的其他幾個使用場景:

  • 模擬多繼承
  • 把framework的私有方法公開

Objective-C的這個語言特性對於純動態語言來說可能不算什麼,比如javascript,你可以隨時為一個“類”或者物件新增任意方法和例項變數。但是對於不是那麼“動態”的語言而言,這確實是一個了不起的特性。

2、連類比事-category和extension

extension看起來很像一個匿名的category,但是extension和有名字的category幾乎完全是兩個東西。 extension在編譯期決議,它就是類的一部分,在編譯期和標頭檔案裡的@interface以及實現檔案裡的@implement一起形成一個完整的類,它伴隨類的產生而產生,亦隨之一起消亡。extension一般用來隱藏類的私有資訊,你必須有一個類的原始碼才能為一個類新增extension,所以你無法為系統的類比如NSString新增extension。(詳見2

但是category則完全不一樣,它是在執行期決議的。
就category和extension的區別來看,我們可以推匯出一個明顯的事實,extension可以新增例項變數,而category是無法新增例項變數的(因為在執行期,物件的記憶體佈局已經確定,如果新增例項變數就會破壞類的內部佈局,這對編譯型語言來說是災難性的)。

3、挑燈細覽-category真面目

我們知道,所有的OC類和物件,在runtime層都是用struct表示的,category也不例外,在runtime層,category用結構體category_t(在objc-runtime-new.h中可以找到此定義),它包含了
1)、類的名字(name)
2)、類(cls)
3)、category中所有給類新增的例項方法的列表(instanceMethods)
4)、category中所有新增的類方法的列表(classMethods)
5)、category實現的所有協議的列表(protocols)
6)、category中新增的所有屬性(instanceProperties)

從category的定義也可以看出category的可為(可以新增例項方法,類方法,甚至可以實現協議,新增屬性)和不可為(無法新增例項變數)。
ok,我們先去寫一個category看一下category到底為何物:

MyClass.h:

MyClass.m:

我們使用clang的命令去看看category到底會變成什麼:

好吧,我們得到了一個3M大小,10w多行的.cpp檔案(這絕對是Apple值得吐槽的一點),我們忽略掉所有和我們無關的東西,在檔案的最後,我們找到了如下程式碼片段:

我們可以看到,
1)、首先編譯器生成了例項方法列表OBJC$_CATEGORY_INSTANCE_METHODSMyClass$_MyAddition和屬性列表OBJC$_PROP_LISTMyClass$_MyAddition,兩者的命名都遵循了公共字首+類名+category名字的命名方式,而且例項方法列表裡面填充的正是我們在MyAddition這個category裡面寫的方法printName,而屬性列表裡面填充的也正是我們在MyAddition裡新增的name屬性。還有一個需要注意到的事實就是category的名字用來給各種列表以及後面的category結構體本身命名,而且有static來修飾,所以在同一個編譯單元裡我們的category名不能重複,否則會出現編譯錯誤。
2)、其次,編譯器生成了category本身OBJC$_CATEGORYMyClass$_MyAddition,並用前面生成的列表來初始化category本身。
3)、最後,編譯器在DATA段下的objc_catlist section裡儲存了一個大小為1的category_t的陣列L_OBJC_LABELCATEGORY$(當然,如果有多個category,會生成對應長度的陣列^_^),用於執行期category的載入。
到這裡,編譯器的工作就接近尾聲了,對於category在執行期怎麼載入,我們下節揭曉。

4、追本溯源-category如何載入

我們知道,Objective-C的執行是依賴OC的runtime的,而OC的runtime和其他系統庫一樣,是OS X和iOS通過dyld動態載入的。
想了解更多dyld地同學可以移步這裡(3)。

對於OC執行時,入口方法如下(在objc-os.mm檔案中):

category被附加到類上面是在map_images的時候發生的,在new-ABI的標準下,_objc_init裡面的呼叫的map_images最終會呼叫objc-runtime-new.mm裡面的_read_images方法,而在_read_images方法的結尾,有以下的程式碼片段:

首先,我們拿到的catlist就是上節中講到的編譯器為我們準備的category_t陣列,關於是如何載入catlist本身的,我們暫且不表,這和category本身的關係也不大,有興趣的同學可以去研究以下Apple的二進位制格式和load機制。
略去PrintConnecting這個用於log的東西,這段程式碼很容易理解:
1)、把category的例項方法、協議以及屬性新增到類上
2)、把category的類方法和協議新增到類的metaclass上

值得注意的是,在程式碼中有一小段註釋 / || cat->classProperties /,看來蘋果有過給類新增屬性的計劃啊。
ok,我們接著往裡看,category的各種列表是怎麼最終新增到類上的,就拿例項方法列表來說吧:
在上述的程式碼片段裡,addUnattachedCategoryForClass只是把類和category做一個關聯對映,而remethodizeClass才是真正去處理新增事宜的功臣。

而對於新增類的例項方法而言,又會去呼叫attachCategoryMethods這個方法,我們去看下attachCategoryMethods:

attachCategoryMethods做的工作相對比較簡單,它只是把所有category的例項方法列表拼成了一個大的例項方法列表,然後轉交給了attachMethodLists方法(我發誓,這是本節我們看的最後一段程式碼了^_^),這個方法有點長,我們只看一小段:

需要注意的有兩點:
1)、category的方法沒有“完全替換掉”原來類已經有的方法,也就是說如果category和原來類都有methodA,那麼category附加完成之後,類的方法列表裡會有兩個methodA
2)、category的方法被放到了新方法列表的前面,而原來類的方法被放到了新方法列表的後面,這也就是我們平常所說的category的方法會“覆蓋”掉原來類的同名方法,這是因為執行時在查詢方法的時候是順著方法列表的順序查詢的,它只要一找到對應名字的方法,就會罷休^_^,殊不知後面可能還有一樣名字的方法。

5、旁枝末葉-category和+load方法

我們知道,在類和category中都可以有+load方法,那麼有兩個問題:
1)、在類的+load方法呼叫的時候,我們可以呼叫category中宣告的方法麼?
2)、這麼些個+load方法,呼叫順序是咋樣的呢?
鑑於上述幾節我們看的程式碼太多了,對於這兩個問題我們先來看一點直觀的:

專案結構

我們的程式碼裡有MyClass和MyClass的兩個category (Category1和Category2),MyClass和兩個category都新增了+load方法,並且Category1和Category2都寫了MyClass的printName方法。
在Xcode中點選Edit Scheme,新增如下兩個環境變數(可以在執行load方法以及載入category的時候列印log資訊,更多的環境變數選項可參見objc-private.h):

環境變數

執行專案,我們會看到控制檯列印很多東西出來,我們只找到我們想要的資訊,順序如下:

objc[1187]: REPLACED: -[MyClass printName] by category Category1
objc[1187]: REPLACED: -[MyClass printName] by category Category2
.
.
.
objc[1187]: LOAD: class ‘MyClass’ scheduled for +load
objc[1187]: LOAD: category ‘MyClass(Category1)’ scheduled for +load
objc[1187]: LOAD: category ‘MyClass(Category2)’ scheduled for +load
objc[1187]: LOAD: +[MyClass load]
.
.
.
objc[1187]: LOAD: +[MyClass(Category1) load]
.
.
.
objc[1187]: LOAD: +[MyClass(Category2) load]

所以,對於上面兩個問題,答案是很明顯的:
1)、可以呼叫,因為附加category到類的工作會先於+load方法的執行
2)、+load的執行順序是先類,後category,而category的+load執行順序是根據編譯順序決定的。
目前的編譯順序是這樣的:

編譯順序1

我們調整一個Category1和Category2的編譯順序,run。ok,我們可以看到控制檯的輸出順序變了:

編譯順序2

objc[1187]: REPLACED: -[MyClass printName] by category Category2
objc[1187]: REPLACED: -[MyClass printName] by category Category1
.
.
.
objc[1187]: LOAD: class ‘MyClass’ scheduled for +load
objc[1187]: LOAD: category ‘MyClass(Category2)’ scheduled for +load
objc[1187]: LOAD: category ‘MyClass(Category1)’ scheduled for +load
objc[1187]: LOAD: +[MyClass load]
.
.
.
objc[1187]: LOAD: +[MyClass(Category2) load]
.
.
.
objc[1187]: LOAD: +[MyClass(Category1) load]

雖然對於+load的執行順序是這樣,但是對於“覆蓋”掉的方法,則會先找到最後一個編譯的category裡的對應方法。
這一節我們只是用很直觀的方式得到了問題的答案,有興趣的同學可以繼續去研究一下OC的執行時程式碼。

6、觸類旁通-category和方法覆蓋

鑑於上面幾節我們已經把原理都講了,這一節只有一個問題:
怎麼呼叫到原來類中被category覆蓋掉的方法?
對於這個問題,我們已經知道category其實並不是完全替換掉原來類的同名方法,只是category在方法列表的前面而已,所以我們只要順著方法列表找到最後一個對應名字的方法,就可以呼叫原來類的方法:

7、更上一層-category和關聯物件

如上所見,我們知道在category裡面是無法為category新增例項變數的。但是我們很多時候需要在category中新增和物件關聯的值,這個時候可以求助關聯物件來實現。

MyClass+Category1.h:

MyClass+Category1.m:

#import <objc/runtime.h>

但是關聯物件又是存在什麼地方呢? 如何儲存? 物件銷燬時候如何處理關聯物件呢?
我們去翻一下runtime的原始碼,在objc-references.mm檔案中有個方法_object_set_associative_reference:

我們可以看到所有的關聯物件都由AssociationsManager管理,而AssociationsManager定義如下:

AssociationsManager裡面是由一個靜態AssociationsHashMap來儲存所有的關聯物件的。這相當於把所有物件的關聯物件都存在一個全域性map裡面。而map的的key是這個物件的指標地址(任意兩個不同物件的指標地址一定是不同的),而這個map的value又是另外一個AssociationsHashMap,裡面儲存了關聯物件的kv對。
而在物件的銷燬邏輯裡面,見objc-runtime-new.mm:

嗯,runtime的銷燬物件函式objc_destructInstance裡面會判斷這個物件有沒有關聯物件,如果有,會呼叫_object_remove_assocations做關聯物件的清理工作。

後記

正如侯捷先生所講-“原始碼面前,了無祕密”,Apple的Cocoa Touch框架雖然並不開源,但是Objective-C的runtime和Core Foundation卻是完全開放原始碼的(在http://www.opensource.apple.com/tarballs/可以下載到全部的開原始碼)。
本系列runtime原始碼學習將會持續更新,意猶未盡的同學可以自行到上述網站下載原始碼學習。行筆簡陋,如有錯誤,望指正。