NS_UNAVAILABLE 与 NS_DESIGNATED_INITIALIZER

https://www.jianshu.com/p/5654942cd8f7

当面对多个初始化方法时,外部调用者往往会手足无措,不知道哪一个才是正确的初始化方法,对此,苹果提供了两个关键字: NS_UNAVAILABLE 与 NS_DESIGNATED_INITIALIZER 来帮助我们约束定义方式,使得接口描述更加清晰。

对于多个 init 方法,苹果给出了一个调用顺序,而我们也应该遵守这种调用顺序,以确保无论外部调用者从哪个入口进入,都能够正确的初始化:

init方法调用顺序

可以看到真正在进行初始化参数的,是 initWithTitle:date: ,如果调用者通过 init 或者 initWithTitle: 进入,都应该确保变量 title 和 date 能正确赋值,所以 init 与 initWithTitle: 都通过调用 initWithTitle:date: 来初始化。
最后 initWithTitle:date: 在通过父类的 init 初始化,并初始化两个变量。
对于这种能初始化全部必需变量的方法,一般可作为 designed initializer 。所以,可以明确的告诉外部调用者,无论调用哪种初始化方法,最终,都会调用 designed initializer:

  • (instancetype)initWithTitle:(NSString *)title date:(NSDate *)date NS_DESIGNATED_INITIALIZER;

一个子类如果有自己的 designed initializer,则必须要实现父类的 designed initializer。比如一个继承自 NSObject 的 Person 类,就必须要重写 init 方法,并在 init 方法中,调用自己的 designed initializer,而不是调用 super 的初始化方法。如果未实现,可以看到编译警告:

Method override for the designed initializer of the superclass ‘- init’ not found.

所以,对于 Person 来说,如果 initWithName: 被标记了 NS_DESIGNED_INITIALIZER ,那么实现应该为:

  • (instancetype)init {
    // 在外部调用不需要 name 变量时,应该给出默认值
    return [self initWithName:@"John doe"];
    }

  • (instancetype)initWithName:(NSString *)name {
    self = [super init];
    if (self) {
    self.name = name;
    }
    return self;
    }

除此之外,子类的 designed initializer 方法,在调用 super 时,也应该调用 super 的 designed initializer。也就是说,如果 CustomView 是 UIView 的子类,那么应该写作:

// 实现 UIView 的 designed initializer

  • (instancetype)initWithCoder:(NSCoder *)aDecoder {
    return [self initWithVideoID:@0];
    }

// 实现 UIView 的 designed initializer

  • (instancetype)initWithFrame:(CGRect)frame {
    return [self initWithVideoID:@0];
    }

// 实现自己的 designed initializer

  • (instancetype)initWithVideoID:(NSNumber *)videoID {
    // 这里在调用 super 的初始化方法时,就不能调用 init,因为 init 不是 UIView 的 designed initializer
    self = [super initWithFrame:CGRectZero];
    if (self) {
    self.videoID = videoID;
    [self setupUI];
    }
    return self;
    }

NS_UNAVAILABLE

在定义初始化方法时,除了能够用 NS_DESIGNATED_INITIALIZER 标记以外,还可以使用更为强势的 NS_UNAVAILABLE 。和 NS_DESIGNATED_INITIALIZER 用于明确初始化方法方式不同, NS_UNAVAILABLE 的作用是,直接禁用其他初始化方法,简单粗暴。

假设,对于 User 类,如果没有 userID 就代表着用户无效,那么我们也没必要给 init 方法一个默认的 userID = 0 ,或者 userID = nil 。此时,需要告诉调用者,就只能通过 userID 来初始化,那么可以写作:

  • (instancetype)new NS_UNAVAILABLE;
  • (instancetype)init NS_UNAVAILABLE; ///< 直接标记 init 方法不可用
  • (instancetype)initWithUserID:(NSNumber *)userID;

方法一旦标记 NS_UNAVAILABLE ,那么在 IDE 自动补全时,就不会索引到该方法,并且如果强制调用该方法,编译器会报错(但并不代表着方法不能被调用,runtime 依然可以做到)。

除了可以直接使用 NS_UNAVAILABLE 标记不可用以外,还有一些其他的方式:

// 作用与 NS_UNAVAILABLE 类似

  • (id) init __unavailable;
  • (id) init attribute((unavailable));
  • (id) init UNAVAILABLE_ATTRIBUTE;

// 在调用时给出提示

  • (id) init attribute((unavailable("Must use initWithFoo: instead.")));

甚至是在调用时抛出异常等,比如 userID 不能小于 0:

  • (instancetype)initWithUserID:(NSNumber *)userID {
    self = [super init];
    if (self) {
    if (userID.integerValue <= 0) {
    // raise: 原因
    // format: 具体描述
    [NSException raise:@"error parameter" format:@"user id can not = %@", userID];
    }
    self.userID = userID;
    }
    return self;
    }

小结

NS_DESIGNATED_INITIALIZER 与 NS_UNAVAILABLE 都能清晰的告知调用者应该如何调用方法。

如果是可以给出默认值初始化方法,那么使用 NS_DESIGNATED_INITIALIZER 就可以。
如果是必须要用某参数来初始化的,可以使用 NS_UNAVAILABLE 。
如果需要在内部验证参数是否合法,如果不合法就一定不能成功的,也可以在实现的时候,验证并抛出异常。
具体选择使用哪一种方式,可以根据具体的情况来看。

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

推荐阅读更多精彩内容