Android新架构组件WorkManager

       WorkManager是谷歌2018年新推出的Architecture Components库,主要用来管理后台任务的执行,保证任务在满足执行条件时即使应用没有启动也能执行。WorkManager发布之前,有多种方式可以用来做后台任务,但它们都有各自的局限性;AsyncTask、ThreadPool、RxJava能够在应用中开后台线程执行任务,但应用关闭以后任务就无法执行了;JobScheduler、Firebase的JobDispatcher则对android api level有要求;AlarmManager虽然支持所有的android版本,但针对不同api level也要调不同的接口来适应行为变更。WorkManager会根据设备的 api level和app的运行状况选择合适的方法来执行后台任务。当app正在运行时直接开辟新的线程来执行;当app没有运行时,如果api level>=23则使用JobScheduler;api level >=14时,如果应用引用了Firebase则使用Firebase JobDispatcher;剩余情况则使用AlarmManager。

1.导入WorkManager

    在app/build.gradle文件中加入如下依赖配置:

        kotlin:implementation"android.arch.work:work-runtime-ktx::$work_version

         java: implementation"android.arch.work:work-runtime::$work_version"

2.类和概念

    WorkManager API使用了一些不同的类,使用时需要继承其中某个类。最主要的类包括以下几个:

    Worker:定义了需要执行的任务,该类是一个抽象类,需要我们继承这个类并重写它的doWork方法。该类会在运行时被WorkManager实例化,然后在后台线程执行doWork方法。

    WorkRequest:代表类一个单独的任务,至少包含执行任务的Worker类信息,此外你还可以向WorkRequest添加其他信息比如任务执行条件。每个WorkRequest都有一个自动生成的唯一Id,我们可以使用这个id来取消任务或者获取任务的状态。WorkRequest也是一个抽象类,我们需要使用它的直接子类,WorkManager目前支持两个类型OneTimeWorkRequest和PeriodicWorkRequest创建WorkRequest需要使用WorkRequest.Builder类,我们实际用到的是它的子类OneTimeWorkRequest.Builder和PeriodicWorkRequest.Builder。

    WorkManager:将WorkRequest加入队列并管理,我们将WorkRequest传递给WorkManager,WorkManager将WorkManager加入队列并保证其在指定条件下执行,从而达到分散系统资源负载的目的。

    WorkStatus:包含了相关任务的信息,WorkManager为每一个WorkRequest提供了LiveData 来保存WorkStatus,通过观察该LiveData我们可以获取任务的当前状态,并在任务执行完毕后获取返回值。

3.工作流程

3.1创建worker

创建一个Worker的子类,重写doWork方法,在重写doWork方法中执行相关任务,该方法返回值是一个Worker.Result对象,Result.SUCCESS表示任务执行成功,Result.FAILURE表示任务执行失败,Result.RETRY表示任务暂时失败,需要重新执行(执行条件通过 WorkRequest.Builder.setBackoffCriteria()方法设置);该类只指明如何执行任务, 并不包含该任务何时执行的任何信息。

3.2WorkRequest

运行一次性任务需要创建OneTimeWorkRequest对象, 运行周期任务则创建PeriodicWorkRequest对象。如下

private fun createRequest(tag:String?):OneTimeWorkRequest{

    val builder = OneTimeWorkRequest.Builder(OneTimeWork::class.java)

    builder.setInputData(createData())

    builder.setConstraints(createConstraints())

    return builder.build()

}


private fun createRequest(tag:String?):PeriodicWorkRequest{

        val builder = PeriodicWorkRequest.Builder(PeriodicWork::class.java, 5, TimeUnit.HOURS)

        builder.setInputData(createData())

        builder.setConstraints(createConstraints())

        return builder.build()

}

3.3任务约束条件

    我们可以定义约束条件以告诉WorkManager何时安排任务执行,如果没有提供任何约束条件,那么该任务将立即运行。约束条件通过Constraints.Builder类创建。

private fun createConstraints(): Constraints {

    val builder = Constraints.Builder()

    builder.setRequiredNetworkType(NetworkType.NOT_REQUIRED)

    builder.setRequiresBatteryNotLow(false)

    .setRequiresCharging(false)

    .setRequiresStorageNotLow(false)

    if(Build.VERSION.SDK_INT >=23)

        builder.setRequiresDeviceIdle(false)

    if(Build.VERSION.SDK_INT >=24)

        builder.addContentUriTrigger(ContactsContract.Contacts.CONTENT_URI, true)

    return builder.build()

}

