使用NDOperation实现图片异步加载

最新推荐文章于 2017-03-30 17:49:00 发布

weixin_34392843

最新推荐文章于 2017-03-30 17:49:00 发布

阅读量65

点赞数

文章标签：移动开发设计模式

原文链接：http://blog.51cto.com/5575603/938967

版权

在 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:[NSDate distantFuture]];

}

接下来，是 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];

}

运行程序，查看控制台的输出。

4、libxml的sax解析接口

iphone和服务器交互通常使用xml数据交换格式，因此本文中也涉及到了xml文件解析的问题。有许多有名气的xml解析器可供我们选择，如：BXML，TouchXML，KissXML，TinyXML的第三方库和GDataXML。

Xml解析分为两类，一类是DOM解析，一类为SAX解析。前者如GDataXML，解析过程中需要建立文档树，操作XML元素时通过树形结构进行导航。DOM解析的特点是便于程序员理解xml文档树结构，API的使用简单；缺点是速度较SAX解析慢，且内存开销较大。在某些情况下，比如iphone开发，受制于有限的内存空间（一个应用最多可用10几m的内存）， DOM解析无法使用（当然，在模拟器上是没有问题的）。

libxml2的是一个开放源码库，默认情况下iPhone SDK 中已经包括在内。它是一个基于C的API，所以在使用上比cocoa的NSXML要麻烦许多（一种类似c函数的使用方式），但是该库同时支持DOM和SAX解析，其解析速度较快，而且占用内存小，是最适合使用在iphone上的解析器。从性能上讲，所有知名的解析器中，TBXML最快，但在内存占用上，libxml使用的内存开销是最小的。因此，我们决定使用libxml的sax接口。

首先，我们需要在 project中导入framework：libxml2.dylib。

虽然 libxml是sdk中自带的，但它的头文件却未放在默认的地方，因此还需要我们设置project的build选项：HEADER_SEARCH_PATHS= /usr/include/libxml2，否则libxml库不可用。

然后，我们就可以在源代码中 #import <libxml/tree.h> 了。

假设我们要实现这样的功能：有一个登录按钮，点击后将用户密码帐号发送 http请求到服务器（用上文中介绍的异步请求技术），服务器进行验证后以xml文件方式返回验证结果。我们要用libxml的sax方式将这个xml文件解析出来。

服务器返回的 xml文件格式可能如下：

<?xml version="1.0"encoding="GB2312" standalone="no" ?>

<root>

<login_info>

<login_status>true</login_status>

</login_info>

<List>

……

</List>

</root>

其中有我们最关心的 1个元素：login_status 。

如果 login_status返回false，说明登录验证失败，否则，服务器除返回login_status外，还会返回一个list元素，包含了一些用户的数据，这些数据是<system>元素的集合。

整个实现步骤见下。

首先，实现一个超类，这个超类是一个抽象类，许多方法都只是空的，等待 subclass去实现。

其中有 3个方法与libxml的sax接口相关，是sax解析过程中的3个重要事件的回调方法，分别是元素的开始标记、元素体（开始标记和结束标记之间的文本）、结束标记。Sax中有许多的事件，但绝大部分时间，我们只需要处理这3个事件。因为很多时候，我们只会对xml文件中的元素属性和内容感兴趣，而通过这3个事件已经足以使我们读取到xml节点的属性和内容。

而成员变量中， _root变量是比较关键的，它以dictionary的形式保存了解析结果，因为任何xml文档的根节点都是root，所以无论什么样子的xml文件，都可以放在这个_root中。

因此我们为 _root 变量提供了一个访问方法getResult，等xml解析结束，可以通过这个方法访问_root。

#import <Foundation/Foundation.h>

#import <libxml/tree.h>

@interface BaseXmlParser :NSObject {

NSStringEncoding enc;

NSMutableDictionary* _root;

}

// Property

- (void)startElementLocalName:(const xmlChar*)localname

