读书笔记:WorkManager的使用

本笔记来自第一行代码第三版第13章,作者郭霖,各大平台均可购买。

前言

WorkManger为了解决开发者需要在后台执行一些耗时性或周期性的独立的任务。WorkManger不属于Android的四大组件,是独立的任务,在应用退出时,仍然可能会执行。

WorkManager具有以下特点:
1、周期任务不一定会准时执行,可能受到系统其它策略的影响(省电等等);
2、兼容性好,会根据系统版本自动选择使用AlarmManager或是JobScheduler;
2、国内厂商可能会删除此功能,无法使用WorkManager;

正文

基本用法

首先需要在gradl文件中添加依赖:

dependencies {
    ......
    implementation 'androidx.work:work-runtime:2.3.4'
}

创建一个后台任务,继承Worker:

class SimpleWorker(context: Context, workerParams: WorkerParameters) :
    Worker(context, workerParams) {
    override fun doWork(): Result {
        Log.d("SimpleWorker", "doWork")
        return Result.success()
    }
}

自定义Worker,需要注意一下问题:

  1. SimpleWorker不可以直接实例化,后续内容会介绍;
  2. 重写doWork方法可以执行耗时任务,不必再创建新的线程;
  3. doWork执行完毕,需要返回此次执行任务的结果, Result.success()/ Result.failure()/ Result.retry(),方便监听任务的执行状态。

实例化自定义Worker:

// 执行一次的任务
val request = OneTimeWorkRequest.Builder(SimpleWorker::class.java).build()
// 周期任务,循环周期不可小于15分钟
val request2 = PeriodicWorkRequest.Builder(SimpleWorker::class.java, 15, TimeUnit.MINUTES).build()

执行Worker:

WorkManager.getInstance(this).enqueue(request)

高级用法

上面介绍的是WorkManager的基本用法,为了丰富WorkManager的应用场景,它还有很多的个性设置,下面介绍常用的几种:

1、设置请求的首次延迟时间

val request = OneTimeWorkRequest.Builder(SimpleWorker::class.java)
                .setInitialDelay(3, TimeUnit.MINUTES) // 设置任务延迟3分钟开始执行
                .build()

2、设置请求的标签

val request = OneTimeWorkRequest.Builder(SimpleWorker::class.java)
                .addTag("Simple")  // 为任务添加标记位,方便统一取消
                .build()

3、设置请求的失败的重试策略

val request = OneTimeWorkRequest.Builder(SimpleWorker::class.java)
                .setBackoffCriteria(BackoffPolicy.LINEAR, 1, TimeUnit.MINUTES) // 表示任务失败后,会以延迟的方式执行
                .build()

如果任务失败了,适当的延迟任务的下次执行时间,有助于节省手机消耗。
BackoffPolicy.LINEAR:线性的方式延迟;
BackoffPolicy.EXPONENTIAL:指数的方式延迟
该设置需要dowWork返回Result.retry()。

4、监听任务的执行状态

// 监听任务的执行状态
WorkManager.getInstance(this).getWorkInfoByIdLiveData(request.id)
       .observe(this, Observer {
              when (it.state) {
                   WorkInfo.State.SUCCEEDED -> {}
                   WorkInfo.State.FAILED -> {}
                   else -> {}
              }
       })

5、创建链式任务

需要三个任务顺序执行:A - B - C,如果中间的某个任务失败了,剩下的任务不会得到执行。

 // 创建链式任务, 如果在前面的人任务失败,之后的任务不会得到在执行
 WorkManager.getInstance(this)
         .beginWith(request)
         .then(request)
         .then(request).enqueue()

beginWith: 开始的任务;
then:接下来的任务;

6、执行唯一任务

WorkManager.getInstance(this).enqueueUniqueWork("test1", ExistingWorkPolicy.APPEND, request)

第一个参数为任务的名称;
第二个参数为任务执行的策略(ExistingWorkPolicy枚举类):替换,保持,添加
第三个参数为创建的任务

6、取消任务

// 取消任务的方式
WorkManager.getInstance(this).cancelAllWork()
WorkManager.getInstance(this).cancelAllWorkByTag("Simple")
WorkManager.getInstance(this).cancelWorkById(request.id)
WorkManager.getInstance(this).enqueueUniqueWork("test1", ExistingWorkPolicy.APPEND, request)
WorkManager.getInstance(this).cancelUniqueWork("test1")

总结

WorkManager适合做一些业务无关的功能,例如同步数据等等,即使无法得到执行也不会对app的使用有影响,加上国内厂商定制,暂时还是保留起来吧。

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