本文将介绍2011-06-1516:04ASIHTTPRequest-详解的详细情况，特别是关于http的api的相关信息。我们将通过案例分析、数据研究等多种方式，帮助您更全面地了解这个主题，同时也将

本文将介绍2011-06-15 16:04 ASIHTTPRequest-详解的详细情况，特别是关于http的api的相关信息。我们将通过案例分析、数据研究等多种方式，帮助您更全面地了解这个主题，同时也将涉及一些关于1. ASIHttpRequest-创建和执行request、2. ASIHttpRequest-发送数据、20170615-Ajax和XMLHttpRequest、3. ASIHTTPRequest-下载数据的知识。

本文目录一览：

• 2011-06-15 16:04 ASIHTTPRequest-详解（http的api）
• 1. ASIHttpRequest-创建和执行request
• 2. ASIHttpRequest-发送数据
• 20170615-Ajax和XMLHttpRequest
• 3. ASIHTTPRequest-下载数据

2011-06-15 16:04 ASIHTTPRequest-详解（http的api）

1. ASIHttpRequest-创建和执行request

同步请求

同步请求会在当前线程中执行，使用error属性来检查结束状态（要下载大文件，则需要设定downloadDestinationPath来保存文件到本地）：

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

同步请求会阻塞主线程的执行，这导致用户界面不响应用户操作，任何动画都会停止渲染。

 

异步请求

下面是最简单的异步请求方法，这个request会在全局的NSOperationQueue中执行，若要进行更复杂的操作，我们需要自己创建NSOperationQueue或者ASINetworkQueue，后面会讲到。

