配置

// 在AppDelegate文件里
// 不能使用懒加载
var sessionManager: SessionManager = {
 var configuration = SessionConfiguration()
 configuration.allowsCellularAccess = true
 let manager = SessionManager("default", configuration: configuration, operationQueue: DispatchQueue(label: "com.Tiercel.SessionManager.operationQueue"))
 return manager
}()
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
 // 必须要保证在这个方法结束前完成SessionManager初始化
 
 return true
}
// 必须实现此方法,并且把identifier对应的completionHandler保存起来
func application(_ application: UIApplication, handleEventsForBackgroundURLSession identifier: String, completionHandler: @escaping () -> Void) {
 if sessionManager.identifier == identifier {
 sessionManager.completionHandler = completionHandler
 }
}

基本用法

// 创建下载任务并且开启下载,同时返回可选类型的DownloadTask实例,如果url无效,则返回nil
let task = sessionManager.download("http://api.gfs100.cn/upload/20171219/201712191530562229.mp4")
// 批量创建下载任务并且开启下载,返回有效url对应的任务数组,url需要跟fileNames一一对应
let tasks = sessionManager.multiDownload(URLStrings)

// 回调闭包的参数是Task实例,可以得到所有相关的信息
// 所有闭包都可以选择是否在主线程上执行,由onMainQueue参数控制,如果onMainQueue传false,则会在sessionManager初始化时指定的队列上执行
// progress 闭包:如果任务正在下载,就会触发
// success 闭包:任务已经下载过,或者下载完成,都会触发,这时候task.status == .succeeded
// failure 闭包:只要task.status != .succeeded,就会触发:
// 1. 暂停任务,这时候task.status == .suspended
// 2. 任务下载失败,这时候task.status == .failed
// 3. 取消任务,这时候task.status == .canceled
// 4. 移除任务,这时候task.status == .removed
let task = sessionManager.download("http://api.gfs100.cn/upload/20171219/201712191530562229.mp4")
task?.progress(onMainQueue: true, { (task) in
 let progress = task.progress.fractionCompleted
 print("下载中, 进度:\(progress)")
}).success { (task) in
 print("下载完成")
}.failure { (task) in
 print("下载失败")
}

let URLString = "http://api.gfs100.cn/upload/20171219/201712191530562229.mp4"
// 创建下载任务并且开启下载,同时返回可选类型的DownloadTask实例,如果url无效,则返回nil
let task = sessionManager.download(URLString)
// 根据URLString查找下载任务,返回可选类型的Task实例,如果不存在,则返回nil
let task = sessionManager.fetchTask(URLString)
// 开始下载
// 如果调用suspend暂停了下载,可以调用这个方法继续下载
sessionManager.start(URLString)
// 暂停下载
sessionManager.suspend(URLString)
// 取消下载,没有下载完成的任务会被移除,不保留缓存,已经下载完成的不受影响
sessionManager.cancel(URLString)
// 移除下载,任何状态的任务都会被移除,没有下载完成的缓存文件会被删除,可以选择是否保留已经下载完成的文件
sessionManager.remove(URLString, completely: false)
// 除了可以对单个任务进行操作,TRManager也提供了对所有任务同时操作的API
sessionManager.totalStart()
sessionManager.totalSuspend()
sessionManager.totalCancel()
sessionManager.totalRemove(completely: false)

后台下载

// 必须实现此方法,并且把identifier对应的completionHandler保存起来
func application(_ application: UIApplication, handleEventsForBackgroundURLSession identifier: String, completionHandler: @escaping () -> Void) {
 if sessionManager.identifier == identifier {
 sessionManager.completionHandler = completionHandler
 }
}

文件校验

let task = sessionManager.download("http://dldir1.qq.com/qqfile/QQforMac/QQ_V4.2.4.dmg")
// 回调闭包可以选择是否在主线程上执行
task?.validateFile(code: "9e2a3650530b563da297c9246acaad5c",
 type: .md5,
 onMainQueue: true,
 { (task) in
 if task.validation == .correct {
 // 文件正确
 } else {
 // 文件错误
 }
})

/// 对文件进行校验,是在子线程进行的
///
/// - Parameters:
/// - filePath: 文件路径
/// - verificationCode: 文件的Hash值
/// - verificationType: Hash类型
/// - completion: 完成回调, 在子线程运行
public class func validateFile(_ filePath: String, 
 code: String, 
 type: FileVerificationType, 
 _ completion: @escaping (Bool) -> ()) {
 
}

SessionManager

/// 初始化方法
///
/// - Parameters:
/// - identifier: 设置SessionManager实例的标识,区分不同的下载模块,同时为urlSession的标识,原生级别的后台下载必须要有唯一标识
/// - configuration: SessionManager的配置
/// - operationQueue: urlSession的代理回调执行队列,SessionManager中的所有闭包回调如果没有指定在主线程执行,也会在此队列中执行
public init(_ identifier: String,
 configuration: SessionConfiguration,
 operationQueue: DispatchQueue = DispatchQueue(label: "com.Tiercel.SessionManager.operationQueue")) {
 // 实现的代码... 
}

