ASIHTTPRequest

柴兴贤
2023-12-01

ASIHTTPRequest是一款极其强劲的HTTP访问开源项目。让简单的API完成复杂的功能,

如:
异步请求,队列请求,GZIP压缩,缓存,断点续传,进度跟踪,上传文件,HTTP认证
在新的版本中,还加入了Objective-C闭包Block的支持,让我们的代码更加轻简灵活。

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

发起一个同步请求

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

 1 - (IBAction)grabURL:(id)sender
 2 {
 3   NSURL *url = [NSURL URLWithString:@"http://www.tryingx.com"];
 4   ASIHTTPRequest *request = [ASIHTTPRequest requestWithURL:url];
 5   [request startSynchronous];
 6   NSError *error = [request error];
 7   if (!error) {
 8     NSString *response = [request responseString];
 9   }
10 }

a, 用requestWithURL快捷方法获取ASIHTTPRequest的一个实例
b, startSynchronous 方法启动同步访问,
c, 由于是同步请求,没有基于事件的回调方法,所以从request的error属性获取错误信息。
d, responseString,为请求的返回NSString信息。

创建一个异步请求

异步请求的好处是不阻塞当前线程,但相对于同步请求略为复杂,至少要添加两个回调方法来获取异步事件。

下面异步请求代码完成上面同样的一件事情:

 1 - (IBAction)grabURLInBackground:(id)sender
 2 {
 3    NSURL *url = [NSURL URLWithString:@"http://www.tryingx.com"];
 4    ASIHTTPRequest *request = [ASIHTTPRequest requestWithURL:url];
 5    [request setDelegate:self];
 6    [request startAsynchronous];
 7 }
 8  
 9 - (void)requestFinished:(ASIHTTPRequest *)request
10 {
11    // Use when fetching text data
12    NSString *responseString = [request responseString];
13  
14    // Use when fetching binary data
15    NSData *responseData = [request responseData];
16 }
17  
18 - (void)requestFailed:(ASIHTTPRequest *)request
19 {
20    NSError *error = [request error];
21 }

a,与上面不同的地方是指定了一个 "delegate",并用startAsynchronous来启动网络请求。
b,在这里实现了两个delegate的方法,当数据请求成功时会调用requestFinished,请求失败时(如网络问题或服务器内部错误)会调用requestFailed。

队列请求

提供了一个对异步请求更加精准丰富的控制。

如:可以设置在队列中,同步请求的连接数。往队列里添加的请求实例数大于maxConcurrentOperationCount时,请求实例将被置为等待,直到前面至少有一个请求完成并出列才被放到队列里执行。
也适用于当我们有多个请求需求按顺序执行的时候(可能是业务上的需要,也可能是软件上的调优),仅仅需要把maxConcurrentOperationCount设为“1”。

 1 - (IBAction)grabURLInTheBackground:(id)sender
 2 {
 3    if (![self queue]) {
 4       [self setQueue:[[[NSOperationQueue alloc] init] autorelease]];
 5    }
 6  
 7    NSURL *url = [NSURL URLWithString:@"http://www.tryingx.com"];
 8    ASIHTTPRequest *request = [ASIHTTPRequest requestWithURL:url];
 9    [request setDelegate:self];
10    [request setDidFinishSelector:@selector(requestDone:)];
11    [request setDidFailSelector:@selector(requestWentWrong:)];
12    [[self queue] addOperation:request]; //queue is an NSOperationQueue
13 }
14  
15 - (void)requestDone:(ASIHTTPRequest *)request
16 {
17    NSString *response = [request responseString];
18 }
19  
20 - (void)requestWentWrong:(ASIHTTPRequest *)request
21 {
22    NSError *error = [request error];
23 }

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

请求队列上下文

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

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

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

ASINetworkQueues, 丰富功能的delegate

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

a,requestDidStartSelector,请求发起时会调此方法,你可以在此方法中跟据业务选择性的设置request对象的deleaget。
b,requestDidReceiveResponseHeadersSelector,当接受完响应的Header后设计此方法,这个对下载大数据的时候相当有用,你可以在方法里做更多业务上的处理。
c,requestDidFinishSelector,请求并响应成功完成时调用此方法
d,requestDidFailSelector,请求失败
e,queueDidFinishSelector,整个队列里的所有请求都结束时调用此方法。

它是NSOperationQueues的扩展,小而强大。但也与它的父类略有区别。如:仅添加到队列中其实并不能执行请求,只有调用[queue go]才会执行;一个正在运行中的队列,并不需要重复调用[queue go]。

