Block

题记：用最通俗的语言，描述最难懂的技术

❝

最近在学习和迁移Swift方面的代码，正好看到了闭包这部分，看完之后整个人都被着魔了一样，于是便有了这两篇文章，如果有那些论述模糊或者不准确，请联系weiniu@sohu-inc.com

目录表

• Block是什么

• Block有什么用

• 语法

• 使用场景

• 原理

• Block的数据结构及编译过程
• 关于Block的Copy
• 关于Block捕获的变量

• 注意事项

• 参考文档

• 结束语

Block是什么

• Block是Objective-C编程语言下的一个闭包实现，那么什么是闭包？闭包有两个特性，第一某个结构体包含了被引用的局部变量，第二包含了相关的代码块。

• 在Apple在线源文件（https://opensource.apple.com/source/libclosure/libclosure-63/Block_private.h.auto.html）可以找到另外的答案，它的结构体中包含了isa指针，所以我们在Objc下可以认为是对象

• 最后在它让人抓狂的语法（http://fuckingblocksyntax.com/）中，我们也可以发现函数特征，所以在Objc中我们也称之为匿名函数,函数块等。

Block有什么用

• 综上所述：可选的传递某些参数从而实现某些回调功能

语法

• 作为局部变量

returnType (^blockName)(parameterTypes) = ^returnType(parameters) {...};
eg:
void (^successBlock)(NSDictionary *params) = ^void(NSDictionary *params) {...};

• 作为属性

@property (nonatomic, copy, nullability) returnType (^blockName)(parameterTypes);
eg:
@property (nonatomic,copy,nullable) void (^failBlock)(NSError *error);

• 作为方法参数

- (void)someMethodThatTakesABlock:(returnType (^nullability)(parameterTypes))blockName;
eg:
- (void)URLRequestCompletion:( void (^ _Nullable )(NSDictionary *))successBlock {...}
//  一般在实际项目中我们都会先声明一个全局变量，然后使用这个变量进行使用
// 1.统一进行管理和修改 2.代码可读性
typedef void(^successBlock)(NSDictionary *params);
- (void)URLRequestCompletion2:(_Nullable successBlock)successBlock {...}

• 作为方法结束后的回调

[someObject someMethodThatTakesABlock:^returnType (parameters) {...}];
eg:
[UIView animateWithDuration:0.5f animations:^(void)(NSDictionary *params){ ... }];

• 作为C方法的参数

void SomeFunctionThatTakesABlock(returnType (^blockName)(parameterTypes));
eg:
void testCFunc(void (^successBlock)(char *name)) { ... }

• 作为别名

typedef returnType (^TypeName)(parameterTypes);
eg:
successBlock block = ^void(NSDictionary *params) { ... };

使用场景

原理

Block的数据结构及编译过程

我们要看底层的原理，需要对编译器对这个高级代码片段做了那些操作进行分析，所以我们就需要用到一个关于编译器的命令clang

• 环境：Apple clang version 12.0.5 (clang-1205.0.22.11)，Xcode：Version 12.5.1 (12E507)

• 测试项目准备工作

• 创建项目Xcode->File->New->Project

• 选择macOS->Command Line Tool->Next

• 填入Product Name和选择Language为Objective-C完成




代码文件

运行clang命令

• 选中main.m文件，点击右键选中Show in Finder，把项目拖入到Terminal(终端)或者iTerm(个人喜欢的一款终端工具)，进入到main.m所在路径

• 运行命令

• 查看是否编译C++文件成功

Block结构体定义

// Block的描述
struct Block_descriptor_1 {
 // Block的保留参数
  uintptr_t reserved;
  // Block的大小
   uintptr_t size;
};
//Block的布局
struct Block_layout {
 // Block的无符号定位指针
 void *isa;
 // 编译器优化参数修饰的Block的包含参数的标志位
 volatile int32_t flags; // contains ref count
 // Block布局的保留字段
 int32_t reserved; 
 // Block布局的触发函数
 void (*invoke)(void *, ...);
 // Block描述结构体指向的指针
 struct Block_descriptor_1 *descriptor;
 // imported variables -- 捕获的变量
};

C++代码分析，这个main.cpp大概有11w行左右，不要怕一点一点来，逐个分析

• 在代码片段中直接搜索bdBlock,然后定位到该处，bdBlock数据结构的定义和描述

