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客户端实现注册、登录详解(2)

    Android客户端实现注册、登录详解(2)

    这篇文章主要为大家详细介绍了Android客户端实现注册、登录代码第二篇,App与服务器的交互实现登录和自动登录功能,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2016-11-11
  • Android camera实时预览 实时处理,人脸识别示例

    Android camera实时预览 实时处理,人脸识别示例

    本篇文章主要介绍了Android camera实时预览 实时处理,面部认证示例,具有一定的参考价值,有兴趣的可以了解一下。
    2017-01-01
  • Android平台下轻量级http网络传输库

    Android平台下轻量级http网络传输库

    这篇文章主要介绍了Android平台下轻量级http网络传输库的相关资料,需要的朋友可以参考下
    2016-01-01
  • Android开发之WebView组件的使用解析

    Android开发之WebView组件的使用解析

    WebView 类是 WebKit 模块 Java 层的视图类, 所有需要使用 Web 浏览功能的Android应用程序都要创建该视图对象显示和处理请求的网络资源,接下来将详细介绍,需要了解的朋友可以参考下
    2012-12-12
  • 自定义View之kotlin绘制折线图实例教程

    自定义View之kotlin绘制折线图实例教程

    折线图是我们在开发中经常会遇到的一个需求,下面这篇文章主要给大家介绍了关于自定义View之kotlin绘制折线图的相关资料,文中通过示例代码介绍的非常详细,需要的朋友可以参考借鉴,下面随着小编来一起学习学习吧
    2018-09-09
  • Android屏幕旋转之横屏竖屏切换的实现

    Android屏幕旋转之横屏竖屏切换的实现

    这篇文章主要介绍了Android屏幕旋转之横屏竖屏切换的实现,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2019-10-10
  • Android Studio 常见问题及解决方法(推荐)

    Android Studio 常见问题及解决方法(推荐)

    这篇文章主要介绍了Android Studio 常见问题及解决方法,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2020-08-08
  • Flutter Map常用操作方法总结

    Flutter Map常用操作方法总结

    Flutter 中的 Map 是一种键值对的集合,可以存储任意类型的数据,并且可以通过键来访问和操作对应的值,下面我们就来学习一下Flutter Map的常用操作方法吧
    2023-11-11
  • Android获取当前运行的类名或者方法

    Android获取当前运行的类名或者方法

    这篇文章主要介绍了Android获取当前运行的类名或者方法,涉及Android操作类与方法的技巧,需要的朋友可以参考下
    2015-05-05
  • Android中findViewById获取控件返回为空问题怎么解决

    Android中findViewById获取控件返回为空问题怎么解决

    这篇文章主要介绍了Android中findViewById获取控件返回为空问题怎么解决的相关资料,非常不错,具有参考借鉴价值,需要的朋友可以参考下
    2016-06-06

最新评论