ASIHTTPRequest类库简介和使用说明

本文详细介绍ASIHTTPRequest类库的使用方法,包括同步与异步请求、队列管理、文件上传及下载等功能。此外,还介绍了如何处理请求进度和响应信息。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

ASIHTTPRequest类库简介和使用说明(一)

使 用iOS SDK中的HTTP网络请求API,相当的复杂,调用很繁琐,ASIHTTPRequest就是一个对CFNetwork API进行了封装,并且使用起来非常简单的一套API,用Objective-C编写,可以很好的应用在Mac OS X系统和iOS平台的应用程序中。ASIHTTPRequest适用于基本的HTTP请求,和基于REST的服务之间的交互。

ASIHTTPRequest功能很强大,主要特色如下:

  • l 通过简单的接口,即可完成向服务端提交数据和从服务端获取数据的工作
  • l 下载的数据,可存储到内存中或直接存储到磁盘中
  • l 能上传本地文件到服务端
  • l 可以方便的访问和操作请求和返回的Http头信息
  • l 可以获取到上传或下载的进度信息,为应用程序提供更好的体验
  • l 支持上传或下载队列,并且可获取队列的进度信息
  • l 支持基本、摘要和NTLM身份认证,在同一会话中授权凭证会自动维持,并且可以存储在Keychain(Mac和iOS操作系统的密码管理系统)中
  • l 支持Cookie
  • l 当应用(iOS 4+)在后台运行时,请求可以继续运行
  • l 支持GZIP压缩数据
  • l 内置的ASIDownloadCache类,可以缓存请求返回的数据,这样即使没有网络也可以返回已经缓存的数据结果
  • l ASIWebPageRequest –可以下载完整的网页,包括包含的网页、样式表、脚本等资源文件,并显示在UIWebView /WebView中。任意大小的页面都可以无限期缓存,这样即使没有网络也可以离线浏览
  • l 支持客户端证书
  • l 支持通过代理发起Http请求
  • l 支持带宽限制。在iOS平台,可以根据当前网络情况来自动决定是否限制带宽,例如当使用WWAN(GPRS/Edge/3G)网络时限制,而当使用WIFI时不做任何限制
  • l 支持断点续传
  • l 支持同步和异步请求
2.1.1安装说明

如果想在iOS项目中使用ASIHTTPRequest,需要在项目中进行简单的配置,步骤如下:

1) 添加文件

往一个Xcode项目中添加第三方类库文件,有两种方式:

1. 第一种方式,在Finder中打开需要添加到文件或文件夹,在Xcode中打开要添加文件的项目,然后选中要添加的文件或文件夹,将它从Finder中拖 到Xcode中,然后释放。在弹出的对话框中,如果文件已经拷贝到了项目文件目录中,则不需要选中“Copy items”的复选框;如果文件没有拷贝到项目文件目录,就需要选中“Copy items”的复选框,这样Xcode会自动把文件复制到项目文件目录下。

2. 第二种方式,在Xcode中,在要添加文件的分组下点右键,选中“Add Files to “My Project”…”菜单,在弹出的文件浏览对话框中选中要添加到文件或文件夹。如果要添加文件已经拷贝到了项目文件目录中,则不需要选中“Copy items”的复选框;如果文件没有拷贝到项目文件目录,就需要选中“Copy items”的复选框,这样Xcode会自动把文件复制到项目文件目录下。

根据上面的说明,添加ASIHTTPRequest相关文件到Xcode项目中,所需文件列表如下:

ASIHTTPRequestConfig.h

ASIHTTPRequestDelegate.h

ASIProgressDelegate.h

ASICacheDelegate.h

ASIHTTPRequest.h

ASIHTTPRequest.m

ASIDataCompressor.h

ASIDataCompressor.m

ASIDataDecompressor.h

ASIDataDecompressor.m

ASIFormDataRequest.h

ASIInputStream.h

ASIInputStream.m

ASIFormDataRequest.m

ASINetworkQueue.h

ASINetworkQueue.m

ASIDownloadCache.h

ASIDownloadCache.m

ASIAuthenticationDialog.h

ASIAuthenticationDialog.m

Reachability.h (在源码的 External/Reachability 目录下)

Reachability.m (在源码的 External/Reachability 目录下)

2) 链接相关类库

1. 选中项目

2. 选中目标

3. 跳转到“Build Phases”标签

4. 展开“Link Binary With Libraries”分组

5. 点击“+”添加类库

6. 从列表中选择CFNetwork.framework,然后点击“Add”按钮。

7. 按照上一步相同的方法添加:SystemConfiguration.framework, MobileCoreServices.framework,CoreGraphics.framework和libz.1.2.3.dylib这几个类库。

8. 添加完后,可以将添加好的一起类库拖到Xcode项目的Frameworks目录下

ASIHTTPRequest类库简介和使用说明(二)
2.1.2使用说明

ASIHTTPRequest有很多功能,所有功能说明都可以在其官方网站的相关文档中查到,限于篇幅,本章仅简单介绍一下如何使用ASIHTTPRequest来进行同步Http请求和异步Http请求。在后面的章节中,我们还会用到它的一些其他功能。

在使用ASIHTTPRequest之前,请确认已经正确安装,然后在需要应用它的代码文件头部,加入:

#import “ASIHTTPRequest.h”

