Skip to content

Latest commit

 

History

History
303 lines (244 loc) · 17.3 KB

ReactiveCocoa部分源码简析.md

File metadata and controls

303 lines (244 loc) · 17.3 KB

对 ReactiveCocoa 中几个函数的解读

哈咪.gif

flattenMap 与 map

  • mapflatten 是基于 flattenMap, 而 flattenMap 是基于 bind:, 所以在此之前先来看看 bind 函数。
  • 具体来看源码(为方便理解,去掉了源代码中 RACDisposable, @synchronized, @autoreleasepool 相关代码 )。当新信号 N 被外部订阅时,会进入信号 NdidSubscribeBlock (1),之后订阅原信号 O (2),当原信号 O 有值输出后就用 bind 函数传入的 bindBlock 将其变换成中间信号 M (3), 并马上对其进行订阅 (4),最后将中间信号 M 的输出作为新信号 N 的输出 (5)。即:当新生成的信号被订阅时,源信号也会立即被订阅。
- (RACSignal *)bind:(RACStreamBindBlock (^)(void))block {return [RACSignal createSignal:^(id<RACSubscriber> subscriber) {// (1)
        RACStreamBindBlock bindingBlock = block(); // (MARK: 此处执行 block 回调, 生成一个 bindingBlock)
        
        [self subscribeNext:^(id x) {// (2)
            BOOL stop = NO;
            id middleSignal = bindingBlock(x, &stop);  // (3) map 与 flatten 结果不同,问题就出在这里
            
            if (middleSignal != nil) {RACDisposable *disposable = [middleSignal subscribeNext:^(id x) {// (4)
                    [subscriber sendNext:x];  // (5)
                } error:^(NSError *error) {[subscriber sendError:error];
                } completed:^{[subscriber sendCompleted];
                }];
            }
        } error:^(NSError *error) {[subscriber sendError:error];
        } completed:^{[subscriber sendCompleted];
        }];
        
        return nil
    }];
}
  • flattenMap 其实就是对 bind: 方法进行了一些安全检查,它最终返回的是 bindBlock 执行后生成的那个中间 signal 又被订阅后传递出的值的信号,而 map 方法返回的是 bindBlock 的执行结果生成的那个信号,没有再加工处理(即被订阅,再发送值)
- (instancetype)flattenMap:(RACStream * (^)(id value))block {
	Class class = self.class;

	return [[self bind:^{
		/// @return 返回的是 RACStreamBindBlock
		/// @discussion
		///
		/// 跟 `bind:` 方法中的代码对应起来如下:
		/// BOOL stop = NO;
     	/// id middleSignal = bindingBlock(x, &stop);
     	///
     	/// 与上面 `bind:` 函数中的 (3) 对应起来,
     	/// 可以看出 bindBlock 中的 x 是原信号被 subscribe 后传出的值,即对应下面的 value
     	/// 也即 flattenMap block 中执行后传出的值,
     	/// 即上面的 (RACStream * (^ block)(id value)) 中的 value
     	/// flattenMap: 后的那个 block 其实与 bind: 后的 block 基本是一样的,参数都是原信号发出的值,返回值都是 RACStream,差别就是一个 bool 参数,所以说,flattenMap 其实就是对 bind 方法进行了一些安全检查
     	/// 综上所述:*flattenMap 方法中传进来的那个 block 参数值就是原信号被订阅后发送的值*
		return ^(id value, BOOL *stop) {
			// 下面这个 value 并不是 flattenMap 后面 block 中的那个 value(原信号被订阅后发出去的值),而是原信号发出的值被转换为中间信号后,又被订阅后发出去的值。
			id stream = block(value) ?: [class empty];
			NSCAssert([stream isKindOfClass:RACStream.class], @"Value returned from -flattenMap: is not a stream: %@", stream);

			return stream;
		};
	}] setNameWithFormat:@"[%@] -flattenMap:", self.name];
}
  • map: 下面是 map 方法的源码,可以看出,map 只是对 flattenMap 传出的 vaue(即原信号传出的值)进行了 mapBlock 操作,并没有再进行订阅操作,即并不像 bind: 一样再次对原信号进行 bindBlock 后生成的中间信号进行订阅。
