DEBUG=1 宏定义对 @weakify 和 @strongify 的影响分析

时间:2022-07-28
本文章向大家介绍DEBUG=1 宏定义对 @weakify 和 @strongify 的影响分析,主要内容包括其使用实例、应用技巧、基本知识点总结和需要注意事项,具有一定的参考价值,需要的朋友可以参考一下。

前言

相信大部分使用过 ReactiveCocoa 的开发者都会使用都会喜欢 @weakify 和 @strongify 这两个宏。

通过这两个宏,可以实现保持代码可读性的同时,解决 weak-strong dance 问题。

下面,我们带着几个疑问来逐步讲解“DEBUG=1 宏定义对 @weakify 和 @strongify 的影响”

  • 什么情况下会存在 DEBUG=1 宏定义?
  • DEBUG=1 宏定义对 @weakify 和 @strongify 的有什么影响
  • @weakify 和 @strongify 是如何实现首字母是 @ 符号的
  • 为什么 DEBUG=1 宏定义会对 @weakify 和 @strongify 相关编译产生影响

什么情况下会存在 DEBUG=1 宏定义?

默认情况下,Xcode 新建的项目会包含两个 Build Configuration:Debug 和 Release(对于大型APP,可能会扩充到5个以上,用于产出 daily包、内测包、灰度包。)

Debug 和 Release 的不同点:

  • Debug 配置会默认包含 DEBUG=1 的宏定义,而 Release 模式不包含(当然,可以手动添加或者移除)
  • Release 模式启动编译优化(可以手动调整)
  • Profile 和 Archive(打包) 默认使用 Release 模式 (可以手动调整为 Debug)
  • Release 模式默认针对 OC 语言关闭 NSAssert 相关的宏(可以手动打开)
  • ...

知识一、Debug 配置默认添加了 DEBUG=1 的宏定义

知识二、是否存在 DEBUG=1 完全由开发者决定,不受其它因素影响

如何查看当前的配置

点击项目名称,在弹出框中,点击 Edit Scheme...

左侧的 Run、Test、Profile 下方就是每种 Action 使用配置,比如,Run 使用 Debug 配置。

如何调整当前的配置

以 Run 为例,在模态视图中,点击 Build Configuration 右侧的 Debug 就可以切换配置

知识三:对于普通程序员来说,只要掌握了 Release 和 Debug 的默认不同点,完全可以在 Release 模式增加 DEBUG=1 进行开发。

DEBUG=1 宏定义对 @weakify 和 @strongify 有什么影响

如下:示例代码中定义了一个 block,该 block 用于判断入参 obj 是否和 foofar 其中的任何一个对象相等并返回 YESNO

    id foo = [[NSObject alloc] init];
    id bar = [[NSObject alloc] init];

    @weakify(foo, bar);

    // this block will not keep 'foo' or 'bar' alive
    BOOL (^matchesFooOrBar)(id) = ^ BOOL (id obj){
        // but now, upon entry, 'foo' and 'bar' will stay alive until the block has
        // finished executing
        @strongify(foo, bar);

        return [foo isEqual:obj] || [bar isEqual:obj];
    };

首先,我们将 block 最后一行代码 return [foo isEqual:obj] || [bar isEqual:obj]; 移走。 如下所示,

    {
        id foo = [[NSObject alloc] init];
        id bar = [[NSObject alloc] init];

        @weakify(foo, bar);

        BOOL (^matchesFooOrBar)(id) = ^ BOOL (id obj){
            @strongify(foo, bar);
            NSLog(@"%@,%@", foo, bar);
        };
    }

在 DEBUG=1 存在时,进行编译。如下所示,Xcode 产生一个 Control reaches end of non-void block 的编译错误。

错误提示.png

下面,再试试 DEBUG=1 宏定义不存在的场景。 理想的情况时,Xcode 依然编译错误。但是,现实往往是残酷的,Xcode 只提供了一个未使用变量的警告⚠️。

无错误提示.png