// Block的定义实现
struct __block_impl {
   void *isa;
   int Flags;
   int Reserved;
   void *FuncPtr;
};
// 在main函数内的bdBlock数据结构的描述
static struct __main_block_desc_0 {
   size_t reserved;
   size_t Block_size;
   void (*copy)(struct __main_block_impl_0*, struct __main_block_impl_0*);
   void (*dispose)(struct __main_block_impl_0*);
} __main_block_desc_0_DATA = { 0, sizeof(struct __main_block_impl_0), __main_block_copy_0, __main_block_dispose_0};

// 在main方法中的bdBlock的数据结构的定义
struct __main_block_impl_0 {
   struct __block_impl impl;
   struct __main_block_desc_0* Desc;
   int x;
   NSNumber *number;
   __main_block_impl_0(void *fp, struct __main_block_desc_0 *desc, int _x, NSNumber *_number, int flags=0) : x(_x), number(_number) {
     impl.isa = &_NSConcreteStackBlock;
     impl.Flags = flags;
     impl.FuncPtr = fp;
     Desc = desc;
   }
};
static float __main_block_func_0(struct __main_block_impl_0 *__cself) {
   int x = __cself->x; // bound by copy
  NSNumber *number = __cself->number; // bound by copy
         return x * ((float (*)(id, SEL))(void *)objc_msgSend_fpret)((id)number, sel_registerName("floatValue"));
    }
// bdBlock中的copy方法
static void __main_block_copy_0(struct __main_block_impl_0*dst, struct __main_block_impl_0*src) {
 _Block_object_assign((void*)&dst->number, (void*)src->number, 3/*BLOCK_FIELD_IS_OBJECT*/);
}
// bdBlock中的dispose方法
static void __main_block_dispose_0(struct __main_block_impl_0*src) {
  _Block_object_dispose((void*)src->number, 3/*BLOCK_FIELD_IS_OBJECT*/);}

代码分析

• 当前编译器会根据bdBlock捕获的变量，生成具体的结构体的定义，对应到代码就是上述中的__main_block_desc_0和__main_block_impl_0
• bdBlock中的块函数也会被编译器生成一个C函数，对应到上述中的__main_block_func_0，同理可得，执行bdBlock其实也就是执行这个C函数。‍‍‍‍‍‍‍‍‍

关于Block的Copy

• 在上述代码片段的__main_block_impl_0中我们也不难发现，定义完bdBlock之后Block存储在当前函数的_NSConcreteStackBlock上面，也就是bdBlock中的isa指向的是该Block的Class的类型是_NSConcreteStackBlock,在run time中定义了6种关于Block的类

  _NSConcreteStackBlock  // 栈上创建的block
  _NSConcreteMallocBlock // 堆上创建的block
  _NSConcreteGlobalBlock //作为全局变量的block
  _NSConcreteWeakBlockVariable
  _NSConcreteAutoBlock
  _NSConcreteFinalizingBlock

  关于后三种是用于垃圾回收（Garbage Collection）机制下的，我们在此不作分析

• bdBlock初始化完成之后在栈上面，捕获的变量会被赋值到结构体的成员上，所以初始化完成捕获到的局部变量不能修改。当main函数返回时，函数的栈被销毁，bdBlock的内存也会被清除，如果在函数结束后仍然引用这个Block的时候，就需要将它拷贝到堆上，详细逻辑点这：https://opensource.apple.com/source/libclosure/libclosure-63/runtime.c

• Block_copy伪代码
‍

‍‍‍


• // 申请跟现有block size一样的内存
  struct Block_layout *result = malloc(aBlock->descriptor->size);
  // 将现有的block中的数据复制过去
  memmove(result, aBlock, aBlock->descriptor->size);
  // 更新isa指针指向堆
  result->isa = _NSConcreteMallocBlock;
  // 向捕获的对象发送retian，增加新的block的引用计数
  _Block_call_copy_helper(result, aBlock);
  return result; 

关于Block捕获的变量

Objective-C中的变量分为

• 全局静态变量

• 全局变量

• 局部静态变量

• 局部变量（自动变量）

• ❝

  留个小问题大家知道为啥又被称作自动变量么😊

Block对变量的捕获

• 全局静态变量，从代码和打印结果看出变量始终在全局数据区，内存地址不变

• 全局变量，从代码和打印结果观察和上述一样，也在全局数据区，内存地址不变

• 局部静态变量，static延长了局部变量的生命周期