- (instancetype)map:(id (^)(id value))block {NSCParameterAssert(block != nil);

	Class class = self.class;
	
	return [[self flattenMap:^(id value) {return [class return:block(value)];
	}] setNameWithFormat:@"[%@] -map:", self.name];
}
  • flatten: 该操作主要作用于信号的信号。原信号 O 作为信号的信号,在被订阅时输出的数据必然也是个信号 (signalValue),这往往不是我们想要的。当我们执行 [O flatten] 操作时,因为 flatten 内部调用了 flattenMap (1),flattenMap 里对应的中间信号就是原信号 O 输出的 signalValue (2)。按照之前分析的经验,在 flattenMap 操作中新信号 N 输出的结果就是各中间信号 M 输出的集合。因此在 flatten 操作中新信号 N 被订阅时输出的值就是原信号 O 的各个子信号输出值的集合。
- (instancetype)flatten
{return [self flattenMap:^(RACSignal *signalValue) {// (1)
    		/// 返回值作为 bind: 中的中间信号
        return signalValue; // (2)
    };
}

小结: 一直不理解 flattenmap 的区别,然后经过不断在源码中打断点,一步步跟代码,终于了解了他们之间的区别: flattenmap 后面的 block 返回结果其实最终都会变为 bind: 方法中的中间信号,但是 flatten: 的 block 是直接把原信号发出的值返回来作为中间信号的,所以中间信号被订阅,其实就是原信号发出的值又被订阅,这也就是 flatten: 能拿到信号中的信号中的值的原因。 而 map: 后面的 block 是把原信号发出的值加工处理了的,又生成了一个新的信号,即 map: 方法 block 返回的中间信号已经不是原来的信号中的信号了,而是把原信号发出的值作为它的包含值的一个新的信号,它被订阅时,发送的是原信号发出的那个值,这就是 map 拿不到原信号中的信号的原因。 说白了就是 flatten: 操作的始终是原来的信号,而 map: 会生成一个包含原信号发送值的新信号。


简单分析一下 - (RACMulticastConnection *)multicast:(RACSubject *)subject; 方法:
  • 1、当 RACSignal 类的实例调用 - (RACMulticastConnection *)multicast:(RACSubject *)subject 时,以 selfsubject 作为构造参数创建一个 RACMulticastConnection 实例。
  • 2、RACMulticastConnection 构造的时候,保存 sourcesubject 作为成员变量,创建一个 RACSerialDisposable 对象,用于取消订阅。
  • 3、当 RACMulticastConnection 类的实例调用 - (RACDisposable *)connect 这个方法的时候,判断是否是第一次。如果是的话 用 _signal 这个成员变量(RACSubject 类型)来订阅 sourceSignal, 之后返回 self.serialDisposable,否则直接返回 self.serialDisposable
  • 4、RACMulticastConnectionsignal 只读属性,就是一个热信号,订阅这个热信号就避免了各种副作用的问题。它会在 - (RACDisposable *)connect 第一次调用后,根据 sourceSignal 的订阅结果来传递事件。
  • 5、想要确保第一次订阅就能成功订阅 sourceSignal ,可以使用 - (RACSignal *)autoconnect 这个方法,它保证了第一个订阅者触发 sourceSignal 的订阅,也保证了当返回的信号所有订阅者都关闭连接后 sourceSignal 被正确关闭连接。
  • 6、这里面订阅 sourceSignal 是重点,_signal 是一个 RACSubject 类型,它里面维护着一个可变数组,每当它被订阅时,会把所有的订阅者保存到这个数组中。当 connection.signal(即 _signal)被订阅时,其实是 _signal 被订阅了。由于 _signalRACSubject 类型对象,且 _signal 也是信号,它里面重写了订阅方法,所以会执行它自己的 subscribe: 方法,执行此方法之前订阅者参数是 RACSubscriber 类型,但是在这个 subscribe 方法中,初始化了一个 RACPassthroughSubscriber 实例对象,使它作为新的订阅者(其实就是对订阅者进行了一层包装),并把它存入了 subject 维护的那个订阅者数组里(原来的 订阅者信号RACPassthroughSubscriber 实例保存了),所以数组中最终保存的是 RACPassthroughSubscriber 类型的订阅者,然后它发送消息的时候调的还是它持有的 subject 对象进行发送消息。
  • 7、当 RACMulticastConnection 调用 connect 方法时,源信号 sourceSignal_signal 订阅,即执行 [sourceSignal subscribe:subject] 方法,然后执行订阅 subscribeNext:block 回调,在回调中执行 sendNext:,由于订阅者是 RACSubject 类型的实例对象,它里面也会执行 sendNext: 方法,此方法中会遍历它的数组中的订阅者依次发送消息。
  • 8、connect 时订阅者是 RACSubject 发送的 sendNext:,subject 会拿到它那个订阅者数组遍历,取出其中的 RACPassthroughSubscriber 对象,然后用 RACPassthroughSubscriber 对象中的真实的订阅者去发送数据。

再来看看 RACCommand

直接上源码:

- (id)initWithEnabled:(RACSignal *)enabledSignal signalBlock:(RACSignal * (^)(id input))signalBlock {NSCParameterAssert(signalBlock != nil);

	self = [super init];
	if (self == nil) return nil;

	_activeExecutionSignals = [[NSMutableArray alloc] init];
	_signalBlock = [signalBlock copy];
	
	// 监听 `activeExecutionSignals` 数组
	RACSignal *newActiveExecutionSignals = [[[[[self
		rac_valuesAndChangesForKeyPath:@keypath(self.activeExecutionSignals) options:NSKeyValueObservingOptionNew observer:nil]
		reduceEach:^(id _, NSDictionary *change) {NSArray *signals = change[NSKeyValueChangeNewKey];
			if (signals == nil) return [RACSignal empty];
			// 把数组转换为信号发送出去
			return [signals.rac_sequence signalWithScheduler:RACScheduler.immediateScheduler];
		}]
		concat]    		// 把各个信号中的信号连接起来
		publish]			// 广播出去,可以被多个订阅者订阅
		autoconnect];	// 有订阅了再发送广播

	// 把上面的信号 `map` 一下, 当出现错误的时候转换成 `empty` 空信号, 并在主线程上传递
	_executionSignals = [[[newActiveExecutionSignals
		map:^(RACSignal *signal) {return [signal catchTo:[RACSignal empty]];
		}]
		deliverOn:RACScheduler.mainThreadScheduler]
		setNameWithFormat:@"%@ -executionSignals", self];
	
	// 先通过 `ignoreValues` 方法屏蔽掉 `sendNext:` 的结果,只保留 `sendError:` 和 `sendCompleted` 结果,然后再通过 `catch:` 方法拿到所有的 `sendError:` 结果,发送给订阅者。
	// 此处用的是 `flattenMap`,可以直接获取到错误信息。
	RACMulticastConnection *errorsConnection = [[[newActiveExecutionSignals
		flattenMap:^(RACSignal *signal) {
			return [[signal
				ignoreValues]
				catch:^(NSError *error) {return [RACSignal return:error];
				}];
		}]
		deliverOn:RACScheduler.mainThreadScheduler]
		publish];
	
	_errors = [errorsConnection.signal setNameWithFormat:@"%@ -errors", self];
	[errorsConnection connect];

	// 根据执行信号的数量判断 `RACCommand` 当前是否正在执行
	RACSignal *immediateExecuting = [RACObserve(self, activeExecutionSignals) map:^(NSArray *activeSignals) {return @(activeSignals.count > 0);
	}];
	
	// 是否正在执行
	_executing = [[[[[immediateExecuting
		deliverOn:RACScheduler.mainThreadScheduler]
		// This is useful before the first value arrives on the main thread.
		startWith:@NO]
		distinctUntilChanged]
		replayLast]
		setNameWithFormat:@"%@ -executing", self];
	
	// 如果允许并发执行,返回 `YES`,否则反转 `immediateExecuting` 信号的结果
	RACSignal *moreExecutionsAllowed = [RACSignal
		if:RACObserve(self, allowsConcurrentExecution)
		then:[RACSignal return:@YES]
		else:[immediateExecuting not]];
	
	if (enabledSignal == nil) {enabledSignal = [RACSignal return:@YES];
	} else {
		enabledSignal = [[[enabledSignal
			startWith:@YES]
			takeUntil:self.rac_willDeallocSignal]
			replayLast];
	}
	
	_immediateEnabled = [[RACSignal
		combineLatest:@[enabledSignal, moreExecutionsAllowed]]
		and];
	
	_enabled = [[[[[self.immediateEnabled
		take:1]
		concat:[[self.immediateEnabled skip:1] deliverOn:RACScheduler.mainThreadScheduler]]
		distinctUntilChanged]
		replayLast]
		setNameWithFormat:@"%@ -enabled", self];
	
	return self;
}

// 使用时,我们通常会去生成一个 RACCommand 对象,并传入一个返回 signal 对象的 block。每次 RACCommand execute 执行操作时,都会通过传入的这个 signal block 生成一个执行信号 E (1),并将该信号添加到 RACCommand 内部信号数组 activeExecutionSignals 中 (2),同时将信号 E 由冷信号转成热信号 (3),最后订阅该热信号 (4),并将其返回 (5)。
- (RACSignal *)execute:(id)input {RACSignal *signal = self.signalBlock(input); //(1)
    RACMulticastConnection *connection = [[signal subscribeOn:RACScheduler.mainThreadScheduler] multicast:[RACReplaySubject subject]]; // (3)

    @weakify(self);
    [self addActiveExecutionSignal:connection.signal]; // (2)

    [connection.signal subscribeError:^(NSError *error) {@strongify(self);
        [self removeActiveExecutionSignal:connection.signal];
    } completed:^{@strongify(self);
        [self removeActiveExecutionSignal:connection.signal];
    }];

    [connection connect]; // (4)

    return [connection.signal]; // (5)
}

接下来再来简单说说 RACCommand 中用到的几个函数

// 以下是对 `allowsConcurrentExecution` 属性的处理方法,利用了属性的原子性,防止资源竞争,值得学习
@property (atomic, assign) BOOL allowsConcurrentExecution;
@property (atomic, copy, readonly) NSArray *activeExecutionSignals;

{
	// The mutable array backing `activeExecutionSignals`.
	//
	// This should only be used while synchronized on `self`.
	NSMutableArray *_activeExecutionSignals;

	// Atomic backing variable for `allowsConcurrentExecution`.
	volatile uint32_t _allowsConcurrentExecution;
}


//============================================================

- (BOOL)allowsConcurrentExecution {return _allowsConcurrentExecution != 0;}

- (void)setAllowsConcurrentExecution:(BOOL)allowed {[self willChangeValueForKey:@keypath(self.allowsConcurrentExecution)];

	if (allowed) {
		// 以下函数类似于 `||`  
		// 只要前者和后者有一个为真,那么后者就为真;即:不管 `_allowsConcurrentExecution` 是否等于 1,它最终都会变为 `1`,因为前者是 1;
		OSAtomicOr32Barrier(1, &_allowsConcurrentExecution);
	} else {
		// 以下函数类似于 `&&`  
		// 前后二者必须都为真,后者才会变为真;即:不管 `_allowsConcurrentExecution` 等于 0 还是 1,它最终都会变为 `0`,因为前者是 0
		OSAtomicAnd32Barrier(0, &_allowsConcurrentExecution);
	}
	// 手动调用 KVO,通知监听者 `allowsConcurrentExecution` 属性改变了
	[self didChangeValueForKey:@keypath(self.allowsConcurrentExecution)];
}

//======================== 数组属性 ================================
- (NSArray *)activeExecutionSignals {@synchronized (self) {return [_activeExecutionSignals copy];
	}
}

- (void)addActiveExecutionSignal:(RACSignal *)signal {NSCParameterAssert([signal isKindOfClass:RACSignal.class]);

	@synchronized (self) {NSIndexSet *indexes = [NSIndexSet indexSetWithIndex:_activeExecutionSignals.count];
		[self willChange:NSKeyValueChangeInsertion valuesAtIndexes:indexes forKey:@keypath(self.activeExecutionSignals)];
		[_activeExecutionSignals addObject:signal];
		[self didChange:NSKeyValueChangeInsertion valuesAtIndexes:indexes forKey:@keypath(self.activeExecutionSignals)];
	}
}

- (void)removeActiveExecutionSignal:(RACSignal *)signal {NSCParameterAssert([signal isKindOfClass:RACSignal.class]);

	@synchronized (self) {
		// 从当前数组中获取到要移除的对象的 indexSets,如果不存在直接返回
		NSIndexSet *indexes = [_activeExecutionSignals indexesOfObjectsPassingTest:^ BOOL (RACSignal *obj, NSUInteger index, BOOL *stop) {return obj == signal;}];

		if (indexes.count == 0) return;
		// 手动调用 KVO,通知监听者 `activeExecutionSignals` 数组的改变
		[self willChange:NSKeyValueChangeRemoval valuesAtIndexes:indexes forKey:@keypath(self.activeExecutionSignals)];
		[_activeExecutionSignals removeObjectsAtIndexes:indexes];
		[self didChange:NSKeyValueChangeRemoval valuesAtIndexes:indexes forKey:@keypath(self.activeExecutionSignals)];
	}
}

附 1:对其中几个函数的图表说明

CombineLatest Zip 操作结果 Merge Concat

附 2:ReactiveCocoaRxSwift API 图,引用自 FRPCheatSheeta

ReactiveCocoa-Objc

ReactiveCocoa-Objc ReactiveCocoa-Swift

ReactiveCocoaV4.x-Swift.png RxSwift

RXSwift.png

最后推荐一篇解析 @weakify@strongify 宏的文章:Reactive Cocoa 中的 @weakify、@strongify 的实现