iphone 开发之 第三方 network框架 ASIHTTPRequest 详解

ASIHTTPRequest 详解, http 请求终结者   

 

今天把这个的官方文档翻译的出来以做分享~

让迷途之人有路可寻~

 

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

 

如:

异步请求,队列请求,GZIP压缩,缓存,断点续传,进度跟踪,上传文件,HTTP认证

在新的版本中,还加入了Objective-C闭包Block的支持,让我们的代码更加轻简灵活。

 

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

 

发起一个同步请求

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

 

复制代码

  1. - (IBAction)grabURL:(id)sender
  2. {
  3.   NSURL *url = [NSURL URLWithString:@"http://allseeing-i.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://allseeing-i.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://allseeing-i.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的子类。也就是说它可以直接被放到"任务队列"中,并被执行。上面的代码队了队列的创建与添加操作外,其它代码与上一例一样。

 

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

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 g o ]才会执行;一个正在运行中的队列,并不需要重复调用[  queue go  ]。

 

引用

text/">

默认情况下,队列中的一个请求如果失败,它会取消所有未完成的请求。可以设置[  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:@"Ben" forKey:@"first_name"];
  3. [request setPostValue:@"Copsey" forKey:@"last_name"];
  4. [request setFile:@"/Users/ben/Desktop/ben.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:@".allseeing-i.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://allseeing-i.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 ];

就可以了。

你可能感兴趣的:(框架,properties,header,url,iPhone,NetWork)