AFNetWorking：iOS/macOS JSON网络请求实战指南

恋爱大魔头

于 2024-08-28 13:39:05 发布

阅读量734

点赞数 6

本文链接：https://blog.csdn.net/weixin_32925455/article/details/141683739

版权

本文还有配套的精品资源，点击获取

简介：AFNetWorking是Objective-C编写的iOS和macOS平台上的网络请求库，由Alamofire Software Foundation维护。它提供了HTTP网络请求功能，并支持JSON格式数据处理。 AFJSONRequestOperation 是AFNetWorking中的关键组件，用于处理JSON请求和响应，具有自动序列化和反序列化能力。本文通过详细步骤介绍如何使用 AFJSONRequestOperation 发起和处理JSON网络请求，并探讨其代理方法和Block回调机制，以及附加特性如缓存和请求优先级等。

1. AFNetWorking库简介

随着移动互联网的快速发展，网络请求库的选择变得尤为重要。 AFNetWorking 是一个轻量级、支持多种HTTP请求方法、易于使用且功能强大的iOS网络通信框架。该库不仅简化了HTTP请求的编码过程，还提供了高级功能，比如JSON参数自动编码、文件上传下载、会话管理等。无论是新手开发者还是资深程序员， AFNetWorking 都以其灵活性和扩展性成为其网络请求的首选工具。本文将带你从基础到深入，探索 AFNetWorking 的强大之处及其在项目中的实际应用。

2. `AFJSONRequestOperation` 核心功能

2.1 HTTP方法支持（GET, POST, PUT, DELETE等）

AFJSONRequestOperation 是AFNetworking库中用于处理JSON数据的一个非常重要的操作类。它支持多种HTTP方法，包括但不限于GET、POST、PUT和DELETE，这些方法在进行Web服务交互时是基础且核心的功能。

2.1.1 GET请求的使用和场景

GET请求是用于从指定的资源请求数据。GET请求方法应只用于获取数据，而不应包含数据内容，即请求体应为空。使用场景包括获取资源列表、用户信息等。

// 示例代码：使用GET请求获取数据
AFHTTPRequestOperationManager *manager = [AFHTTPRequestOperationManager manager];
[manager GET:@"***" parameters:nil成功的:^(AFHTTPRequestOperation *operation, id responseObject) {
    NSLog(@"JSON: %@", responseObject);
}失败:^(AFHTTPRequestOperation *operation, NSError *error) {
    NSLog(@"Error: %@", error);
}];

在上述代码块中，我们使用 GET 方法向服务器发送请求。通过指定的URL获取JSON数据，并处理成功和失败的回调。这里使用的是 AFHTTPRequestOperationManager 类，它负责管理网络请求。

2.1.2 POST请求的使用和场景

POST请求通常用于提交数据到服务器上新资源的创建，或者对现有资源的更新。在数据提交和创建新资源时，POST请求是最常见的操作之一。

// 示例代码：使用POST请求提交数据
NSDictionary *parameters = @{@"key1": @"value1", @"key2": @"value2"};
[manager POST:@"***" parameters:parameters成功的:^(AFHTTPRequestOperation *operation, id responseObject) {
    NSLog(@"Success: %@", responseObject);
}失败:^(AFHTTPRequestOperation *operation, NSError *error) {
    NSLog(@"Error: %@", error);
}];

在该代码段中，我们构造了一个包含键值对参数的字典，并通过 POST 方法提交到服务器。成功和失败的回调用于处理响应结果。

2.1.3 PUT和DELETE请求的使用和场景

PUT请求通常用于更新资源，而DELETE请求用于删除服务器上的资源。在很多RESTful API设计中，PUT和DELETE方法被用来创建和删除资源，它们与GET和POST方法一起构成了HTTP协议的主要操作方法。

// 示例代码：使用PUT请求更新资源
[manager PUT:@"***" parameters:parameters成功的:^(AFHTTPRequestOperation *operation, id responseObject) {
    NSLog(@"Updated: %@", responseObject);
}失败:^(AFHTTPRequestOperation *operation, NSError *error) {
    NSLog(@"Error: %@", error);
}];

// 示例代码：使用DELETE请求删除资源
[manager DELETE:@"***"成功的:^(AFHTTPRequestOperation *operation, id responseObject) {
    NSLog(@"Deleted");
}失败:^(AFHTTPRequestOperation *operation, NSError *error) {
    NSLog(@"Error: %@", error);
}];

