Objective-C 和 Swift 混編專案的小 Tips(一)

tingxins發表於2017-12-24

本文主要閒聊一些 Objective-C 和 Swift 混編專案帶來的一些潛規則,希望能幫到對此感到疑惑的朋友。下面我們開始進入主題:

命名

官方 Guide 上只是簡單敘述(Using Swift with Cocoa and Objective-C),即 Swift 編譯器會在我們使用 Objective-C 的 API 時自動的將其轉成 Swift 風格的 API(說白了就是會對一些方法名、列舉名等等做一些有規則的刪減,即重新命名)。

單例方法命名

在 Swift 中引用 Objective-C 單例時,如果單例方法包含於類名,則會出現編譯錯誤,下面我們來看幾個例子。

Example 1


@interface TXLocationManager : NSObject

+ (instancetype)manager;

@end

複製程式碼

TXLoginManager 類有一個單例方法命名為 manager,在 Swift 中引用 manager 方法時,會出現編譯錯誤:

Objective-C 和 Swift 混編專案的小 Tips(一)

說白了,manager 方法已經廢了。。。

Example 2

在 Example 1 的基礎上,我們把單例方法的命名改一改:


@interface TXLocationManager : NSObject

+ (instancetype)shareInstance;

@end

複製程式碼

單例方法命名改成 shareInstance 後,編譯通過了。至此,至少問題已經解決了,現在我們再簡單看看是什麼原因?為何 manager 方法無法引用,而 shareInstance 卻可以引用呢?

Example 3

在 Example 1 的基礎上,把 manager 單例方法名稱改為 shareManager :


@interface TXLocationManager : NSObject

+ (instancetype)shareManager;

@end

複製程式碼

我們可以發現在 Swift 中引用時,shareManager 方法名被重新命名為 share :

Objective-C 和 Swift 混編專案的小 Tips(一)

小結

至此,我們可以得出一個簡單的命名潛規則:在 Swift 中引用 Objective-C 單例時,如果單例方法包含於類名,則會出現編譯錯誤,準確的說,應該是如果單例方法的名稱正好是該類名駝峰命名的字尾,那麼在 Swift 中引用該單例方法時,會出現編譯錯誤。

為何在 Swift 中引用 Objective-C 類的 API 會出現這種問題呢?官方 Guide 上時這樣描述的:

The Swift compiler automatically imports Objective-C code as conventional Swift code. It imports Objective-C class factory methods as Swift initializers, and Objective-C enumeration cases truncated names.

因為 Swift 編譯器在使用 Objective-C 的程式碼時會自動的將其轉成 Swift 風格的程式碼,就是會對一些方法名、列舉名等等做一些有規則的刪減。

There may be edge cases in your code that are not automatically handled. If you need to change the name imported by Swift of an Objective-C method, enumeration case, or option set value, you can use the NS_SWIFT_NAME macro to customize how a declaration is imported.

根據官方 Guide,上述的這種 case 屬於 特殊的情況。那如何解決這種問題呢,Swift 提供了一個巨集,專門處理我們遇到的這種 case —— NS_SWIFT_NAME


@interface TXLocationManager : NSObject

+ (instancetype)manager NS_SWIFT_NAME(shareInstance());

@end

複製程式碼

這樣,manager 該單例方法,當我們在 Swift 中引用時,會被重新命名為 shareInstance。


let _ = TXLocationManager.shareInstance()

複製程式碼

普通方法命名

有時候,我們在 Swift 中引用 Objective-C 中某個類的 API 時,方法名是可能會被重新命名的,下面我們直接看例子。

類方法


@interface TXLocationManager : NSObject

+ (instancetype)managerWithCoordinateY:(CGFloat)y

// Or
// + (TXLocationManager *)managerWithCoordinateY:(CGFloat)y

@end

複製程式碼

當該類的類方法返回自身型別的例項物件時,上述的方法會被重新命名。應該這樣引用:

// 方式一:
let _ = TXLocationManager.init(coordinateY: 9)

// 方式二:
let _ = TXLocationManager(coordinateY: 9)

// 錯誤引用方式,編譯失敗
let _ = TXLocationManager.manager(withCoordinateY: 9)

複製程式碼

通過上述實踐,我們可以發現類方法中的 manager 字首會被刪掉,而且變成了 Swift 中的 init 方法。如果該類的類方法不返回自身型別的例項物件呢?


@interface TXLocationManager : NSObject

+ (void)managerWithCoordinateY:(CGFloat)y;

// Or
// + (NSObject *)managerWithCoordinateY:(CGFloat)y;
// + (CGFloat)managerWithCoordinateY:(CGFloat)y;

@end

複製程式碼

通過實踐可以發現,在 Swift 中是可以這樣引用的:


TXLocationManager.manager(withCoordinateY: 9)

複製程式碼

這種方式的引用同我們一般的方法引用是一致的,無異同。

例項方法

例項方法的重新命名規則與類方法有點相似,此處就不再詳述了,感興趣的朋友可以自己實踐一下。(當然方法的重新命名我們一般都可以通過 NS_SWIFT_NAME 來指定)

參考連結

How to call an Objective-C singleton from Swift?

相關文章