原文地址在这里。
本文源码:https://github.com/olegam/RACCommandExample
RACCommand
RACCommand是ReactiveCocoa的基本组件之一,能节省开发的大部分时间,同时使得iOS/OS X 应用更健壮。
我看到一部分ReactiveCocoa(以下简单RAC)新人并没有完全理解RACCommand,自然也就不知道怎么用它。所以我写了这个小小介绍性文章,希望能对你的理解有所帮助。RACCommand源文件里的注释写得很不错,不过它并没有给任何例子来说说具体怎么用它,对于RAC的新人来说,只看这些注释还是比较难以理解的。
RACCommand类用于表示事件的执行,一般来说是在UI上的某些动作来触发这些事件,比如点击一个按钮。RACCommand的实例能够决定是否可以被执行,这个特性能反应在UI上,而且它能确保在其不可用时不会被执行。通常,当一个命令可以执行时,会将它的属性allowsConcurrentExecution设置为它的默认值:NO,从而确保在这个命令已经正在执行的时候,不会同时再执行新的操作。命令执行的返回值是一个RACSignal,因此我们能对该返回值进行next:,completed或error:,这在下文会有所展示。
例子应用
现在假设我们要写一个简单的iOS APP,它能让用户订阅邮件列表。我们将其做到最简单:一个输入框和一个按钮。当用户输入了电子邮箱地址、点击订阅按钮后,电子邮箱地址会提交到我们的web服务器上。够简单了吧!然而,我们还是得处理一些边界情况,以提供最好的体验。比如如果用户点击按钮两次怎么办?错误如何处理?如果邮箱地址非法呢?RACCommand能帮助我们处理这些情况。我已经实现了一个小的app来演示本文中所讨论的这些概念。
源码:https://github.com/olegam/RACCommandExample
本例用了一个非常简单的视图控制器,同样还演示了iOS应用的MVVM模式。
根视图控制器包含了视图,还有view model的实例。
- (void)bindWithViewModel {
RAC(self.viewModel, email) =self.emailTextField.rac_textSignal;
self.subscribeButton.rac_command = self.viewModel.subscribeCommand;
RAC(self.statusLabel, text) =RACObserve(self.viewModel, statusMessage);
}
上面的这个方法(在viewDidLoad中调用)将view以及view model绑定。对于咱们感兴趣的代码在都view model中。看看view model的接口:
@interface SubscribeViewModel :NSObject
@property(nonatomic, strong)RACCommand *subscribeCommand; // writeto this property
@property(nonatomic, strong) NSString *email; // read from this property
@property(nonatomic, strong) NSString *statusMessage;
@end
RACCommand暴露在这里,就是本文接下来要讨论的。另外还有两个被绑定到view上用于展示的字符串。这个view model的完整实现如下:
#import "SubscribeViewModel.h"
#import "AFHTTPRequestOperationManager+RACSupport.h"
#import"NSString+EmailAdditions.h"
static NSString *const kSubscribeURL =@"http://reactivetest.apiary.io/subscribers";
@interface SubscribeViewModel ()
@property(nonatomic, strong) RACSignal*emailValidSignal;
@end
@implementation SubscribeViewModel
- (id)init {
self= [super init];
if(self) {
[selfmapSubscribeCommandStateToStatusMessage];
}
returnself;
}
-(void)mapSubscribeCommandStateToStatusMessage {
RACSignal*startedMessageSource = [self.subscribeCommand.executionSignalsmap:^id(RACSignal *subscribeSignal) {
returnNSLocalizedString(@"Sending request...", nil);
}];
RACSignal*completedMessageSource = [self.subscribeCommand.executionSignalsflattenMap:^RACStream *(RACSignal *subscribeSignal) {
return[[[subscribeSignal materialize] filter:^BOOL(RACEvent *event) {
returnevent.eventType == RACEventTypeCompleted;
}]map:^id(id value) {
returnNSLocalizedString(@"Thanks", nil);
}];
}];
RACSignal*failedMessageSource = [[self.subscribeCommand.errors subscribeOn:[RACSchedulermainThreadScheduler]] map:^id(NSError *error) {
returnNSLocalizedString(@"Error :(", nil);
}];
RAC(self,statusMessage) = [RACSignal merge:@[startedMessageSource,completedMessageSource, failedMessageSource]];
}
- (RACCommand *)subscribeCommand {
if(!_subscribeCommand) {
@weakify(self);
_subscribeCommand= [[RACCommand alloc] initWithEnabled:self.emailValidSignalsignalBlock:^RACSignal *(id input) {
@strongify(self);
return[SubscribeViewModel postEmail:self.email];
}];
}
return_subscribeCommand;
}
+ (RACSignal *)postEmail:(NSString *)email{
AFHTTPRequestOperationManager*manager = [AFHTTPRequestOperationManager manager];
manager.requestSerializer= [AFJSONRequestSerializer new];
NSDictionary*body = @{@"email": email ?: @""};
return[[[manager rac_POST:kSubscribeURL parameters:body] logError] replayLazily];
}
- (RACSignal *)emailValidSignal {
if(!_emailValidSignal) {
_emailValidSignal= [RACObserve(self, email) map:^id(NSString *email) {
return@([email isValidEmail]);
}];
}
return_emailValidSignal;
}
@end
呃,这是个大块头,我们一点一点来看。我们最感兴趣的RACCommand的创建如下:
- (RACCommand *)subscribeCommand {
if(!_subscribeCommand) {
@weakify(self);
_subscribeCommand= [[RACCommand alloc] initWithEnabled:self.emailValidSignalsignalBlock:^RACSignal *(id input) {
@strongify(self);
return[SubscribeViewModel postEmail:self.email];
}];
}
return_subscribeCommand;
}
command的初始化方法中有一个enabledSignal参数,这个signal就是用来指名command能否被执行的。在我们的例子中,当用户输入的email地址合法时,它才能被执行。self.emailValidSignal这个signal每当email的文本更新时,会发送NO或YES。
signalBlock参数在command需要执行时调用,这个block需要返回一个signal用来表示正在执行,之前将allowsConcurrentExecute的值设置为默认值NO,此时command会观察这个signal,而且在这个执行进度完成前,不允许新的执行。
由于command是button的rac_command的属性(定义在UIButton+RACCommandSupport),这个button的enable状态会根据command能否执行来自动改变。
当用户点击按钮时,command会自动执行。如果你需要手动执行command,可以发送消息:-[RACCommand execute:],参数是可选的,在我们的例子中,我们不需要手动执行。尽管在我们这里不用,但它还是很有用的,这个-execute:方法是一个查看命令执行的状态的方法,如下:
[[self.viewModel.subscribeCommand execute:nil] subscribeCompleted:^{
NSLog(@"Thecommand executed");
}];
在我们的例子中,button自动执行command(所以我们不需要调用-execute:),所以我们得监听command的另一个属性,在command执行时更新UI。在这里有几种选择来达到目的,也许会有点小迷惑。executionSignals是RACCommand的signal,每当command开始执行时next:,其参数是由command创建的signal,所以这个executionSignals是一个值为signal的signal。我们在view model的mapSubscribeCommandStateToStatusMessage方法中,在command每次开始执行时得到一个包含字符串值的signal:
RACSignal*startedMessageSource = [self.subscribeCommand.executionSignalsmap:^id(RACSignal *subscribeSignal) {
returnNSLocalizedString(@"Sending request...", nil);
}];
如果我们想用纯粹的函数在command执行完成后得到一个包含字符串的signal,我们不得不多做一点小工作:
RACSignal *completedMessageSource =[self.subscribeCommand.executionSignals flattenMap:^RACStream *(RACSignal*subscribeSignal) {
return[[[subscribeSignal materialize] filter:^BOOL(RACEvent *event) {
returnevent.eventType == RACEventTypeCompleted;
}]map:^id(id value) {
returnNSLocalizedString(@"Thanks", nil);
}];
}];
flattenMap:方法在command执行时,会调用block并传入subscribeSignal,这个block会返回一个新的signal,它的值就在这个要返回的signal中。materialize会将一个signal转换为RACEvent信号(将一个signal的next:complete和error:消息转换为RACEvent实例的next:的值)。接下来我们就过滤这些事件,只留下RACEventTypeCompleted完成事件,并将其map成一个字符串值。看懂了没?如果没看懂的话,你最好看一下flattenMap:和materialize:是用来做什么的。
我们可以用一个不同的方法来实现上面这种行为,还可能更容易懂:
@weakify(self);
[self.subscribeCommand.executionSignals subscribeNext:^(RACSignal*subscribeSignal) {
[subscribeSignalsubscribeCompleted:^{
@strongify(self);
self.statusMessage= @"Thanks";
}];
}];
我不推荐上面这种方法,因为在block里的是副作用(side effects)。还有,上面的block会referring和retaining self,所以我用了@weakify和@strongify宏(在libextobjc中定义)来避免循环引用。所以为了避免使用这种副作用,还是要尽量采用原始的实现好一些。
还有一个要重点注意的是executionSignals属性,这个signals不会发送了error事件,而是由errors这个属性来发送的。在一个command的执行期间,如果一个signal发送了error,这会被signals当成一个next:事件发送,而errors属性则会发送这个错误信息。errors属性不会发送error:事件。我们很容易就能将错误信息map成一个字符串消息:
RACSignal *failedMessageSource = [[self.subscribeCommand.errorssubscribeOn:[RACScheduler mainThreadScheduler]] map:^id(NSError *error) {
returnNSLocalizedString(@"Error :(", nil);
}];
现在我们有3个关于状态的signals了,现在要展示给用户看,我们将这个3个signals合并成一个signal,并将其绑定到view model的statusMessage属性上(这会被绑定到view controller的statusLabel.text属性上)。
RAC(self, statusMessage) = [RACSignalmerge:@[startedMessageSource, completedMessageSource, failedMessageSource]];
以上就是在iOS应用里怎么使用RACCommand的一例子了。我认为这个实现逻辑相比较于在view controller里用UITextFieldDegate实现来说要好得多,因为它不需要各种状态变量和属性。