使用NSOperation实现异步下载和注册通知

分类： iphone2011-08-29 15:21 66人阅读 评论(0) 收藏 举报

http://blog.csdn.net/kmyhy/article/details/6050345

在iphone开发中，异步操作是一个永恒的话题，尤其当iphone手机需要和远程服务器进行交互时，使用异步请求是很普遍的做法。

通常，这需要NSURLConnection和NSOperation结合起来使用。这方面的资料网络上自然有不少的介绍，不过要找一个能运行的代码也并不容易。许多文章介绍的并不全面，或者使用了过时的SDK，在新IOS版本下并不适用（当前最新的ios是4.2了）。这些代码很经典，但仍然很容易使人误入歧途。

本文总结了众多文档介绍的方法和代码，揭示了异步操作中的实现细节和初学者（包括笔者）易犯的错误，使后来者少走弯路。

一、使用NSOperation实现异步请求

1、新建类，继承自NSOperation。

@interface URLOperation :NSOperation

{

    NSURLRequest* _request;

    NSURLConnection* _connection;

    NSMutableData* _data;

    //构建gb2312的encoding

    NSStringEncoding enc;

   

}

 

- (id)initWithURLString:(NSString *)url;

@property (readonly) NSData *data;

@end

接口部分不多做介绍，我们来看实现部分。

首先是带一个NSString参数的构造函数。在其中初始化成员变量。

其中enc是 NSStringEncoding 类型，因为服务器返回的字符中使用了中文 ，所以我们通过它指定了一个gb2312的字符编码。

许多资料中说，需要在NSOperation中重载一个叫做isConcurrent的函数并在其中返回YES，否则不支持异步执行。但是实际上，我们在这里注释了这个重载方法，程序也没有报任何错误，其执行方式依然是异步的。

@implementation URLOperation

@synthesize data=_data;

- (id)initWithURLString:(NSString *)url {

    if (self = [self init]) {

        NSLog(@"%@",url);

        _request = [[NSURLRequest alloc] initWithURL:[NSURL URLWithString:url]];

        //构建gb2312的encoding

        enc =CFStringConvertEncodingToNSStringEncoding(kCFStringEncodingGB_18030_2000);

       

        _data = [[NSMutableData data] retain];

    }

    return self;

}

- (void)dealloc {

    [_request release],_request=nil;

    [_data release],_data=nil;

    [_connection release],_connection=nil;

    [super dealloc];

}

 

// 如果不重载下面的函数，异步方式调用会出错

//-(BOOL)isConcurrent {

//  return YES;//返回yes表示支持异步调用，否则为支持同步调用

//}

整个类中最重要的方法是start方法。Start是NSOperation类的主方法，主方法的叫法充分说明了其重要性，因为这个方法执行完后，该NSOperation的执行线程就结束了（返回调用者的主线程），同时对象实例就会被释放，也就意味着你定义的其他代码（包括delegate方法）也不会被执行。很多资料中的start方法都只有最简单的一句（包括“易飞扬的博客“的博文）：

[NSURLConnection connectionWithRequest:_requestdelegate:self];

如果这样的话，delegate方法没有执行机会。因为start方法结束后delegate（即self对象）已经被释放了，delegate的方法也就无从执行。

所以在上面的代码中，还有一个while循环，这个while循环的退出条件是http连接终止（即请求结束）。 当循环结束，我们的工作也就完成了。

 

 

// 开始处理-本类的主方法

- (void)start {

    if (![self isCancelled]) {

        NSLog(@"start operation");

        // 以异步方式处理事件，并设置代理

        _connection=[[NSURLConnection connectionWithRequest:_request delegate:self]retain];

        //下面建立一个循环直到连接终止，使线程不离开主方法，否则connection的delegate方法不会被调用,因为主方法结束对象的生命周期即终止

        //这个问题参考http://www.cocoabuilder.com/archive/cocoa/279826-nsurlrequest-and-nsoperationqueue.html

        while(_connection != nil) {

            [[NSRunLoop currentRunLoop] runMode:NSDefaultRunLoopMode beforeDate:[NSDatedistantFuture]];   

        }

    }

}

接下来，是NSURLConnection的delegate方法，这部分的代码和大部分资料的介绍是一样的，你可以实现全部的delegate方法，但这里我们只实现其中3个就足够了，其余的方法不用理会。如你所见，你可以在其中添加自己想到的任何代码，包括接收数据，进行字符编码或者做xml解析。

 

#pragma mark NSURLConnection delegate Method

// 接收到数据（增量）时

- (void)connection:(NSURLConnection*)connection

   didReceiveData:(NSData*)data {

    NSLog(@"connection:");

    NSLog(@"%@",[[NSString alloc] initWithData:data encoding:enc]);

    // 添加数据

    [_data appendData:data];

}

 

// HTTP请求结束时

- (void)connectionDidFinishLoading:(NSURLConnection*)connection {

    [_connection release],_connection=nil;

    //NSLog(@"%@",[[NSString alloc] initWithData:_dataencoding:enc]);

}

