Swift 调用 OC 实用技巧

Swift App

混入OC/C/C++代码

方法一

使用桥接文件。

方法二

使用.modulemap

  1. Swift App项目,引入OC/C/C++文件。
  2. 创建文件名必须为module 后缀为.modulemap的文件。
image.png
  1. 配置工程BuildSettingSwift Compiler - Search Paths选项,值为module.modulemap文件所在的目录路径或其上层目录路径。
image.png

此处可为:

${SRCROOT}/MixFrameworkTest
${SRCROOT}/MixFrameworkTest/ObjcInSwitApp

如果这里的路径配置不正确便会报错:error build: No such module '*'

4.配置module.modulemap内容

module OcInApp {
    // 所引入头文件相对于`.modulemap`的路径; "./OcClassInApp.h"也可以
    header "OcClassInApp.h" 
    export *
}
  1. import导入使用
import OcInApp
class ViewController: UIViewController {
    override func viewDidLoad() {
        super.viewDidLoad()
        OcClassInApp.description()
    }
}

混入OC Framework

如果引入的OC FrameWork中含有Modules/module.modulemap文件,则直接拖入Swift工程中,使用import引入并进行调用即可。

如果OC FrameWork不支持modulemap(没有module.modulemap文件),则有两种方法:

方法一

建立桥接文件,按需导入头文件

方法二

基于OC FrameWork/Modules/module.modulemap路径,创建module.modulemap文件,并输入以下内容并保存,之后便可使用import引入并进行调用。

// 按需导入
framework module SameAsFrameWorkName { //必须与导入的`OC Framework`同名
  header "A.h"
  header "B.h"
  header "b.h"
  //..
  export *
}
///递归导入
framework module SameAsFrameWorkName { //必须与导入的`OC Framework`同名
  umbrella header "SameAsFrameWorkName.h" //SDK对外头文件,包含SDK对外暴露的诸多.h文件

  export *
  module * { export * }
}

混入OC xcframework

与混入OC framework操作基本一致,如果引入的OC xcframework下不同的架构文件下的framework中含有Modules/module.modulemap文件,则直接拖入Swift工程中,使用import引入并进行调用即可。

如果OC xcframework不支持modulemap,也是有两种方法:

方法一

建立桥接文件,按需导入头文件。

方法二

OC xcframework下不同架构framework,参考混入OC framework的方法二,即可调用。

Swift Framework

Swift Framework仅有Swift类时,如果是需要SDK外部使用的ClassMethod,则只需要使用publicopen修饰。

image.png

Swift工程导入Swift Framework后,直接在Swift的工程中使用即可。

import RadarSDK
class ViewController: UIViewController {
    override func viewDidLoad() {
        super.viewDidLoad()
        RadarEntry.start()
    }
}

注意:Swift Framework中是不支持使用桥接文件的,不然的话会报错:

image.png

混入OC/C/C++代码

示例工程结构如下:

image.png

内部使用 OC

SDK内部的Swift类,不能直接使用OC的代码,并且不支持桥接文件。因此只能使用module.modulemap文件

  1. 创建文件名必须为module 后缀为.modulemap的文件。
  2. 配置工程BuildSettingSwift Compiler - Search Paths选项,值为module.modulemap文件所在的目录路径或其上层目录路径,此处可为:
${SRCROOT}/SwiftMixSDK/ObjcSources
${SRCROOT}/SwiftMixSDK
  1. 配置module.modulemap内容
module ObjcInFramwork {
    header "ObjcClassA.h"
    header "ObjcClassB.h"
    export *
}
  1. 使用
import ObjcInFramwork
public class SwiftMixTest: NSObject {
   public static func mixTest() {
        ObjcClassA.description()
        print("Swift MixIn OC")
    }
}

外部使用OC

如果Swift Framework外部需要调用混入的OC,有两种方法:

方法一

Swift Framework外接.h头文件以#import <SwiftMixSDK/PublicHeader.h>的方法对外公开需要使用的OC头文件。

  1. 配置 Frame Targetbuild Phases,使得OC头文件公开
image.png


image.png
  1. Swift Framework外接.h文件import需要公开的OC头文件
    image.png
  1. 使用
import UIKit
import SwiftMixSDK
class ViewController: UIViewController {
    override func viewDidLoad() {
        super.viewDidLoad()
        SwiftMixTest.mixTest()
        ObjcClassA.description()
        ObjcClassB.description()
    }
}
  1. 编译最终产物对外暴露的头文件
image.png


image.png

方法二

自定义Swift Framework.modulemap文件。

  1. 自定义module.modulemap文件;此处的文件名不强制module,但建议用module,因为编译器最终会合并自定义的文件,最终导出module.modulemap文件。
  2. 配置 Frame Targetbuild Setting,保证Define ModuleYES; Module Map File 为自定义.modulemap文件的路径。
image.png
  1. 配置module.modulemap内容
framework module SwiftMixSDK {
    umbrella header "SwiftMixSDK.h"
    export *
    module * {export *}
    module ObjcInFramwork {
        header "/Users/*/Desktop/*/SwiftSDKExample/SwiftMixSDK/ObjcSources/ObjcClassA.h"
        header "/Users/*/Desktop/*/SwiftSDKExample/SwiftMixSDK/ObjcSources/ObjcClassB.h"
        export *
    }
}

最终SDKmodulemap:

image.png

值得注意的是,此处的header,只能使用绝对路径,否则会出错。 stackoverflow此问题的QA

  1. 使用
import UIKit
import SwiftMixSDK.ObjcInFramwork
class ViewController: UIViewController {
    override func viewDidLoad() {
        super.viewDidLoad()
        SwiftMixTest.mixTest()
        ObjcClassA.description()
        ObjcClassB.description()
    }
}
  1. 编译最终产物对外暴露的头文件
image.png

小结

综上可以看出,两种方法编译的最终产物存在差异:

方法一会暴露OC头文件的;方法二会隐藏OC的头文件。
多人协作开发Swift Framework时,方法二会存在频繁修改.modulemap文件文件。因此实际开发中还得基于项目决定方案。

混入OC Framework

OC Framework不支持Module时,有两种方式混入OC Framework

方法一

通过使用.modulemap文件,实现对OC Framework调用。即:OC Framework支持(自动或者手动)module

方法二

参考上述 混入OC/C/C++代码 —— 内部使用OC ,创建module.modulemap文件,配置相关Building Setting。配置module.modulemap内容如下:

module ObjcFramwork {
    ///相对于module.modulemap的相对路径
    umbrella header "../ObjcFramwork.framework/Headers/ObjcFramwork.h"
    export *
    module * { export * }
}

最后在Swift文件中import ObjcFramwork,即可调用。

混入OC xcframework

OC xcframework不支持Module时,有两种方式混入OC xcframework

方法一
OC xcframework下不同架构framework,参考混入OC Framework方法一,进行操作后即可调用。

方法二

参考上述 混入OC/C/C++代码 —— 内部使用OC ,创建module.modulemap文件,配置相关Building Setting

这些操作与混入OC Framework方法二一致,唯一有区别在于:OC xcframework包含多种架构的Framework

image.png

因此不能通过相对路径直接引入,因为不同架构路径下的同一个头文件会相互覆盖而报错;

image.png

如何解决呢?我们可以通过新建一个ObjcXCFramwork-umbrella.h文件(可以是其它名称),并在其中引入xcframework的头文件:

#import <MyTestSDK/MyTestSDK.h>

然后配置module.modulemap内容如下:

module ObjcXCFramwork {
  umbrella header "ObjcXCFramwork-umbrella.h"

  export *
  module * { export * }
}

最后在Swift文件中import ObjcXCFramwork,即可调用。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 156,907评论 4 360
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 66,546评论 1 289
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 106,705评论 0 238
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,624评论 0 203
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 51,940评论 3 285
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,371评论 1 210
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,672评论 2 310
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,396评论 0 195
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,069评论 1 238
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,350评论 2 242
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,876评论 1 256
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,243评论 2 251
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,847评论 3 231
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,004评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,755评论 0 192
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,378评论 2 269
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,266评论 2 259

推荐阅读更多精彩内容