在iOS混编项目中改造objc代码

对objc代码改造,适应swift调用的同时,也能提升objc代码质量

1.可选值

//在这两个宏之间的都默认是nonnull型
NS_ASSUME_NONNULL_BEGIN
NS_ASSUME_NONNULL_END
//如要指定某个属性、返回值或者参数为可选值类型,则可以单独使用下面的关键字
nullable _Nullable

nullable、nonnull_Nullable、_Nonnull的区别
nullable、nonnull用在方法参数或者属性的修饰
_Nullable、_Nonnull用在常量、任意指针的修饰
当不确定是否会返回空值时,可使用null_unspecified、_Null_unspecified修饰
ps.当使用以上关键词修饰后,需特别注意编译器抛出的警告⚠️
例如一个使用nonnull修饰的NSString属性,返回了nil,此时编译器会抛出警告,不影响编译执行,但在swift调用中,则会返回一个""空的字符串,这可能就会导致类似 if string == "xx" else的条件语句结果与预期不一致,导致逻辑错误。而如果是其它类型,则可能会导致闪退

2.枚举、常量、宏

枚举,首先要避免使用c的enum,改为使用NS_ENUMNS_OPTION;然后使用NS_SWIFT_NAME适配swift规范

如下一个OC的枚举

typedef NS_ENUM(NSUInteger, NotificationServiceType) {
    NotificationServiceTypeLocal,
    NotificationServiceTypeRemote
};

系统会自动转换为

public enum NotificationServiceType : UInt {
    case local = 0
    case remote = 1
}

如果要像UITableViewCellStyle转换为UITableViewCell.Style则可使用NS_SWIFT_NAME(NotificationService.Type)

typedef NS_ENUM(NSUInteger, NotificationServiceType) {
    NotificationServiceTypeLocal,
    NotificationServiceTypeRemote
} NS_SWIFT_NAME(NotificationService.Type);
@interface NotificationService : UNNotificationServiceExtension
@end
extension NotificationService {
    public enum `Type` : UInt {
        case local = 0
        case remote = 1
    }
}
open class NotificationService : UNNotificationServiceExtension {
    open var type: NotificationService.`Type`
}

常量改造

字符串常量使用:NS_STRING_ENUM NS_EXTENSIBLE_STRING_ENUM
常数常量使用:NS_TYPED_ENUM NS_TYPED_EXTENSIBLE_ENUM
如下定义的字符串常量

FOUNDATION_EXTERN NSString *const NotificationServiceOptionTitle;
FOUNDATION_EXTERN NSString *const NotificationServiceOptionSubtitle;
FOUNDATION_EXTERN NSString *const NotificationServiceOptionBody;

如要更适用swift调用,则需做如下改造
1.首先上述的例子,在objc中也是不够规范的,应当typedef NSString *const NotificationServiceOption;进行类型声明
2.使用NS_STRING_ENUM或者NS_EXTENSIBLE_STRING_ENUM修饰NotificationServiceOption
改造如下:

typedef NSString *const NotificationServiceOption NS_STRING_ENUM;
FOUNDATION_EXTERN NotificationServiceOption NotificationServiceOptionTitle;
FOUNDATION_EXTERN NotificationServiceOption NotificationServiceOptionSubtitle;
FOUNDATION_EXTERN NotificationServiceOption NotificationServiceOptionBody;

swift转换如下

//NS_STRING_ENUM
public struct NotificationServiceOption : Hashable, Equatable, RawRepresentable {
    public init(rawValue: String)
}
extension NotificationServiceOption {
    public static let title: NotificationServiceOption
    public static let subtitle: NotificationServiceOption
    public static let body: NotificationServiceOption
}

NS_STRING_ENUMNS_EXTENSIBLE_STRING_ENUM的区别在于,NS_EXTENSIBLE_STRING_ENUM在swift中可扩展

宏定义

swift无法完全识别objc中的宏定义,对于单个变量的宏定义,如字符串、常数等,swift会识别为常量
#define NotificationServiceToken @"abcdefg"会被识别为public var NotificationServiceToken: String { get }
而一些复杂的表达式,方法宏则无法被swift识别

3.错误处理

使用NS_ERROR_ENUM定义error枚举
SDWebImage中的做法为例

FOUNDATION_EXPORT NSErrorDomain const _Nonnull SDWebImageErrorDomain;
typedef NS_ERROR_ENUM(SDWebImageErrorDomain, SDWebImageError) {
    SDWebImageErrorInvalidURL = 1000, 
    SDWebImageErrorBadImageData = 1001,
};

会被swift识别为

public let SDWebImageErrorDomain: String
public struct SDWebImageError {
    public init(_nsError: NSError)
    public static var errorDomain: String { get }
    public enum Code : Int {
        public typealias _ErrorType = SDWebImageError
        case invalidURL = 1000
        case badImageData = 1001 
    }
    public static var invalidURL: SDWebImageError.Code { get }
    public static var badImageData: SDWebImageError.Code { get }
}

这样就可以像swift原生一样,使用SDWebImageError处理异常

func testSDWebImageError() {
    do {
        let url = try testThrowSDError(path: "")
    } catch let error as SDWebImageError {
        switch error.code {
        case .invalidURL:
            // do something
            print("invalidURL")
            break
        default: break
        }
    } catch {
    }
}
func testThrowSDError(path: String?) throws -> URL {
    if let path = path, !path.isEmpty, let url = URL(string: path) {
        return url
    } else {
        throw SDWebImageError(.invalidURL)
    }
}

4.api命名 NS_SWIFT_NAME

通常swift识别的objc方法,会根据返回值类型、方法名、参数类型、参数名等语义识别出恰当的swift函数名、参数标签、参数名等,但有时并不能完全符合开发者的期望,此时可NS_SWIFT_NAME手动声明swift转换的函数名

5.构造器

NS_DESIGNATED_INITIALIZER,NS_UNAVAILABLE

6.第三方库的引用

1.CocoaPods引用OC库,在pod路径后添加:modular_headers => true参数
2....

7.使用objc泛型

//bad
@property (strong) NSArray *array;
@property (strong) NSDictionary *dictionary;
//good
@property (strong) NSArray<NSString *> *genericArray;
@property (strong) NSDictionary<NSString *, NSString *> *genericDictionary;

//bad
open var array: [Any]
open var dictionary: [AnyHashable : Any]
//good
open var genericArray: [String]
open var genericDictionary: [String : String]

最后,值得一提的是,以上改造不仅仅便于swift调用,也能提升objc的代码质量和规范。同时从swift的角度去思考objc代码,也能加深对objc结构的理解。

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

推荐阅读更多精彩内容