在上述代码中，我们分别演示了如何使用 PUT 和 DELETE 方法进行资源的更新和删除操作。回调函数用于处理服务器响应和可能出现的错误。

通过本章节的介绍，我们了解了 AFJSONRequestOperation 支持的HTTP方法，这些方法是构建网络请求的基础。通过使用GET、POST、PUT和DELETE请求，开发者可以在遵循REST原则的同时，完成各种数据交互的任务。在下一小节中，我们将详细探讨如何发送JSON格式的请求数据，以及如何接收和处理JSON格式的响应数据。

3. 请求和响应的序列化和反序列化

3.1 创建请求对象和设置请求头

3.1.1 构建请求对象的步骤和方法

构建一个请求对象是使用 AFNetWorking 发送网络请求的第一步。 AFHTTPSessionManager 提供了简便的方法来创建这些对象。通过这个类，我们可以快速搭建一个HTTP会话，并进行配置。以下是创建请求对象的典型步骤：

初始化 AFHTTPSessionManager 类。
使用该类提供的方法构建特定类型的请求对象（如GET、POST等）。
设置请求头信息，以便于服务端能正确解析和响应。

下面是一个创建 GET 请求的示例代码：

let manager = AFHTTPSessionManager(baseURL: URL(string: "***")!)
manager.request("get", parameters: nil).responseJSON { (response) in
    // 处理响应
}

以上代码展示了如何创建一个 AFHTTPSessionManager 实例，并通过 .request 方法发起一个 GET 请求。 responseJSON 是一个回调函数，用于处理响应的 JSON 数据。

3.1.2 自定义请求头及注意事项

请求头（Headers）的设置是自定义请求非常重要的一步。请求头通常用于指定内容类型（Content-Type）、授权信息（Authorization）、语言（Accept-Language）等。在 AFNetWorking 中设置请求头可以通过 .setRequestHeader 方法实现。

manager.requestSerializer.setValue("application/json", forHTTPHeaderField: "Content-Type")
manager.requestSerializer.setValue("Bearer \(token)", forHTTPHeaderField: "Authorization")

在设置自定义请求头时，需要注意以下几点：

请求头的字段和值应遵循 HTTP 协议标准。
对于敏感信息，确保传输过程的安全性，例如使用 HTTPS。
在请求头中添加自定义字段时，要确保服务器端能够正确解析这些字段。

3.2 请求体的设置和请求发起步骤

3.2.1 设置请求体的多种方式

请求体（Body）通常用于 POST 或 PUT 请求，用于传递数据到服务器。AFNetWorking 提供了多种方式来设置请求体。例如，可以直接传递一个字典作为参数：

manager.post("urlPath", parameters: ["key": "value"], progress: nil, success: { (response) in
    // 请求成功处理
}, failure: { (error) in
    // 请求失败处理
})

或者，你也可以使用 AFJSONRequestOperation 来创建一个 JSON 请求体：

let parameters = ["key": "value"]
let operation = AFJSONRequestOperation(jsonObject: parameters, success: { (request, response) in
    // JSON 响应处理
}, failure: { (request, response, error) in
    // 错误处理
})
manager.execute(operation)

3.2.2 发起网络请求的完整流程

发起一个网络请求可以分成以下几个步骤：

初始化请求管理器（ AFHTTPSessionManager ）。
设置请求头（如果需要）。
设置请求体（对于 POST、PUT 请求）。
发起请求并处理响应。
确保错误处理机制完整。

一个典型的 POST 请求流程代码示例如下：

let parameters: [String: Any] = ["key": "value"]
manager.request("post", parameters: parameters, progress: nil, success: { (operation, response) in
    // 处理响应数据
}, failure: { (operation, error) in
    // 处理错误
})

在实际应用中，可能还需要考虑网络状态监测、超时处理等安全和用户体验相关的因素。AFNetWorking 提供了丰富的回调函数和参数，开发者可以根据具体需求进行设置。

manager.requestSerializer.timeout = 10 // 设置超时时间
manager.requestSerializer.shouldCacheResponse = true // 是否缓存响应数据

本章节介绍了在 AFNetWorking 中创建请求对象、设置请求头和请求体，以及发起网络请求的基本流程。通过这些操作，可以实现与服务器端的基本交互。在第四章中，我们将深入讨论如何处理响应数据和错误，实现更加复杂的网络请求功能。

4. 响应处理的代理方法和Block回调

4.1 响应数据的接收和处理

4.1.1 设计回调函数处理不同状态码

