Cocoa深入淺出:Framework
Framework 簡介
Mac OS X 擴展了 framework 的功能,讓我們能夠利用它來共享代碼和資源。framework 在概念上有點像 Window 下的庫,但是比庫更加強大,通過 framework 我們可以共享所有形式的資源,如動態共享庫,nib 文件,圖像字符資源以及文檔等。系統會在需要的時候將 framework 載入內存中,多個應用程序可以同時使用同一個 framework,而內存中的拷貝只有一份。一個 framework 同時也是一個 bundle,我們可以在 finder 里瀏覽其內容,也可以在代碼中通過 NSBundle 訪問它。利用 framework 我們可以實現動態或靜態庫的功能。與動態/靜態庫相比,framework 有如下優勢:
第一,framework 能將不同類型的資源打包在一起,使之易于安裝,卸載與定位;
第二,framework 能夠進行版本管理,這使得 framework 能不斷更新并向后兼容;
第三,在同一時間,即使有多個應用程序使用同一 framework,但在內存中只有一份 framework 只讀資源的拷貝,這減少了對內存的占用
Framework 的結構
下面是一個帶有A,B兩個版本和一個 resources 目錄的 framework 結構,并設定當前版本為 B:
MyFramework.framework/
Headers -> Versions/Current/Headers
MyFramework -> Versions/Current/MyFramework
Resources -> Versions/Current/Resources
Versions/
A/
Headers/
MyHeader.h
MyFramework
Resources/
English.lproj/
Documentation
InfoPlist.strings
Info.plist
B/
Headers/
MyHeader.h
MyFramework
Resources/
English.lproj/
Documentation
InfoPlist.strings
Info.plist
Current -> B
結合上面的結構,下面我們來看本例中 ExampleFramework 的結構圖:
Framework 存放位置
在 Mac OS 中有三個級別的位置來存放 framework。一般我們自己編寫的 framework 都應該是應用程序級別。
1,系統級,/Library/Frameworks,放置到該級別,這需要管理員權限,整個系統都可以共享使用該級別的 framework;
2,用戶級,/Users/用戶名/Library/Frameworks,擁有用戶權限的應用程序都可以共享使用該級別的 framework;
3,應用程序級。
在應用程序中內嵌 Framework
1,創建 Framework
新建一個名為 FrameworkDemo 的 Cocoa application 工程,然后選中項目名,向其中添加名為 ExampleFramework 的 Cocoa Framework。
2,添加內容
向 Framework 中添加源代碼(請下載源代碼),并導出需要向外部公開的頭文件。
導出頭文件有一些技巧:
1,如果有我們不想向用戶公開的類名出現在必須公開的頭文件中,我們可以使用 id 替代該類名或使用 @class 前置申明來避免導出該類的頭文件,在本例中使用 id 替代 InternalObject,從而避免導出 InternalObject 類的頭文件。
2,如果需要導出多個頭文件,常見的做法是新建一個與 framework 同名的 .h 文件,將需要導出的頭文件包含到該頭文件中來。如本例中的 ExampleFramework.h。
3,修改 framework build 選項
我們在使用自己編寫的庫時,常碰到下面的編譯錯誤:
Library not loaded: path/to/framework
Referenced from: path/to/app/
Reason: image not found
這多半是由于 framework 的 Installation Directory 編譯選項設置不正確,導致應用程序無法正確定位 framework 所致。這需要我們設置編譯選項 Installation Directory 為 @executable_path/../Frameworks。
4,使用 framework
至此,framework 編寫完成,下面我們來在 FrameworkDemo 中來使用它。首先我們需要將 ExampleFramework 導入到 FrameworkDemo 中來,這樣 FrameworkDemo 在運行時才能定位該 framework。新建一個 Add copy files 型的 build phase,設置其 destination 為 framework,加入已經編寫好的 ExampleFramework。
導入 framework 之后,我們就可以在工程中使用該 framework 了。編寫如下代碼:
// // FrameworkDemoAppDelegate.m // FrameworkDemo // // Created by kesalin on 11-10-16. // Copyright 2011年 kesalin@gmail.com. All rights reserved. // #import "FrameworkDemoAppDelegate.h" <span style="color:#ff6666;"><strong>#import <ExampleFramework/ExampleFramework.h></strong></span> @implementation FrameworkDemoAppDelegate @synthesize window; - (void)applicationDidFinishLaunching:(NSNotification *)aNotification { <span style="color:#cc9933;"> EntityObjectA *objectA = [[EntityObjectA alloc] init]; EntityObjectB *objectB = [[EntityObjectB alloc] init]; NSLog(@"Object A called: %@", [objectA methodOne]); NSLog(@"Object B called: %@", [objectA methodTwo]); NSLog(@"Object B called: %@", [objectB methodOne]); NSLog(@"Object B called: %@", [objectB methodTwo]);</span> } @end
注意:我們使用 framework 的方式為 :framework名/framework名.h,這是約定的常規做法,Cocoa 自帶的 framework 也都遵守這一約定,所以我們自己編寫的庫最后也遵守這一約定。
5,編譯運行
至此,工作完成,編譯運行,應當輸出如下:
Object A called: EntityObjectA:methodOne
Object B called: EntityObjectA:methodTwo - InternalObject:description
Object B called: EntityObjectB:methodOne
Object B called: EntityObjectB:methodTwo - InternalObject:description
6,清除冗余文件
這時可選項,且只對使用內嵌 framework 的應用程序有效。當我們拷貝導入 framework 之后,應用程序 bundle 已經拷貝了一份 framework,那么原本編譯生成的那一份 framework就變得多余了,我們可以將其清理掉。在使用內嵌 framework 的應用程序的 build phases 中加入 run script phase,腳本內容如下:
echo "build path ${TARGET_BUILD_DIR}"
cd ${TARGET_BUILD_DIR}/${FULL_PRODUCT_NAME}/Contents/Frameworks
rm -rf */Headers
rm -rf */Versions/*/Headers
rm -rf */Versions/*/PrivateHeaders
rm -rf */Versions/*/Resources/*/Contents/Headers
使用外部 framework
上面的示例是在應用程序內嵌 framework,供應用程序本身使用,很多時候,我們是使用第三方編寫的 framework,下面接著來演示如何將 ExampleFramework 當做外部framework。
1,新建名為 TestExampleFramework 的 Cocoa Application 程序,在 TestExampleFrameworkAppDelegate.m 中添加如上步驟 4 中使用 framework 的代碼。
2,編譯運行,這時會報找不到頭文件,類名的錯誤。這時因為我們還沒有導入framework。在 Build Phase 的 Link Binary With Libraries 中加入生成好的 ExampleFramework,該 framework 的默認生成路徑在: /用戶名/Library/Developer/XCode/DerivedData/FrameworkDemo-XXXX/Build/Products/Debug/下。至此,編譯運行,輸出應當如上步驟 5 相同。
此外還有一種方式使用第三方 framework,如果我們擁有第三方 framework 的源代碼工程,想在我們的工程中編譯該 framework,并使用它。我們可以將第三方 framework 的工程文件加入我們自己的工程,并在 Target Dependencies 和 Link Binary With Libraires 加入第三方 framework,這樣我們就可以使用該 framework了。如下圖所示: