Swift 调用 OC 实用技巧

语言: CN / TW / HK

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 此处可为: sh ${SRCROOT}/MixFrameworkTest ${SRCROOT}/MixFrameworkTest/ObjcInSwitApp 如果这里的路径配置不正确便会报错:error build: No such module '*'

4.配置module.modulemap内容 js module OcInApp { // 所引入头文件相对于`.modulemap`的路径; "./OcClassInApp.h"也可以 header "OcClassInApp.h" export * } 5. import导入使用 swift 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引入并进行调用。 js // 按需导入 framework module SameAsFrameWorkName { //必须与导入的`OC Framework`同名 header "A.h" header "B.h" header "b.h" //.. export * } ``js ///递归导入 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.pngSwift工程导入Swift Framework后,直接在Swift的工程中使用即可。 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文件所在的目录路径或其上层目录路径,此处可为:

sh ${SRCROOT}/SwiftMixSDK/ObjcSources ${SRCROOT}/SwiftMixSDK 3. 配置module.modulemap内容

js module ObjcInFramwork { header "ObjcClassA.h" header "ObjcClassB.h" export * } 4. 使用 swift 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.pngimage.png 2. 在Swift Framework外接.h文件import需要公开的OC头文件 image.png

  1. 使用

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

image.pngimage.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内容

js 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. 使用

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

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内容如下: js 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的头文件: ```objc

import

然后配置`module.modulemap`内容如下:js module ObjcXCFramwork { umbrella header "ObjcXCFramwork-umbrella.h"

export * module * { export * } } `` 最后在Swift文件中import ObjcXCFramwork`,即可调用。