在AFNetworking中，回调函数是处理响应的主要方式之一。使用代理方法能够让我们根据不同的HTTP状态码来执行相应的逻辑处理。代理方法通常以 didReceiveResponse: 、 didFailWithError: 等形式存在，根据不同的状态码执行不同的代码路径。

示例代码

// Objective-C 示例
- (void)connection:(NSURLConnection *)connection didReceiveResponse:(NSURLResponse *)response {
    // 对响应进行处理
    NSHTTPURLResponse* httpResponse = (NSHTTPURLResponse *)response;
    NSInteger statusCode = [httpResponse statusCode];
    if (statusCode == 200) {
        // 处理成功的响应
    } else {
        // 处理非成功状态码的响应
        [self.connection cancel]; // 根据需要取消或继续请求
    }
}

- (void)connection:(NSURLConnection *)connection didFailWithError:(NSError *)error {
    // 处理错误情况
    NSLog(@"Error: %@", error);
}

代码逻辑分析

在上述代码块中， didReceiveResponse: 方法会在接收到服务器响应后调用，允许开发者检查响应的状态码并作出相应的逻辑决策。例如，当状态码是200时，可以认为请求成功，执行成功的处理逻辑；当状态码不是200时，根据业务需求，可能会取消当前请求或执行其他错误处理逻辑。

didFailWithError: 方法则用于处理网络请求过程中出现的错误。当网络请求失败时，此方法会被调用，并提供一个包含错误信息的 NSError 对象。开发者可以使用这个错误对象的描述信息来进行错误提示或是记录日志。

通过使用这些代理方法，可以将逻辑处理与网络请求紧密集成，使得响应处理更加灵活和强大。

4.1.2 利用Block回调实现异步处理

除了传统的代理方法，AFNetworking还支持使用Block回调来进行异步处理，这种方式可以让代码更加简洁，避免了实现多个代理方法的繁琐。

示例代码

// Objective-C 示例
AFHTTPRequestOperation *operation = [[AFHTTPRequestOperation alloc] initWithRequest:request];

[operation setCompletionBlockWithSuccess:^(AFHTTPRequestOperation *operation, id responseObject) {
    // 处理成功的响应数据
    NSLog(@"Response: %@", responseObject);
} failure:^(AFHTTPRequestOperation *operation, NSError *error) {
    // 处理错误情况
    NSLog(@"Error: %@", error);
}];

[operation start];

代码逻辑分析

在使用Block回调时， setCompletionBlockWithSuccess:failure: 方法允许你提供两个Block，一个用于处理成功的响应，另一个用于处理失败的情况。这里的成功和失败是相对于网络请求本身而言的，即请求发送成功但返回了错误状态码，仍会被认为是失败。

使用Block回调的优势在于能够让代码更加简洁明了，无需关心代理方法的调用顺序或实现多个代理方法，这对于回调逻辑较为简单的场景非常有用。

通过代理方法和Block回调，开发者可以灵活地处理网络请求的响应，无论是处理状态码还是错误逻辑，都能做到游刃有余。

4.2 错误处理和异常管理

4.2.1 常见网络错误的识别和处理

网络请求过程中可能会遇到各种各样的错误，例如网络不可达、服务器无响应、数据解析错误等。AFNetworking提供了一系列机制来帮助开发者识别和处理这些错误。

示例代码

// Objective-C 示例
[managerGET setCompletionBlockWithSuccess:^(AFHTTPRequestOperation *operation, id responseObject) {
    // 处理成功的响应数据
} failure:^(AFHTTPRequestOperation *operation, NSError *error) {
    // 判断错误类型进行相应处理
    if ([error.domain isEqualToString:AFNetworkingErrorDomain] && error.code == AFErrorStatusCodeCancelled) {
        NSLog(@"请求被取消");
    } else {
        NSLog(@"发生未知错误: %@", error);
    }
}];

代码逻辑分析

在上述代码块中，通过检查 NSError 对象的 domain 和 code 可以确定错误的类型。在AFNetworking中，通过 AFErrorStatusCodeCancelled 可以识别请求是否被用户主动取消。其他错误类型则需要根据具体的错误代码来进行处理。

4.2.2 异常捕获和用户友好的错误提示

在处理网络请求错误时，除了要捕获和分类错误，更重要的是向用户提供友好的错误提示，以增强用户体验。

示例代码

