Cocoa Inside With Ease 8 Framework

[Cocoa]深入浅出Cocoa之Framework

深入浅出Cocoa之Framework
罗朝辉 (http://www.cnblogs.com/kesalin/)
本文遵循“署名-非商业用途-保持一致”创作公用协议
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年 moc.liamg|nilasek#moc.liamg|nilasek. 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了。如下图所示: