Android WorkManager入门（二）

最新推荐文章于 2024-09-25 22:29:35 发布
最新推荐文章于 2024-09-25 22:29:35 发布
阅读量1.4k 收藏 22
点赞数 18
分类专栏： android jetpack 文章标签： android
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/shop_and_sleep/article/details/135658689
版权

WorkManager入门

上一篇

Android WorkManager入门（一）

前言

在当今快节奏的生活中，移动设备已经成为我们日常工作和生活不可或缺的一部分。然而，随着应用程序的复杂性不断增加，开发人员面临着一个重要的挑战：如何在后台执行任务，而不会影响用户的体验和设备的性能？
在过去，开发人员通常使用传统的后台服务或定时任务来解决这个问题。然而，这些方法往往很复杂，需要大量的代码和资源，并且很难管理和调度任务。幸运的是，谷歌最近推出了一个新的解决方案：安卓WorkManager。
安卓WorkManager是一个灵活、强大的后台任务调度库，旨在帮助开发人员轻松管理和执行后台任务。它提供了一种简单的方式来调度任务，无论是一次性任务、定期任务还是延迟任务，都可以很容易地实现。同时，WorkManager还提供了一系列强大的功能，如任务链、约束条件和灵活的重试机制，以确保任务能够在最佳的时间和条件下执行。
在本文中，我们将深入探讨安卓WorkManager的原理和用法，并通过实际示例演示如何使用它来解决常见的后台任务问题。无论您是一名初学者还是一名有经验的开发人员，本文都将为您提供宝贵的知识和实用的技巧，帮助您更好地利用安卓WorkManager来优化您的应用程序。让我们一起开始这段关于安卓WorkManager的探索之旅吧！

好吧，不多BB，其实是因为安卓12以上想起后台服务必须要悬浮窗权限，想起还有个WorkManager这种东西，去官网学习然后总结一下。没有看入门一的可以先看一，或者看官网的也可以。

创建 WorkRequest并提交 定时的任务（PeriodicWorkRequest）

我们可能要定期备份数据、定期下载应用中的新鲜内容或者定期上传日志到服务器。就可以使用PeriodicWorkRequest

在使用之前我们除了接入依赖还需要新建一个worker

import android.content.Context
import android.util.Log
import androidx.work.Worker
import androidx.work.WorkerParameters

class MyWorker(appContext: Context, workerParams: WorkerParameters):Worker(appContext, workerParams) {
    companion object{
        private const val TAG = "MyWorker"
    }


    override fun doWork(): Result {

        Log.d(TAG, "doWork: 我正在做一些工作")

        return Result.success()
    }

}

然后我们在需要使用的地方加上下例代码：

 val mWorkerRequest4 =
            PeriodicWorkRequestBuilder<MyWorker>(1, TimeUnit.HOURS)
                .build()

        //通过WorkManager提交WorkRequest，执行MyWorker
        WorkManager
            .getInstance(this)
            .enqueue(mWorkerRequest4)

可以定义的最短重复间隔是 15 分钟（与 JobScheduler API 相同）。

然后我们运行项目，等待一小时…

在这里插入图片描述

ok，一分钟过去了，然后我们发现一跑起来其实就有日志输出了，所以这个时间其实是最小间隔时间，和setInitialDelay的延时是不一样的。

配合约束使用

这时我们加上一个约束，这时代码变成了下例这样：

	val constraints = Constraints.Builder()
            .setRequiresCharging(true)
            .build()
	 val mWorkerRequest4 =
            PeriodicWorkRequestBuilder<MyWorker>(1, TimeUnit.HOURS)
                .setConstraints(constraints)
                .build()

        //通过WorkManager提交WorkRequest，执行MyWorker
        WorkManager
            .getInstance(this)
            .enqueue(mWorkerRequest4)

setRequiresCharging(true)标水充电时执行，如果不充电，那么这个定时任务就不会执行。不然就会像第一个例子一样，定时任务一开始就执行了。

定义执行范围

这是官方在每小时的最后 15 分钟内运行的定期工作的示例：

  //每小时的最后 15 分钟内运行的定期工作
        val mWorkerRequest5 =
            PeriodicWorkRequestBuilder<MyWorker>(
            1, TimeUnit.HOURS, // 执行周期
            15, TimeUnit.MINUTES) // 实际执行时间
            .build()


        //通过WorkManager提交WorkRequest，执行MyWorker
        WorkManager
            .getInstance(this)
            .enqueue(mWorkerRequest5)

结合这张图可以更好地理解两个时间在这里插入图片描述

RequiresApi最低为26

失败后的重试

