美文网首页iOS开发点滴selector
iOS优雅开发SDK详细教程

iOS优雅开发SDK详细教程

作者: 落寞绅士 | 来源:发表于2022-08-05 15:54 被阅读0次

    基本概念

    基本概念这里参照了奔狂的蜗牛_文章里的内容。

    什么是SDK

    软件开发工具包(缩写:SDK,英语全称:Software Development Kit),一般都是一些软件工程师为特定的软件包、软件框架、硬件平台、操作系统等建立应用软件时的开发工具的集合。
    在OC的开发中,我们涉及到的一般是静态库(.a)或者动态库(.framework)。(注:不是所有的.framework就一定是动态库)

    静态库与动态库的区别?

    静态库:链接时完整地拷贝至可执行文件中,被多次使用就有多份冗余拷贝。表现形式为 .a和.framework。动态库:链接时不复制,程序运行时由系统动态加载到内存,供程序调用,系统只加载一次,多个程序共用,节省内存。 表现形式为 .dylib和.framework。注意:动态库只能苹果使用,如果项目中使用了动态库不允许上架(如:jspatch)

    a与.framework有什么区别?

    .a是一个纯二进制文件,.framework中除了有二进制文件之外还有资源文件。 .a文件不能直接使用,至少要有.h文件配合(微信的SDK就是这种形式),.framework文件可以直接使用。 .a + .h + sourceFile = .framework。 建议用.framework。再者 静态方式开发,一直是iOS SDK开发的主流方式

    一、准备工作

    1、创建一个目录

    用于将后面开发的文件统一管理在此目录下。我这里命名为HLTestSDK-library

    2、创建一个Workspace放在HLTestSDK-library目录下。

    用于管理SDK和SDK测试的工程。这里命名为HLTestSDK-workspace
    2.1、快捷键创建:control + command + n
    2.2、手动创建如图:

    1.创建Workspace.jpg
    3、创建SDK工程也放在HLTestSDK-library目录下。

    命名为HLTestSDK
    3.1、快捷键创建:shift + command + n
    3.2、手动创建如图:

    2.创建工程.jpg
    3.创建Framework.jpg
    4.创建Framework.jpg
    4.创建一个测试工程也放在HLTestSDK-library目录下。

    用于测试SDK,命名为HLTestSDK-test
    4.1、快捷键创建:shift + command + n
    4.2、手动创建如图:

    1.创建Workspace.jpg
    5.创建测试工程.jpg
    6.创建测试工程.jpg
    至此我们准备工作已经做完。
    查看HLTestSDK-library是否如下图:
    7.HLTest-library目录.jpg
    查看HLTestSDK-workspace.xcworkspace是否如下图:
    8.HLTestSDK-workspace工作空间目录结构.jpg

    二、在HLTestSDK中添加测试类

    主要用于后面演示暴露头文件和测试用,如图:


    9.在SDK中添加测试类.jpg
    10.在SDK中添加测试类.jpg

    三、创建一个AggreGate文件关联SDK

    命名为HLTestSDK-aggregate

    11.创建Aggregate文件.jpg
    12.创建Aggregate文件.jpg
    13.创建Aggregate文件.jpg
    14.添加自动生成framework的脚本文件.jpg
    脚本内容如下,可直接复制
    #!/bin/sh
    #要build的target名
    TARGET_NAME=${PROJECT_NAME}
    if [[ $1 ]]
    then
    TARGET_NAME=$1
    fi
    UNIVERSAL_OUTPUT_FOLDER="${SRCROOT}/${PROJECT_NAME}/"
    
    #创建输出目录,并删除之前的framework文件
    mkdir -p "${UNIVERSAL_OUTPUT_FOLDER}"
    rm -rf "${UNIVERSAL_OUTPUT_FOLDER}/${TARGET_NAME}.framework"
    
    #分别编译模拟器和真机的Framework
    xcodebuild -target "${TARGET_NAME}" ONLY_ACTIVE_ARCH=NO -configuration ${CONFIGURATION} -sdk iphoneos BUILD_DIR="${BUILD_DIR}" BUILD_ROOT="${BUILD_ROOT}" clean build
    xcodebuild -target "${TARGET_NAME}" ONLY_ACTIVE_ARCH=NO -configuration ${CONFIGURATION} -sdk iphonesimulator BUILD_DIR="${BUILD_DIR}" BUILD_ROOT="${BUILD_ROOT}" clean build
    
    #拷贝framework到univer目录
    cp -R "${BUILD_DIR}/${CONFIGURATION}-iphonesimulator/${TARGET_NAME}.framework" "${UNIVERSAL_OUTPUT_FOLDER}"
    
    lipo "${BUILD_DIR}/${CONFIGURATION}-iphonesimulator/${TARGET_NAME}.framework/${TARGET_NAME}" -remove arm64 -output "${BUILD_DIR}/${CONFIGURATION}-iphonesimulator/${TARGET_NAME}.framework/${TARGET_NAME}"
    
    
    #合并framework,输出最终的framework到build目录
    lipo -create -output "${UNIVERSAL_OUTPUT_FOLDER}/${TARGET_NAME}.framework/${TARGET_NAME}" "${BUILD_DIR}/${CONFIGURATION}-iphonesimulator/${TARGET_NAME}.framework/${TARGET_NAME}" "${BUILD_DIR}/${CONFIGURATION}-iphoneos/${TARGET_NAME}.framework/${TARGET_NAME}"
    
    #删除编译之后生成的无关的配置文件
    dir_path="${UNIVERSAL_OUTPUT_FOLDER}/${TARGET_NAME}.framework/"
    for file in ls $dir_path
    do
    if [[ ${file} =~ ".xcconfig" ]]
    then
    rm -f "${dir_path}/${file}"
    fi
    done
    #判断build文件夹是否存在,存在则删除
    if [ -d "${SRCROOT}/build" ]
    then
    rm -rf "${SRCROOT}/build"
    fi
    rm -rf "${BUILD_DIR}/${CONFIGURATION}-iphonesimulator" "${BUILD_DIR}/${CONFIGURATION}-iphoneos"
    #打开合并后的文件夹
    open "${UNIVERSAL_OUTPUT_FOLDER}"
    

    拷贝关联后如图:


    15.添加自动生成framework的脚本文件.jpg

    四、配置SDK基础设置及暴露给外部调用的头文件

    1.配置SDK支持最低版本

    16.配置SDK支持最低版本.jpg
    2.配置SDK支持设备
    17.配置SDK支持设备.jpg
    3.配置SDK为静态库(重点)
    18.配置SDK为静态库.jpg
    4.配置Enable Bitcode
    19.配置Enable Bitcode.jpg
    5.配置SDK Bulid Configuration
    20.配置SDK Bulid Configuration.jpg
    21.配置SDK Bulid Configuration.jpg
    6.配置Other Linker Flags,添加-ObjC
    22.配置Other Linker Flags.jpg
    23.配置Other Linker Flags.jpg
    7.配置Build Active Architecture Only
    24.配置Build Active Architecture Only.jpg

    设置为yes表示它只编译当前的architecture版本
    设置为no表示会编译所有的版本
    为了提高编译速度:
    一般debug的时候可以选择设置为yes,release的时候要改为no,以适应不同设备。

    8.SDK暴露头文件给第三方访问

    25.SDK暴露头文件给第三方访问.jpg
    26.SDK暴露头文件给第三方访问.jpg
    9.配置Perform Single-Object PrelinkYES
    27.配置Perform Single-Object Prelink.jpg

    五、测试

    28.测试.jpg
    29.测试.jpg
    30.测试.jpg
    31.测试.jpg
    如果控制台打印了Hello SDK,表示你已入门SDK开发了!

    六、SDK项目中的资源文件Bundle(可选)

    SDK开发过程中可能会使用到图片等资源,这些资源我们需要使用Bundle来管理。

    1、创建Bundle

    最简单的方式就是:在桌面上创建一个空的文件夹,然后文件名称修改为.bundle结尾,那么系统就把这个文件转变成bundle文件,然后拖入你的SDK项目中。

    2、向Bundle中添加资源

    选中Bundle文件 - 右键 - 显示包内容 - 将资源文件拖入即可

    3、SDK中使用资源

    我们用图片资源演示

    /**
     * 从Bundle中获取图片
     * @param bundleName bundle名称
     * @param imageName 图片名称
     */
    + (UIImage *)imageWithBundle:(NSString *)bundleName imageName:(NSString *)imageName
    {
        if ([UIScreen mainScreen].scale == 3) {
            imageName = [NSString stringWithFormat:@"%@@3x", imageName];
        } else {
            imageName = [NSString stringWithFormat:@"%@@2x", imageName];
        }
        
        // 静态库 url 的获取
        NSURL *url = [[NSBundle mainBundle] URLForResource:bundleName withExtension:@"bundle"];
        if (!url) {
            // 动态库 url 的获取
            url = [[NSBundle bundleForClass:[self class]] URLForResource:bundleName withExtension:@"bundle"];
        }
        if (!url) {
            return nil;
        }
        NSBundle *bundle = [NSBundle bundleWithURL:url];
        UIImage *image = [UIImage imageNamed:imageName inBundle:bundle compatibleWithTraitCollection:nil];
        return image;
    }
    
    

    七、SDK开发中其他扩展(可选)

    • 获取当前显示的ViewController
    /**
    * 获取当前显示的 UIViewController
    */
    + (UIViewController *)findCurrentShowingViewController {
        //获得当前活动窗口的根视图
        UIViewController *vc = [UIApplication sharedApplication].keyWindow.rootViewController;
        UIViewController *currentShowingVC = [self findCurrentShowingViewControllerFrom:vc];
        return currentShowingVC;
    }
    
    + (UIViewController *)findCurrentShowingViewControllerFrom:(UIViewController *)vc
    {
        // 递归方法 Recursive method
        UIViewController *currentShowingVC;
        if ([vc presentedViewController]) {
            // 当前视图是被presented出来的
            UIViewController *nextRootVC = [vc presentedViewController];
            currentShowingVC = [self findCurrentShowingViewControllerFrom:nextRootVC];
    
        } else if ([vc isKindOfClass:[UITabBarController class]]) {
            // 根视图为UITabBarController
            UIViewController *nextRootVC = [(UITabBarController *)vc selectedViewController];
            currentShowingVC = [self findCurrentShowingViewControllerFrom:nextRootVC];
    
        } else if ([vc isKindOfClass:[UINavigationController class]]){
            // 根视图为UINavigationController
            UIViewController *nextRootVC = [(UINavigationController *)vc visibleViewController];
            currentShowingVC = [self findCurrentShowingViewControllerFrom:nextRootVC];
    
        } else {
            // 根视图为非导航类
            currentShowingVC = vc;
        }
    
        return currentShowingVC;
    }
    
    • Xcode13+: 工程目录中没有 products 路径了
      点击顶部菜单 Product > Show Build Folder in Finder 打开编译后的路径,Release-iphoneos 中的库就是编译后的库文件。

    相关文章

      网友评论

        本文标题:iOS优雅开发SDK详细教程

        本文链接:https://www.haomeiwen.com/subject/nvtpwrtx.html