Kotlin WorkManager使用方法详解

 更新时间:2023年01月20日 11:25:08   作者:Hdnw  
这篇文章主要介绍了Kotlin WorkManager使用方法,WorkManager是 安卓体系结构之一,也是Android JetPack的一部分。WorkManager用于可延期并需要保证执行的后台工作

WorkMananger的简介

Google推出WorkManager组件,WorkManager很适合用于处理一些要求定时执行的任务,它可以根据操作系统的版本自动选择底层是使用AlarmManager实现还是JobScheduler实现,从而降低了我们的使用成本。另外,它还支持周期性任务,链式任务处理等功能,是一个非常强大的工具。

WorkManager的基本用法

在app/build.gradle文件添加依赖

 implementation "androidx.work:work-runtime:2.7.1"

WorkManager的基本用法其实非常简单,主要分为以下3步:

  • 定义一个后台任务,并实现具体的任务逻辑。
  • 配置该后台任务的运行条件和约束信息,并构建后台任务请求。
  • 将该后台任务请求传入WorkManager的enqueue()方法中,系统会在合适的时间运行。

第一步要定义一个后台任务,这里创建一个SimpleWorker类,代码如下所示:

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

第二步,配置后台任务的运行条件和约束信息,代码如下所示:

 //设置约束条件
 //NetworkType.CONNECTED 最通用的连上网络
 //NetworkType.UNMETERED  WF
 //NetworkType.METERED 流量,4G
  val constraints: Constraints =Constraints.Builder()
       .setRequiredNetworkType(NetworkType.CONNECTED)
       .build()
  val request=OneTimeWorkRequest.Builder(SimpleWorker::class.java)
        .setConstraints(constraints)
        .build()

最后一步,将构建出的后台任务请求传入WorkManager的enqueue()方法中,系统就会在合适的时间去运行了,代码如下所示:

WorkManager.getInstance(context).enqueue(request)

使用WorkManager处理复杂的任务

(1)让后台任务在指定的推迟时间后运行

val request=OneTimeWorkRequest.Builder(SimpleWorker::class.java)
                .setInitialDelay(5,TimeUnit.MINUTES)
                .build()

(2)给后台任务请求添加标签

val request=OneTimeWorkRequest.Builder(SimpleWorker::class.java)
                ...
                .addTag("simple")
                .build()

(3)通过标签来取消后台任务请求

WorkManager.getInstance(this).cancelAllWorkByTag("simple")

(4)即使没有标签,也可以通过id来取消后台任务请求

WorkManager.getInstance(this).cancelAllWorkById(request.id)

(5) 一次性取消所有后台任务请求

WorkManager.getInstance(this).cancelAllWork()

(6)如果后台任务的doWork()方法中返回了Result.retry(),那么是可以结合setBackoffCriteria()方法来重新执行任务的。

setBackoffCriteria():第一个参数用于指定如果任务失败再次执行失败,下次重试的时间应该以什么样的形式延迟,可选值有两种:1.LINEAR,代表下次重试时间以线性的方式延迟。2.EXPONENTIAL,代表下次重试时间以指数的方式延迟。第二个参数和第三个参数用于指定在多久之后重新执行任务,时间最短不能少于10秒钟。

val request=OneTimeWorkRequest.Builder(SimpleWorker::class.java)
                ...
                .setBackoffCriteria(BackoffPolicy.LINEAR,10,TimeUnit.SECONDS)
                .build()

(7)doWork方法中返回Result.success()和Result.failure()又有什么作用?这两个返回值其实就是用于通知任务运行结果的,我们可以使用如下代码对后台任务的运行结果进行监听:

WorkManager.getInstance(this).getWorkInfoByIdLiveData(request.id).observer(this){workInfo->
    if(workInfo.state==WorkInfo.State.SUCCEEDED){
        Log.d("MainActivity","do work succeeded")
    }else if(workInfo.state==WorkInfo.State.FAILED){
         Log.d("MainActivity","do work failed")
    }
}

链式任务

假如这里定义了3个独立的后台任务:同步数据,压缩数据和上传数据。现在我们想要实现先同步,再压缩,最后上传的功能,就可以借助链式任务来实现。

val sync=...
val compress=...
val upload=...
WorkManager.getInstance(this)
   .beginWith(sync)
   .then(compress)
   .then(upload)
   .enqueue()

到此这篇关于Kotlin WorkManager使用方法详解的文章就介绍到这了,更多相关Kotlin WorkManager内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

您可能感兴趣的文章:

相关文章

  • Android进程间通信(IPC)机制Binder简要介绍

    Android进程间通信(IPC)机制Binder简要介绍

    本文主要介绍 Android进程间通信(IPC)机制Binder简要介绍, 这里介绍了Binder机制如何实现进程通信机制,有研究Android源码的朋友可以看下
    2016-08-08
  • Android shape标签使用方法介绍

    Android shape标签使用方法介绍

    shape算是我们常用的一个标签,他可以生成线条,矩形, 圆形, 圆环,像我们圆角的按钮就可以通过shape来实现,最终Android会把这个带有shape标签的图片解析成一个Drawable对象,这个Drawable对象本质是GradientDrawable
    2022-09-09
  • Android View 事件分发机制详解

    Android View 事件分发机制详解

    本文主要介绍Android View 事件分发机制,这里整理了相关资料并详细介绍了view分发机制的知识及简单示例代码,有兴趣的小伙伴可以参考下
    2016-08-08
  • Android实现动态圆环的图片头像控件

    Android实现动态圆环的图片头像控件

    这篇文章主要为大家详细介绍了Android实现带有动态圆环的圆形图片控件DynamicAvatarView的相关代码,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2016-11-11
  • 谈谈Android里的Context的使用实例

    谈谈Android里的Context的使用实例

    这篇文章主要介绍了谈谈Android里的Context的使用实例,具有一定的参考价值,感兴趣的小伙伴们可以参考一下。
    2016-11-11
  • flutter直接上传文件到阿里云oss

    flutter直接上传文件到阿里云oss

    上传视频到oss,之前是走后端上传到oss,会有一个问题就是我要先上传给后端,后端再上传给oss就会导致上传多次,消耗时间过长影响用户体验,所以我参考文档写了直接上传到阿里云oss获取到文件访问路径。
    2021-05-05
  • Android集成百度地图开发流程和注意事项

    Android集成百度地图开发流程和注意事项

    现在很多项目都需要集成百度地图,所以就把自己做过一个项目的经验写出来和大家分享,方便自己和大家使用的时候参考借鉴,下面就来一起看看Android集成百度地图开发流程和注意事项吧。
    2016-09-09
  • Android中退出确认框的实现代码

    Android中退出确认框的实现代码

    这篇文章主要介绍了Android中退出确认框的实现代码的相关资料,需要的朋友可以参考下
    2017-05-05
  • Android 屏幕切换监听的实例代码

    Android 屏幕切换监听的实例代码

    我试着在屏幕切换时,使View显示在不同的位置,在网上搜索了一些资料,自己做了一段时间,终于完成了功能,今天小编给大家分享android 屏幕切换监听的实例代码,需要的的朋友参考下吧
    2017-01-01
  • Android自定义流式布局实现淘宝搜索记录

    Android自定义流式布局实现淘宝搜索记录

    这篇文章主要为大家详细介绍了Android自定义流式布局实现淘宝搜索记录,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2020-10-10

最新评论