网上学习资料一大堆,但如果学到的知识不成体系,遇到问题时只是浅尝辄止,不再深入研究,那么很难做到真正的技术提升。
一个人可以走的很快,但一群人才能走的更远!不论你是正从事IT行业的老鸟或是对IT行业感兴趣的新人,都欢迎加入我们的的圈子(技术交流、学习资源、职场吐槽、大厂内推、面试辅导),让我们一起学习成长!
//表示任务执行成功
Result.success()
} catch (e: IOException) {
//重试,WorkManager根据配置的策略过一段时间重新执行
Result.retry()
} catch (e: Exception) {
//表示任务执行失败
Result.failure()
}
}
private fun updateAppData() {
//耗时操作
}
}
#### CoroutineWorker
如果你想使用协程,可以继承`CoroutineWorker`。继承`CoroutineWorker`之后`doWork`将会是一个`suspend`方法,因此你可以使用协程进行任务处理。下面是一个例子。
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
顾名思义,这种工作请求是一次性的。我这里介绍一些常用的设置,下面给出示例代码并介绍。
val workRequest = OneTimeWorkRequestBuilder()
.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`。
//一个参数的构造方法
PeriodicWorkRequestBuilder(
Duration.ofHours(1)//repeatInterval
).build()
//两个个参数的构造方法
PeriodicWorkRequestBuilder(
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`了。
这里介绍常用的两种添加类型
//添加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,则会根据这个参数进行如下行为。
![img](https://img-blog.csdnimg.cn/img_convert/a72ae85c1c2d1f030136ee3def06b05d.png)
![img](https://img-blog.csdnimg.cn/img_convert/482d7640fbf302d28702c43bb3d35d6d.png)
**网上学习资料一大堆,但如果学到的知识不成体系,遇到问题时只是浅尝辄止,不再深入研究,那么很难做到真正的技术提升。**
**[需要这份系统化的资料的朋友,可以戳这里获取](https://bbs.csdn.net/topics/618636735)**
**一个人可以走的很快,但一群人才能走的更远!不论你是正从事IT行业的老鸟或是对IT行业感兴趣的新人,都欢迎加入我们的的圈子(技术交流、学习资源、职场吐槽、大厂内推、面试辅导),让我们一起学习成长!**
*网上学习资料一大堆,但如果学到的知识不成体系,遇到问题时只是浅尝辄止,不再深入研究,那么很难做到真正的技术提升。**
**[需要这份系统化的资料的朋友,可以戳这里获取](https://bbs.csdn.net/topics/618636735)**
**一个人可以走的很快,但一群人才能走的更远!不论你是正从事IT行业的老鸟或是对IT行业感兴趣的新人,都欢迎加入我们的的圈子(技术交流、学习资源、职场吐槽、大厂内推、面试辅导),让我们一起学习成长!**