iOS - Block

一、简介

// 定义一个 Block
typedef returnType (^BlockName)(parameterA, parameterB, ...);

eg: typedef void (^RequestResult)(BOOL result);

// 实例
^{
    NSLog(@"This is a block");
 }

Block 本质上是一个 Objective-C 的对象，它内部也有一个 isa 指针，它是一个封装了函数及函数调用环境的 Objective-C 对象，可以添加到 NSArray 及 NSDictionary 等集合中，它是基于 C 语言及运行时特性，有点类似标准的 C 函数。但除了可执行代码以外，另外包含了变量同堆或栈的自动绑定。

1.Block 的类型

（1）NSGlobalBlock

void (^exampleBlock)(void) = ^{
    // block
};
NSLog(@"exampleBlock is: %@",[exampleBlock class]);

打印日志：exampleBlock is: __NSGlobalBlock__
如果一个 block 没有访问外部局部变量，或者访问的是全局变量，或者静态局部变量，此时的 block 就是一个全局 block ，并且数据存储在全局区。

（2）NSStackBlock

int temp = 100;
void (^exampleBlock)(void) = ^{
    // block
    NSLog(@"exampleBlock is: %d", temp);
};

NSLog(@"exampleBlock is: %@",[exampleBlock class]);

打印日志：exampleBlock is: __NSMallocBlock__ ？？？不是说好的 __NSStackBlock__ 的吗？为什么打印的是 __NSMallocBlock__ 呢？这里是因为我们使用了 ARC ，Xcode 默认帮我们做了很多事情。

我们可以去 Build Settings 里面，找到 Objective-C Automatic Reference Counting ，并将其设置为 No ，然后再 Run 一次代码。你会看到打印日志是：exampleBlock is: __NSStackBlock__

如果 block 访问了外部局部变量，此时的 block 就是一个栈 block，并且存储在栈区。由于栈区的释放是由系统控制，因此栈中的代码在作用域结束之后内存就会销毁，如果此时再调用 block 就会发生问题，( 注： 此代码运行在 MRC 下)如：

void (^simpleBlock)(void);
void callFunc() {
    int age = 10;
    simpleBlock = ^{
        NSLog(@"simpleBlock-----%d", age);
    };
}

int main(int argc, char * argv[]) {
    NSString * appDelegateClassName;
    @autoreleasepool {
        callFunc();
        simpleBlock();
        // Setup code that might create autoreleased objects goes here.
        appDelegateClassName = NSStringFromClass([AppDelegate class]);
    }
    return 0;
}

（3）NSMallocBlock

当一个 __NSStackBlock__ 类型 block 做 copy 操作后，就会将这个 block 从栈上复制到堆上，而堆上的这个 block 类型就是 __NSMallocBlock__ 类型。在 ARC 环境下，编译器会根据情况，自动将 block 从栈上 copy 到堆上。

具体会进行 copy 的情况有如下 4 种：

• block 作为函数的返回值时；
• block 赋值给 __strong 指针，或者赋值给 block 类型的成员变量时；
• block 作为 Cocoa API 中方法名含有 usingBlock 的方法参数时；
• block 作为 GCD API 的方法参数时；

2.__block 的作用

简单来说，__block 作用是允许 block 内部访问和修改外部变量，在 ARC 环境下还可以用来防止循环引用；

__block int age = 10;
void (^exampleBlock)(void) = ^{
    // block
    NSLog(@"1.age is: %d", age);
    age = 16;
    NSLog(@"2.age is: %d", age);
};
exampleBlock();
NSLog(@"3.age is: %d", age);

__block 主要用来解决 block 内部无法修改 auto 变量值的问题，为什么加上 __block 修饰之后，auto 变量值就能修改了呢？
这是因为，加上 __block 修饰之后，编译器会将 __block 变量包装成一个结构体 __Block_byref_age_0，结构体内部 *__forwarding 是指向自身的指针，并且结构体内部还存储着外部 auto 变量。

struct __Block_byref_val_0 {
    void *__isa; // isa指针
    __Block_byref_val_0 *__forwarding; 
    int __flags;
    int __size; // Block结构体大小
    int age; // 捕获到的变量
}