默认情况下,队列中的一个请求如果失败,它会取消所有未完成的请求。可以设置[queue setShouldCancelAllRequestsOnFailure:NO]来修正。

取消异步请求

首先,同步请求是不能取消的。
其次,不管是队列请求,还是简单的异步请求,全部调用[request cancel]来取消请求。

取消的请求默认都会按请求失败处理,并调用请求失败delegate。
如果不想调用delegate方法,则设置:[request clearDelegatesAndCancel];

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

安全的内存回收建议

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

1 - (void)dealloc
2 {
3    [request clearDelegatesAndCancel];
4    [request release];
5    ...
6    [super dealloc];
7 }
向服务器端上传数据

ASIFormDataRequest ,模拟 Form表单提交,其提交格式与 Header会自动识别。
没有文件:application/x-www-form-urlencoded
有文件:multipart/form-data

1 ASIFormDataRequest *request = [ASIFormDataRequest requestWithURL:url];
2 [request setPostValue:@"Gavin" forKey:@"first_name"];
3 [request setPostValue:@"TryingX" forKey:@"last_name"];
4 [request setFile:@"/Users/Gavin/Desktop/gavin.jpg" forKey:@"photo"];
5 [request addData:imageData withFileName:@"george.jpg" andContentType:@"image/jpeg"forKey:@"photos"];

如果要发送自定义数据:

1 ASIHTTPRequest *request = [ASIHTTPRequest requestWithURL:url];
2 [request appendPostData:[@"This is my data" dataUsingEncoding:NSUTF8StringEncoding]];
3 // Default becomes POST when you use appendPostData: / appendPostDataFromFile: / setPostBody:
4 [request setRequestMethod:@"PUT"];
下载文件

通过设置request的setDownloadDestinationPath,可以设置下载文件用的下载目标目录。
首先,下载过程文件会保存在temporaryFileDownloadPath目录下。如果下载完成会做以下事情:
1,如果数据是压缩的,进行解压,并把文件放在downloadDestinationPath目录中,临时文件被删除
2,如果下载失败,临时文件被直接移到downloadDestinationPath目录,并替换同名文件。

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

获取响应信息

信息:status , header, responseEncoding

1 [request responseStatusCode];
2 [[request responseHeaders] objectForKey:@"X-Powered-By"];
3 [request responseEncoding];
获取请求进度

有两个回调方法可以获取请求进度,
1,downloadProgressDelegate,可以获取下载进度
2,uploadProgressDelegate,可以获取上传进度

cookie的支持

如果Cookie存在的话,会把这些信息放在NSHTTPCookieStorage容器中共享,并供下次使用。

你可以用

[ASIHTTPRequest setSessionCookies:nil] ;

 

清空所有Cookies。
当然,你也可以取消默认的Cookie策略,而使自定义的Cookie:

 1 //Create a cookie
 2 NSDictionary *properties = [[[NSMutableDictionary alloc] init] autorelease];
 3 [properties setValue:[@"Test Value" encodedCookieValue] forKey:NSHTTPCookieValue];
 4 [properties setValue:@"ASIHTTPRequestTestCookie" forKey:NSHTTPCookieName];
 5 [properties setValue:@"www.tryingx.com" forKey:NSHTTPCookieDomain];
 6 [properties setValue:[NSDate dateWithTimeIntervalSinceNow:60*60] forKey:NSHTTPCookieExpires];
 7 [properties setValue:@"/asi-http-request/tests" forKey:NSHTTPCookiePath];
 8 NSHTTPCookie *cookie = [[[NSHTTPCookie alloc] initWithProperties:properties] autorelease];
 9  
10 //This url will return the value of the 'ASIHTTPRequestTestCookie' cookie
11 url = [NSURL URLWithString:@"http://www.tryingx.com/ASIHTTPRequest/tests/read_cookie"];
12 request = [ASIHTTPRequest requestWithURL:url];
13 [request setUseCookiePersistence:NO];
14 [request setRequestCookies:[NSMutableArray arrayWithObject:cookie]];
15 [request startSynchronous];
16  
17 //Should be: I have 'Test Value' as the value of 'ASIHTTPRequestTestCookie'
18 NSLog(@"%@",[request responseString]);

大文件断点续传

0.94以后支持大文件的断点下载,只需要设置:
[ request setAllowResumeForFileDownloads:YES ];
[ request setDownloadDestinationPath:downloadPath ];
就可以了。

ASIHTTPRequest会自动保存访问过的URL信息,并备之后用。在以下几个场景非常有用:
1,当没有网络连接的时候。
2,已下载的数据再次请求时,仅当它与本地版本不一样时才进行下载。

