ASIHTTPRequest

ASIHTTPRequest，是一个直接在CFNetwork上做的开源项目，提供了一个比官方更方便更强大的HTTP网络传输的封装。
ASIHTTPRequest 官方网站地址：http://allseeing-i.com/  

 
一、介绍
特色功能如下：
1.下载的数据直接保存到 内存 或 文件 系统里
2.提供直接提交(HTTP POST)文件的API
3.可以直接访问与修改HTTP请求与响应HEADER
4.轻松获取 上传 与下载的进度信息
5.异步请求与队列，自动管理上传与下载队列管理机
6.认证与授权的支持
7.Cookie
8.请求与响应的GZIP
9.代理请求
ASIHTTPRequest -Main classes介绍：
1.ASIHTTPRequest：处理与 服务 器的基本交互，包括下载上传，认证，cookies以及进度查看。
2.ASIFormDataRequest：是ASIHTTPRequest子类，主要处理post事件，它能使post更加简单。
3.ASINetworkQueue：是NSOperationQueue子类，当处理多个请求时可以 使用 ，如果每次都是单个请求就不必使用。
4.ASIDownloadCache：该类允许ASIHTTPRequest从服务器传递cookie。
ASIHTTPRequest -Support classes介绍：
1.ASIInputStream：当使用ASIHTTPRequest上传数据时使用，如果工程中用了ASIHTTPRequest，就一定要include这个类。
2.ASIAuthenticationDialog：该类允许ASIHTTPRequest连接到服务器时呈现登录框。在所有 iPhone OS工程中都要使用，Mac OS工程中可以不用。
3.Reachability：相信很多人对这个类已经很熟悉了，当在你程序中侦测网络状态时它将非常有用。
ASIHTTPRequest -Protocols and configuration介绍：
1.ASIHTTPRequestDelegate：该协议指定了ASIHTTPRequest的delegate可能需要实现的方法，所有方法都是optional。
2.ASIProgressDelegate：该协议列出了uploadProgressDelegate和downloadProgressDelegate可能需要实现的方法，所有方法为optional。
3.ASICacheDelegate：该协议指定了download cache必须实现的方法。如果你要写你自己的download cache，确保实现required方法。
4.ASIHTTPRequestConfig.h： 该文件定义了编译时所有的全局配置选项。使用该文件中的方法可以在控制台中输出request正在进行的任务，Don't forget to turn these off in shipping applicati*****!（这句啥意思？...？时候要关闭？）

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

发起一个同步请求

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

    - (IBAction)grabURL:(id)sender
    {
      NSURL *url = [NSURL URLWithString:@"http://allseeing-i.com"];
      ASIHTTPRequest *request = [ASIHTTPRequest requestWithURL:url];
      [request startSynchronous];
      NSError *error = [request error];
      if (!error) {
        NSString *response = [request responseString];
      }
    }

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

创建一个异步请求

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

- (IBAction)grabURLInBackground:(id)sender
{
   NSURL *url = [NSURL URLWithString:@"http://allseeing-i.com"];
   ASIHTTPRequest *request = [ASIHTTPRequest requestWithURL:url];
   [request setDelegate:self];
   [request startAsynchronous];
}
 
- (void)requestFinished:(ASIHTTPRequest *)request
{
   // Use when fetching text data
   NSString *responseString = [request responseString];
 
   // Use when fetching binary data
   NSData *responseData = [request responseData];
}
 
- (void)requestFailed:(ASIHTTPRequest *)request
{
   NSError *error = [request error];
}

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

队列请求

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

- (IBAction)grabURLInTheBackground:(id)sender
{
   if (![self queue]) {
      [self setQueue:[[[NSOperationQueue alloc] init] autorelease]];
   }
 
   NSURL *url = [NSURL URLWithString:@"http://allseeing-i.com"];
   ASIHTTPRequest *request = [ASIHTTPRequest requestWithURL:url];
   [request setDelegate:self];
   [request setDidFinishSelector:@selector(requestDone:)];
   [request setDidFailSelector:@selector(requestWentWrong:)];
   [[self queue] addOperation:request]; //queue is an NSOperationQueue
}
 
- (void)requestDone:(ASIHTTPRequest *)request
{
   NSString *response = [request responseString];
}
 
- (void)requestWentWrong:(ASIHTTPRequest *)request
{
   NSError *error = [request error];
}

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

取消异步请求

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

    其次，不管是队列请求，还是简单的异步请求，全部调用[ request cancel ]来取消请求。取消的请求默认都会按请求失败处理，并调用请求失败delegate。
    如果不想调用delegate方法，则设置：[ request clearDelegatesAndCancel];

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

安全的内存回收建议

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

 - (void)dealloc
{
   [request clearDelegatesAndCancel];
   [request release];
   ...
   [super dealloc];
}

向服务器端上传数据

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

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

     ASIFormDataRequest *request = [ASIFormDataRequest requestWithURL:url];
    [request setPostValue:@"Ben" forKey:@"first_name"];
    [request setPostValue:@"Copsey" forKey:@"last_name"];
    [request setFile:@"/Users/ben/Desktop/ben.jpg" forKey:@"photo"];
    [request addData:imageData withFileName:@"george.jpg" andContentType:@"image/jpeg" forKey:@"photos"];

    如果要发送自定义数据：

    ASIHTTPRequest *request = [ASIHTTPRequest requestWithURL:url];
    [request appendPostData:[@"This is my data" dataUsingEncoding:NSUTF8StringEncoding]];
    // Default becomes POST when you use appendPostData: / appendPostDataFromFile: / setPostBody:
    [request setRequestMethod:@"PUT"];

下载文件

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

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

• 如果数据是压缩的，进行解压，并把文件放在 downloadDestinationPath 目录中，临时文件被删除
• 如果下载失败，临时文件被直接移到 downloadDestinationPath 目录，并替换同名文件

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

获取响应信息

    信息：status , header, responseEncoding

    [request responseStatusCode];
    [[request responseHeaders] objectForKey:@"X-Powered-By"];
    [request responseEncoding];

获取请求进度

 

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

• downloadProgressDelegate，可以获取下载进度
• uploadProgressDelegate，可以获取上传进度

 cookie的支持 

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

    //Create a cookie
    NSDictionary *properties = [[[NSMutableDictionary alloc] init] autorelease];
    [properties setValue:[@"Test Value" encodedCookieValue] forKey:NSHTTPCookieValue];
    [properties setValue:@"ASIHTTPRequestTestCookie" forKey:NSHTTPCookieName];
    [properties setValue:@".allseeing-i.com" forKey:NSHTTPCookieDomain];
    [properties setValue:[NSDate dateWithTimeIntervalSinceNow:60*60] forKey:NSHTTPCookieExpires];
    [properties setValue:@"/asi-http-request/tests" forKey:NSHTTPCookiePath];
    NSHTTPCookie *cookie = [[[NSHTTPCookie alloc] initWithProperties:properties] autorelease];
     
    //This url will return the value of the 'ASIHTTPRequestTestCookie' cookie
    url = [NSURL URLWithString:@"http://allseeing-i.com/ASIHTTPRequest/tests/read_cookie"];
    request = [ASIHTTPRequest requestWithURL:url];
    [request setUseCookiePersistence:NO];
    [request setRequestCookies:[NSMutableArray arrayWithObject:cookie]];
    [request startSynchronous];
     
    //Should be: I have 'Test Value' as the value of 'ASIHTTPRequestTestCookie'
    NSLog(@"%@",[request responseString]);

大文件断点续传

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

[ request setAllowResumeForFileDownloads:YES ];

[ request setDownloadDestinationPath:downloadPath ];