// Objective-C 示例
[managerGET setCompletionBlockWithSuccess:^(AFHTTPRequestOperation *operation, id responseObject) {
    // 处理成功的响应数据
} failure:^(AFHTTPRequestOperation *operation, NSError *error) {
    // 向用户展示友好错误提示
    UIAlertView *alertView = [[UIAlertView alloc] initWithTitle:@"Error" message:[error localizedDescription] delegate:nil cancelButtonTitle:@"OK" otherButtonTitles:nil];
    [alertView show];
}];

代码逻辑分析

使用 UIAlertView 可以创建一个简单的错误提示对话框，显示错误信息。 [error localizedDescription] 是一个 NSError 对象方法，它会返回一个适合向用户显示的本地化错误描述信息。通过这种方式，可以让用户了解发生了什么错误，并采取相应的措施。

错误处理和异常管理是网络请求中不可或缺的一部分，通过合理地使用AFNetworking提供的错误处理机制，可以确保应用在面对网络问题时能够更加稳健地运行。

5. AFNetWorking的高级功能

AFNetWorking库不仅仅是一个简单的HTTP客户端库，它还提供了一些高级功能，以帮助开发者更好地管理网络请求。本章节将重点介绍AFNetWorking的缓存机制、请求优先级管理、取消请求以及进度回调等高级特性。

5.1 缓存机制的应用与实践

缓存是提高应用性能的关键部分，它允许开发者存储数据以减少服务器请求，并减少用户在使用应用时的等待时间。AFNetWorking提供了灵活的缓存策略来满足不同的需求。

5.1.1 缓存策略的选择和配置

AFNetWorking支持多种缓存策略，开发者可以根据具体需求选择合适的策略：

AFNetworkingReachabilityManager : 监听网络状态变化，根据网络可用性动态调整缓存行为。
AFHTTPSessionManager 的 cachePolicy : 可以设置为不同的缓存策略，如 AFNETWORKINGURLCacheUseMemoryOnly 、 AFNETWORKINGURLCacheDiskOnly 或者 AFNETWORKINGURLCacheCombinedCachePolicy 等。

一个典型配置缓存的示例代码如下：

let cache = URLCache(memoryCapacity: 100 * 1024 * 1024, diskCapacity: 200 * 1024 * 1024, diskPath: nil)
URLCache.shared = cache
AFHTTPSessionManager.setSharedManager(AFMutableSharedManager().apply {
    $0.cachePolicy = .returnCacheDataElseLoad // Use .reloadIgnoringLocalCacheData to always hit the server
})

此代码配置了100MB的内存缓存和200MB的磁盘缓存，并设置了一个默认的缓存策略，以决定何时返回缓存数据，何时加载网络数据。

5.1.2 缓存与数据一致性处理

缓存机制需要考虑数据的一致性问题，特别是当服务器数据更新时，如何确保客户端的缓存也是最新的。AFNetWorking允许开发者通过 setCacheResponseBlock 来自定义缓存逻辑：

AFHTTPSessionManager.default().manager.setCacheResponseBlock { (request, response) in
    // Custom logic to determine if the cached response is valid
    let isValid = isCachedDataValid(response)
    return isValid ? response : nil
}

5.2 请求优先级、取消请求与进度回调

处理大量或复杂的网络请求时，请求优先级和取消机制可以帮助提高效率和用户体验。

5.2.1 管理请求优先级的策略和实现

在AFNetWorking中，开发者可以为不同的请求设置优先级，这会影响请求队列中的处理顺序。这可以通过自定义 AFHTTPSessionManager 来实现，为每个请求分配优先级。

class CustomAFHTTPSessionManager: AFHTTPSessionManager {
    override func enqueueTask(withUploadResponsibility uploadResponsibility: uploadingResponsibility, using request: URLRequest) -> URLSessionTask? {
        var priority = URLSession.TaskPriority.default
        // Set priority based on your custom criteria
        // For example: priority = .low

        return super enqueueTask(withUploadResponsibility: uploadResponsibility, usingRequest: request, withPriority: priority)
    }
}

5.2.2 如何取消正在进行的网络请求

取消请求是常见的需求，特别是在网络条件差或用户不需要特定请求结果时。可以通过任务的 cancel 方法来取消正在进行的请求。

let task = manager.dataTask(with: request) { ... }
task.resume()
task.cancel() // Cancel the task if needed

5.2.3 进度回调的设计和优化

在下载大型文件或流媒体时，进度回调非常有用。AFNetWorking提供了进度回调，可以用来更新UI或为用户提供反馈。

manager.downloadTask(with: request) { (location, response, error) in
    // ...
}.progress { progress in
    print("Download Progress: \(progress.fractionCompleted)")
}.resume()