ASIDownloadCache 设置下载缓存

它对Get请求的响应数据进行缓存(被缓存的数据必需是成功的200请求):

[ASIHTTPRequest setDefaultCache:[ASIDownloadCache sharedCache]];

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

ASIHTTPRequest *request = [ASIHTTPRequest requestWithURL:url];
[request setDownloadCache:[ASIDownloadCache sharedCache]];
多种的缓存并存

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

1 ASIDownloadCache *cache = [[[ASIDownloadCache alloc] init] autorelease];
2 [cache setStoragePath:@"/Users/ben/Documents/Cached-Downloads"];
3 [self setMyCache:cache];
4 ASIHTTPRequest *request = [ASIHTTPRequest requestWithURL:url];
5 [request setDownloadCache:[self myCache]];
缓存策略

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

ASIUseDefaultCachePolicy这是一个默认的缓存策略“ASIAskServerIfModifiedWhenStaleCachePolicy”,这个很明白,见名知意(它不能与其它策略组合使用)
ASIDoNotReadFromCacheCachePolicy所读数据不使用缓存
ASIDoNotWriteToCacheCachePolicy不对缓存数据进行写操作
ASIAskServerIfModifiedWhenStaleCachePolicy默认缓存行为,request会先判断是否存在缓存数据。a, 如果没有再进行网络请求。 b,如果存在缓存数据,并且数据没有过期,则使用缓存。c,如果存在缓存数据,但已经过期,request会先进行网络请求,判断服务器版本与本地版本是否一样,如果一样,则使用缓存。如果服务器有新版本,会进行网络请求,并更新本地缓存
ASIAskServerIfModifiedCachePolicy与默认缓存大致一样,区别仅是每次请求都会 去服务器判断是否有更新
ASIOnlyLoadIfNotCachedCachePolicy如果有缓存在本地,不管其过期与否,总会拿来使用
ASIDontLoadCachePolicy仅当有缓存的时候才会被正确执行,如果没有缓存,request将被取消(没有错误信息)
ASIFallbackToCacheIfLoadFailsCachePolicy这个选项经常被用来与其它选项组合使用。请求失败时,如果有缓存当网络则返回本地缓存信息(这个在处理异常时非常有用),如果设置了“defaultCachePolicy”则所有的请求都会使用此缓存。

 

缓存存储方式

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

1 ASIHTTPRequest *request = [ASIHTTPRequest requestWithURL:url];
2 [request setCacheStoragePolicy:ASICachePermanentlyCacheStoragePolicy];

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

缓存其它特性

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

[[ASIDownloadCache sharedCache] setShouldRespectCacheControlHeaders:NO];

设置request缓存的有效时间:

[request setSecondsToCache:60*60*24*30]; // 缓存30天,以秒为单位

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

[request didUseCachedResponse];

设置缓存所使用的路径:

[request setDownloadDestinationPath:[[ASIDownloadCache sharedCache] pathToStoreCachedResponseDataForRequest:request]];
实现自定义的缓存

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

使用代理请求

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

1 // Configure a proxy server manually
2 NSURL *url = [ NSURL URLWithString:@"http://www.tryingx.com/gavin" ];
3 ASIHTTPRequest *request = [ ASIHTTPRequest requestWithURL:url ];
4 [ request setProxyHost:@"192.168.0.1" ];          //IP地址
5 [ request setProxyPort:3128 ];                 //端口
6  
7 // Alternatively, you can use a manually-specified Proxy Auto Config file (PAC)
8 // (It's probably best if you use a local file)
9 [request setPACurl:[NSURL URLWithString:@"file:///Users/ben/Desktop/test.pac"]];
ASIHTTPRequest, 请求的其它特性

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

[request setShouldContinueWhenAppEntersBackground:YES];

是否有网络请求:

[ASIHTTPRequest isNetworkInUse];

是否显示网络请求信息在status bar上:

[ASIHTTPRequest setShouldUpdateNetworkActivityIndicator:NO];

设置请求超时时,设置重试的次数:

[request setNumberOfTimesToRetryOnTimeout:2];

KeepAlive的支持:

1 // Set the amount of time to hang on to a persistent connection before it should expire to 2 minutes
2 [ request setPersistentConnectionTimeoutSeconds:120 ];
3  
4 // Disable persistent connections entirely
5 [ request setShouldAttemptPersistentConnection:NO ]; 

转载于:https://www.cnblogs.com/tryingx/articles/3878043.html

 类似资料:

相关阅读

相关文章

相关问答