一个很是简单易用且功能丰富的纯Swift下载框架-Tiercel

时间  2019-12-07
标签 一个 很是 简单 易用 功能 丰富 swift 下载 框架 tiercel 栏目 Swift 繁體版
原文   原文链接

项目地址：github.com/Danie1s/Tie…

Tiercel

Tiercel是一个很是简单易用且功能丰富的纯Swift下载框架。最大的特色就是拥有强大的任务管理功能和能够直接获取常见的下载信息，而且只要加上一些简单的UI，就能够实现一个下载类APP的大部分功能。ios

Features:

  • [x] 支持大文件下载
  • [x] 支持离线断点续传，APP关闭后依然能够恢复全部下载任务
  • [x] 每一个下载任务均可以单独管理操做
  • [x] 每一个下载任务和manager都有进度回调、成功回调和失败回调
  • [x] 弃用单例模式，APP里面能够有多个manager，能够根据须要区分不一样的下载模块
  • [x] 内置了常见的下载信息，而且能够选择是否持久化下载任务信息
  • [x] 支持后台下载
  • [x] 链式语法调用
  • [x] 能够控制下载的最大并发数
  • [x] 线程安全

Requirements

  • iOS 8.0+
  • Xcode 9.0+
  • Swift 4.0+​

Installation

CocoaPods

CocoaPods is a dependency manager for Cocoa projects. You can install it with the following command:git

$ gem install cocoapods
复制代码

CocoaPods 1.1+ is required to build Tiercel.github

To integrate Tiercel into your Xcode project using CocoaPods, specify it in your Podfile:swift

source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '8.0'
use_frameworks!

target '<Your Target Name>' do
    pod 'Tiercel'
end
复制代码

Then, run the following command:数组

$ pod install
复制代码

Manually

If you prefer not to use any of the aforementioned dependency managers, you can integrate Tiercel into your project manually.xcode

Example

To run the example project, clone the repo, and run Example.xcodeproj from the Example directory.缓存

Usage

最简单的用法

只须要简单的几行代码便可开启下载安全

let URLString = "http://120.25.226.186:32812/resources/videos/minion_01.mp4"
let downloadManager = TRManager()
// 建立下载任务而且开启下载
downloadManager.download(URLString)
复制代码

固然也能够对下载任务设置回调ruby

downloadManager.download(URLString, fileName: "小黄人1.mp4", progressHandler: { (task) in
    let progress = task.progress.fractionCompleted                                                                        
    print("下载中, 进度：\(progress)")
}, successHandler: { (task) in
    print("下载完成")
}) { (task) in
    print("下载失败")
}
复制代码

下载任务的管理和操做bash

// 建立下载任务而且开启下载，同时返回可选类型的TRDownloadTask对象，若是URLString无效，则返回nil
let task = downloadManager.download(URLString)
// 根据URLString查找下载任务，返回可选类型的FCTask对象，若是不存在，则返回nil
let task = downloadManager.fetchTask(URLString)

// 开始下载
// 若是设置了downloadManager.isStartDownloadImmediately = false，须要手动开启下载
// 若是调用suspend暂停了下载，能够调用这个方法继续下载
downloadManager.start(URLString)

// 暂停下载
downloadManager.suspend(URLString)

// 取消下载，没有下载完成的任务会被移除，但保留没有下载完成的缓存文件
downloadManager.cancel(URLString)

// 移除下载，已经完成的任务也会被移除，没有下载完成的缓存文件会被删除，已经下载完成的文件能够选择是否保留
downloadManager.remove(URLString, completely: false)
复制代码

TRManager

TRManager是下载任务的管理者，管理全部下载任务，要使用Tiercel进行下载，必需要先建立TRManager对象。Tiercel没有设计成单例模式，由于一个APP可能会有多个不一样的下载模块，开发者能够根据需求建立多个TRManager对象来进行下载。

/// 初始化方法
///
/// - Parameters:
/// - name: 设置TRManager对象的名字，区分不一样的下载模块，每一个模块中下载相关的文件会保存到对应的沙盒目录
/// - MaximumRunning: 下载的最大并发数
/// - isStoreInfo: 是否把下载任务的相关信息持久化到沙盒，若是是，则初始化完成后自动恢复上次的任务
public init(_ name: String? = nil, MaximumRunning: Int? = nil, isStoreInfo: Bool = false) {
    // 实现的代码... 
}
复制代码

