WorkManager
是Android Jetpack
库的一部分,用于简化在Android应用程序中执行后台任务的管理。它提供了一种灵活、可靠的方式来调度和执行异步任务,而无需开发人员过多关注任务的管理和设备状态。
介绍
下面是WorkManager
的一些关键特性和用途:
- 任务调度:
WorkManager
允许你定义需要执行的任务,包括延迟执行、定时执行和根据触发条件执行的任务。你可以创建单次或重复性任务。 - 任务链: 你可以创建任务链,将多个任务按顺序排列,以确保它们以特定顺序执行。这对于处理复杂的工作流非常有用。
- 约束:
WorkManager
支持约束,这意味着你可以指定任务执行的条件,例如在特定网络状态下、设备充电时等。这有助于减少不必要的任务执行,提高电池寿命和性能。 - 后台适应性:
WorkManager
能够选择最佳的后台任务调度方法,以适应不同Android版本和制造商的设备。它在Android 2.3(API级别 9)及更高版本中运行,并针对不同版本使用不同的后台任务调度API。 - 持久性:
WorkManager
具有内置的持久性,可以保证任务即使在设备重启后也能够继续执行。这有助于确保任务完成,而不会丢失。 - 观察和反馈: 你可以观察任务的执行状态,包括成功、失败、取消等。这为有效的错误处理提供了机会。
- 简化多线程:
WorkManager
处理了多线程的复杂性,使任务管理和执行更加简单。
WorkManager
的推荐使用场景如下。
- 如果你需要定期执行某些任务,即使重启手机和关闭APP。
- 如果你有一些任务,需要在用户有Wi-Fi或充电状态的时候执行,如上传任务。
- 如果你的任务是一个复杂的任务链,
WorkManager
可以将其中一个任务的输出作为另一个任务的输入,以便实现更复杂的任务流程,例如图片处理。 - 可用于在后台定期同步应用数据,以确保数据保持最新。
- 如果你想要发送日志到后端。
存在的坑,因为有很多安卓厂商为了保证电池的续航,所以当你的应用被退出后,任务的执行可能不是很及时(特别是VIVO),除非在设置页面将APP的电池优化关闭。
与协程和AlarmManager的区别
API | 推荐用法 | 与WorkManager的关系 |
---|---|---|
协程 | 用来执行所有不需要维持的异步任务。 | 协程是用来处理非主线程工作任务的。因为协程退出APP后就会被停止,所以如果想要确保工作在退出APP后还能执行的话请使用WorkManger 。 |
AlarmManager | 定时提醒。 | AlarmManager 会将设备从 Doze mode 中唤醒,因此会比较耗电。除了需要精确执行提醒或者通知外,请使用WorkManager代替。 |
引入WorkManager
groovy
// Java用这个
implementation("androidx.work:work-runtime:2.7.1")
// Kotlin用这个,支持协程。
implementation("androidx.work:work-runtime-ktx:2.7.1")
基本使用
创建Worker
Worker
是负责处理任务的,在doWork()
中进行耗时任务的处理,然后返回一个Result
,Result
可以是Success
、Failure
、Retry
,其中Success
和Failure
表示任务的执行情况,Retry
表示需要重新执行一次doWork()
,WorkManager
根据配置的策略过一段时间重新执行。
Worker
这是一个更新APP数据的Woker
,在doWork
进行逻辑处理。
kotlin
class UpdateWork(appContext: Context, params: WorkerParameters) : Worker(appContext, params) {
override fun doWork(): Result {
return try {
//更新APP数据
updateAppData()
//表示任务执行成功
Result.success()
} catch (e: IOException) {
//重试,WorkManager根据配置的策略过一段时间重新执行
Result.retry()
} catch (e: Exception) {
//表示任务执行失败
Result.failure()
}
}
private fun updateAppData() {
//耗时操作
}
}
CoroutineWorker
如果你想使用协程,可以继承CoroutineWorker
。继承CoroutineWorker
之后doWork
将会是一个suspend
方法,因此你可以使用协程进行任务处理。下面是一个例子。
kotlin
class UpdateWork(appContext: Context, params: WorkerParameters) : CoroutineWorker(appContext, params) {
override suspend fun doWork(): Result {
return try {
//设置超时时间一分钟
val success = withTimeout(1.minutes) {
//执行挂起函数
updateAppData()
}
//根据执行结果返回success或者failure
if (success) Result.success() else Result.failure()
} catch (e: TimeoutCancellationException) {
//一分钟内没执行完毕,重试。
Result.retry()
}
}
//这是一个挂起函数
private suspend fun updateAppData(): Boolean {
//耗时操作
delay(1000)
return Random.nextInt(2) == 0
}
}
创建WorkRequest
刚才创建了Worker
,Worker
是来执行任务的。但是什么时候执行,怎么样执行以及携带什么数据则是由WorkRequest
来设置的,也就是说使用WorkRequest
来制定Worker
工作的条件和时机。下面介绍OneTimeWorkRequest
一次性任务和PeriodicWorkRequest
周期性任务。
OneTimeWorkRequest
顾名思义,这种工作请求是一次性的。我这里介绍一些常用的设置,下面给出示例代码并介绍。
kotlin
val workRequest = OneTimeWorkRequestBuilder<UpdateWork>()
.setConstraints(
Constraints.Builder()
.setRequiredNetworkType(NetworkType.UNMETERED)
.setRequiresBatteryNotLow(true)
.setRequiresCharging(true)
.setRequiresDeviceIdle(true)
.setRequiresStorageNotLow(true)
.build()
)
.setInitialDelay(Duration.ofMinutes(1))
.setBackoffCriteria(
BackoffPolicy.LINEAR,
Duration.ofMinutes(1)
)
.setInputData(
workDataOf(
UpdateWork.WORK_DATA_ID to "work data",
)
)
.build()
Constraints
指定工作会在什么指定的条件下才执行,上面示例代码的含义如下。
setRequiredNetworkType
:网络类型。NOT_REQUIRED
,不需要网络。CONNECTED
,网络连接的状态。UNMETERED
,Wi-Fi等不需要计费的网络。NOT_ROAMING
,非漫游网络。METERED
,计费网络
setRequiresBatteryNotLow
:设置true的时候,Worker
只有在非省电模式的时候运行。setRequiresCharging
:设置true的时候,Worker
需要在充电状态才会运行。setRequiresDeviceIdle
:设置true的时候,Worker
会在设备闲置的时候运行。如果你的任务逻辑是比较消耗性能的话,可以设置成true,这样的话不会影响用户在使用设备时候的体验。setRequiresStorageNotLow
:设置为true的话,Worker
只会在存储空间充足的时候运行。
InitialDelay
Woker
要执行doWork()
前,进行一个特定的延迟时间,上面示例代码所设置的时间为1分钟。
BackoffCriteria
Worker
返回Result.retry()
的时候代表工作需要重新执行,那么就需要用这个方法来设置重试策略和时机。
-
先说第二个参数,很明显,就是重试的延迟时间,我这里设置的是1分钟,可以设置的最低时间是10秒。
-
第一个参数
BackoffPolicy
目前有两种。LINEAR
:线性的增加时间。第一次重试会在1分钟后执行,如果重试后还是失败则会延迟2分钟后执行,如果还是失败则3分钟以此类推。EXPONENTIAL
:指数的增加时间。第一次重试会在1分钟后执行,如果重试后还是失败则会延迟2分钟后执行,如果还是失败则4分钟以此类推。
InputData
用来传输数据,在这里设置后Worker
可以使用inputData.getXXX()
获取到这里传过去的数据
PeriodicWorkRequest
如果你想要执行周期性的任务,及时APP退出了也会执行,比如上传日志,更新配置等,可以使用PeriodicWorkRequest
。
kotlin
//一个参数的构造方法
PeriodicWorkRequestBuilder<UpdateWork>(
Duration.ofHours(1)//repeatInterval
).build()
//两个个参数的构造方法
PeriodicWorkRequestBuilder<UpdateWork>(
Duration.ofHours(1),//repeatInterval
Duration.ofMinutes(15)//flexTimeInterval
).build()
使用方法和刚才介绍的OneTimeWorkRequest
一样也是可以设置各种执行条件和时机,不同的是PeriodicWorkRequestBuilder
需要设置repeatInterval
,另外一个参数flexTimeInterval
是可选的,如果不设置则与repeatInterval
一样。
repeatInterval
指定执行的周期,上面的代码设置的执行周期为一个小时。在这一个周期的什么时候执行是不确定的,但是能确保的是每一个执行周期内会执行一次。最小可以设置的值为15分钟。
flexTimeInterval
如果你想要你的任务执行的时机比较准确。换句话说,你想要每次任务执行的间隔都差不多,差不多每一小时执行一次。那么你可以设置flexTimeInterval
。上面的代码中,flexTimeInterval
设置的值为15分钟,也就是说,在每个时长为一小时的执行周期中,最后十五分钟才会执行你的任务。flexTimeInterval
最小设置的值为5分钟。
添加WorkRequest
最后一步,就是添加WorkRequest
到WorkManager
了。
这里介绍常用的两种添加类型
kotlin
//添加WorkRequest到WorkManager
WorkManager.getInstance(this).enqueue(oneTimeWorkRequest)
//添加唯一的oneTimeWorkRequest到WorkManager
WorkManager.getInstance(this).enqueueUniqueWork(
TAG,
ExistingWorkPolicy.KEEP,
oneTimeWorkRequest
)
//添加唯一的periodicWorkRequest到WorkManager
WorkManager.getInstance(this).enqueueUniquePeriodicWork(
TAG,
ExistingPeriodicWorkPolicy.KEEP,
periodicWorkRequest
)
enqueue
这个方法可以添加oneTimeWorkRequest
和periodicWorkRequest
,添加后WorkManager
会根据WorkRequest
所设置的条件执行Worker
的doWork()
。
enqueueUniqueWork
这个方法只添加oneTimeWorkRequest
,一共有三个参数。
- 第一个参数
uniqueWorkName
:可以认为是本次任务执行的id。 - 第二个参数
existingWorkPolicy
:加入任务的时候WorkManager
的还未执行的任务中存在了第一个参数的id,则会根据这个参数进行如下行为。REPLACE
:删除掉之前的任务,添加这一个。KEEP
:什么都不做,相当于这次的enqueue
取消掉了。APPEND
:作为之前那个任务的子任务,前面执行成功后这个再执行。如果前面的任务执行失败或取消,这个任务也不会执行。APPEND_OR_REPLACE
:作为之前那个任务的子任务,无论前面的任务是否成功,这个任务也会执行。
- 第三个参数
work
:添加的oneTimeWorkRequest
。
enqueueUniquePeriodicWork
与enqueueUniqueWork
差不多,唯一的区别就是第二个参数existingWorkPolicy
。
PeriodicWork
的existingWorkPolicy
只支持REPLACE
和KEEP
。
总结
Worker
是负责处理任务的。- 使用
WorkRequest
来制定Worker
工作的条件和时机。 - 调用
WorkManager
的enqueue
方法添加任务到WorkManager
里面,等待执行。
好了,到这里已经介绍的差不多了,大家有空可以试一下~
