您的位置：首页 > 理论基础 > 计算机网络

ASIHTTPRequest详解

2013-02-18 14:40 323 查看

ASIHTTPRequest详解

ASIHTTPRequest是一款极其强劲的HTTP访问开源项目。让简单的API完成复杂的功能，如：异步请求，队列请求，GZIP压缩，缓存，断点续传，进度跟踪，上传文件，HTTP认证。在新的版本中，还加入了
Objective-C闭包Block的支持，让我们的代码加轻简灵活。

下面就举例说明它的API用法。

发起一个同步请求

同步意为着线程阻塞，在主线程中使用此方法会使应用Hang住而不响应任何用户事件。所以，在应用程序设计时，大多被用在专门的子线程增加用户体验，或用异步请求代替（下面会讲到）。

01	- (IBAction)grabURL:(id)sender

03	NSURL *url=[NSURLURLWithString:@ "http://allseeing-i.com" ];

04	ASIHTTPRequest *request=[ASIHTTPRequestrequestWithURL:url];

05	[request startSynchronous];

06	NSError *error=[requesterror];

07	if (!error) {

08	NSString *response=[requestresponseString];

用requestWithURL快捷方法获取ASIHTTPRequest的一个实例

startSynchronous方法启动同步访问

由于是同步请求，没有基于事件的回调方法，所以从request的error属性获取错误信息

responseString，为请求的返回NSString信息

创建一个异步请求

异步请求的好处是不阻塞当前线程，但相对于同步请求略为复杂，至少要添加两个回调方法来获取异步事件。下面异步请求代码完成上面同样的一件事情：

01	- (IBAction)grabURLInBackground:(id)sender

04	NSURL *url=[NSURLURLWithString:@ "http://allseeing-i.com" ];

06	ASIHTTPRequest *request=[ASIHTTPRequestrequestWithURL:url];

08	[request setDelegate:self];

10	[request startAsynchronous];

13	- ( void )requestFinished:(ASIHTTPRequest *)request

17	// Usewhenfetchingtextdata

19	NSString *responseString=[requestresponseString];

21	// Usewhenfetchingbinarydata

23	NSData *responseData=[requestresponseData];

27	- ( void )requestFailed:(ASIHTTPRequest *)request

31	NSError *error=[requesterror];

与上面不同的地方是指定了一个"delegate"，并用startAsynchronous来启动网络请求

在这里实现了两个delegate的方法，当数据请求成功时会调用requestFinished，请求失败时（如网络问题或服务器内部错误）会调用requestFailed。

队列请求

提供了一个对异步请求更加精准丰富的控制。如：可以设置在队列中同步请求的连接数。往队列里添加的请求实例数大于maxConcurrentOperationCount时，请求实例将被置为等待，直到前面至少有一个请求完成并出列才被放到队列里执行。这也适用于当我们有多个请求需求按顺序执行的时候（可能是业务上的需要，也可能是软件上的调优），仅仅需要把
maxConcurrentOperationCount设为“1”。

01	1. -(IBAction)grabURLInTheBackground:(id)sender

2.
{

05	3. if (![self queue]){

07	4. [selfsetQueue:[[[NSOperationQueuealloc]init]autorelease]];

5.
}

6.

13	7. NSURL*url=[NSURLURLWithString:@ "http://allseeing-i.com" ];

15	8. ASIHTTPRequest*request=[ASIHTTPRequestrequestWithURL:url];

17	9. [requestsetDelegate:self];

19	10. [requestsetDidFinishSelector:@selector(requestDone:)];

21	11. [requestsetDidFailSelector:@selector(requestWentWrong:)];

23	12. [[selfqueue]addOperation:request]; //queue isanNSOperationQueue

13.
}

14.

29	15. -( void )requestDone:(ASIHTTPRequest *)request

16.
{

33	17. NSString*response=[requestresponseString];

18.
}

19.

39	20. -( void )requestWentWrong:(ASIHTTPRequest *)request

21.
{

43	22. NSError*error=[requesterror];

23.
}

创建NSOperationQueue，这个Cocoa架构的执行任务（NSOperation）的任务队列。我们通过ASIHTTPRequest.h的源码可以看到，此类本身就是一个NSOperation
的子类。也就是说它可以直接被放到"任务队列"中并被执行。上面的代码除了队列的创建与添加操作外，其它代码与上一例一样。

队列异步请求中中获取或识别不同request小技巧

可以设置一个上下文（userInfo）到request对象中，当请求响应完后可以通过访问request对象的userInfo获取里面的信息

为每一个请求实例设置不同的setDidFinishSelector/setDidFailSelector的回调方法

子类化ASIHTTPRequest，重写requestFinished:与failWithProblem:方法

ASINetworkQueues,它的delegate提供更为丰富的功能

提供的更多的回调方法如下：

requestDidStartSelector，请求发起时会调此方法，你可以在此方法中跟据业务选择性的设置request对象的deleaget

requestDidReceiveResponseHeadersSelector，当接受完响应的Header后设计此方法，这个对下载大数据的时候相当有用，你可以在方法里做更多业务上的处理

requestDidFinishSelector，请求并响应成功完成时调用此方法

requestDidFailSelector，请求失败

queueDidFinishSelector，整个队列里的所有请求都结束时调用此方法

它是NSOperationQueues的扩展，小而强大。但也与它的父类略有区别。如，仅添加到队列中其实并不能执行请求，只有调用[queuego]才会执行；一个正在运行中的队列，并不需要重复调用[queue
go]。默认情况下，队列中的一个请求如果失败，它会取消所有未完成的请求。可以设置[queuesetShouldCancelAllRequestsOnFailure:NO]来修正。

取消异步请求

首先，同步请求是不能取消的。

其次，不管是队列请求，还是简单的异步请求，全部调用[requestcancel]来取消请求。取消的请求默认都会按请求失败处理，并调用请求失败delegate。

如果不想调用delegate方法，则设置：[requestclearDelegatesAndCancel];

队列请求中需要注意的是，如果你取消了一个请求，队列会自动取消其它所有请求。如果只想取消一个请求，可以设置队列：[queuesetShouldCancelAllRequestsOnFailure:NO
];如果想明确取消所有请求：[queuecancelAllOperations];

安全的内存回收建议

request并没有retain你的delegate，所以在没有请求完的时候释放了此delegate，需要在dealloc方法里先取消所有请求，再释放请求实例，如：

01	1. -( void )dealloc

2.
{

05	3. [requestclearDelegatesAndCancel];

07	4. [requestrelease];

5.
...

11	6. [superdealloc];

7.
}

向服务器端上传数据

ASIFormDataRequest，模拟Form表单提交，其提交格式与Header会自动识别。

没有文件：application/x-www-form-urlencoded

有文件：multipart/form-data

1	1. ASIFormDataRequest*request=[ASIFormDataRequestrequestWithURL:url];

3	2. [requestsetPostValue:@ "Ben" forKey:@ "first_name" ];

5	3. [requestsetPostValue:@ "Copsey" forKey:@ "last_name" ];

7	4. [requestsetFile:@ "/Users/ben/Desktop/ben.jpg" forKey:@ "photo" ];

9	5. [requestaddData:imageDatawithFileName:@ "george.jpg" andContentType:@ "image/jpeg" forKey:@ "photos" ];

如果要发送自定义数据：

1	1. ASIHTTPRequest*request=[ASIHTTPRequestrequestWithURL:url];

3	2. [requestappendPostData:[@ "This ismydata" dataUsingEncoding:NSUTF8StringEncoding]];

5	3. // DefaultbecomesPOSTwhenyouuseappendPostData:/appendPostDataFromFile:/setPostBody:

7	4. [requestsetRequestMethod:@ "PUT" ];

下载文件

通过设置request的setDownloadDestinationPath，可以设置下载文件用的下载目标目录。

首先，下载过程文件会保存在temporaryFileDownloadPath目录下。如果下载完成会做以下事情：

如果数据是压缩的，进行解压，并把文件放在downloadDestinationPath目录中，临时文件被删除

如果下载失败，临时文件被直接移到downloadDestinationPath目录，并替换同名文件

如果你想获取下载中的所有数据，可以实现delegate中的request:didReceiveData:方法。但如果你实现了这个方法，request在下载完后，request并不把文件放在
downloadDestinationPath中，需要手工处理。

获取响应信息

信息：status,header,responseEncoding

[requestresponseStatusCode];

[[requestresponseHeaders]objectForKey:@"X-Powered-By"];

[requestresponseEncoding];

获取请求进度

有两个回调方法可以获取请求进度：

downloadProgressDelegate，可以获取下载进度

uploadProgressDelegate，可以获取上传进度

cookie的支持

如果Cookie存在的话，会把这些信息放在NSHTTPCookieStorage容器中_共享，并供下次使用。你可以用[ASIHTTPRequestsetSessionCookies:nil
];清空所有Cookies。当然，你也可以取消默认的Cookie策略，而使自定义的Cookie：

01	1. //Create acookie

03	2. NSDictionary*properties=[[[NSMutableDictionaryalloc]init]autorelease];

05	3. [propertiessetValue:[@ "Test Value" encodedCookieValue] forKey:NSHTTPCookieValue];

07	4. [propertiessetValue:@ "ASIHTTPRequestTestCookie" forKey:NSHTTPCookieName];

09	5. [propertiessetValue:@ ".allseeing-i.com" forKey:NSHTTPCookieDomain];

11	6. [propertiessetValue:[NSDatedateWithTimeIntervalSinceNow:60*60]forKey:NSHTTPCookieExpires];

13	7. [propertiessetValue:@ "/asi-http-request/tests" forKey:NSHTTPCookiePath];

15	8. NSHTTPCookie*cookie=[[[NSHTTPCookiealloc]initWithProperties:properties]autorelease];

9.

19	10. //This urlwillreturnthevalueofthe'ASIHTTPRequestTestCookie'cookie

21	11. url=[NSURLURLWithString:@ "http://allseeing-i.com/ASIHTTPRequest/tests/read_cookie" ];

23	12. request=[ASIHTTPRequestrequestWithURL:url];

25	13. [requestsetUseCookiePersistence:NO];

27	14. [requestsetRequestCookies:[NSMutableArrayarrayWithObject:cookie]];

29	15. [requeststartSynchronous];

16.

33	17. //Should be:Ihave'TestValue'asthevalueof'ASIHTTPRequestTestCookie'

35	18. NSLog(@ "%@" ,[request responseString]);

大文件断点续传

0.94以后支持大文件的断点下载，只需要设置

1	[ requestsetAllowResumeForFileDownloads:YES];

3	[ requestsetDownloadDestinationPath:downloadPath];

就好了。

ASIHTTPRequest会自动保存访问过的ＵＲＬ信息，并备之后用。在以下几个场景非常有用： 

1，当没有网络连接的时候。

 2，已下载的数据再次请求时，仅当它与本地版本不样时才进行下载。

ASIDownloadCache设置下载缓存

它对Get请求的响应数据进行缓存（被缓存的数据必需是成功的200请求）：

[ASIHTTPRequestsetDefaultCache:[ASIDownloadCachesharedCache]];

当设置缓存策略后，所有的请求都被自动的缓存起来。 另外，如果仅仅希望某次请求使用缓存操作，也可以这样使用：

ASIHTTPRequest*request=[ASIHTTPRequestrequestWithURL:url];

[requestsetDownloadCache:[ASIDownloadCachesharedCache]];

多种的缓存并存

仅仅需要创建不同的ASIDownloadCache，并设置缓存所使用的路径，并设置到需要使用的request实例中：

ASIDownloadCache*cache=[[[ASIDownloadCachealloc]init]autorelease];

[cachesetStoragePath:@"/Users/ben/Documents/Cached-Downloads"];

[selfsetMyCache:cache];

ASIHTTPRequest*request=[ASIHTTPRequestrequestWithURL:url];

[requestsetDownloadCache:[selfmyCache]];

缓存策略

缓存策略是我们控制缓存行为的主要方式，如：什么时候进行缓存，缓存数据的利用方式。 以下是策略可选列表（可组合使用）：

ASIUseDefaultCachePolicy

这是一个默认的缓存策略“ASIAskServerIfModifiedWhenStaleCachePolicy”，这个很明白，见名知意（它不能与其它策略组合使用）

ASIDoNotReadFromCacheCachePolicy

所读数据不使用缓存

ASIDoNotWriteToCacheCachePolicy

不对缓存数据进行写操作

ASIAskServerIfModifiedWhenStaleCachePolicy

默认缓存行为，request会先判断是否存在缓存数据。a,如果没有再进行网络请求。b，如果存在缓存数据，并且数据没有过期，则使用缓存。c，如果存在缓存数据，但已经过期，request会先进行网络请求，判断服务器版本与本地版本是否一样，如果一样，则使用缓存。如果服务器有新版本，会进行网络请求，并更新本地缓存

ASIAskServerIfModifiedCachePolicy

与默认缓存大致一样，区别仅是每次请求都会去服务器判断是否有更新

ASIOnlyLoadIfNotCachedCachePolicy

如果有缓存在本地，不管其过期与否，总会拿来使用

ASIDontLoadCachePolicy

仅当有缓存的时候才会被正确执行，如果没有缓存，request将被取消（没有错误信息）

ASIFallbackToCacheIfLoadFailsCachePolicy

这个选项经常被用来与其它选项组合使用。请求失败时，如果有缓存当网络则返回本地缓存信息（这个在处理异常时非常有用）

如果设置了“defaultCachePolicy”则所有的请求都会使用此缓存。

缓存存储方式

你可以设置缓存的数据需要保存多长时间，ASIHTTPRequest提供了两种策略： a，ASICacheForSessionDurationCacheStoragePolicy，默认策略，基于session的缓存数据存储。当下次运行或[ASIHTTPRequestclearSession]时，缓存将失效。 b，ASICachePermanentlyCacheStoragePolicy，把缓存数据永久保存在本地， 如：

ASIHTTPRequest*request=[ASIHTTPRequestrequestWithURL:url];

[requestsetCacheStoragePolicy:ASICachePermanentlyCacheStoragePolicy];

另外，也可以使用clearCachedResponsesForStoragePolicy来清空指定策略下的缓存数据。

缓存其它特性

设置是否按服务器在Header里指定的是否可被缓存或过期策略进行缓存：

[[ASIDownloadCachesharedCache]setShouldRespectCacheControlHeaders:NO];

设置request缓存的有效时间:

[requestsetSecondsToCache:60*60*24*30];//缓存30天

可以判断数据是否从缓存读取：

[requestdidUseCachedResponse];

设置缓存所使用的路径：

[requestsetDownloadDestinationPath:[[ASIDownloadCachesharedCache]pathToStoreCachedResponseDataForRequest:request]];

实现自定义的缓存

只要简单的实现ASICacheDelegate接口就可以被用来使用。

使用代理请求

默认的情况下，ASIHTTPRequest会使用被设置的默认代理。但你也可以手动修改http代理：

//Configureaproxyservermanually

NSURL*url=[NSURLURLWithString:@"http://allseeing-i.com/ignore"];

ASIHTTPRequest*request=[ASIHTTPRequestrequestWithURL:url];

[requestsetProxyHost:@"192.168.0.1"];

[requestsetProxyPort:3128];

//Alternatively,youcanuseamanually-specifiedProxyAutoConfigfile(PAC)

//(It'sprobablybestifyouusealocalfile)

[requestsetPACurl:[NSURLURLWithString:@"file:///Users/ben/Desktop/test.pac"]];

ASIHTTPRequest,请求的其它特性

iOS4中，当应用后台运行时仍然请求数据：

[requestsetShouldContinueWhenAppEntersBackground:YES];

是否有网络请求：

[ASIHTTPRequestisNetworkInUse]

是否显示网络请求信息在statusbar上：

[ASIHTTPRequestsetShouldUpdateNetworkActivityIndicator:NO];

设置请求超时时，设置重试的次数：

[requestsetNumberOfTimesToRetryOnTimeout:2];

KeepAlive的支持：

//Settheamountoftimetohangontoapersistentconnectionbeforeitshouldexpireto2minutes

[requestsetPersistentConnectionTimeoutSeconds:120];

//Disablepersistentconnectionsentirely

[requestsetShouldAttemptPersistentConnection:NO];

转自http://my.oschina.net/u/819843/blog/98876

内容来自用户分享和网络整理，不保证内容的准确性，如有侵权内容，可联系管理员处理

标签：

相关文章推荐

新的分享

章节导航