SDK开发系列.md

一、Framework与.a基础

此处等下一期

---

二、工程嵌套联调静态库

1、新建一个主工程

2、新建一个Library工程

3、将静态库工程拖到主工程文件夹下

如果你要拖到其他目录，就要改Library Search Paths

4、将Library工程下.a文件拖入主工程的Link Binary With Libraries

image.png

如果有必要（运行时崩溃），将静态库需要加入 Embedded Binaries 中

image.png

5. 主工程添加对子工程的依赖，避免每次修改都要手动编译子工程

如下图给主工程添加对子工程的依赖，这样每次编译主工程的时候也会编译子工程。

image.png

---

三、在静态库中使用图片以及 xib 等资源文件

1、添加 Bundle Target

image.png

因为iOS框架中没有bundle，要选中OS X框架找到bundle，如下图

image.png

2、将资源文件加入 bundle 中

将工程中的资源文件都加入到刚刚建的bundle中，如xib、图片。点+号或直接拖都行。

image.png

3、iOS Deployment Target改为你支持的最低版本

image.png

4、设置base SDK 为latest iOS

image.png

5、编译 Bundle

image.png

6、主工程添加对子工程的依赖，避免每次修改都要手动编译子工程

image.png

7、加载 Bundle 里的资源文件

7.1、加载图片

使用运行时替换 [UIImage imageNamed:]方法，减少修改代码的工作量。
相关代码在以下几个类中

image.png

// 在AppDelegate中执行以下代码即可swizzle 所有 [UIImage imageNamed:]

#import "UIImage+Swizzle.h"

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    [UIImage kk_autoLoadImageInBundle];
    return YES;
}

• UIImage+Swizzle.m

//  
// 修改所有的 [UIImage imageNamed:]的实现，改为先从同一项目中的 .bundle 文件中加载，没有再使用系统默认实现加载
+ (void)kk_autoLoadImageInBundle {
    SEL original = @selector(imageNamed:);
    SEL new = @selector(hook_kk_imageWithName:);
    [self kk_swizzleClassMethod:original with:new];
}

// 1. 从 .bundle 中加载图片
// 2. 按照默认的方法加载图片
+ (instancetype)hook_kk_imageWithName:(NSString *)imageName {
    UIImage *image = [NSBundle kk_imageInBundle:kk_BundleName imageName:imageName];
    if (!image) {
        image = [self hook_kk_imageWithName:imageName];
    }
    
    return image;
}

• NSObject+Swizzle.m

#import "NSObject+Swizzle.h"
#import 
#import 

@implementation NSObject (Swizzle)

+ (BOOL)kk_swizzleInstanceMethod:(SEL)originalSel with:(SEL)newSel {
    Class class = object_getClass(self);
    Method originalMethod = class_getInstanceMethod(class, originalSel);
    Method newMethod = class_getInstanceMethod(class, newSel);

    if (!originalMethod || !newMethod) return NO;
    method_exchangeImplementations(originalMethod, newMethod);
    
    return YES;
}

+ (BOOL)kk_swizzleClassMethod:(SEL)originalSel with:(SEL)newSel {
    Class class = object_getClass(self);
    Method originalMethod = class_getClassMethod(class, originalSel);
    Method newMethod = class_getClassMethod(class, newSel);
    
    if (!originalMethod || !newMethod) return NO;
    method_exchangeImplementations(originalMethod, newMethod);
    
    return YES;
}

@end

7.2、加载 xib

7.2.1 加载xib对应的UIViewController

需要重写xib对应控制器的 init 方法，否则可能出现找不到xib文件导致crash
参考bundle打包xib文件

- (instancetype)init {

    NSBundle *bundle = [NSBundle kk_bundleWithName:kBundleTargetName];

    self = [super initWithNibName:@"CalculatePriceViewController" bundle:bundle];

    return self;

}

代码参见：github](https://github.com/action456789/SKS_Collection/blob/master/SKS_Collection/Classes/Category/Framework开发/NSBundle%2BResource.h))

7.2.1 加载xib对应的UIVIew

需要重写xib对应View的 init 方法，，否则可能出现找不到xib文件导致crash

@implementation OfflineView

//重写要加载的view的init方法
- (instancetype)init {
    if (self = [super init]) {
        NSBundle *bundle = [NSBundle kk_bundleWithName:kk_BundleName];
        self = [[bundle loadNibNamed:@"OfflineView" owner:self options:nil] lastObject];
    }
    return self;
}

@end

7.3、加载 Localizable.strings

第一步：在Bundle中新建国际化文件

image.png

第二步：添加语言，并将之前的国际化文件中的代码复制过来

image.png

第三步：

使用 NSBundle+Resource 如下方法

+ (NSString *)mj_localizedStringForKey:(NSString *)key;
+ (NSString *)mj_localizedStringForKey:(NSString *)key value:(NSString *)value;

然后使用如下宏定义

// 加载 Bundle 中的国际化语句
#undef NSLocalizedString
#define NSLocalizedString(key, comment) \
[NSBundle mj_localizedStringForKey:(key)]

然后就可以自动的加载Bundle中的字符串了

---

四、将整个App打包为Framework

需要注意的地方

1. 整个项目都要解除 AppDelegate 的依赖，AppDelegate不能打入Framework中
2. 图片和xib文件需要按照 三 中的处理
3. 可以使用 runtime 动态加载图片和xib文件，减少工作量
4. 注意点：bundle中的国际化文件需要重新新建，添加语言，然后将之前App中的内容复制过来，直接拖进去是无效的

image.png

实际操作中存在的问题

1. 图片同时存在@2x和@3x后缀导致加载的图片为nil的问题
   解决办法为只要@2x的图片

---

五、使用 appledoc 生成文档

官网

• 安装
  brew install appledoc
• 查看版本
  appledoc --version
• 查看帮助
  appledoc --help
• 生成文档

appledoc --output ./doc --project-name "D103Framework"  --project-company "RICISUNG" --company-id "RICISUNG" .  

”.“ 和前面的符号一定要加 空格 否则就会报错。

image.png

参考

iOS 工程套子工程，主工程和framework工程或.a library静态库工程联调](http://www.cnblogs.com/zhanglinfeng/p/5494762.html))

iOS framework静态库中使用xib和图片资源详解