prefix:(const xmlChar*)prefix

URI:(const xmlChar*)URI

nb_namespaces:(int)nb_namespaces

namespaces:(const xmlChar**)namespaces

nb_attributes:(int)nb_attributes

nb_defaulted:(int)nb_defaultedslo

attributes:(const xmlChar**)attributes;

- (void)endElementLocalName:(const xmlChar*)localname

prefix:(const xmlChar*)prefix URI:(const xmlChar*)URI;

- (void)charactersFound:(const xmlChar*)ch

len:(int)len;

-(NSDictionary*)getResult;

@end

#import "BaseXmlParser.h"

@implementation BaseXmlParser

// Property

-(id)init{

if(self=[super init]){

//构建gb2312的encoding

enc =CFStringConvertEncodingToNSStringEncoding(kCFStringEncodingGB_18030_2000);

_root=[[NSMutableDictionary alloc]init];

}

return self;

}

-(void)dealloc{

[_root release],_root=nil;

[super dealloc];

}

//--------------------------------------------------------------//

#pragma mark -- libxml handler，主要是3个回调方法--

//--------------------------------------------------------------//

//解析元素开始标记时触发,在这里取元素的属性值

- (void)startElementLocalName:(const xmlChar*)localname

prefix:(const xmlChar*)prefix

URI:(const xmlChar*)URI

nb_namespaces:(int)nb_namespaces

namespaces:(const xmlChar**)namespaces

nb_attributes:(int)nb_attributes

nb_defaulted:(int)nb_defaultedslo

attributes:(const xmlChar**)attributes

{

}

//解析元素结束标记时触发

- (void)endElementLocalName:(const xmlChar*)localname

prefix:(const xmlChar*)prefix URI:(const xmlChar*)URI

{

}

//解析元素体时触发

- (void)charactersFound:(const xmlChar*)ch

len:(int)len

{

}

//返回解析结果

-(NSDictionary*)getResult{

return _root;

}

@end

现在我们需要扩展这个 BaseXmlParser，并重载其中的3个sax方法。

该子类除了重载父类的 3个方法外，还增加了几个成员变量。其中flag是一个int类型，用于sax解析的缘故，解析过程中需要合适的标志变量，用于标志当前处理到的元素标记。为了简单起见，我们没有为每一个标记都设立一个标志，而是统一使用一个int标志，比如flag为1时，表示正在处理login_status标记，为2时，表示正在处理system标记。

回顾前面的 xml文件格式，我们其实只关心两种标记，login_status标记和system标记。Login_status标记没有属性，但它的元素体是我们关心的；而system标记则相反，它并没有元素体，但我们需要它的属性值。

这是一个很好的例子。因为它同时展示了属性的解析和元素体的解析。浏览整个类的代码，我们总结出 3个sax事件的使用规律是：

如果要读取元素属性，需要在“元素开始标记读取”事件（即 startElementLocalName 方法）中处理；

如果要读取元素体文本，则在“元素体读取”事件（即 charactersFound方法）中处理；

在“元素标记读取”事件（即endElementLocalName 方法）中，则进行标志变量的改变／归零。

#import <Foundation/Foundation.h>

#import <libxml/tree.h>

#import "BaseXmlParser.h"

@interface DLTLoginParser :BaseXmlParser {

int flag;

NSMutableDictionary* _currentItem;

}

- (void)startElementLocalName:(const xmlChar*)localname

prefix:(const xmlChar*)prefix

URI:(const xmlChar*)URI

nb_namespaces:(int)nb_namespaces

namespaces:(const xmlChar**)namespaces

nb_attributes:(int)nb_attributes

nb_defaulted:(int)nb_defaultedslo

attributes:(const xmlChar**)attributes;

- (void):(const xmlChar*)localname

prefix:(const xmlChar*)prefix URI:(const xmlChar*)URI;

- (void)charactersFound:(const xmlChar*)ch

len:(int)len;

