原文:https://insert.io/frameworkios8xcode6/ 来自Oded Regev
网上充满了关于如何构建一个iOS Framework的教程。然而,当我们开始了着手开始做这件事情时候,仍然必须克服一些不小的挑战,才能够得到以我们想要的方式工作的SDK。
此外,在Xcode 6中,苹果极大地改变开发人员创建和构建Frameworks的方式,所以你会发现在互联网上很多的frameworks制作教程都是没有及时更新。
在这篇文章中,我们会告诉你,如何一步一步在iOS8创建和构建一个Framwork,本教程中的Framework源代码可以在Github获取到。
我们将针对性指出下面这些重要的挑战:
- 如何混合Swift和Objective-C代码结合在同一个SDK中?
- 如何构建能被所有相关的架构(armv7,armv7s,arm64,i386)使用的framework。如果你只需要这一个解决方案,只需要添加一个新的构建阶段(Build Phase)到项目中,并使用“run script“, 脚本ios-build-framework-script.sh可以在这篇文章的底部找到。
在我们的例子中,我们将使用一个管理器(Manager)启用\禁用framework,CustomView类将包含(惊喜吧)一个自定义的UIView。在这个例子中,我们要告诉你如何把xib文件和PNG文件资源整合在Framework中。
让我们开始第1步 #1
1)从头开始创建一个项目
因为Xcode6中有一个内置的选项来创建一个动态的Framework项目。选择这个选项,如果你需要从头开始创建一个框架,项目的选择:
“静态库(Static Library)”和“框架(Framework)”的区别是什么?
“静态库”主要是将代码编译成.a文件的样式,例如InsertLib.a。可以通过导出的静态库与他人共享,静态库中包含一些公共类和方法,客户端获取到静态库后可以使用这些公共类和方法。
“Cocoa Touch Framework”实质上是一个包,其中包含一个“动态库(dynamic library)”,若干.h文件和资源文件。 “动态库”的概念(换个词“动态链接(dynamic linking)”) 就是有共享代码的一个副本在单个设备中(CoreLocation.Framework就是一个例子)由所有链接到它的应用程序共享。这种动态链接的方式将提高系统的性能,通过最小化framework的内存使用。
2)添加Manager类文件,下面是代码:
InsertManager.h
#import
#import
@interface InsertManager : NSObject
+(instancetype) sharedManager;
-(void) startManager;
-(void) stopManager;
-(void) showMessageInViewController:(UIViewController *)viewController;
-(BOOL) isManagerRunning;
@end
InsertManager.m
#import "InsertManager.h"
#import "CustomView.h"
@interface InsertManager()
@property (nonatomic) BOOL isEnabled;
@end
@implementation InsertManager
+ (instancetype) sharedManager {
static InsertManager *sharedManager = nil;
static dispatch_once_t onceToken;
dispatch_once(&onceToken, ^{
sharedManager = [[[self class] alloc] init];
});
return sharedManager;
}
- (void) startManager {
NSLog(@"Manager is running");
_isEnabled = YES;
}
- (void) stopManager {
NSLog(@"Manager stopped..");
_isEnabled = NO;
}
-(BOOL) isManagerRunning {
return _isEnabled;
}
-(void) showMessageInViewController:(UIViewController *)viewController {
if (_isEnabled) {
NSBundle* frameworkBundle = [NSBundle bundleForClass:[self class]];
CustomView *csView = [[frameworkBundle loadNibNamed:@"CustomView" owner:self options:nil] firstObject];
csView.frame = CGRectMake(0, 0, [[UIScreen mainScreen] bounds].size.width, [[UIScreen mainScreen] bounds].size.height);
[viewController.view addSubview:csView];
}
}
@end
3)添加CustomView代码:
CustomView.h
#import
#import
@interface CustomView : UIView
@property (weak, nonatomic) IBOutlet UIImageView *imageView;
@property (weak, nonatomic) IBOutlet UIButton *closeButton;
@end
CustomView.m
#import "CustomView.h"
@implementation CustomView
- (IBAction)closeButtonClicked:(id)sender {
[self removeFromSuperview];
}
@end
CustomView.xib - 下载从Github上,看看它是如何配置的。
Newsroom.png - 我们用这个文件作为背景图片来演示,如何在一个框架中使PNG一类的资源文件并且传给一个应用程序。
4)当你在Xcode中创建一个新的“Cocoa Touch Framework” 项目,默认的.h文件将被自动命名生成的“项目名.h” 。请确保您的所有公开的.h文件添加到该文件中,公开.h文件中包含公开方法,客户端可以通过framework调用这些公开方法,在我们的例子中添加以下代码:
#import
//!InsertSampleFramework项目的版本号。
FOUNDATION_EXPORT double InsertSampleFrameworkVersionNumber;
//!InsertSampleFramework项目版本字符串。
FOUNDATION_EXPORT const unsigned char InsertSampleFrameworkVersionString [];
//在这头,你应该导入使用类似语句的框架的所有公共头
#import
5)在Xcode中单击Target,并转到“Build Phase”部分,在“Headers”中添加需要公开的.h文件到“Public”中
Build Phase:
6)现在只是建立了Framework,还没有准备好调用framework的项目。我们只能够使用该framework在一个项目应用中。我们将在名为“Tabster”苹果范例项目使用这个framework。该项目的完整源代码可以从iOS Developer Library 下载,搜索“Tabster”,点击结果。在Tabster页面,查找按钮“Download Sample Code”,下载代码,并在Xcode打开项目。
来看看如何能够让我们的Framework在这个项目中工作起来...
在项目中集成framework
1)打开Tabster项目并运行应用程序,看到它如我们期望一样运行起来。
2)复制“InsertSampleFramework”项目的根文件夹到Tabster的根文件夹
3)现在拖动Framework项目到Tabster项目中作为一个依赖(请注意,您必须先关闭Framework项目的Xcode的窗口,因为xcodeproj只可以在一个Xcode窗口中打开)。
4)加入该Framework作为依赖在Build Phases中
5)加入该框架为“Link Binary with Libraries”。如果框架有Swift代码,你还需要添加框架中的““General”标签下的“Embedded Binaries”
6)点击Run,看看它是是否能工作,这个操作是一个完整性检查(注意,我们还没有用代码集成framework)。
7)现在让我们在Tabster项目中使用我们的神奇的Framework。Tabster这是一个相当简单的应用程序:打开Storyboard ,并添加一个label(Insert Framework Enable\Disable),UISegmentControl和一个UIButton到ThreeViewController
8)在Tabster的ThreeViewController.m中添加:
#import
9)添加下面的IBActions到ThreeViewController.m:
#pragma mark - IBAction
- (IBAction)segmentValueChanged:(id)sender {
UISegmentedControl *sc = (UISegmentedControl *)sender;
NSInteger selectedSegment = sc.selectedSegmentIndex;
if (selectedSegment == 1) {
[[InsertManager sharedManager] startManager];
}
else if (selectedSegment == 0) {
[[InsertManager sharedManager] stopManager];
}
}
- (IBAction)showCustomView:(id)sender {
[[InsertManager sharedManager] showMessageInViewController:self];
}
10)运行应用程序,点击标签“Three”,点击 On\Off segment control。点击确认按钮“Show Custom View”将显示view,确保manager运行时才能使用。
分发我们的framework使其能够融合到其他外部应用程序中
大多数公司和个人开发为iOS开发框架(framework),最终希望将自己的框架能够分发给别人使用。你必须要做的最重要的一步就是,建立对所有可能的架构(armv7,armv7s,arm64,X86等)都支持的框架。一为架构的每个家庭(iPhone模拟器,旧设备(ARMv7的,armv7s),新设备(arm64) - 我们为了做到这一点,通过增加一个“Build Phase”运行一个脚本,脚本将build framework3次。
点击框架目标,并添加一个“New Run Script Phase”:
这一行你应该复制和粘贴到build phase:
/${PROJECT_DIR}/OTRGuideManager/ios-build-framework-script.sh
一些开发人员更喜欢直接在此框中写脚本,我更倾向于让脚本在一个单独的sh文件,这样我可以在Git的跟踪它,当需要在未来,他们跟踪更改。
具体的脚本是在ios-build-framework-script.sh:
set -e
set +u
#避免递归调用这个脚本。
if [[ $SF_MASTER_SCRIPT_RUNNING ]]
then
exit 0
fi
set -u
export SF_MASTER_SCRIPT_RUNNING=1
#常量
SF_TARGET_NAME=${PROJECT_NAME}
UNIVERSAL_OUTPUTFOLDER=${BUILD_DIR}/${CONFIGURATION}-universal
#构建Target
if [[ "$SDK_NAME" =~ ([A-Za-z]+) ]]
then
SF_SDK_PLATFORM=${BASH_REMATCH[1]}
else
echo "Could not find platform name from SDK_NAME: $SDK_NAME"
exit 1
fi
if [[ "$SF_SDK_PLATFORM" = "iphoneos" ]]
then
echo "Please choose iPhone simulator as the build target."
exit 1
fi
IPHONE_DEVICE_BUILD_DIR=${BUILD_DIR}/${CONFIGURATION}-iphoneos
#生成其他(非虚拟机)平台
xcodebuild -project "${PROJECT_FILE_PATH}" -target "${TARGET_NAME}" -configuration "${CONFIGURATION}" -sdk iphoneos BUILD_DIR="${BUILD_DIR}" OBJROOT="${OBJROOT}" BUILD_ROOT="${BUILD_ROOT}" CONFIGURATION_BUILD_DIR="${IPHONE_DEVICE_BUILD_DIR}/arm64" SYMROOT="${SYMROOT}" ARCHS='arm64' VALID_ARCHS='arm64' $ACTION
xcodebuild -project "${PROJECT_FILE_PATH}" -target "${TARGET_NAME}" -configuration "${CONFIGURATION}" -sdk iphoneos BUILD_DIR="${BUILD_DIR}" OBJROOT="${OBJROOT}" BUILD_ROOT="${BUILD_ROOT}" CONFIGURATION_BUILD_DIR="${IPHONE_DEVICE_BUILD_DIR}/armv7" SYMROOT="${SYMROOT}" ARCHS='armv7 armv7s' VALID_ARCHS='armv7 armv7s' $ACTION
#复制framework结构的universal folder(先清空)
rm -rf "${UNIVERSAL_OUTPUTFOLDER}"
mkdir -p "${UNIVERSAL_OUTPUTFOLDER}"
cp -R "${BUILD_DIR}/${CONFIGURATION}-iphonesimulator/${PROJECT_NAME}.framework" "${UNIVERSAL_OUTPUTFOLDER}/${PROJECT_NAME}.framework"
#把这些架构(architectures)搅碎融合到一起
lipo -create "${BUILD_DIR}/${CONFIGURATION}-iphonesimulator/${PROJECT_NAME}.framework/${PROJECT_NAME}" "${BUILD_DIR}/${CONFIGURATION}-iphoneos/arm64/${PROJECT_NAME}.framework/${PROJECT_NAME}" "${BUILD_DIR}/${CONFIGURATION}-iphoneos/armv7/${PROJECT_NAME}.framework/${PROJECT_NAME}" -output "${UNIVERSAL_OUTPUTFOLDER}/${PROJECT_NAME}.framework/${PROJECT_NAME}"
1)请确保选择是iPhone模拟器,当你想建立的发布版本的framework - 脚本会检测,并自动建立的其他平台。
2)运行“ Build”后,你需要选择Distribution-universal目录下的Framework。
3)整合framework到Xcode项目中,使用framework和你已经配置好的设置。