一、WorkManager 特點及適用場景
特點
- 保證任務一定會被執(zhí)行
WorkManager 有自己的數(shù)據(jù)庫余蟹，每一個任務的信息與任務狀態(tài)卷胯，都會保存在本地數(shù)據(jù)庫中。所以即使程序沒有在運行威酒，或者在設(shè)備重啟等情況下窑睁，WorkManager 依然可以保證任務的執(zhí)行，只是不保證任務立即被執(zhí)行葵孤。 - 合理使用設(shè)備資源
在執(zhí)行很多周期性或非立即執(zhí)行的任務時担钮，WorkManager 提供我們 API，幫助我們合理利用設(shè)備資源尤仍，避免不必要的內(nèi)存箫津，流量，電量等消耗吓著。
適用場景
- 可延遲進行的任務
a. 滿足某些條件才執(zhí)行的任務鲤嫡，如需要在充電時才執(zhí)行的任務。
b. 用戶無感知或可延遲感知的任務绑莺，如同步配置信息暖眼，同步資源，同步通訊錄等纺裁。 - 定期重復性任務诫肠，但時效性要求不高的，如定期log上傳欺缘，數(shù)據(jù)備份等栋豫。
- 退出應用后還應繼續(xù)執(zhí)行的未完成任務。
二谚殊、WorkManager 的各個角色
Worker
需要執(zhí)行的任務丧鸯，這是一個抽象類我們需要繼承它，在doWork()方法中實現(xiàn)我們自己的業(yè)務邏輯嫩絮。-
WorkRequest
工作請求丛肢，每個 Worker 想要被執(zhí)行都需要向 WorkManager 發(fā)出一個 WorkRequest，同時在 WorkRequest 中指定 Worker 執(zhí)行的條件剿干。- WorkRequest對象必須指定Work執(zhí)行的任務
- WorkRequest都有一個自動生成的唯一ID蜂怎，可以使用ID執(zhí)行取消
排隊任務 或 獲取任務狀態(tài)等操作 - WorkRequest是一個抽象的類；系統(tǒng)默認實現(xiàn)子類 OneTimeWorkRequest 或 PeriodicWorkRequest
- WorkRequest.Builder 創(chuàng)建 WorkRequest 對象置尔；相應的子類：
OneTimeWorkRequest.Builder 或 PeriodicWorkRequest.Builder - Constraints：指定對任務運行時間的限制（任務約束）杠步；使用
Constraints.Builder 創(chuàng)建 Constraints 對象 ，并傳遞給 WorkRequest.Builder
WorkManager的簡述
WorkManager：排隊和管理工作請求；將WorkRequest 對象傳遞WorkManager的任務隊列（注意：如果未指定任何約束幽歼， WorkManager立即運行任務）
三朵锣、WorkManager 使用
首先需要添加依賴
def work_version = "2.4.0"
implementation "androidx.work:work-runtime:$work_version"
WorkManager 最新版本查看Google 官方地址： WorkManager 最新版本地址
WorkManager的使用步驟：
- 創(chuàng)建一個后臺任務Worker。
- 定義WorkRequest试躏，配置運行任務的方式和時間猪勇。
- 將任務提交給系統(tǒng)處理。
- 觀察Worker的進度或狀態(tài)颠蕴。
然后介紹 WorkManager 的幾種使用方式：
- 基本使用
- 數(shù)據(jù)互相傳遞
- 多個任務 順序執(zhí)行
- 重復執(zhí)行后臺任務
- 約束條件泣刹，約束后臺任務執(zhí)行
1. WorkManager 基本使用
繼承 Worker 類，覆蓋 doWork() 方法犀被，所有需要在任務中執(zhí)行的代碼都在該方法中編寫椅您。
WorkManager 提供了四種 Worker 的創(chuàng)建模式：
- Worker：最簡單的實現(xiàn)，WorkManager 會在后臺線程上自動運行它寡键。
- CoroutineWorker：CoroutineWorker 針對后臺工作公開掛起函數(shù)掀泳。默認情況下，它們運行默認的 Dispatcher西轩。
- RxWorker：如果有很多現(xiàn)有異步代碼是用 RxJava 建模的建議使用员舵。與所有 RxJava2 概念一樣，可以自由選擇所需的線程處理策略藕畔。
- ListenableWorker：是 Worker马僻，CoroutineWorker，RxWorker 的基類注服，為需要與基于回調(diào)的異步 API 進行交互并且不使用 RxJava2 的 Java 開發(fā)者而設(shè)計韭邓。
Worker的創(chuàng)建示例：
//新建一個繼承 Worker 的類
public class MainWorker1 extends Worker {
private final static String TAG = MainWorker1.class.getSimpleName();
public MainWorker1(@NonNull Context context, @NonNull WorkerParameters workerParams) {
super(context, workerParams);
}
@NonNull @Override public Result doWork() {
Log.d(TAG, "MainWorker1 doWork: run started ... ");
try {
Thread.sleep(8000); // 睡眠
} catch (Exception e) {
e.printStackTrace();
return Result.failure(); // 本次任務失敗
} finally {
Log.d(TAG, "MainWorker1 doWork: run end ... ");
}
/**
* 返回值一共有五種
* 基礎(chǔ)的有是三種
* Result.success() // 執(zhí)行成功
* Result.retry() // 執(zhí)行失敗
* Result.failure() // 重新執(zhí)行
* 剩下兩種是帶有輸出數(shù)據(jù)
* Result.success(Data outputData)
* Result.failure(Data outputData)
*/
return Result.success();// 本次任務成功
}
}
// 構(gòu)建一個請求，只執(zhí)行一次的 OneTimeWorkRequest
OneTimeWorkRequest oneTimeWorkRequest = new OneTimeWorkRequest.Builder(MainWorker1.class).build();
// 將任務提交給系統(tǒng)溶弟。WorkManager.enqueue()方法會將你配置好的WorkRequest交給系統(tǒng)來執(zhí)行女淑。
WorkManager.getInstance(this).enqueue(oneTimeWorkRequest);
運行結(jié)果：
2. WorkManager 數(shù)據(jù)互相傳遞
public class MainWorker2 extends Worker {
public final static String TAG = MainWorker2.class.getSimpleName();
private WorkerParameters workerParams;
public MainWorker2(@NonNull Context context, @NonNull WorkerParameters workerParams) {
super(context, workerParams);
this.workerParams = workerParams;
}
@SuppressLint("RestrictedApi")
@NonNull
@Override
public Result doWork() {
Log.d(TAG, "MainWorker2 doWork: 后臺任務執(zhí)行了");
// 接收 MainActivity 傳遞過來的數(shù)據(jù)
String dataString = workerParams.getInputData().getString("key");
Log.d(TAG, "MainWorker2 doWork: 接收Activity傳遞過來的數(shù)據(jù):" + dataString);
// 反饋數(shù)據(jù) 給 MainActivity
// 把任務中的數(shù)據(jù)回傳到activity中
Data outputData = new Data.Builder().putString("key", "數(shù)據(jù)反饋").build();
Result.Success success = new Result.Success(outputData);
return success;
}
}
/**
* 數(shù)據(jù) 互相傳遞
* 測試后臺任務 2
*
* @param view
*/
public void testBackgroundWork2(View view) {
// 數(shù)據(jù)
Data data = new Data.Builder().putString("key", "數(shù)據(jù)傳遞").build();
// 請求對象初始化
OneTimeWorkRequest oneTimeWorkRequest = new OneTimeWorkRequest.Builder(MainWorker2.class)
.setInputData(data) // 數(shù)據(jù)的攜帶
.build();
// 通過LiveData，可以在任務狀態(tài)發(fā)生變化的時候辜御，收到通知鸭你。
WorkManager.getInstance(this).getWorkInfoByIdLiveData(oneTimeWorkRequest.getId())
.observe(this, new Observer<WorkInfo>() {
@Override public void onChanged(WorkInfo workInfo) {
Log.d(MainWorker2.TAG, "狀態(tài)：" + workInfo.getState().name());
if (workInfo.getState().isFinished()) {
// 知道 本次任務執(zhí)行的時候 各種狀態(tài) （SUCCEEDED，isFinished=true擒权， 我再接收 任何回饋給我的數(shù)據(jù)）
// 狀態(tài)機 成功的時候 才去打印
Log.d(MainWorker2.TAG, "Activity取到了任務回傳的數(shù)據(jù): " + workInfo.getOutputData().getString("key"));
Log.d(MainWorker2.TAG, "狀態(tài)：isFinished=true 注意：后臺任務已經(jīng)完成了...");
}
}
});
WorkManager.getInstance(this).enqueue(oneTimeWorkRequest);
}
運行結(jié)果：
3. WorkManager 多個任務 順序執(zhí)行
創(chuàng)建 MainWorker3苇本、MainWorker4、MainWorker5菜拓、MainWorker6 繼承 Worker 的類。
public class MainWorker3 extends Worker {
public final static String TAG = MainWorker3.class.getSimpleName();
public MainWorker3(@NonNull Context context, @NonNull WorkerParameters workerParams) {
super(context, workerParams);
}
@SuppressLint("RestrictedApi")
@NonNull
@Override
public Result doWork() {
Log.d(TAG, "MainWorker3 doWork: 后臺任務執(zhí)行了");
return new Result.Success(); // 本地執(zhí)行 doWork 任務時 成功 執(zhí)行任務完畢
}
}
/**
* 多個任務 順序執(zhí)行
* 測試后臺任務 3
*
* @param view
*/
public void testBackgroundWork3(View view) {
// 單一的任務 一次
OneTimeWorkRequest oneTimeWorkRequest3 = new OneTimeWorkRequest.Builder(MainWorker3.class).build();
OneTimeWorkRequest oneTimeWorkRequest4 = new OneTimeWorkRequest.Builder(MainWorker4.class).build();
OneTimeWorkRequest oneTimeWorkRequest5 = new OneTimeWorkRequest.Builder(MainWorker5.class).build();
OneTimeWorkRequest oneTimeWorkRequest6 = new OneTimeWorkRequest.Builder(MainWorker6.class).build();
// 順序執(zhí)行 3 4 5 6
WorkManager.getInstance(this)
.beginWith(oneTimeWorkRequest3) // 檢查的任務
.then(oneTimeWorkRequest4) // 業(yè)務1任務
.then(oneTimeWorkRequest5) // 業(yè)務2任務
.then(oneTimeWorkRequest6) // 最后檢查工作任務
.enqueue();
// 需求：先執(zhí)行 3 4 最后執(zhí)行 6
List<OneTimeWorkRequest> oneTimeWorkRequests = new ArrayList<>();
oneTimeWorkRequests.add(oneTimeWorkRequest3);// 先同步日志信息
oneTimeWorkRequests.add(oneTimeWorkRequest4);// 先更新服務器數(shù)據(jù)信息
WorkManager.getInstance(this)
.beginWith(oneTimeWorkRequests)
.then(oneTimeWorkRequest6)// 最后再 檢查同步
.enqueue();
}
運行結(jié)果：
順序執(zhí)行結(jié)果圖
合并執(zhí)行
4. WorkManager 重復執(zhí)行后臺任務
/**
* 重復執(zhí)行后臺任務 非單個任務笛厦，多個任務
* 測試后臺任務 4
*
* @param view
*/
public void testBackgroundWork4(View view) {
// 重復的任務 多次/循環(huán)/輪詢 , 哪怕設(shè)置為 10秒 輪詢一次, 那么最少輪詢/循環(huán)一次 15分鐘（Google規(guī)定的）
// 不能小于15分鐘纳鼎，否則默認修改成 15分鐘
PeriodicWorkRequest periodicWorkRequest = new PeriodicWorkRequest
.Builder(MainWorker3.class, 10, TimeUnit.SECONDS).build();
// 【狀態(tài)機】 為什么一直都是 ENQUEUE，因為 你是輪詢的任務，所以你看不到 SUCCESS [如果你是單個任務贱鄙，就會看到SUCCESS]
// 監(jiān)聽狀態(tài)
WorkManager.getInstance(this).getWorkInfoByIdLiveData(periodicWorkRequest.getId())
.observe(this, new Observer<WorkInfo>() {
@Override public void onChanged(WorkInfo workInfo) {
Log.d(MainWorker3.TAG, "狀態(tài)：" + workInfo.getState().name()); // ENQUEEN SUCCESS
if (workInfo.getState().isFinished()) {
Log.d(MainWorker3.TAG, "狀態(tài)：isFinished=true 注意：后臺任務已經(jīng)完成了...");
}
}
});
WorkManager.getInstance(this).enqueue(periodicWorkRequest);
// 取消 任務的執(zhí)行
// WorkManager.getInstance(this).cancelWorkById(periodicWorkRequest.getId());
}
5. WorkManager 約束條件劝贸，約束后臺任務執(zhí)行
/**
* 約束條件，約束后臺任務執(zhí)行
* 測試后臺任務 5
*
* @param view
*/
public void testBackgroundWork5(View view) {
// 約束條件逗宁，必須滿足我的條件映九，才能執(zhí)行后臺任務 （在連接網(wǎng)絡(luò)，插入電源 并且 處于空閑時）
Constraints constraints = new Constraints.Builder()
.setRequiredNetworkType(NetworkType.CONNECTED) // 網(wǎng)絡(luò)鏈接中...
/*.setRequiresCharging(true) // 充電中..
.setRequiresDeviceIdle(true) // 空閑時.. (例如：你沒有玩游戲瞎颗，你沒有看片)*/
.build();
/*
* 除了上面設(shè)置的約束外件甥，WorkManger還提供了以下的約束作為Work執(zhí)行的條件：
* setRequiredNetworkType：網(wǎng)絡(luò)連接設(shè)置
* setRequiresBatteryNotLow：是否為低電量時運行 默認false
* setRequiresCharging：是否要插入設(shè)備（接入電源），默認false
* setRequiresDeviceIdle：設(shè)備是否為空閑哼拔，默認false
* setRequiresStorageNotLow：設(shè)備可用存儲是否不低于臨界閾值
*/
// 請求對象
OneTimeWorkRequest request = new OneTimeWorkRequest.Builder(MainWorker3.class)
.setConstraints(constraints) // Request關(guān)聯(lián) 約束條件
.build();
// 加入隊列
WorkManager.getInstance(this).enqueue(request);
}