从上图可以看到，如果 block 是在栈上，那么这个 __forwarding 指针就是指向它自己，当这个 block 从栈上复制到堆上后，栈上的 __forwarding 指针指向的是复制到堆上的 __block 结构体。堆上的 __block 结构体中的 __forwarding 指向的还是它自己，即 age->__forwarding 获取到堆上的 __block 结构体，age->__forwarding->age 会把堆上的 age 赋值为 16 。因此不管是栈上还是堆上的 __block 结构体，最终使用到的都是堆上的 __block 结构体里面的数据。

3.__weak 的作用

简单来说是为了防止循环引用。
self 本身会对 block 进行强引用，block 也会对 self 形成强引用，这样就会造成循环引用的问题。我们可以通过使用 __weak 打破循环，使 block 对象对 self 弱引用。

此时我们注意，由于 block 对 self 的引用为 weak 引用，因此有可能在执行 block 时，self 对象本身已经释放，那么我们如何保证 self 对象不在 block 内部释放呢？这就引出了下面 __strong 的作用。

4.__strong 的作用

简单来说，是防止 block 内部引用的外部 weak 变量被提前释放，进而在 block 内部无法获取 weak 变量以继续使用的情况；

__weak __typeof(self) weakSelf = self;
void (^exampleBlock)(void) = ^{
    __strong __typeof(weakSelf) strongSelf = weakSelf;
    [strongSelf exampleFunc];
};

这样就保证了在 block 作用域结束之前，block 内部都持有一个 strongSelf 对象可供使用。

但是，即便如此，依然有一个场景，就是执行 __strong __typeof(weakSelf) strongSelf = weakSelf; 之前，weakSelf 对象已经释放，这时如果给 self 对象发送消息，这没有问题，Objective-C 的消息发送机制允许我们给一个 nil 对象发送消息，这不会出现问题。但如果有额外的一些操作，比如说将 self 添加到数组，这时因为 self 为 nil，程序就会 Crash。

我们可以增加一层安全保护来解决这个问题，如：

__weak __typeof(self) weakSelf = self;
void (^exampleBlock)(void) = ^{
    __strong __typeof(weakSelf) strongSelf = weakSelf;
    if (strongSelf) {
        // Add operation here
    }
};

二、拓展

1.思考题

block 内修改外部 NSMutableString 、NSMutableArray 、NSMutableDictionary 对象，是否需要添加 __block修饰？

NSMutableArray *mutableArray = [[NSMutableArray alloc] init];
[mutableArray addObject:@"1"];
void (^exampleBlock)(void) = ^{
    // block
    [mutableArray addObject:@"2"];
};
exampleBlock();
NSLog(@"mutableArray: %@", mutableArray);

答案是：不需要，因为在 block 内部，我们只是使用了对象 mutableArray 的内存地址，往其中添加内容。并没有修改其内存地址，因此不需要使用 __block 也可以正确执行。当我们只是使用局部变量的内存地址，而不是对其内存地址进行修改时，我们无需对其添加 __block ，如果添加了 __block 系统会自动创建相应的结构体，这种情况冗余且低效。

2. Block 数据结构

内部数据结构图如下：

struct Block_descriptor {
    unsigned long int reserved;
    unsigned long int size;
    void (*copy)(void *dst, void *src);
    void (*dispose)(void *);
};

struct Block_layout {
    void *isa;
    int flags;
    int reserved; 
    void (*invoke)(void *, ...);
    struct Block_descriptor *descriptor;
    /* Imported variables. */
};

Block_layout 结构体成员含义如下：

• isa: 指向所属类的指针，也就是 block 的类型
• flags: 按 bit位表示一些 block 的附加信息，比如判断 block 类型、判断 block 引用计数、判断 block 是否需要执行辅助函数等；
• reserved: 保留变量；
• invoke: block 函数指针，指向具体的 block 实现的函数调用地址，block 内部的执行代码都在这个函数中；
• descriptor: 结构体 Block_descriptor，block 的附加描述信息，包含 copy/dispose 函数，block 的大小，保留变量；
• variables: 因为 block 有闭包性，所以可以访问 block 外部的局部变量。这些 variables 就是复制到结构体中的外部局部变量或变量的地址；

Block_descriptor 结构体成员含义如下：

• reserved: 保留变量；
• size: block 的大小；
• copy: 函数用于捕获变量并持有引用；
• dispose: 析构函数，用来释放捕获的资源；