-(void)connection: (NSURLConnection *) connection didFailWithError: (NSError *) error{

    NSLog(@"connection error");

}

@end

到此，虽然代码还没有完成，但我们已经可以运行它了。你可以看到console输出的内容，观察程序的运行状态。

2、调用NSOperation

我们的NSOperation类可以在ViewController中调用，也可以直接放在AppDelegate中进行。

在这里，我是通过点击按钮来触发调用代码的：

-(void)loginClicked{

    //构造登录请求url

    NSString* url=@”http://google.com”;

    _queue = [[NSOperationQueue alloc] init];

   

    URLOperation* operation=[[URLOperation alloc ]initWithURLString:url];

    // 开始处理

    [_queue addOperation:operation];

    [operationrelease];//队列已对其retain，可以进行release；

}

_queue是一个 NSOperationQueue 对象，当往其中添加 NSOperation 对象后， NSOperation 线程会被自动执行（不是立即执行，根据调度情况）。

3、KVO编程模型

我们的NSOperation完成了向服务器的请求并将服务器数据下载到成员变量_data中了。现在的问题是，由于这一切是通过异步操作进行的，我们无法取得_data中的数据，因为我们不知道什么时候异步操作完成，以便去访问_data属性（假设我们将_data定义为属性了），取得服务器数据。

我们需要一种机制，当NSOperation完成所有工作之后，通知调用线程。

这里我们想到了KVO编程模型（键－值观察模型）。这是cocoa绑定技术中使用的一种设计模式，它可以使一个对象在属性值发生变化时主动通知另一个对象并触发相应的方法。具体请参考cocoa参考库：http://www.apple.com.cn/developer/mac/library/documentation/Cocoa/Conceptual/CocoaBindings/index.html，以及http://www.apple.com.cn/developer/mac/library/documentation/Cocoa/Conceptual/KeyValueObserving/Concepts/KVOBasics.html#//apple_ref/doc/uid/20002252两篇文档。

首先，我们在NSOperation的子类中添加一个BOOL变量，当这个变量变为YES时，标志异步操作已经完成：

BOOL _isFinished;

在实现中加入这个变量的访问方法：

- (BOOL)isFinished

{

    return _isFinished;

}

cocoa的KVO模型中，有两种通知观察者的方式，自动通知和手动通知。顾名思义，自动通知由cocoa在属性值变化时自动通知观察者，而手动通知需要在值变化时调用 willChangeValueForKey:和didChangeValueForKey: 方法通知调用者。为求简便，我们一般使用自动通知。

要使用自动通知，需要在 automaticallyNotifiesObserversForKey方法中明确告诉cocoa，哪些键值要使用自动通知：

//重新实现NSObject类中的automaticallyNotifiesObserversForKey:方法，返回yes表示自动通知。

+ (BOOL):(NSString*)key

{

    //当这两个值改变时，使用自动通知已注册过的观察者，观察者需要实现observeValueForKeyPath:ofObject:change:context:方法

    if ([key isEqualToString:@"isFinished"])

    {

        return YES;

    }

   

    return [super automaticallyNotifiesObserversForKey:key];

}

然后，在需要改变_isFinished变量的地方，使用

[self setValue:[NSNumber numberWithBool:YES] forKey:@"isFinished"];

方法，而不是仅仅使用简单赋值。

我们需要在3个地方改变isFinished值为YES， 请求结束时、连接出错误，线程被cancel。请在对应的方法代码中加入上面的语句。

最后，需要在观察者的代码中进行注册。打开ViewController中调用NSOperation子类的地方，加入：

    //kvo注册

    [operation addObserver:self forKeyPath:@"isFinished"

                   options:(NSKeyValueObservingOptionNew |NSKeyValueObservingOptionOld) context:operation];

 

并实现 observeValueForKeyPath 方法：

//接收变更通知

- (void)observeValueForKeyPath:(NSString *)keyPath

                      ofObject:(id)object

                       change:(NSDictionary *)change

                      context:(void *)context

{

    if ([keyPath isEqual:@"isFinished"]){

        BOOL isFinished=[[change objectForKey:NSKeyValueChangeNewKey] intValue];

        if (isFinished) {//如果服务器数据接收完毕

            [indicatorView stopAnimating];

            URLOperation* ctx=(URLOperation*)context;

           NSStringEncodingenc=CFStringConvertEncodingToNSStringEncoding(kCFStringEncodingGB_18030_2000);

            NSLog(@"%@",[[NSString alloc] initWithData:[ctx data] encoding:enc]);

            //取消kvo注册

            [ctxremoveObserver:self

                     forKeyPath:@"isFinished"];

        }      

    }else{

        // be sure to call the super implementation

        // if the superclass implements it

        [super observeValueForKeyPath:keyPath

                             ofObject:object

                               change:change

                              context:context];

    }

}