Android WorkManager入门（二）

WorkManager入门

  • 上一篇
  • 前言
  • 创建 WorkRequest并提交 定时的任务（PeriodicWorkRequest）
  • 配合约束使用
  • 定义执行范围
  • 失败后的重试
  • 为WorkRequest打上TAG
    • 其他取消方法
  • 传参和返回参数
  • 总结
  • 参考资料

上一篇

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.WorkerParametersclass 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，执行MyWorkerWorkManager.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，执行MyWorkerWorkManager.getInstance(this).enqueue(mWorkerRequest4)

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

定义执行范围

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

  //每小时的最后 15 分钟内运行的定期工作val mWorkerRequest5 =PeriodicWorkRequestBuilder<MyWorker>(1, TimeUnit.HOURS, // 执行周期15, TimeUnit.MINUTES) // 实际执行时间.build()//通过WorkManager提交WorkRequest，执行MyWorkerWorkManager.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.WorkerParametersclass 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 = trueif (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，执行MyWorkerWorkManager.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，执行MyWorkerWorkManager.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，执行MyWorkerWorkManager.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.WorkerParametersclass 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 使用入门

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.hqwc.cn/news/414874.html

如若内容造成侵权/违法违规/事实不符，请联系编程知识网进行投诉反馈email:809451989@qq.com，一经查实，立即删除！

相关文章

GZ036 区块链技术应用赛项赛题第3套

GZ036 区块链技术应用赛项赛题第3套

2023年全国职业院校技能大赛 高职组 “区块链技术应用” 赛项赛卷&#xff08;3卷&#xff09; 任 务 书 参赛队编号&#xff1a; 背景描述 新能源作为新兴领域&#xff0c;产业呈现碎片化与复杂化的特性&#xff0c;逐渐出现管理困难、供应链金融、可信监管与数…
阅读更多...
OpenAI GPT应用商城正式上线！超300万个GPT应用供选择

OpenAI GPT应用商城正式上线！超300万个GPT应用供选择

原创 | 文 BFT机器人 千呼万唤始出来&#xff0c;终于在北京时间1月11日凌晨&#xff0c;OpenAI在官网发布了令人振奋的消息&#xff1a;备受瞩目的GPT store正式上线&#xff01; 这个商店旨在让团体和企业用户轻松找到那些既实用又热门的GPT应用。在这里&#xff0c;用户可以…
阅读更多...
rust使用protobuf

rust使用protobuf

前言 c,java,go 等直接是用 &#xff0c;具体就不说了&#xff0c;这章主要讲述rust 使用protobuf 这章主要讲述2种 1 > protoc protoc-gen-rust plugin 2> protoc prost-build 1&#xff1a;环境 win10 rustrover64 25-2 下载地址 https://github.com/protocolbu…
阅读更多...
线性代数基础【5】特征值和特征向量

线性代数基础【5】特征值和特征向量

第五章 特征值和特征向量 第一节、特征值和特征向量的基本概念 一、特征值和特征向量的理论背景 在一个多项式中,未知数的个数为任意多个,且每一项次数都是2的多项式称为二次型,二次型分为两种类型:即非标准二次型及标准二次型 注意: ①二次型X^T AX为非标准二次型的充分必…
阅读更多...
Git学习笔记（第3章）：Git常用命令

Git学习笔记（第3章）：Git常用命令

目录 3.1 设置用户签名 3.2 初始化本地库 3.3 查看本地库状态 3.4 添加暂存区 3.5 提交本地库 3.6 历史版本 3.7 修改文件 3.8 版本穿梭 小结 命令 作用 git config --global user.name 用户名 设置用户签名 git config --global user.email 邮箱 设置用户签名 …
阅读更多...
大模型学习与实践笔记（六）

大模型学习与实践笔记（六）

一、finetune 简介 两种微调模式&#xff1a;增量预训练 与指令跟随 1.增量预训练 2.指令微调 二、LoRA 与 QLoRA 介绍 三、XTuner 介绍 四、低显存玩转LLM的方法
阅读更多...
【Flink-CDC】Flink CDC 介绍和原理概述

【Flink-CDC】Flink CDC 介绍和原理概述

【Flink-CDC】Flink CDC 介绍和原理概述 1&#xff09;基于查询的 CDC 和基于日志的 CDC2&#xff09;Flink CDC3&#xff09;Flink CDC原理简述4&#xff09;基于 Flink SQL CDC 的数据同步方案实践4.1.案例 1 : Flink SQL CDC JDBC Connector4.2.案例 2 : CDC Streaming ETL…
阅读更多...
OR-343，IGBT驱动光耦，替代ACPL-W343，TLP5702等

OR-343，IGBT驱动光耦，替代ACPL-W343，TLP5702等

OR-343 具有MOSFET高输入阻抗和GTR低导通压降特性提供隔离反馈 高隔离电压 4.0 A 最大峰值输出电流 3.0 A 最小峰值输出电流 工业温度范围&#xff1a;–40C 至 105C 宽工作 VCC 范围 特征 轨到轨输出电压 。 带迟滞的 LED 电流输入 ICC&#xff08;最大值&#xff…
阅读更多...
Ubuntu下将nvidia-smi封装为GUI界面，实时查看显卡信息

Ubuntu下将nvidia-smi封装为GUI界面，实时查看显卡信息

和win系统不同的是&#xff0c;在Ubuntu端&#xff0c;系统级的系统监视器中&#xff0c;只能查看内存、CPU和网络状态&#xff0c;并不能查看GPU状态 而使用NVIDIA显卡的朋友都知道一条指令 nvidia-smi 在终端运行后即可查看显卡信息、资源占用情况等 但是这样会占用终端&am…
阅读更多...
C Primer Plus 第6版 编程练习 chapter 16

C Primer Plus 第6版 编程练习 chapter 16

文章目录 1. 第1题1.1 题目描述1.2 编程源码1.3 结果显示 2. 第2题2.1 题目描述2.2 编程源码2.3 结果显示 3. 第3题3.1 题目描述3.2 编程源码3.3 结果显示 4. 第4题4.1 题目描述4.2 编程源码4.3 结果显示 5. 第5题5.1 题目描述5.2 编程源码5.3 结果显示 6. 第6题6.1 题目描述6.…
阅读更多...
2024年甘肃省职业院校技能大赛信息安全管理与评估 样题三 理论题

2024年甘肃省职业院校技能大赛信息安全管理与评估 样题三 理论题

竞赛需要完成三个阶段的任务&#xff0c;分别完成三个模块&#xff0c;总分共计 1000分。三个模块内容和分值分别是&#xff1a; 1.第一阶段&#xff1a;模块一 网络平台搭建与设备安全防护&#xff08;180 分钟&#xff0c;300 分&#xff09;。 2.第二阶段&#xff1a;模块二…
阅读更多...
新手也能看懂的【前端自动化测试入门】！

新手也能看懂的【前端自动化测试入门】！

前言 最近在网上搜索前端自动化测试相关的文档&#xff0c;但是发现网上的文章都是偏使用&#xff0c;没有把一些基础概念说清楚&#xff0c;导致后续一口气遇到一些karma、Jasmine、jest、Mocha、Chai、BDD等词汇的时候很容易一头雾水&#xff0c;这次一方面整理一下收获的知…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023