最近幫兄弟公司的做支付業務sdk,積累了 sdk 封裝的經驗!下面我會從零開始把我的 sdk 封裝和除錯經歷分享給大家,希望能給看到這篇文章的人有所幫助!
本文我會從以下幾個方面來講述:
-
Framework生成配置以及整合在主專案裡除錯
-
xib 檔案和圖片的存放和引用
-
Pods以及第三方庫的使用
-
Framework匯出與文件
Framework生成配置以及整合在主專案裡除錯
1.新建主專案,主專案的 ProjectName 是 HelloFramework(也就是我們要使用 sdk 業務的主專案)
2.接下來在主專案裡建立Framework,就叫MyFramework好了
3.然後我們點開 Project 檔案,在Target 列表裡選中 MyFramework,Build Settings
a、Architectures→Architectures 配置支援的指令集,這裡系統已經預設配置了 arm64和 armv7,所以只要增加一個 armv7s 就可以了
以下是指令集對應的裝置
armv6
iPhone、iPhone 3G
iPod 1G、iPod 2G
armv7
iPhone 3GS、iPhone 4
iPod 3G、iPod 4G、iPod 5G
iPad、iPad 2、iPad 3、iPad Mini
armv7s
iPhone 5、iPhone 5C
iPad 4
arm64
iPhone 5s iPhone 6iPhone 6P iPhone 6s iPhone 6sP iPhone 7 iPhone 7P
iPad Air, Retina iPad Mini
b、Linking→Mach-O Type 將Dynimic Library 改成 Static Library
c、Deployment→iOS Deployment Target 選擇你想相容的最低 iOS 版本
d、新建一個 FrameworkManager,然後再建立好我們要使用的內容,這裡建立一個用 Xib 來顯示的 UIViewController,以及在裡面顯示圖片(用來示例 Xib 和圖片檔案的引用)
我在FrameworkManager類裡實現了一個方法
//.h檔案宣告
#import <UIKit/UIKit.h>
#import <Foundation/Foundation.h>
@interface MyFrameworkManager : NSObject
+ (NSString *)showFileVCWithSourceVC:(UIViewController *)VC;
@end
//.m檔案實現
#import "MyFrameworkManager.h"
@implementation MyFrameworkManager
+ (NSString *)showFileVCWithSourceVC:(UIViewController *)VC {
return @"Call framework success!!!";
}
@end
e、在Build phase→Headers 裡面將要暴露出去的.h檔案拖放到 Public 目錄下(這裡我們開發 MyFrameworkManager)
f、現在我們可以在主專案裡引用 MyFrameworkManager,跑跑試試了!我加了一個按鈕和標籤用來演示呼叫效果!
//主專案 ViewController.m檔案
#import "ViewController.h"
@interface ViewController ()
@property (weak, nonatomic) IBOutlet UILabel *callResultLbl;
@end
@implementation ViewController
- (void)viewDidLoad {
[super viewDidLoad];
// Do any additional setup after loading the view, typically from a nib.
}
- (IBAction)callFramework:(UIButton *)sender {
NSString *results = [MyFrameworkManager showFileVCWithSourceVC:self];
self.callResultLbl.text = results;
}
- (void)didReceiveMemoryWarning {
[super didReceiveMemoryWarning];
// Dispose of any resources that can be recreated.
}
@end
xib 檔案和圖片的存放和引用
1.建立bundle,放置資原始檔(xib 檔案,圖片)
a、新建一個空檔案
b、把要用圖片放置進檔案
c、編譯 framework
d、在 finder 裡,會找到一個FrameworkFileViewController.nib檔案,copy 出來也放到剛新建的資料夾裡(注意:如果 xib 檔案有改動,就得重新編譯和替換)
e、然後把檔名改成任何你想要的名字(一般都會與你的 Framework 名字匹配),但是注意,記得更改檔名字尾為 .bundle
f、新增完檔案,將該 bundle引用到主工程裡,接下來就可以將 MyFramework 裡的程式碼改改,試下 xib 檔案和圖片的引用效果了
//MyFrameworkManager.m檔案實現
#import "MyFrameworkManager.h"
#import "FrameworkFileViewController.h"
#define MYFRAMEWORK_BUNDLE_IMG(imageName) [@"MyFramework.bundle" stringByAppendingPathComponent:imageName]
#define MYFRAMEWORK_BUNDLE [NSBundle bundleWithPath: [[NSBundle mainBundle] pathForResource:@"MyFramework" ofType: @"bundle"]]
@implementation MyFrameworkManager
+ (NSString *)showFileVCWithSourceVC:(UIViewController *)VC {
FrameworkFileViewController *fileVC = [[FrameworkFileViewController alloc] initWithNibName:@"FrameworkFileViewController" bundle:MYFRAMEWORK_BUNDLE];
[VC presentViewController:fileVC animated:YES completion:^{
}];
return @"Call framework success!!!";
}
@end
//FrameworkFileViewController.m 檔案實現
#import "FrameworkFileViewController.h"
@interface FrameworkFileViewController ()
@property (weak, nonatomic) IBOutlet UIImageView *testImage;
@end
@implementation FrameworkFileViewController
- (void)viewDidLoad {
[super viewDidLoad];
// Do any additional setup after loading the view from its nib.
self.testImage.highlightedImage = [UIImage imageNamed:MYFRAMEWORK_BUNDLE_IMG(@"生日快樂")];
self.testImage.image = [UIImage imageNamed:MYFRAMEWORK_BUNDLE_IMG(@"七夕")];
}
- (IBAction)dismiss:(UIButton *)sender {
[self dismissViewControllerAnimated:YES completion:^{
}];
}
- (IBAction)changImage:(id)sender {
self.testImage.highlighted = !self.testImage.highlighted;
}
- (void)didReceiveMemoryWarning {
[super didReceiveMemoryWarning];
// Dispose of any resources that can be recreated.
}
@end
Pods以及第三方庫的使用
1.pods 庫的引用和除錯,同普通的 pods 庫應用,直接 pod init ,在 podfile 裡新增自己要用的庫,pod install 就可以直接在 Framework 裡直接引用使用 pods 庫的東西了
2.第三方庫的使用,這裡以引入支付寶為例
a、在主工程引入 AlipaySDK.framework 和 AlipaySDK.bundle
b、在主工程的 link binary 新增支付寶 sdk 依賴的庫
c、MyFramework 下link binary 新增 AlipaySDK.framework
d、在 FrameworkManager 裡呼叫 AlipaySDK API,編譯通過,正常使用
Framework 的匯出與文件
首先需要切換到 Release 模式:Product→Edit Scheme→Build Configuration
1.手動匯出 Framework
a、在 Target 為 MyFramework 下,選擇模擬器和Generic iOS Device各自 Build 一次
b、在工程目錄 Products 下→右擊 framework→show in finder,會看到有兩個資料夾,一個是真機包,一個是模擬器包。我們要在終端通過 lipo -create將這兩個檔案的 MyFramework 檔案合成,命令如下:
lipo -create 模擬器包路徑/MyFramework.framework/MyFramework 真機包路徑/MyFramework.framework/MyFramework -output 匯出路徑/MyFramework
c、將合成的MyFramework 包替換其中的一個,然後這個 MyFramework.framework就是我們需要的了
2.用 shell 指令碼自動匯出 Framework
新建一個 Aggregate,新增指令碼
a、如果是單 Project
# Sets the target folders and the final framework product.
# 如果工程名稱和Framework的Target名稱不一樣的話,要自定義FMKNAME
FMK_NAME="MyFramework"
#FMK_NAME=${PROJECT_NAME}
# Install dir will be the final output to the framework.
# The following line create it in the root folder of the current project.
INSTALL_DIR=${SRCROOT}/Products/${FMK_NAME}.framework
# Working dir will be deleted after the framework creation.
WRK_DIR=build
DEVICE_DIR=${WRK_DIR}/Release-iphoneos/${FMK_NAME}.framework
SIMULATOR_DIR=${WRK_DIR}/Release-iphonesimulator/${FMK_NAME}.framework
# -configuration ${CONFIGURATION}
# Clean and Building both architectures.
xcodebuild -configuration "Release" -target "${FMK_NAME}" -sdk iphoneos clean build
xcodebuild -configuration "Release" -target "${FMK_NAME}" -sdk iphonesimulator clean build
# Cleaning the oldest.
if [ -d "${INSTALL_DIR}" ]
then
rm -rf "${INSTALL_DIR}"
fi
mkdir -p "${INSTALL_DIR}"
cp -R "${DEVICE_DIR}/" "${INSTALL_DIR}/"
# Uses the Lipo Tool to merge both binary files (i386 + armv6/armv7) into one Universal final product.
lipo -create "${DEVICE_DIR}/${FMK_NAME}" "${SIMULATOR_DIR}/${FMK_NAME}" -output "${INSTALL_DIR}/${FMK_NAME}"
rm -r "${WRK_DIR}"
open "${INSTALL_DIR}"
b、 如果你新增了 Pods 庫或者其他,用的workspace 的話,指令碼編譯的命令會有些區別:
(1)編譯的檔案路徑WRK_DIR=build這個獲取的路徑就不對了,需要根據自己的路徑靈活配置
(2)xcodebuild不是配置 Target 而是配置workspace 和 scheme,這兩個引數的值可以在終端 cd 當前專案目錄下通過 xcodebuild -list檢視,以下是我根據 例子配置了一個
xcodebuild -configuration "Release" -workspace "HelloFramework.xcworkspace" -scheme "${FMK_NAME}" -sdk iphoneos -arch armv7 -arch armv7s -arch arm64 clean build
xcodebuild -configuration "Release" -workspace "HelloFramework.xcworkspace" -scheme "${FMK_NAME}" -sdk iphonesimulator -arch x86_64 -arch i386 clean build
c、配置好了Run Script,就可以選擇 FrameworkMerge 直接 Run 了,然後就會自動開啟已經合成好的 MyFramework.framework檔案,怎麼樣,是不是特別方便!
d、匯出了合成的 framework 檔案,就導到其它專案裡試試吧,這裡我就不多加贅述了!
3.最後一步就是編寫文件了,作為 sdk 的匯出,文件裡你得寫清楚自己 Release 版本和依賴的庫,有 Pods 配置的話也得註明,系統配置,編譯配置等等~More detailed the better!
至此,整個Framework 除錯和封裝流程就分享完了!希望路過的大牛不要笑話,也熱烈歡迎大家指正錯誤和不足,或者有更好的方式方法我們一起討論!
行文前我參閱過的文章:
http://www.jianshu.com/p/038dab7accbc
https://gist.github.com/leonardvandriel/3775603
https://developer.apple.com/legacy/library/documentation/Darwin/Reference/ManPages/man1/xcodebuild.1.html
轉載請註明出處,謝謝!
作者:Timmy_Yang
連結:http://www.jianshu.com/p/38ed8811c17f
來源:簡書
著作權歸作者所有。商業轉載請聯絡作者獲得授權,非商業轉載請註明出處。