开启下载任务，而且对其进行管理。Tiercel的设计理念是一个URLString对应一个下载任务，全部操做都必须经过TRManager对象进行，URLString做为下载任务的惟一标识。

let URLString = "http://120.25.226.186:32812/resources/videos/minion_01.mp4"
let downloadManager = TRManager()

// 若是URLString无效，则返回nil
let task = downloadManager.download(URLString, fileName: "小黄人1.mp4", progressHandler: {  (task) in
    let progress = task.progress.fractionCompleted                                                                        
    print("下载中, 进度：\(progress)")
}, successHandler: { (task) in
    print("下载完成")
}) { (task) in
    print("下载失败")
}

// 批量开启下载任务，返回有效URLString对应的任务数组，URLStrings须要跟fileNames一一对应
let tasks = downloadManager.multiDownload(URLStrings, fileNames: fileNames)


// 根据URLString查找下载任务，返回可选类型的FCTask对象
// let task = downloadManager.fetchTask(URLString)

// 开始下载
// 若是设置了downloadManager.isStartDownloadImmediately = false，须要手动开启下载
// 若是调用suspend暂停了下载，能够调用这个方法继续下载
downloadManager.start(URLString)

// 暂停下载
downloadManager.suspend(URLString)

// 取消下载，没有下载完成的任务会被移除，但保留没有下载完成的缓存文件
downloadManager.cancel(URLString)

// 移除下载，已经完成的任务也会被移除，没有下载完成的缓存文件会被删除，已经下载完成的文件能够选择是否保留
downloadManager.remove(URLString, completely: false)
复制代码

TRManager也提供了对全部任务同时操做的API

downloadManager.totalStart()
downloadManager.totalSuspend()
downloadManager.totalCancel()
downloadManager.totalRemove(completely: false)
复制代码

TRManager做为全部下载任务的管理者，也能够设置回调

// 回调闭包的参数都是TRManager对象，由于开发者能够经过TRManager对象获得任何相关的信息，把灵活度最大化
// 回调闭包都是在主线程运行
// progress 闭包：只要有一个任务正在下载，就会触发
// success 闭包：有两种状况会触发：
// 1. 全部任务都下载成功(取消和移除的任务会被移除而后销毁，再也不被manager管理) ，这时候manager.status == .completed
// 2. 任何一个任务的状态都不是成功或者失败，且没有等待运行的任务，也没有正在运行的任务，这时候manager.status == .suspend
// failure 闭包：有三种状况会触发：
// 1. 每一个任务的状态是成功或者失败，且有一个是失败的，这时候manager.status == .failed
// 2. 调用所有取消的方法，或者剩下一个任务的时候把这个任务取消，这时候manager.status == .cancel
// 3. 调用所有移除的方法，或者剩下一个任务的时候把这个任务移除，这时候manager.status == .remove
downloadManager.progress { (manager) in
    let progress = manager.progress.fractionCompleted
    print("downloadManager运行中, 总进度：\(progress)")
    }.success { (manager) in
        if manager.status == .suspend {
            print("manager暂停了")
        } else if manager.status == .completed {
            print("全部下载任务都下载成功")
        }
    }.failure { (manager) in
        if manager.status == .failed {
            print("存在下载失败的任务")
        } else if manager.status == .cancel {
            print("manager取消了")
        } else if manager.status == .remove {
            print("manager移除了")
        }
}
复制代码

Tiercel的销毁

// 因为Tiercel是使用URLSession实现的，session须要手动销毁，因此当再也不须要使用Tiercel也须要手动销毁
// 通常在控制器中添加如下代码
deinit {
    downloadManager.invalidate()
}
复制代码

TRManager的主要属性

// 设置内置日志打印等级，若是为none则不打印
public static var logLevel: TRLogLevel = .high
// 设置是否建立任务后立刻下载，默认为是
public var isStartDownloadImmediately = true
// TRManager的状态
public var status: FCStatus = .waiting
// TRManager的缓存管理对象
public var cache: TRCache
// TRManager的进度
public var progress: Progress
// 设置请求超时时间
public var timeoutIntervalForRequest = 30.0
// 全部下载中的任务加起来的总速度
public private(set) var speed: Int64 = 0
// 全部下载中的任务须要的剩余时间
public private(set) var timeRemaining: Int64 = 0