总结一、DEBUG=1 不存在时,Xcode 会 suppress return-type warnings,导致产出错误的可执行程序。

@weakify 和 @strongify 是如何实现首字母是 @ 符号的

在进一步分析前,我们需要看看 @weakify 和 @strongify 是如何实现首字母是 @ 符号的。

本文意在说明“DEBUG=1 宏定义对 @weakify 和 @strongify ”的影响,所以不会全面的讲解这两个宏。 如果您对其感兴趣,请参考其它作者的文章或者自行查看源码。

这两个宏的定义如下:

EXTScope.h#L45-L47

#define weakify(...) 
    rac_keywordify 
    metamacro_foreach_cxt(rac_weakify_,, __weak, __VA_ARGS__)

EXTScope.h#L83-L88

#define strongify(...) 
    rac_keywordify 
    _Pragma("clang diagnostic push") 
    _Pragma("clang diagnostic ignored "-Wshadow"") 
    metamacro_foreach(rac_strongify_,, __VA_ARGS__) 
    _Pragma("clang diagnostic pop")

其中 rac_keywordify 的定义如下: EXTScope.h#L114-L118

#if DEBUG
#define rac_keywordify autoreleasepool {}
#else
#define rac_keywordify try {} @catch (...) {}
#endif

当 DEBUG=1 时,@weakify 会被展开为 @autoreleasepool {} 。所以,* @weakify 和 @strongify 是实现了首字母是 @ 符号。 知识四:@autoreleasepool {} 是合法的 OC 语法糖。 知识五: @try {} @catch (...) {} 是合法的 OC 语法糖。

为什么 DEBUG=1 宏定义会对 @weakify 和 @strongify 相关编译产生影响

最后,我们看看问题的本质。 移除 DEBUG 宏定义后,rac_keywordify 被定义为 #define rac_keywordify try { } @catch(...) {},经预处理器处理后,会转换为下面的代码

        id foo = [[NSObject alloc] init];
        id bar = [[NSObject alloc] init];

        @try { } @catch(...) {} __attribute__((objc_ownership(weak))) __typeof__(foo) foo_weak_ = (foo); __attribute__((objc_ownership(weak))) __typeof__(bar) bar_weak_ = (bar);;

        BOOL (^matchesFooOrBar)(id) = ^ BOOL (id obj){
            @try { } @catch(...) {}
# 99 "/Users/L/Documents/workspace/.../AppDelegate.m"
#pragma clang diagnostic push
# 99 "/Users/L/Documents/workspace/.../AppDelegate.m"
#pragma clang diagnostic ignored "-Wshadow"
# 99 "/Users/L/Documents/workspace/.../AppDelegate.m"
 __attribute__((objc_ownership(strong))) __typeof__(foo) foo = foo_weak_; __attribute__((objc_ownership(strong))) __typeof__(bar) bar = bar_weak_;
# 99 "/Users/L/Documents/workspace/.../AppDelegate.m"
#pragma clang diagnostic pop
# 99 "/Users/L/Documents/workspace/.../AppDelegate.m"
;
            NSLog(@"%@,%@", foo, bar);
        };

@try { } @catch(...) {}被添加到了等式的前面。

在这种情况下,Xcode 本身的错误提示能力能被抑制了,就如同源码的注释中提到的那样。

// Details about the choice of backing keyword:
//
// The use of @try/@catch/@finally can cause the compiler to suppress
// return-type warnings.
// The use of @autoreleasepool {} is not optimized away by the compiler,
// resulting in superfluous creation of autorelease pools.
//
// Since neither option is perfect, and with no other alternatives, the
// compromise is to use @autorelease in DEBUG builds to maintain compiler
// analysis, and to use @try/@catch otherwise to avoid insertion of unnecessary
// autorelease pools.
#if DEBUG
#define rac_keywordify autoreleasepool {}
#else
#define rac_keywordify try {} @catch (...) {}
#endif

总结:

在享受 @weakify 和 @strongify 带来便利的同时,开发者需要确保 DEBUG=1 宏定义的存在。