优雅的开发Swift和Objective-C混编的Framework

前言

为什么要写这样一篇文章，因为昨天和一个朋友讨论到Swift和Objective C如何混合开发Framework，中途发现了很多有意思的坑。

用Swift封装OC的库是一件比较常见的事情，毕竟对于大多数公司来说，老的代码都是用OC写的，而且经过多次迭代，这些OC的代码已经被验证了是稳定的，用Swift重写代价太大。这就引入了一个需求：

• 用Swift和OC来混编一个Framework。

如果你之前没有用Swift和Objective C混合开发，建议看看这篇文档：

• Swift and Objective-C in the Same Project

https://developer.apple.com/library/content/documentation/Swift/Conceptual/BuildingCocoaApps/MixandMatch.html

按照文档一步一步来

新建一个基于单页面工程，然后新建一个一个Target，选中Cocoa Touch Framework。然后，分别新建一个Swift文件和Objective C类，注意Target Member Ship选中Framework。类的内容如下：

OCSource.h

1. #import <span class="hljs-title"><Foundation/Foundation.h></span> 
2.  
3.   
4.  
5. @interface OCSource : NSObject 
6.  
7. - (void)functionFromOC; 
8.  
9. @end  

OCSource.m

1. #import "OCSource.h" 
2.  
3.   
4.  
5. @implementation OCSource 
6.  
7.   
8.  
9. - (void)functionFromOC{ 
10.  
11.     NSLog(@"%@",@"Log from objective c in framework"); 
12.  
13. } 
14.  
15. @end  

Swift调用OC

新建SwiftSource.swift

1. open class SwiftIt{ 
2.  
3.     public init(){} 
4.  
5.     let ocObject = OCSource() 
6.  
7.     public func encapsulate(){ 
8.  
9.         ocObject.functionFromOC() 
10.  
11.     } 
12.  
13. }  

然后，按照文档中，为了让Swift文件访问Objective C文件，我们应该在umbrella header，也就是MixFramework.h中，暴露所需要的header。

也就是，MixFramework.h,

1. #import <MixFramework/OCSource.h> 

然后，自信满满的点击build。

Boom～～～，编译不通过。

原因：OCSource.h默认编译的时候是Project权限. 为了在umbrella header中使用，要把这个文件的权限改成Public

按照图中的方式拖过去即可。

嗯，现在build，可以看到build成功了。

OC调用Swift

在SwiftSource.swift中，增加一个类，

1. open class ClassForOC:NSObject{ 
2.  
3.     public static let textForOC = "textForOC" 
4.  
5. }  

然后，为了在OC中调用Swift的方法，我们需要导入头文件，这时候，OCSource.m文件内容如下

1. #import "OCSource.h" 
2.  
3. #import <MixFramework/MixFramework-Swift.h> 
4.  
5.   
6.  
7. @implementation OCSource 
8.  
9.   
10.  
11. - (void)functionFromOC{ 
12.  
13.     NSLog(@"%@",[ClassForOC textForOC]); 
14.  
15. } 
16.  
17. @end  

然后，build，发现成功了，很开心。

外部调用

在ViewController.swift中，我们调用Framework中的内容。

1. import MixFramework 
2.  
3. class ViewController: UIViewController { 
4.  
5.     var t = SwiftIt() 
6.  
7.     override func viewDidLoad() { 
8.  
9.         super.viewDidLoad() 
10.  
11.         t.encapsulate() 
12.  
13.         // Do any additional setup after loading the view, typically from a nib. 
14.  
15.     } 
16.  
17.   
18.  
19.     override func didReceiveMemoryWarning() { 
20.  
21.         super.didReceiveMemoryWarning() 
22.  
23.         // Dispose of any resources that can be recreated. 
24.  
25.     } 
26.  
27. }  

然后运行，发现控制台打印出

1. 2017-03-02 16:08:24.000 HostApplication[19524:167669] textForOC 

嗯，framework打包成功了。

问题

通常，我们希望暴露给外部的接口是纯Swift，而OC文件的具体接口应该隐藏，这就是我标题中的优雅两个字的含义。

如果你好奇，你会发现，在ViewController.swift中你可以这么调用

1. var s = OCSource() 

也就是说，OC的内容也暴露出来了，这破坏了Framework的封装特性。

通过查看MixFramework的编译结果，发现最后暴露出的接口是这样子的

1. import Foundation 
2.  
3. import MixFramework.OCSource 
4.  
5. import MixFramework 
6.  
7. import MixFramework.Swift 
8.  
9. import SwiftOnoneSupport 
10.  
11. import UIKit 
12.  
13.   
14.  
15. // 
16.  
17. //  MixFramework.h 
18.  
19. //  MixFramework 
20.  
21. // 
22.  
23. //  Created by Leo on 2017/3/2. 
24.  
25. //  Copyright © 2017年 Leo Huang. All rights reserved. 
26.  
27. // 
28.  
29.   
30.  
31. //! Project version number for MixFramework. 
32.  
33. public var MixFrameworkVersionNumber: Double 
34.  
35. open class ClassForOC : NSObject { 
36.  
37.   
38.  
39.     public static let textForOC: String 
40.  
41. } 
42.  
43.   
44.  
45. open class SwiftIt { 
46.  
47.   
48.  
49.     public init() 
50.  
51.   
52.  
53.     public func encapsulate() 
54.  
55. }  

这一行，把OC对应的实现暴露出来了

1. import MixFramework.OCSource 

优雅的解决方案

不再通过umbrella header的方式让framework中的Swift调用OC方法。而是通过modulemap。

新建一个module.modulemap文件，内容如下

1. module OCSource [system] { 
2.  
3.     //由于module.modulemap和OCSource.h是在同一个文件夹的，如果不是同一个，路径要写全 
4.  
5.     header "OCSource.h" 
6.  
7.     export * 
8.  
9. }   

这里的#(SRCROOT)是XCode的宏，会自动替换成项目所在的根目录，这里输入的路径是module.modulemap文件所在的路径。

然后，删除MixFramework.h(umbrella header)中#import 的OC header。

把OCSource.h的权限改回默认的project。

再编译，发现OC的类被隐藏了。

总结

如果你要开发一个framework，一定要想清楚哪些接口暴露出去，哪些封装起来，framework不是简单把一包文件加个壳子。