后台任务有失败的可能，所以在Worker的doWork方法的返回值中给我们提供了三种方法，分别是：

  • Result.success()成功
  • Result.failure()失败
  • Result.retry()重试

成功和失败都是定性的，但是重试这个东西应该是会再执行的，那么怎么执行呢，我们看下面这个例子：

首先，我们将MyWorker改为下面这个样子：

import android.content.Context
import android.util.Log
import androidx.work.Worker
import androidx.work.WorkerParameters

class MyWorker(appContext: Context, workerParams: WorkerParameters):Worker(appContext, workerParams) {
    companion object{
        private const val TAG = "MyWorker"
    }


    override fun doWork(): Result {

        Log.d(TAG, "doWork: 我正在做一些工作")
        val doWorkFail = true
        if (doWorkFail){
            Log.d(TAG, "doWork: 我失败了，重试一下")
            return Result.retry()
        }

        return Result.success()
    }

}

然后再使用 setBackoffCriteria 方法对回退的工作进行处理：

  val mWorkerRequest6 = OneTimeWorkRequestBuilder<MyWorker>()
            .setBackoffCriteria(
                BackoffPolicy.LINEAR,
                MIN_BACKOFF_MILLIS,
                TimeUnit.MILLISECONDS)
            .build()


        //通过WorkManager提交WorkRequest，执行MyWorker
        WorkManager
            .getInstance(this)
            .enqueue(mWorkerRequest6 )

setBackoffCriteria 有一些参数，我们来看下都是什么

  • BackoffPolicy 指定回退时间策略；政策为 LINEAR，每次尝试重试时，重试间隔都会增加约 10 秒。例如，第一次运行以 Result.retry() 结束并在 10 秒后重试；然后，如果工作在后续尝试后继续返回 Result.retry()，那么接下来会在 20 秒、30 秒、40 秒后重试，以此类推。如果退避政策设置为 EXPONENTIAL，那么重试时长序列将接近 20、40、80 秒，以此类推。
    在这里插入图片描述
  • backoffDelay + timeUnit 具体的时间，最小为10s，在WorkRequest中有定义
    在这里插入图片描述
    我们跑起来看下效果：
    在这里插入图片描述
    结果如下
    在这里插入图片描述

为WorkRequest打上TAG

我们可以在使用中为WorkRequest打上Tag，这样就可以通过WorkManager.cancelAllWorkByTag(String) 取消带有特定标记的所有工作请求，或者用WorkManager.getWorkInfosByTag(String) 返回一个 WorkInfo 对象列表，该列表可用于确定当前工作状态。

来看下例代码：

 val mWorkerRequest7 = OneTimeWorkRequestBuilder<MyWorker>()
            .addTag("myWorker")
            .setInitialDelay(12, TimeUnit.MINUTES)
            .build()
//通过WorkManager提交WorkRequest，执行MyWorker
        WorkManager
            .getInstance(this)
            .enqueue(mWorkerRequest7)

        Handler().postDelayed({
            val workInfosByTag = WorkManager.getInstance(this).getWorkInfosByTag("myWorker")
            Log.d(TAG, "testWorkManager: ${workInfosByTag.get()}")

            Log.d(TAG, "testWorkManager: ${WorkManager.getInstance(this).cancelAllWorkByTag("myWorker").result}")
            WorkManager.getInstance(this).cancelAllWorkByTag("myWorker")
            WorkManager.getInstance(this).cancelAllWorkByTag("myWorker1").state.observe(this) {
                Log.d(TAG, "testWorkManager: $it")
            }
        },10*1000L)

通过日志我们可以看到确实可以通过tag找到执行的work，但是并不能取消，还是执行了