- (IBAction)grabURLInBackground:(id)sender
{
   NSURL *url = [NSURL URLWithString:@"http://www.dreamingwish.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];
}

 

使用block

在平台支持情况下，ASIHTTPRequest1.8以上支持block。

- (IBAction)grabURLInBackground:(id)sender
{
   NSURL *url = [NSURL URLWithString:@"http://allseeing-i.com"];
   __block ASIHTTPRequest *request = [ASIHTTPRequest requestWithURL:url];
   [request setCompletionBlock:^{
      // Use when fetching text data
      NSString *responseString = [request responseString];

      // Use when fetching binary data
      NSData *responseData = [request responseData];
   }];
   [request setFailedBlock:^{
      NSError *error = [request error];
   }];
   [request startAsynchronous];
}

注意，声明request时要使用__block修饰符，这是为了告诉block不要retain request，以免出现retain循环，因为request是会retain block的。

 

使用队列

创建NSOperationQueue或者ASINetworkQueue队列，我们还可以设定最大并发连接数：maxConcurrentOperationCount 

- (IBAction)grabURLInTheBackground:(id)sender
{
   if (![self queue]) {
      [self setQueue:[[[NSOperationQueue alloc] init] autorelease]];
      [self queue].maxConcurrentOperationCount = 4;
   }

   NSURL *url = [NSURL URLWithString:@"http://www.dreamingwish.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];
}

如果不设定selector，那么系统会使用默认的requestFinished: 和 requestFailed:方法

如果需要对队列里面的每个request进行区分，那么可以设定request的userInfo属性，它是个NSDictionary，或者更简单的方法是设定每个request的tag属性，这两个属性都不会被发送到服务器。

不要使用request的URL来区分每个request，因为URL可能会改变（例如重定向），如果需要使用request的URL，使用[request originalURL]，这个将永远返回第一个url。

对于ASINetworkQueue

ASINetworkQueue是NSOperationQueue的子类，提供更高级的特性（ASINetworkQueue的代理函数）：

• requestDidStartSelector
  当一个request开始执行时，这个代理函数会被调用。
• requestDidReceiveResponseHeadersSelector
  当队列中的request收到服务器返回的头信息时，这个代理函数会被调用。对于下载很大的文件，这个通常比整个request的完成要早。
• requestDidFinishSelector
  当每个request完成时，这个代理函数会被调用。
• requestDidFailSelector
  当每个request失败时，这个代理函数会被调用。
• queueDidFinishSelector
  当队列完成（无论request失败还是成功）时，这个代理函数会被调用。

ASINetworkQueues与NSOperationQueues稍有不同，加入队列的request不会立即开始执行。如果队列打开了进度开关，那么队列开始时，会先对所有GET型request进行一次HEAD请求，获得总下载大小，然后真正的request才被执行。

向一个已经开始进行的ASINetworkQueue 加入request会怎样？

如果你使用ASINetworkQueue来跟踪若干request的进度，只有当新的request开始执行时，总进度才会进行自适应调整（向后移动）。ASINetworkQueue不会为队列开始后才加入的request进行HEAD请求，所以如果你一次向一个正在执行的队列加入很多request，那么总进度不会立即被更新。

如果队列已经开始了，不需要再次调用[queue go]。

当ASINetworkQueue中的一个request失败时，默认情况下，ASINetworkQueue会取消所有其他的request。要禁用这个特性，设置 [queue setShouldCancelAllRequestsOnFailure:NO]。

ASINetworkQueues只可以执行ASIHTTPRequest操作，二不可以用于通用操作。试图加入一个不是ASIHTTPRequest的NSOperation将会导致抛出错误。

 

取消异步请求

取消一个异步请求（无论request是由[request startAsynchronous]开始的还是从你创建的队列中开始的），使用[request cancel]即可。注意同步请求不可以被取消。

注意，如果你取消了一个request，那么这个request将会被视为请求失败，并且request的代理或者队列的代理的失败代理函数将被调用。如果你不想让代理函数被调用，那么将delegate设置为nil，或者使用clearDelegatesAndCancel方法来取消request。

clearDelegatesAndCancel 将会首先清除所有的代理和block。

当使用ASINetworkQueue时，如果取消了队列中的一个request，那么队列中其他所有request都会被取消，可以设置shouldCancelAllRequestsOnFailure的值为NO来避免这个现象。

 

安全地控制delegate防止request完成之前代理被释放

request并不retain它们的代理，所以有可能你已经释放了代理，而之后request完成了，这将会引起崩溃。大多数情况下，如果你的代理即将被释放，你一定也希望取消所有request，因为你已经不再关心它们的返回情况了。如此做：

// 代理类的dealloc函数
- (void)dealloc
{
   [request clearDelegatesAndCancel];
   [request release];
   ...
   [super dealloc];
}

2. ASIHttpRequest-发送数据

发送数据

设定request头

ASIHTTPRequest *request = [ASIHTTPRequest requestWithURL:url];
[request addRequestHeader:@"Referer" value:@"http://www.dreamingwish.com/"];

使用ASIFormDataRequest POST表单

通常数据是以’application/x-www-form-urlencoded’格式发送的，如果上传了二进制数据或者文件，那么格式将自动变为‘multipart/form-data’ 

文件中的数据是需要时才从磁盘加载，所以只要web server能处理，那么上传大文件是没有问题的。

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

数据的mime头是自动判定的，但是如果你想自定义mime头，那么这样：

ASIFormDataRequest *request = [ASIFormDataRequest requestWithURL:url];

// Upload a file on disk
[request setFile:@"/Users/ben/Desktop/ben.jpg" withFileName:@"myphoto.jpg" andContentType:@"image/jpeg"
forKey:@"photo"];

// Upload an NSData instance
[request setData:imageData withFileName:@"myphoto.jpg" andContentType:@"image/jpeg" forKey:@"photo"];

你可以使用addPostValue方法来发送相同name的多个数据（梦维：服务端会以数组方式呈现）：

ASIFormDataRequest *request = [ASIFormDataRequest requestWithURL:url];
[request addPostValue:@"Ben" forKey:@"names"];
[request addPostValue:@"George" forKey:@"names"];
[request addFile:@"/Users/ben/Desktop/ben.jpg" forKey:@"photos"];
[request addData:imageData withFileName:@"george.jpg" andContentType:@"image/jpeg" forKey:@"photos"];

PUT请求、自定义POST请求

如果你想发送PUT请求，或者你想自定义POST请求，使用appendPostData: 或者 appendPostDataFromFile:

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

20170615-Ajax和XMLHttpRequest

Ajax和XMLHttpRequest

这篇文章转发自我之前的一篇博客,是看过《你真的会使用XMLHttpRequest吗？》后结合自己之前对Ajax认识的总结。

Ajax："Asynchronous JavaScript And XML"即异步JavaScript和XML，是一种创建交互式网页应用的网页开发技术，这项技术的核心是浏览器提供的XMLHttpRequest对象。

XMLHttpRequest的使用

1.设置request header

void setRequestHeader(headerName, headerValue)

• setRequestHeader必须写在open()方法之后，send()方法之前

2. 获取response header

getAllResponseHeaders()

• 获取全部可获取（有一些header是获取不到的）的header字段

getResponseHeader(headerName)

• 获取指定header字段的值(只能获取部分header的值)

3. 指定xhr.response的数据类型

• 通过设置xhr.response的类型，是告诉浏览器或者xhr如何处理响应数据(对响应数据按照什么样的格式去处理)

xhr.overrideMimeType()

• 这个方法的作用就是重写response的MIME类型

• 这个方法必须在send()方法之前进行调用

• 可以通过这种方式，可以得到纯文本格式的图片内容，获取到数据后再使用相应的编码方法重新构建图片

---

var xhr = new XMLHtppRequest()
xhr.open(''get'', ''text.php'', true)
xhr.overrideMimeType("text/xml; charset=utf-8")
xhr.send();

根据上面的例子，将response的MIME类型设置为了''text/xml'',通过这样的方式，xhr会将响应当做text或者xml来处理，通过xhr.response和xhr.responseText可以获取到文本格式的相应数据，通过xhr.responseXML可以获取到XML格式(是一颗DOM树/DOM对象)的数据

---

var xhr = new XMLHtppRequest()
xhr.open(''get'', ''text.php'', true)
xhr.overrideMimeType("text/plain; charset=utf-8")
xhr.send();

根据上面的例子，将response的MIME类型设置为了''text/plain'',通过这样的方式，xhr会将相应当做text或者plain(纯文本)来处理，通过xhr.response和xhr.responseText可以获取到文本格式的相应数据，通过xhr.responseXML获取到的数据为null，即便数据是XML

---

xhr.responseType

responseType是XMLHttpRequest leve2中新增的属性，用来指定xhr.response的数据类型

var xhr = new XMLHttpRequest();
xhr.open(''GET'', ''/path/to/image.png'', true);
//可以将`xhr.responseType`设置为`"blob"`也可以设置为`" arrayBuffer"`
//xhr.responseType = ''arrayBuffer'';
xhr.responseType = ''blob'';

xhr.onload = function(e) {
  if (this.status == 200) {
    // this.response就是Blob对象
    var blob = this.response;
    ...
  }
};

xhr.send();

4. 如何获取response数据

xhr提供了3个属性来获取请求返回的数据，分别是：xhr.response, xhr.responseText, xhr.responseXML

• xhr.response:

  • 无论xhr.responseType的值是什么，只要请求完成，都可以从xhr.response中取到对应的值

  • 请求未完成时，xhr.response的值与xhr.responseType有关，xhr.responseType的值为""(默认值)或者text时，xhr.response的值为"",否则为null

• xhr.responseText:

  • 只有当responseType设置为''''或者text时，才可以使用这个属性获取相应内容

  • 请求未完成、失败时，该值为空字符串

• xhr.responseXML:

  • 只有当 responseType 为''''、document时，此时才能调用xhr.responseXML，否则抛错

  • 请求未完成、失败时，该值为null

5. 如何追踪ajax请求的当前状态

• 用xhr.readyState属性可以获取ajax的状态，每当xhr.readyState的值发生变化时，就会触发xhr.onreadystatechange事件，可以在这个事件中进行相应的操作

• 为了保证跨浏览器兼容性，必须在调用open()方法之前指定onreadystatechange事件处理程序

 xhr.onreadystatechange = function () {
    switch(xhr.readyState){
      case 1://OPENED
        //do something
            break;
      case 2://HEADERS_RECEIVED
        //do something
        break;
      case 3://LOADING
        //do something
        break;
      case 4://DONE
        //do something
         break;
    }

6. 设置请求的超时时间

• XMLHttpRequest提供了timeout属性来允许设置请求的超时时间。

• 从请求开始 算起，若超过 timeout 时间请求还没有结束（包括成功/失败），则会触发ontimeout事件，主动结束该请求。

• 请求开始：xhr.onloadstart事件触发的时候，也就是你调用xhr.send()方法的时候

• 请求结束：xhr.loadend事件触发的时候。

7. 发送同步请求

• 由open()方法的第三个参数决定，当第三个参数async为true时，发送异步请求，为false时则为同步请求

• 当xhr为同步请求时，有如下限制：

  • xhr.timeout必须为0

  • xhr.withCredentials必须为 false

  • xhr.responseType必须为""(即默认值)

• 避免使用同步请求：因为我们无法设置请求超时时间（xhr.timeout为0，即不限时）。在不限制超时的情况下，有可能同步请求一直处于pending状态，服务端迟迟不返回响应，这样整个页面就会一直阻塞，无法响应用户的其他交互。

8. 如何获取上传、下载进度

我们可以通过onprogress事件来实时显示进度，默认情况下这个事件每50ms触发一次。需要注意的是，上传过程和下载过程触发的是不同对象的onprogress事件：

• 上传触发的是xhr.upload对象的 onprogress事件

• 下载触发的是xhr对象的onprogress事件

xhr.onprogress = updateProgress;
xhr.upload.onprogress = updateProgress;
function updateProgress(event) {
    if (event.lengthComputable) {
      var completedPercent = event.loaded / event.total;
    }
 }

xhr相关事件

每一XMLHttpRequest对象都有一个upload属性，而upload是一个XMLHttpRequestUpload对象.XMLHttpRequest和XMLHttpRequestUpload对象共同拥有上述(除onreadystatechange事件)事件。onreadystatechange是XMLHttpRequest对象独有的事件

1. 事件触发顺序

1. 触发xhr.onreadystatechange(之后每次readyState变化时，都会触发一次)

2. 触发xhr.onloadstart

上传阶段开始：

1. 触发xhr.upload.onloadstart

2. 触发xhr.upload.onprogress

3. 触发xhr.upload.onload

4. 触发xhr.upload.onloadend

上传结束，下载阶段开始：

1. 触发xhr.onprogress

2. 触发xhr.onload

3. 触发xhr.onloadend

2. 发生abort/timeout/error异常的处理

1. 一旦发生abort或timeout或error异常，先立即中止当前请求

2. 将 readystate 置为4，并触发 xhr.onreadystatechange事件

3. 如果上传阶段还没有结束，则依次触发以下事件：

   • xhr.upload.onprogress

   • xhr.upload.[onabort或ontimeout或onerror]

   • xhr.upload.onloadend

   • 注意不会触发onload事件

4. 触发 xhr.onprogress事件

5. 触发 xhr.[onabort或ontimeout或onerror]事件

6. 触发xhr.onloadend 事件

7. 注意不会触发onload事件

• 注意： 这时候的xhr.readyState为4，xhr.status为0

3. 在哪个事件中注册成功回调

从上面介绍的事件中，可以知道若xhr请求成功，就会触发xhr.onreadystatechange和xhr.onload两个事件。由于xhr.onreadystatechange是每次xhr.readyState变化时都会触发，而不是xhr.readyState=4时才触发（例如发生abort、timeout、error异常，会先终止当前请求，将readyState设置为4，并触发onreadystatechange事件），因此建议在onload事件中注册成功回调

xhr.onload = function () {
    //如果请求成功
    if((xhr.status >= 200 && xhr.status < 300) || xhr.status == 304){
      //do successCallback
    }
  }

为什么要对xhr.status进行上述判断

xhr.status代表相应的HTTP状态
以2开头的状态码，代表请求已经成功被服务器接收、理解、并接受
状态代码304代表请求的资源并没有修改，可以直接使用浏览器中缓存的版本
其他以3开头的状态代码则表示需要客户端采取进一步的操作才能完成请求。

status和readyState

• status是响应的HTTP状态，statusText是HTTP状态的说明

• readyState是表示在请求/响应过程中的当前活动处于哪个阶段

---

参考文章

你真的会使用XMLHttpRequest吗？

3. ASIHTTPRequest-下载数据

将服务器响应数据直接下载到文件

如果你请求的资源很大，你可以直接将数据下载到文件中来节省内存。此时，ASIHTTPRequest将不会一次将返回数据全部保持在内存中。

ASIHTTPRequest *request = [ASIHTTPRequest requestWithURL:url];
[request setDownloadDestinationPath:@"/Users/ben/Desktop/my_file.txt"];

当我们把数据下载到downloadDestinationPath时，数据将首先被存在临时文件中。此时文件的路径名存储在temporaryFileDownloadPath中(梦维：如果不设置这个值，会自动生成一个文件名，在模拟器中，文件被创建在$TMPDIR中)。当request完成时，会发生下面两件事之一：

• 如果数据是被压缩过（gzip）的，那么这个压缩过的文件将被解压到downloadDestinationPath，临时文件会被删除。
• 如果数据未被压缩，那么这个文件将被移动到downloadDestinationPath，冲突解决方式是：覆盖已存在的文件。

注意，如果服务器响应数据为空，那么文件是不会被创建的。如果你的返回数据可能为空，那么你应该先检查下载文件是否存在，再对文件进行操作。

 

处理收到的服务器响应数据

如果你想处理服务器响应的数据（例如，你想使用流解析器对正在下载的数据流进行处理），你应该实现代理函数 request:didReceiveData:。注意如果你这么做了，ASIHTTPRequest将不会填充responseData到内存，也不会将数据写入文件（downloadDestinationPath ）——你必须自己搞定这两件事（之一）。 

 

获取HTTP状态码

ASIHTTPRequest并不对HTTP状态码做任何处理（除了重定向和授权状态码，下面会介绍到），所以你必须自己检查状态值并正确处理。

ASIHTTPRequest *request = [ASIHTTPRequest requestWithURL:url];
[request startSynchronous];
int statusCode = [request responseStatusCode];
NSString *statusMessage = [request responseStatusMessage];

 

读取响应头

ASIHTTPRequest *request = [ASIHTTPRequest requestWithURL:url];
[request startSynchronous];
NSString *poweredBy = [[request responseHeaders] objectForKey:@"X-Powered-By"];
NSString *contentType = [[request responseHeaders] objectForKey:@"Content-Type"];

 

处理文本编码

ASIHTTPRequest会试图读取返回数据的编码信息（Content-Type头信息）。如果它发现了编码信息，它会将编码信息设定为合适的 NSStringEncoding.如果它没有找到编码信息，它会将编码设定为默认编码（NSISOLatin1StringEncoding）。

当你调用[request responseString]，ASIHTTPRequest会尝试以responseEncoding将返回的Data转换为NSString。

 

处理重定向

当遇到以下HTTP状态码之一时，ASIHTTPRequest会自动重定向到新的URL：

• 301 Moved Permanently
• 302 Found
• 303 See Other

当发生重定向时，响应数据的值（responseHeaders，responseCookies，responseData，responseString等等）将会映射为最终地址的相应返回数据。

当URL发生循环重定向时，设置在这个URL上的cookie将被储存到全局域中，并在适当的时候随重定向的请求发送到服务器。

Cookies set on any of the urls encountered during a redirection cycle will be stored in the global cookie store, and will be represented to the server on the redirected request when appropriate.

你可以关闭自动重定向：将shouldRedirect设置为NO。

默认情况下，自动重定向会使用GET请求（请求体为空）。这种行为符合大多数浏览器的行为，但是HTTP spec规定301和302重定向必须使用原有方法。

要对301、302重定向使用原方法（包含请求体），在发起请求之前，设置shouldUseRFC2616RedirectBehaviour 为YES。

今天关于2011-06-15 16:04 ASIHTTPRequest-详解和http的api的介绍到此结束，谢谢您的阅读，有关1. ASIHttpRequest-创建和执行request、2. ASIHttpRequest-发送数据、20170615-Ajax和XMLHttpRequest、3. ASIHTTPRequest-下载数据等更多相关知识的信息可以在本站进行查询。

本文标签：

• ASIHTTPRequest详解
• HTTPAPI教程
• 网络编程
• Objective-CHTTP库