• 局部变量，很显然，这就是刚才对提到的，局部变量完成之后存储在栈上，也被结构体进行了赋值，不允许跨存储范围进行修改在内存中的地址

解决捕获局部变量的问题

方法1：目前的Xcode编译器已经变得很强大，从上面的提示看出可以使用__block关键字，可是你知道它的原理么？正所谓，知道问题的原因，才能相处对应的处理办法，我们可以逆推也不难猜出肯定是关于对存储域的处理，接下来我们通过代码具体分析下

• 刺激不，很明显__block把变量从栈存储位置移动到了堆位置，你肯定说，你说堆就是堆？那肯定不啊？所有的技术都有原因，所以我们再次可以借用clang命令，把上述的__block的例子进行编译，我都帮你弄好了，接下来我们继续看代码

 // __block a 的定义
struct __Block_byref_a_0 {
   void *__isa;
 __Block_byref_a_0 *__forwarding;
  int __flags;
  int __size;
  int a;
};
// __block a的实现
struct __main_block_impl_0 {
  struct __block_impl impl;
  struct __main_block_desc_0* Desc;
  __Block_byref_a_0 *a; // by ref
  __main_block_impl_0(void *fp, struct __main_block_desc_0 *desc, __Block_byref_a_0 *_a, int flags=0) : a(_a->__forwarding) {
    impl.isa = &_NSConcreteStackBlock;
    impl.Flags = flags;
    impl.FuncPtr = fp;
    Desc = desc;
  }
};
 //__block中代码块中的方法实现
static void __main_block_func_0(struct __main_block_impl_0 *__cself) {
__Block_byref_a_0 *a = __cself->a; // bound by ref
       (a->__forwarding->a) = 12;
    }

• 就一个__block便让一个int的值处理为一个结构体，通过观察可以发现，这个结构体的首地址同样也是*isa，所以这个值是相当于被处理后变成了bdBlock的一部分，随着bdBlock被copy到堆上面也存储到了堆上面，通过代码发现对a的操作其实是对指针的操作，是不是有豁然开朗的感觉？哈哈哈

  
  

方法2：把需要更新的局部变量变成Block的参数，进行传参调用

方法总结：我个人更倾向于方法2，因为我实践了__block的原理之后明白，如果__block修饰的值size过大，那么在此引用过程中会对程序的内存有影响，有可能会有一些未知的问题，所以我更愿意求稳，使用更保守的传参方式，当然在实际的工作中，可以根据业务需求进行灵活使用。

注意事项

Block下的引用循环

• __weak

• 对其中一方的引用循环对象使用__weak修饰，然后__weak就会进行自动管理弱引用，表现为当对象引用计数为0时候的会自动清对象所占内存，具体原理是系统在底层维护了一系列的哈希结构，请自行搜索相关关键词进行查阅，在此不做过多分析

__weak typeof(self)weakSelf = self;
    self.print_name = ^(NSString *name) {

    // A have cycle
 //  self.view.backgroundColor = [UIColor redColor];
   // Use weakSelf to weak of block to strong self
    weakSelf.view.backgroundColor = [UIColor redColor];
   NSLog(@"name is %@",name);
       };

 self.print_name(@"Augus");

• __Block

• __block这种方式修饰的原理就是把其中一方的引用创建一份到Block的栈，随着Block拷贝到堆上，使用完成之后进行销毁，这种方法的利弊也在Block的部分进行了说明，请查看Block对变量的捕获部分的内容

  __block ViewController *blockSelf = self;
    self.print_name = ^(NSString *name) {
     // A have cycle
     //  self.view.backgroundColor = [UIColor redColor];
      // Use __block capture self to belong to block,then destory the variable after finish work
      blockSelf.view.backgroundColor = [UIColor redColor];
      blockSelf = nil;
      NSLog(@"name is %@",name);
    };
    self.print_name(@"Augus");

结束语

❝

好了，关于iOS下的block闭包说了很多，也有一些底层的东西需要去理解和动手，困难肯定是有的，希望一起乘风破浪，所向披靡，我也尽快完稿下一篇姐妹篇closure的开发

参考文档

• https://blog.ibireme.com/2013/11/27/objc-block/)
• https://developer.apple.com/library/archive/documentation/Cocoa/Conceptual/Blocks/Articles/00_Introduction.html
• https://developer.apple.com/library/archive/documentation/Cocoa/Conceptual/ProgrammingWithObjectiveC/WorkingwithBlocks/WorkingwithBlocks.html