2024-01-18 10:35:26.130 22739-22739 MainActivity            com.example.test                     D  testWorkManager: [WorkInfo{mId='17366cc4-fa74-4d42-98d9-9b4e845fb19e', mState=CANCELLED, mOutputData=Data {}, mTags=[myWorker, com.example.test.MyWorker], mProgress=Data {}}, WorkInfo{mId='4c902568-aab9-4a96-b7e5-eccc93eea99c', mState=CANCELLED, mOutputData=Data {}, mTags=[myWorker, com.example.test.MyWorker], mProgress=Data {}}, WorkInfo{mId='708826dd-8e63-44f2-9311-746b15140bac', mState=CANCELLED, mOutputData=Data {}, mTags=[myWorker, com.example.test.MyWorker], mProgress=Data {}}, WorkInfo{mId='79e954b7-9318-4d7c-bd67-b8fd0e810479', mState=SUCCEEDED, mOutputData=Data {}, mTags=[myWorker, com.example.test.MyWorker], mProgress=Data {}}, WorkInfo{mId='7fb339e0-6acc-4b64-b451-ec1c9b82aaa6', mState=CANCELLED, mOutputData=Data {}, mTags=[myWorker, com.example.test.MyWorker], mProgress=Data {}}, WorkInfo{mId='87938938-1fb9-4304-afd3-bff71716a187', mState=CANCELLED, mOutputData=Data {}, mTags=[myWorker, com.example.test.MyWorker], mProgress=Data {}}, WorkInfo{mId='9233f46d-0cd4-48d7-9d05-e504bf46d623', mState=ENQUEUED, mOutputData=Data {}, mTags=[myWorker, com.example.test.MyWorker], mProgress=Data {}}, WorkInfo{mId='a55eb79b-b0b0-4e84-8a46-436056c6a8a7', mState=CANCELLED, mOutputData=Data {}, mTags=[myWorker, com.example.test.MyWorker], mProgress=Data {}}, WorkInfo{mId='a6f46271-e7f7-4f92-87bb-fa2d6e8b8ac2', mState=CANCELLED, mOutputData=Data {}, mTags=[myWorker, com.example.test.MyWorker], mProgress=Data {}}, WorkInfo{mId='d831ee89-d58f-4e7d-8994-4d0fc02370ea', mState=CANCELLED, mOutputData=Data {}, mTags=[myWorker, com.example.test.MyWorker], mProgress=Data {}}, WorkInfo{mId='dd3dca01-d868-465b-8efc-31256b06cc6b', mState=SUCCEEDED, mOutputData=Data {}, mTags=[myWorker, com.example.test.MyWorker], mProgress=Data {}}]
2024-01-18 10:35:26.131 22739-22739 MainActivity            com.example.test                     D  testWorkManager: androidx.work.impl.utils.futures.SettableFuture@ac1927[status=PENDING]
2024-01-18 10:35:26.133 22739-22739 MainActivity            com.example.test                     D  testWorkManager: IN_PROGRESS
2024-01-18 10:35:26.160 22739-22739 MainActivity            com.example.test                     D  testWorkManager: SUCCESS
2024-01-18 10:35:47.721 22739-23012 MyWorker                com.example.test                     D  doWork: 我正在做一些工作
2024-01-18 10:35:47.727 22739-22785 WM-WorkerWrapper        com.example.test                     I  Worker result SUCCESS for Work [ id=b0ba1ea9-8028-45ed-80a9-bb404a6f225c, tags={ com.example.test.MyWorker } ]

这是因为，已经在队列中等待执行的任务是不会被取消的，包括重试回退的任务；这里的cancel是周期性任务使用的，在下一次worker进入队列时生效

其他取消方法

请注意，所有取消方法都是尽力而为的

除了cancelAllWorkByTag，还有下面几个取消方法：

  • cancelWorkById 通过id取消

  • cancelUniqueWork 取消工作链中的工作，这个工作链我们后面进阶讲

  • cancelAllWork 取消所有工作

传参和返回参数

在使用WorkManager中，我们有一些场景需要在使用是传参，在return中返回参数，这时我们就需要使用到setInputData方法，接受一个workDataOf方法

在这里插入图片描述
示例代码如下：

        val mWorkerRequest8= OneTimeWorkRequestBuilder<MyWorker>()
            .addTag("myWorker")
            .setInputData(workDataOf( "MY_DATA" to "这是我传的参数"))
            .build()


        //通过WorkManager提交WorkRequest，执行MyWorker
        WorkManager
            .getInstance(this)
            .enqueue(mWorkerRequest8)



        WorkManager.getInstance(this).getWorkInfoByIdLiveData(mWorkerRequest8.id).observe(this) {
            Log.d(TAG, "testWorkManager: ${it.outputData.getString("MY_DATA")}")
        }