// 回调闭包的参数是SessionManager实例,可以得到所有相关的信息
// 所有闭包都可以选择是否在主线程上执行,由onMainQueue参数控制,如果onMainQueue传false,则会在sessionManager初始化时指定的队列上执行
// progress 闭包:只要有一个任务正在下载,就会触发
// success 闭包:只有一种情况会触发:
// 所有任务都下载成功(取消和移除的任务会被移除然后销毁,不再被manager管理) ,这时候manager.status == .succeeded
// failure 闭包:只要manager.status != .succeeded,就会触发:
// 1. 调用全部暂停的方法,或者没有等待运行的任务,也没有正在运行的任务,这时候manager.status == .suspended
// 2. 所有任务都结束,但有一个或者多个是失败的,这时候manager.status == .failed
// 3. 调用全部取消的方法,或者剩下一个任务的时候把这个任务取消,这时候manager.status == .canceled
// 4. 调用全部移除的方法,或者剩下一个任务的时候把这个任务移除,这时候manager.status == .removed
sessionManager.progress(onMainQueue: true, { (manager) in
 let progress = manager.progress.fractionCompleted
 print("downloadManager运行中, 总进度:\(progress)")
 }.success { (manager) in
 print("所有下载任务都成功了")
 }.failure { (manager) in
 if manager.status == .suspended {
 print("所有下载任务都暂停了")
 } else if manager.status == .failed {
 print("存在下载失败的任务")
 } else if manager.status == .canceled {
 print("所有下载任务都取消了")
 } else if manager.status == .removed {
 print("所有下载任务都移除了")
 }
}

// 设置内置日志打印等级,如果为none则不打印
public static var logLevel: LogLevel = .detailed
// 是否需要对networkActivityIndicator进行管理
public static var isControlNetworkActivityIndicator = true
// urlSession的代理回调执行队列,SessionManager中的所有闭包回调如果没有指定在主线程执行,也会在此队列中执行
public let operationQueue: DispatchQueue
// SessionManager的状态
public var status: Status = .waiting
// SessionManager的缓存管理实例
public var cache: Cache
// SessionManager的标识,区分不同的下载模块
public let identifier: String
// SessionManager的进度
public var progress: Progress
// SessionManager的配置,可以设置请求超时时间,最大并发数,是否允许蜂窝网络下载
public var configuration = SessionConfiguration()
// 所有下载中的任务加起来的总速度
public private(set) var speed: Int64 = 0
// 所有下载中的任务需要的剩余时间
public private(set) var timeRemaining: Int64 = 0
// SessionManager管理的下载任务,取消和移除的任务会被销毁,但操作是异步的,在回调闭包里面获取才能保证正确
public var tasks: [Task] = []

SessionConfiguration

// 请求超时时间
public var timeoutIntervalForRequest = 30.0
// 最大并发数
// 支持后台下载的任务,系统会进行最大并发数限制
// 在iOS 11及以上是6,iOS 11以下是3
public var maxConcurrentTasksLimit
// 是否允许蜂窝网络下载
public var allowsCellularAccess = false

// 无论是否有下载任务正在运行,都可以更改SessionManager配置
// 如果只是更改某一项,可以直接对SessionManager属性设置
sessionManager.configuration.allowsCellularAccess = true
// 如果是需要更改多项,需要重新创建SessionConfiguration,再进行赋值
let configuration = SessionConfiguration()
configuration.allowsCellularAccess = true
configuration.maxConcurrentTasksLimit = 2
configuration.timeoutIntervalForRequest = 60
sessionManager.configuration = configuration

// 不要这样操作
sessionManager.configuration.allowsCellularAccess = true
let task = sessionManager.download("http://api.gfs100.cn/upload/20171219/201712191530562229.mp4")

// 如果实在需要,请延迟开启任务
sessionManager.configuration.allowsCellularAccess = true
DispatchQueue.main.asyncAfter(deadline: .now() + 1) {
 let task = sessionManager.download("http://api.gfs100.cn/upload/20171219/201712191530562229.mp4")
}

DownloadTask

// 保存到沙盒的下载文件的文件名,如果在下载的时候没有设置,则默认为url的md5加上文件扩展名
public internal(set) var fileName: String
// 下载任务对应的url
public let url: URL
// 下载任务的状态
public var status: Status
// 下载文件的校验状态
public var validation: Validation
// 下载任务的进度
public var progress: Progress = Progress()
// 下载任务的开始日期
public var startDate: TimeInterval = 0
// 下载任务的结束日期
public var endDate: TimeInterval = Date().timeIntervalSince1970
// 下载任务的速度
public var speed: Int64 = 0
// 下载任务的剩余时间
public var timeRemaining: Int64 = 0
// 下载文件路径
public var filePath: String
// 下载文件的扩展名
public var pathExtension: String?

Cache

/// 初始化方法
///
/// - Parameters:
/// - name: 不同的name,代表不同的下载模块,对应的文件放在不同的地方,对应SessionManager创建时传入的identifier
public init(_ name: String) {
 // 实现的代码...
}

// 下载模块的目录路径
public let downloadPath: String
// 没有完成的下载文件缓存的目录路径
public let downloadTmpPath: String
// 下载完成的文件的目录路径
public let downloadFilePath: String