// manager管理的下载任务，取消和移除的任务会被销毁，不会在数组里，但操做是异步的，立刻获取的tasks可能不正确
public var tasks: [FCTask] = []
复制代码

TRCache

TRCache是Tiercel中负责管理缓存下载任务信息和下载文件的类。一样地，TRCache没有设计成单例模式，TRCache对象通常做为TRManager对象的属性来使用，若是须要跨控制器使用，那么只须要建立跟TRManager对象一样名字的TRCache对象便可操做对应模块的缓存信息和文件。

/// 初始化方法
///
/// - Parameters:
/// - name: 设置TRCache对象的名字，通常由TRManager对象建立时传递
/// - isStoreInfo: 是否把下载任务的相关信息持久化到沙盒，通常由TRManager对象建立时传递
public init(_ name: String, isStoreInfo: Bool = false) {
    // 实现的代码...
}
复制代码

主要属性

// 下载模块的目录路径
public let downloadPath: String

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

// 下载完成的文件的目录路径
public let downloadFilePath: String
复制代码

主要API分红几大类：

  • 检查沙盒是否存在文件

  • 移除跟下载任务相关的文件

  • 保存跟下载任务相关的文件

  • 读取下载任务相关的文件，得到下载任务相关的信息

    ​

TRDownloadTask

TRDownloadTask是Tiercel中的下载任务类，继承自FCTask。**Tiercel的设计理念是一个URLString对应一个下载任务，全部操做都必须经过TRManager对象进行，URLString做为下载任务的惟一标识。**因此TRDownloadTask对象都是由TRManager对象建立，单首创建没有意义。

主要属性

// 保存到沙盒的下载文件的文件名，若是在下载的时候没有设置，则默认使用url的最后一部分
public internal(set) var fileName: String
// 下载任务对应的URLString
public var URLString: String
// 下载任务的状态
public var status: FCStatus = .waiting
// 下载任务的进度
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
复制代码

下载任务的回调，能够在使用TRManager对象开启下载的时候设置，也能够在得到TRDownloadTask对象后进行设置

let task = downloadManager.fetchTask(URLString)

// 回调闭包的参数都是TRDownloadTask对象，由于开发者能够经过TRDownloadTask对象获得任何相关的信息，把灵活度最大化
// 回调闭包都是在主线程运行
// progress 闭包：若是任务正在下载，就会触发
// success 闭包：任务已经下载过了，或者任务下载完成时，会触发
// failure 闭包：有三种状况会触发：
// 1. 任务下载失败，这时候task.status == .failed
// 2. 取消任务，这时候task.status == .cancel
// 3. 移除任务，或者剩下一个任务的时候把这个任务移除，这时候manager.status == .remove
task.progress { (task) in
     let progress = task.progress.fractionCompleted
     printLog("下载中, 进度：\(progress)")
    }
    .success({ (task) in
        printLog("下载完成")
    })
    .failure({  (task) in
        if task.status == .failed {
            print("下载失败")
        } else if task.status == .cancel {
            print("取消任务")
        } else if task.status == .remove {
            print("移除任务")
        }
    })
复制代码

对下载任务操做，必须经过TRManager对象进行，不能用TRDownloadTask对象直接操做

  • 开启
  • 暂停
  • 取消，会从TRManager对象中的tasks中移除，但保留没有下载完成的缓存文件
  • 移除，已经完成的任务也会被移除，没有下载完成的缓存文件会被删除，已经下载完成的文件能够选择是否保留

注意：取消和移除的任务会被销毁，会从TRManager对象的tasks中移除，但操做是异步的，立刻获取的tasks可能不正确，在回调闭包里面获取的tasks才能保证正确

后台下载

若是须要开启后台下载，只须要在项目的info.plist中添加Required background modes -> App downloads content from the network

License

Tiercel is available under the MIT license. See the LICENSE file for more info.

相关文章
相关标签/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公众号
   欢迎关注本站公众号,获取更多信息
联系我们 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程