方法解析
.setInputData(workDataOf( “MY_DATA” to “这是我传的参数”))`:

这行代码设置了工作请求的输入数据。输入数据可以用来传递参数给 Worker 任务。这里，它设置了一个键为 "MY_DATA" 的数据，值为 "这是我传的参数"。这意味着在 MyWorker 的 doWork() 方法中，可以通过 inputData 获取这个参数。

MyWorker更改为如下：

import android.content.Context
import android.util.Log
import androidx.work.Worker
import androidx.work.WorkerParameters

class MyWorker(appContext: Context, workerParams: WorkerParameters):Worker(appContext, workerParams) {
    companion object{
        private const val TAG = "MyWorker"
    }


    override fun doWork(): Result {


        val input =
            inputData.getString("MY_DATA") ?: return Result.failure()
        Log.d(TAG, "doWork: 我正在做一些工作 $input")
        return Result.success(inputData)
    }

}

这里的inputData就是setInputData中传过来的，然后在success中传递给getWorkInfoByIdLiveData的观察者。

执行结果如下：

2024-01-18 11:35:59.761 12706-12772 MyWorker                com.example.test                     D  doWork: 我正在做一些工作 这是我传的参数
2024-01-18 11:35:59.762 12706-12706 MainActivity            com.example.test                     D  testWorkManager: null
2024-01-18 11:35:59.762 12706-12706 om.example.tes          com.example.test                     I  SmartGc CheckAndAddTask : enable = 1 periodCheck = 1
2024-01-18 11:35:59.781 12706-12750 WM-WorkerWrapper        com.example.test                     I  Worker result SUCCESS for Work [ id=77bfbabb-4234-4db0-8c74-f6d7aeda1b72, tags={ com.example.test.MyWorker, myWorker } ]
2024-01-18 11:35:59.818 12706-12706 MainActivity            com.example.test                     D  testWorkManager: null
2024-01-18 11:35:59.830 12706-12706 MainActivity            com.example.test                     D  testWorkManager: 这是我传的参数

总结

本文主要介绍了WorkManager的一些基础使用，基础基本上学完了，后面学进阶一点的未完期待…

参考资料

WorkManager API
使用 WorkManager 调度任务
官方GitHub 代码示例
WorkManager 使用入门

我怀里的猫
关注
专栏目录
Jetpack ---- WorkManager入门（二）
aha_jasper的博客
12-23 1331
翻译自android官网，可直接去官网观看 Jetpack ---- WorkManager入门（二）三、方法指南一、定义工作请求概览调度一次性工作调度定期工作灵活的运行间隔约束对定期工作的影响工作约束延迟工作重试和退避政策标记工作分配输入数据后续步骤二、工作状态一次性工作的状态定期工作的状态BLOCKED 状态后续步骤三、管理工作唯一工作冲突解决政策观察您的工作复杂的工作查询取消和停止工作停止正在运行的工作器onStopped() 回调isStopped() 属性四、观察工作器的中间进度更新进度观察进度五
Android架构组件JetPack之WorkManager完全解析（五）
AndroidAlvin的博客
11-20 436
阿里P7移动互联网架构师进阶视频（每日更新中）免费学习请点击：https://space.bilibili.com/474380680 什么是Workmanager WorkManager是google提供的异步执行任务的管理框架，会根据手机的API版本和应用程序的状态来选择适当的方式执行任务。当应用在运行的时候会在应用的进程中开一条线程来执行任务，当退出应用时，WorkManag...
深入探秘 WorkManager：Android 异步任务管理的强大工具
最新发布
无尽的大道的专栏
09-25 1466
WorkManager 是 Google 提供的一个异步任务管理框架，它的主要目标是帮助开发者更轻松地管理应用中的异步任务，确保任务在合适的时间和条件下执行，同时提供了强大的功能和灵活性，以满足各种应用场景的需求。WorkManager 的设计理念是将异步任务的管理与应用的生命周期解耦，使得任务的执行不受应用是否处于前台或后台的影响。
Android中的WorkManager
虎哥LoveDroid
06-02 1613
在后台运行任务会消耗设备有限的资源，如RAM和电池。这可能会导致用户体验不佳。例如，后台任务可能会降低设备的电池寿命或用户在观看视频、玩游戏、使用相机等时可能会遇到设备性能不佳的情况。为了提高电池性能，Android在早期版本中发布了一些资源，如Doze模式、应用程序待机、限制位置访问和其他一些内容。
android——workermanager
wy313622821的博客
08-22 310
Android Jetpack WorkManager是一个库，它简化了后台任务管理和异步工作处理，使得开发者可以编写更易于管理、可靠且响应用户交互的应用。WorkManager可以帮助你在合适的时间执行长时间运行的任务，比如定期数据同步、清理缓存等，而不会影响用户体验。。
【Android】WorkManager的使用
每天不是在写bug就是在写bug的路上
07-06 967
WorkManager的使用
Android Jetpack架构组件之WorkManager入门
斌林诚上的博客
03-03 836
——你可以失望，但不能绝望。累的时候可以慢一点，千万不要后退，你还没有拼劲全力。怎么知道没有奇迹。 前言 ——这篇主要是梳理一下Jetpack架构组件之一的Navigation，并结合楼主所学做个总结。面向那些还没接触Navigation的同学们。看完这篇可以快速了解它，并轻松使用。也想请教前辈们指点文章中的错误或不足的地方。本篇只描述Navigation，不会拓展额外的知识,...
Android入门到精通详解 (带目录)
04-01
在Android开发领域，掌握从入门到精通的知识是成为一名专业开发者的关键。这份名为“Android入门到精通详解 (带目录)”的资料全面涵盖了Android开发的基础到高级技术，旨在帮助初学者逐步建立起扎实的技术体系。 ...
Android WorkManager入门（一）
我怀里的猫的博客
12-19 1372
在当今快节奏的生活中，移动设备已经成为我们日常工作和生活不可或缺的一部分。然而，随着应用程序的复杂性不断增加，开发人员面临着一个重要的挑战：如何在后台执行任务，而不会影响用户的体验和设备的性能？在过去，开发人员通常使用传统的后台服务或定时任务来解决这个问题。然而，这些方法往往很复杂，需要大量的代码和资源，并且很难管理和调度任务。幸运的是，谷歌最近推出了一个新的解决方案：安卓WorkManager。安卓WorkManager是一个灵活、强大的后台任务调度库，旨在帮助开发人员轻松管理和执行后台任务。
Jetpack ---- WorkManager入门（三）
aha_jasper的博客
12-23 1173
翻译自android官网，可直接去官网观看 Jetpack ---- WorkManager入门（三）四、先进概念一、自定义WorkManager配置和初始化按需初始化删除默认的初始化程序Implement Configuration.ProviderWorkManager 2.1.0之前的自定义初始化默认初始化自定义初始化（二）WorkManager中的线程总览Threading in WorkerThreading in CoroutineWorkerThreading in RxWorkerThrea
【Android】WorkManager（章二）
sheng_er_sheng的博客
05-17 371
在官方案例的前提下，进行完善。
Android WorkManager使用介绍
pandcu的博客
12-04 1630
WorkManager 是google提供的异步执行任务的管理框架，是 Android Jetpack 的一部分，会根据手机的API版本和应用程序的状态来选择适当的方式执行任务。
Android使用 WorkManager 调度任务
yingaizhu的博客
04-22 8769
一、前言     WorkManager属于Android Jetpack的一部分，通过WorkManager API可以轻松第调度可延迟的任务，即使是那些在应用退出或者设备重启时仍需要运行的任务。 WorkManager的主要功能 最高可向后兼容到 API 14 在 API 23 及以上级别的设备上运行使用 JobScheduler实现 在 API ...
Android Jetpack：WorkManager使用教程
PYJTLK的博客
01-30 1721
介绍 WorkManager是Android Jetpack的一个强大的组件，用于处理后台耗时任务。后台任务可以是一次性的，也可以是重复的。 快速入门 在使用前先把库导进来，其中前两个是必选项。 dependencies { def work_version = "2.7.1" // (Java only) implementation "androidx.work:work-runtime:$work_version" // Kotlin + coroutines
Android架构组件-WorkManager，来自阿里巴巴佛系Android程序员的指南
2201_75604341的博客
03-16 984
更有可能的是，它会希望每隔一段时间检查一次照片，并查看是否有任何新的或改变的图像需要压缩，这个循环任务可以压缩它找到的图像，或者它可以启动新的“压缩图像”任务。假设我们正在开发一个照片库应用，并且该应用程序需要定期压缩其存储的图像，我们想使用 WorkManager API 调度图像压缩任务，在这种情况下，我们并不需要关心压缩发生在何时，我们只需要设置这个任务然后就可以忘记它。：指定我们需要执行的任务。”，想要写出优秀的代码，最重要的一点还是自身的技术水平，不然用再好的工具也不能发挥出它的全部实力。
android原生开发框架，android基础入门
2401_84415126的博客
04-21 949
对于很多初中级Android工程师而言，想要提升技能，往往是自己摸索成长。而不成体系的学习效果低效漫长且无助。时间久了，付出巨大的时间成本和努力，没有看到应有的效果，会气馁是再正常不过的。所以学习一定要找到最适合自己的方式，有一个思路方法，不然不止浪费时间，更可能把未来发展都一起耽误了。如果你是卡在缺少学习资源的瓶颈上，那么刚刚好我能帮到你。《互联网大厂面试真题解析、进阶开发核心学习笔记、全套讲解视频、实战项目源码讲义》点击传送门即可获取！起耽误了。
Android WorkManager 初探
xiaokangss的博客
11-27 117
在日常开发中，有些任务需要在异步线程执行，并且这些工作耗时较长，通过普通的子线程或后台服务无法胜任时，就需要 WorkManager 了。
Android 架构组件之 WorkManager 的使用指南及项目实践
小羊子的技术专栏
02-07 3815
Android 架构组件之 WorkManager 的使用指南及项目实践
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

我怀里的猫

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值