表格示例

为了更好地展示请求管理器的配置，可以创建一个表格来展示不同的配置参数和对应的解释。

| 参数 | 描述 | 示例配置 | |----------------------|------------------------------------------------------------|----------------------| | memoryCapacity | 内存缓存的最大容量（字节） | 100 * 1024 * 1024 | | diskCapacity | 磁盘缓存的最大容量（字节） | 200 * 1024 * 1024 | | cachePolicy | 缓存策略 | .returnCacheDataElseLoad | | isCachedDataValid | 判断缓存数据是否有效的方法 | (response) -> Bool | | priority | 请求优先级 | URLSession.TaskPriority.low |

通过表格，开发者可以轻松地选择和配置适合自身项目的参数，同时也有助于理解每个参数的作用。AFNetWorking的高级功能十分强大，通过合理利用这些功能，可以让应用更加健壮、响应更快，用户体验更佳。

6. AFNetWorking实践应用案例分析

在IT开发中，实践案例分析是理解和掌握技术的最好方式。本章节将结合实际项目经验，对AFNetWorking库的集成和使用进行深入分析，同时探讨在项目中如何应用AFNetWorking的高级功能来优化网络请求。

6.1 实际项目中AFNetWorking的集成和使用

在将AFNetWorking集成到新项目或现有项目中时，需要注意的事项和步骤有很多。这一部分将详细介绍集成过程，并针对项目架构设计给出建议。

6.1.1 第三方库的集成方法和注意事项

集成AFNetWorking通常使用CocoaPods或Carthage这样的包管理器，以简化依赖管理和版本控制。

# 在Podfile中添加
pod 'AFNetworking'

集成后，需要注意：

检查版本兼容性，确保AFNetWorking与iOS的版本兼容。
在 AppDelegate 中配置全局网络请求参数，如设置超时时间、使用HTTPS等。
在适当的位置进行网络请求，避免在主线程中执行网络操作，以免造成应用卡顿。

6.1.2 项目中的网络请求策略和架构

合理的网络请求策略和架构对于项目的稳定性和可维护性至关重要。

设计一个统一的网络请求模块，使用单例模式管理网络请求的配置和缓存。
封装网络请求方法，提供简洁的接口给业务模块使用。
按照MVC或MVVM架构，确保网络模块只负责数据的获取与传输，业务逻辑和视图渲染由其他模块处理。

6.2 高级功能在项目中的应用与优化

AFNetWorking的高级功能能够有效提升应用性能和用户体验。这一部分将探讨如何在实际项目中应用和优化这些功能。

6.2.1 缓存和请求优先级在实战中的调优

在实际应用中合理使用缓存和管理请求优先级，能够显著提高应用的响应速度和用户体验。

使用AFNetWorking的 NSURLRequestCachePolicy 来控制缓存策略，例如在请求中设置 .ReturnCacheDataElseLoad 来优先返回缓存数据。
通过 AFHTTPSessionManager 设置请求优先级，使用 setRequestOperationQueue: 方法来管理请求队列。

manager.requestQueue operationQueue 设置优先级操作

在遇到数据一致性问题时，考虑使用 AFSecurityPolicy 来处理HTTPS的服务器验证和客户端证书验证。

6.2.2 进度反馈与用户体验的提升

进度反馈是提升用户体验的重要方面，AFNetWorking提供了进度回调机制，能够在数据上传或下载时实时反馈进度。

使用 AFNETWORKING进度回调 方法，如 setProgressiveDownloadBlock ，来提供下载进度给用户。
结合iOS的 UIProgressView 或自定义进度条，将进度信息展示给用户，提升交互体验。
对于上传进度，使用 setUploadProgressBlock 方法来获取上传进度，并实时更新。

通过上述内容的介绍和分析，我们可以看到AFNetWorking在项目中实际应用的强大能力和灵活性。合理的集成与优化能够极大地提升开发效率和应用性能。

本文还有配套的精品资源，点击获取

恋爱大魔头

关注

6
点赞
踩
17

收藏

觉得还不错? 一键收藏
0
评论
AFNetWorking：iOS/macOS JSON网络请求实战指南

本文还有配套的精品资源，点击获取简介：AFNetWorking是Objective-C编写的iOS和macOS平台上的网络请求库，由Alamofire Software Foundation维护。它提供了HTTP网络请求功能，并支持JSON格式数据处理。 AFJSONRequestOperation 是AFNetWorking中的关键组件，用于处理JSON请...
复制链接

扫一扫