@end

#import "DLTLoginParser.h"

@implementation DLTLoginParser

-(id)init{

if(self=[super init]){

NSMutableArray* items=[[NSMutableArray alloc]init];

[_root setObject:items forKey:@"items"];

[items release];//已被_root持有了，可以释放

}

return self;

}

-(void)dealloc{

[_currentItem release],_currentItem=nil;

[super dealloc];

}

//--------------------------------------------------------------//

#pragma mark -- libxml handler，主要是3个回调方法--

//--------------------------------------------------------------//

//解析元素开始标记时触发,在这里取元素的属性值

- (void)startElementLocalName:(const xmlChar*)localname

prefix:(const xmlChar*)prefix

URI:(const xmlChar*)URI

nb_namespaces:(int)nb_namespaces

namespaces:(const xmlChar**)namespaces

nb_attributes:(int)nb_attributes

nb_defaulted:(int)nb_defaultedslo

attributes:(const xmlChar**)attributes

{

// login_status，置标志为1

if (strncmp((char*)localname, "login_status", sizeof("login_status"))== 0) {

flag=1;

return;

}

// system,置标志为2

if (strncmp((char*)localname, "system", sizeof("system"))== 0) {

flag=2;

_currentItem = [NSMutableDictionary dictionary];

//查找属性

NSString *key,*val;

for (int i=0; i<nb_attributes; i++){

key= [NSString stringWithCString:(const char*)attributes[0] encoding:NSUTF8StringEncoding];

val= [[NSString alloc] initWithBytes:(const void*)attributes[3] length:(attributes[4] - attributes[3]) encoding:NSUTF8StringEncoding];

NSLog(@"key=%@,val=%@",key,val);

if ([@"Name" isEqualToString:key]){

[_currentItem setObject:val forKey:@"name"];

break;

}

// [val release];

attributes+= 5;//指针移动5个字符串，到下一个属性

}

[[_root objectForKey:@"items"] addObject:_currentItem];

return;

}

//解析元素结束标记时触发

- (void)endElementLocalName:(const xmlChar*)localname

prefix:(const xmlChar*)prefix URI:(const xmlChar*)URI

{

flag=0;//标志归零

}

//解析元素体时触发

- (void)charactersFound:(const xmlChar*)ch

len:(int)len

{

// 取login_status元素体

if (flag==1) {

NSString* string;

string = [[NSString alloc] initWithBytes:ch length:len encoding:NSUTF8StringEncoding];

[_root setObject:string forKey:@"login_status"];

NSLog(@"login_status:%@",string);

}

@end

接下来，改造我们的异步请求操作类 URLOperation。首先在interface中增加

两个变量：

xmlParserCtxtPtr _parserContext; //Xml解析器指针

BaseXmlParser* baseParser; //Xml解析器

其中第 1个变量（一个结构体）的声明显得有点奇怪，似乎是跟第2个变量混淆了。这是因为libxml是一个c函数库，其函数调用仍然使用一种面向结构的编程风格。所以我们在后面还会看到一些结构体似的变量。

另外，把 _data成员的类型从NSMutableData改变为NSMutableDictionary，并把它配置为属性，因为我们的请求结果应当被xml解析器解析为dictionary了：

@property (nonatomic,retain) NSDictionary *data;

当然，记住为它提供访问方法：

@synthesize data=_data;

然后，更改 initWithURLString 构造方法，为其增加一个名为 xmlParser 的参数：

- (id)initWithURLString:(NSString *)url xmlParser:(BaseXmlParser*)parser{

if (self = [super init]) {

baseParser=[parser retain];

NSLog(@"%@",url);

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

//构建gb2312的encoding

enc =CFStringConvertEncodingToNSStringEncoding(kCFStringEncodingGB_18030_2000);

_data = [[NSMutableData data] retain];

}

return self;

}

在 start方法中，我们可以这样创建一个xml解析器指针：

// 创建XML解析器指针

_parserContext =xmlCreatePushParserCtxt(&_saxHandlerStruct, baseParser, NULL, 0, NULL);

注意第 2个参数就是具体实现了sax解析的xml解析器。这个解析器对象是通过构造函数“注入”的。

而第一个参数是一个结构体指针 xmlSAXHandler 结构体，这个结构体我们定义为静态变量（注意把定义放在 @implementation⋯⋯ @end之外）：

//libxml的xmlSAXHandler结构体定义，凡是要实现的handler函数都写在这里，不准备实现的用null代替。一般而言，我们只实现其中3个就够了

static xmlSAXHandler _saxHandlerStruct = {

NULL, /* internalSubset */

NULL, /* isStandalone */

NULL, /* hasInternalSubset */

NULL, /* hasExternalSubset */

NULL, /* resolveEntity */

NULL, /* getEntity */

NULL, /* entityDecl */

NULL, /* notationDecl */

NULL, /* attributeDecl */

NULL, /* elementDecl */

NULL, /* unparsedEntityDecl */

NULL, /* setDocumentLocator */

NULL, /* startDocument */

NULL, /* endDocument */

NULL, /* startElement*/

NULL, /* endElement */

NULL, /* reference */

charactersFoundHandler, /*characters */

NULL, /* ignorableWhitespace */

NULL, /* processingInstruction */

NULL, /* comment */

NULL, /* warning */

NULL, /* error */

NULL, /* fatalError //: unused error() get all the errors */

NULL, /* getParameterEntity */

NULL, /* cdataBlock */

NULL, /* externalSubset */

XML_SAX2_MAGIC, /* initialized 特殊常量，照写*/

NULL, /* private */

startElementHandler, /* startElementNs */

endElementHandler, /* endElementNs */

NULL, /* serror */

};

机构体中填入了我们准备实现的 3个方法句柄，因此我们还应当定义这3个方法。由于结构体是静态的，只能访问静态成员，所以这3个方法也是静态的：

//3个静态方法的实现，其实是调用了参数 ctx的成员方法， ctx在_parserContext初始化时传入

static void startElementHandler(

void* ctx,

const xmlChar* localname,

const xmlChar* prefix,

const xmlChar* URI,

int nb_namespaces,

const xmlChar** namespaces,

int nb_attributes,

int nb_defaulted,

const xmlChar** attributes)

{

[(BaseXmlParser*)ctx

startElementLocalName:localname

prefix:prefix URI:URI

nb_namespaces:nb_namespaces

namespaces:namespaces

nb_attributes:nb_attributes

nb_defaulted:nb_defaulted

attributes:attributes];

}

static void endElementHandler(

void* ctx,

const xmlChar* localname,

const xmlChar* prefix,

const xmlChar* URI)

{

[(BaseXmlParser*)ctx

endElementLocalName:localname

prefix:prefix

URI:URI];

}

static void charactersFoundHandler(

void* ctx,

const xmlChar* ch,

int len)

{

[(BaseXmlParser*)ctx

charactersFound:chlen:len];

}

其实这 3个静态方法只是调用了超类BaseXmlParser的成员方法，他的具体类型依赖于ctx的注入类型，也就是说，这里的ctx可以是任何BaseXmlParser的子类。实际使用中，我们应该注入其子类，从而可以根据不同的情况为URLOperation“注入”不同的解析器，实现解析不同的xml文件的目的。

现在，需要把解析器应用到 NSURLConnection的委托方法中（这里省略了部分代码，只列出了新增加的部分）：

#pragma markNSURLConnection delegate Method

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

- (void)connection:(NSURLConnection*)connection

didReceiveData:(NSData*)data {

// 使用libxml解析器进行xml解析

xmlParseChunk(_parserContext,(const char*)[data bytes], [data length], 0);

⋯⋯

}

// HTTP请求结束时

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

if(baseParser!=nil && baseParser!=NULL){