这样就可以在代码中使用ASIHTTPRequest相关的类。

创建一个同步请求

这是ASIHTTPRequest最简单的一种使用模式,发送startSynchronous消息后即开始在同一线程中执行HTTP请求,线程将一直等待直到请求结束(请求成功或者失败)。通过检查error属性可以判断请求是否成功或者有错误发生。

要获取返回的文本信息,调用responseString方法。如果下载的是二进制文件,例如图片、MP3,则调用responseData方法,可以得到一个NSData对象。

- (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];

}

}

一般情况下,应该优先使用异步请求代替同步请求,当在主线程中使用ASIHTTPRequest同步请求,应用程序的界面会锁定,无法进行任何操作,直到请求完成。

创建一个异步请求

上例中的同步请求,如果换成异步方式来调用,请求是在后台线程中运行,当请求执行完后再通知调用的线程。这样不会导致主线程进行网络请求时,界面被锁定等情况。

- (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

{

// 当以文本形式读取返回内容时用这个方法

NSString *responseString = [request responseString];

// 当以二进制形式读取返回内容时用这个方法

NSData *responseData = [request responseData];

}

- (void)requestFailed:(ASIHTTPRequest *)request

{

NSError *error = [request error];

}

 

ASIHTTPRequest类库简介和使用说明1和2转自:http://www.cnblogs.com/dotey/archive/2011/05/10/2041966.html

//以下转自 旺财勇士 http://www.cnblogs.com/chen1987lei/archive/2011/06/07/2074636.html
今天把这个的官方文档翻译的出来以做分享~
让迷途之人有路可寻~

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. - (void)requestFinished:(ASIHTTPRequest *)request
  9. {
  10.    // Use when fetching text data
  11.    NSString *responseString = [request responseString];

  12.    // Use when fetching binary data
  13.    NSData *responseData = [request responseData];
  14. }

  15. - (void)requestFailed:(ASIHTTPRequest *)request
  16. {
  17.    NSError *error = [request error];
  18. }



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


队列请求
提供了一个对异步请求更加精准丰富的控制。
如,可以设置在队列中,同步请求的连接数。往队列里添加的请求实例数大于maxConcurrentOperationCo unt时,请求实例将被置为等待,直到前面至少有一个请求完成并出列才被放到队列里执行。
也适用于当我们有多个请求需求按顺序执行的时候(可能是业务上的需要,也可能是软件上的调优),仅仅需要把maxConcurrentOperationCo unt设为“1”。
复制代码
  1. - (IBAction)grabURLInTheBackground:(id)sender
  2. {
  3.    if (![self queue]) {
  4.       [self setQueue:[[[NSOperationQueue alloc] init] autorelease]];
  5.    }

  6.    NSURL *url = [NSURL URLWithString:@"http://allseeing-i.com"];
  7.    ASIHTTPRequest *request = [ASIHTTPRequest requestWithURL:url];
  8.    [request setDelegate:self];
  9.    [request setDidFinishSelector:@selector(requestDone:)];
  10.    [request setDidFailSelector:@selector(requestWentWrong:)];
  11.    [[self queue] addOperation:request]; //queue is an NSOperationQueue
  12. }

  13. - (void)requestDone:(ASIHTTPRequest *)request
  14. {
  15.    NSString *response = [request responseString];
  16. }

  17. - (void)requestWentWrong:(ASIHTTPRequest *)request
  18. {
  19.    NSError *error = [request error];
  20. }



创建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,requestDidReceiveRespons eHeadersSelector,当接受完响应的Header后设计此方法,这个对 下载大数据的时候相当有用,你可以在方法里做更多业务上的处理。
c,requestDidFinishSelector ,请求并响应成功完成时调用此方法
d,requestDidFailSelector,请求失败
e,queueDidFinishSelector,整个队列里的所有请求都结束时调用此方法。
 
它是NSOperationQueues的扩展,小而强大。但也与它的父类略有区别。如,仅添加到队列中其实并不能执行请求,只有调用[   queue g o ]才会执行;一个正在运行中的队列,并不需要重复调用[   queue go   ]。

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




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


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


队列请求中需要注意的是,如果你取消了一个请求,队列会自动取消其它所有请求。
如果只想取消一个请求,可以设置队列:[ queue setShouldCancelAllReques tsOnFailure: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的setDownloadDestinationPa th,可以设置下载文件用的下载目标目录。
首先,下载过程文件会保存在temporaryFileDownloadPat h目录下。如果下载完成会做以下事情:
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. //This url will return the value of the 'ASIHTTPRequestTestCookie' cookie
  10. url = [NSURL URLWithString:@"http://allseeing-i.com/ASIHTTPRequest/tests/read_cookie"];
  11. request = [ASIHTTPRequest requestWithURL:url];
  12. [request setUseCookiePersistence:NO];
  13. [request setRequestCookies:[NSMutableArray arrayWithObject:cookie]];
  14. [request startSynchronous];

  15. //Should be: I have 'Test Value' as the value of 'ASIHTTPRequestTestCookie'
  16. NSLog(@"%@",[request responseString]);



大文件断点续传
0.94以后支持大文件的断点下载,只需要设置:
   [ request setAllowResumeForFileDow nloads:YES ];
   [ request setDownloadDestinationPa th:downloadPath ];
就可以了。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值