3.4执行请求

    WorkManager.getInstance().enqueue(request)

3.5取消任务

    WorkManager.getInstance().cancelWorkById(worker.getId())

4.高级应用

4.1链式任务

WorkManager可通过beginWith()方法生成一个WorkContinuation 对象,该对象允许我们将不同的WorkRequest链接在一起按照特定顺序执行。例如定义五个workrequest:request1、request2、request3、request4、request5;

WorkManager.getInstance()?.apply {

    beginWith(request1)

    .then(request2)

    .then(request3)

.    then(request4)

    .then(request5)

    .enqueue()

}

在这种方式下的执行顺序为request1 -> request2 -> request3 -> request4 -> request5。

WorkManager.getInstance()?.apply {

    beginWith(request1, request2)

    .then(request3, request4)

    .then(request5)

    .enqueue()

}

这种方式下执行顺序为request1、 request2 -> request3 、 request4 -> request5,其中request1、 request2的执行顺序不一定; request3 、 request4亦然。

WorkManager.getInstance()?.apply {

    val continuation1 = beginWith(request1, request2)

    val continuation2 = beginWith(request3, request4, request5)

    WorkContinuation.combine(continuation1, continuation2).enqueue()

}

这种情况下continuation1和continuation2执行顺序不一定,其各自包含的request如果有执行顺序则按给定的执行顺序执行。

WorkManager.getInstance()?.apply {

    val continuation = beginWith(request2, request3, request4, request5)

    WorkContinuation.combine(request1, continuation).enqueue()

}

这种情况下当continuation中序列执行完成后执行request1

4.2唯一工作序列

    通过调用 beginUniqueWork() 而不是beginWith()来创建唯一工作序列,每个唯一工作序列都有一个名称,WorkManager同时只能执行一个同名唯一工作序列,当我们创建一个唯一工作序列时,如果已经有一个未完成的序列具有相同的名称,则通过ExistingWorkPolicy指定WorkManager应执行的操作:

ExistingWorkPolicy.KEEP:保持现有工作序列并忽略新的请求

ExistingWorkPolicy.REPLACE:取消现有的序列并用新序列替换

ExistingWorkPolicy.APPEND:将新序列附加到现有序列,在现有序列的最后一个任务完成后运行新序列的第一个任务

WorkManager.getInstance()?.apply {

    beginUniqueWork("a", ExistingWorkPolicy.KEEP, request1).enqueue()

    beginUniqueWork("a", ExistingWorkPolicy.KEEP, request2).enqueue()

}

4.3 tag

    通过WorkRequest.Builder.addTag()方法将字符串tag传递给WorkRequest对象可以将任务进行逻辑分组,WorkManager就可以通过特定方法对具有相同tag的任务进行操作。例如:WorkManager.cancelAllWorkByTag()WorkManager.getStatusesByTag()

4.4输入参数和返回值

    输入参数和返回值是一个Data对象,该对象里面保存有一个HashMap,所有参数都以键值对的形式保存在里面。输入参数可以通过WorkRequest.Builder.setInputData()方法设置,并通过Worker.getInputData()方法读取。返回值通过 Worker.setOutputData()方法设置,并通过观察 LiveData<WorkStatus>来获取。

    在链式任务中,一个任务的输出可用作下一个任务的输入。如果是单个OneTimeWorkRequest跟在另一个OneTimeWorkRequest后面的简单链,第一个任务可通过setOutputData()设置结果,下一个任务可通过getInputData()来获取结果。如果是复杂的链,例如多个任务同时发送结果到后一个任务,可通过WorkRequest.Builder类的setInputMerger()方法指定一个InputMerger,通过该InputMerger来决定当多个任务的输出具有相同的key时该怎么做。InputMerger 是一个抽象类,我们需要使用它的子类:ArrayCreatingInputMergerOverwritingInputMerger。方法如下:

val builder = OneTimeWorkRequest.Builder(OneTimeWork1::class.java)

builder.setInputMerger(ArrayCreatingInputMerger::class.java)

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,457评论 5 459
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,837评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,696评论 0 319
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,183评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,057评论 4 355
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,105评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,520评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,211评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,482评论 1 290
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,574评论 2 309
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,353评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,213评论 3 312
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,576评论 3 298
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,897评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,174评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,489评论 2 341
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,683评论 2 335

推荐阅读更多精彩内容