iOS 文件下载：使用 NSURLSession 实现高效下载（一）

Wu.Nim

已于 2024-10-10 11:15:17 修改

阅读量582

点赞数 22

文章标签： ios cocoa macos xcode

于 2024-10-10 10:59:38 首次发布

本文链接：https://blog.csdn.net/qq_43673244/article/details/142814958

版权

iOS 文件下载：使用 NSURLSession 实现高效下载（一）

1.项目介绍

在 iOS 开发过程中，文件下载功能广泛应用于各种场景：从下载用户上传的文档、媒体文件，到提供应用更新包等。这些操作在现代应用中变得越来越常见，因此掌握如何通过高效、稳定的方法进行文件下载显得尤为重要。

本篇博客将介绍如何使用 NSURLSession 实现文件下载，并详细分析下载文件的步骤与细节，帮助开发者快速掌握这一常见功能。

2. 使用 NSURLSession 进行文件下载

2.1 NSURLSession 简介

NSURLSession 是 iOS 中进行网络请求的强大工具。与其前身 NSURLConnection 相比，NSURLSession 更加灵活，允许创建自定义会话配置，并且提供了对后台任务、数据任务和文件下载任务的全面支持。由于 NSURLSession 提供的异步特性，它非常适合处理需要大量网络资源的任务，比如文件下载。

2.2 实现代码分析

接下来，我们逐步拆解实现文件下载的代码，帮助你理解每个步骤的作用。

2.2.1 创建 NSURLSession 实例

首先，我们需要创建一个 NSURLSession 实例。这是用来发起网络请求的关键工具。NSURLSessionConfiguration 允许我们自定义会话的行为，比如选择默认配置或后台下载配置。

NSURLSessionConfiguration *configuration = [NSURLSessionConfiguration defaultSessionConfiguration];
NSURLSession *session = [NSURLSession sessionWithConfiguration:configuration];

NSURLSessionConfiguration：这是会话的配置对象。在这里，我们选择了默认配置，但如果你需要支持后台下载，可以使用 backgroundSessionConfigurationWithIdentifier。
NSURLSession：NSURLSession 用于创建并管理网络任务，包括数据任务、上传任务和下载任务。在这里，我们将用于创建下载任务。

2.2.2 创建下载任务

我们使用 NSURLSessionDownloadTask 创建一个下载任务，并传入文件的 URL 和一个回调函数。这个回调函数在文件下载完成后执行。

NSURLSessionDownloadTask *downloadTask = [session downloadTaskWithURL:url completionHandler:^(NSURL * _Nullable location, NSURLResponse * _Nullable response, NSError * _Nullable error) {
    if (error) {
        NSLog(@"Download failed with error: %@", error.localizedDescription);
        return;
    }
    NSLog(@"File downloaded successfully");
}];

2.2.3 处理文件移动

文件下载完成后，文件最初会保存在一个临时目录。我们需要将其移动到用户指定的路径以便后续访问。使用 NSFileManager 进行文件操作：

	NSLog(@"File downloaded successfully");
	// 文件下载成功
    NSFileManager *fileManager = [NSFileManager defaultManager];
    NSError *fileError;

    if ([fileManager fileExistsAtPath:destinationPath]) {
        [fileManager removeItemAtPath:destinationPath error:&fileError]; // 如果目标路径已经存在文件，先移除旧文件
    }
    
    BOOL success = [fileManager moveItemAtURL:location toURL:[NSURL fileURLWithPath:destinationPath] error:&fileError];
    if (success) {
        NSLog(@"File downloaded successfully to %@", destinationPath);
    } else {
        NSLog(@"Failed to move downloaded file: %@", fileError.localizedDescription);
    }

NSFileManager：这是 Cocoa 框架中的文件系统管理类，负责对文件进行操作，如复制、移动、删除等。
文件处理：我们首先检查目标路径是否已有旧文件存在。如果存在，我们需要将其删除，避免冲突。然后我们将临时目录中的文件移动到目标目录，以便下载文件能够被正常访问。

3. 使用示例

以下是一个具体的使用示例，你可以参考并直接在项目中应用。

// 创建文件下载器实例
FileDownloader *downloader = [[FileDownloader alloc] init];

// 需要下载的文件 URL
NSURL *fileURL = [NSURL URLWithString:@"https://example.com/path/to/your/file.zip"];


// 获取应用的 Documents 目录
NSArray *paths = NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES);
NSString *documentsDirectory = [paths firstObject];
// 文件保存路径
NSString *fileName = @"xxx.zip"; // 替换为你想要的文件名
NSString *destinationPath = [documentsDirectory stringByAppendingPathComponent:fileName];

// 开始下载文件
[downloader downloadFileFromURL:fileURL toDestination:destinationPath];

4.完整代码示例

#import <Foundation/Foundation.h>

@interface FileDownloader : NSObject

- (void)downloadFileFromURL:(NSURL *)url toDestination:(NSString *)destinationPath;

@end

@implementation FileDownloader

- (void)downloadFileFromURL:(NSURL *)url toDestination:(NSString *)destinationPath {
    NSURLSessionConfiguration *configuration = [NSURLSessionConfiguration defaultSessionConfiguration];
    NSURLSession *session = [NSURLSession sessionWithConfiguration:configuration];

    NSURLSessionDownloadTask *downloadTask = [session downloadTaskWithURL:url
                                                       completionHandler:^(NSURL * _Nullable location, NSURLResponse * _Nullable response, NSError * _Nullable error) {
        if (error) {
            NSLog(@"Download failed with error: %@", error.localizedDescription);
            return;
        }
        
        // 文件下载成功，移动到指定目录
        NSFileManager *fileManager = [NSFileManager defaultManager];
        NSError *fileError;
        
        if ([fileManager fileExistsAtPath:destinationPath]) {
            [fileManager removeItemAtPath:destinationPath error:&fileError]; // 如果目标路径已经存在文件，先移除旧文件
        }
        
        BOOL success = [fileManager moveItemAtURL:location toURL:[NSURL fileURLWithPath:destinationPath] error:&fileError];
        if (success) {
            NSLog(@"File downloaded successfully to %@", destinationPath);
        } else {
            NSLog(@"Failed to move downloaded file: %@", fileError.localizedDescription);
        }
    }];
    
    [downloadTask resume]; // 开始下载任务
}

@end