หากต้องการเริ่มใช้ WorkManager ให้เริ่มด้วยการนำเข้าไลบรารีไปยังโปรเจ็กต์ Android
เพิ่มทรัพยากร Dependency ต่อไปนี้ลงในไฟล์ build.gradle ของแอป
ดึงดูด
dependencies { def work_version = "2.12.0" // (Java only) implementation "androidx.work:work-runtime:$work_version" // Kotlin + coroutines implementation "androidx.work:work-runtime-ktx:$work_version" // optional - RxJava2 support implementation "androidx.work:work-rxjava2:$work_version" // optional - GCMNetworkManager support implementation "androidx.work:work-gcm:$work_version" // optional - Test helpers androidTestImplementation "androidx.work:work-testing:$work_version" // optional - Multiprocess support implementation "androidx.work:work-multiprocess:$work_version" }
Kotlin
dependencies { val work_version = "2.12.0" // (Java only) implementation("androidx.work:work-runtime:$work_version") // Kotlin + coroutines implementation("androidx.work:work-runtime-ktx:$work_version") // optional - RxJava2 support implementation("androidx.work:work-rxjava2:$work_version") // optional - GCMNetworkManager support implementation("androidx.work:work-gcm:$work_version") // optional - Test helpers androidTestImplementation("androidx.work:work-testing:$work_version") // optional - Multiprocess support implementation("androidx.work:work-multiprocess:$work_version") }
เมื่อเพิ่มทรัพยากร Dependency และซิงค์โปรเจ็กต์ Gradle แล้ว ขั้นตอนถัดไปคือการกำหนดงานที่จะเรียกใช้
กำหนดงาน
งานจะกำหนดโดยใช้คลาส Worker เมธอด doWork() จะทำงานแบบอะซิงโครนัสในเทรดเบื้องหลังที่ WorkManager มีให้
หากต้องการสร้างงานให้ WorkManager เรียกใช้ ให้ขยายคลาส Worker และลบล้างเมธอด doWork() ตัวอย่างเช่น หากต้องการสร้าง Worker ที่อัปโหลดรูปภาพ ให้ทำดังนี้
Kotlin
class UploadWorker(appContext: Context, workerParams: WorkerParameters): Worker(appContext, workerParams) { override fun doWork(): Result { // Do the work here--in this case, upload the images. uploadImages() // Indicate whether the work finished successfully with the Result return Result.success() } }
Java
public class UploadWorker extends Worker { public UploadWorker( @NonNull Context context, @NonNull WorkerParameters params) { super(context, params); } @Override public Result doWork() { // Do the work here--in this case, upload the images. uploadImages(); // Indicate whether the work finished successfully with the Result return Result.success(); } }
Result ที่แสดงผลจาก doWork() จะแจ้งบริการ WorkManager ว่างานสำเร็จหรือไม่ และในกรณีที่ล้มเหลว ควรลองทำงานอีกครั้งหรือไม่
Result.success(): งานเสร็จสมบูรณ์แล้วResult.failure(): การทำงานไม่สำเร็จResult.retry(): งานไม่สำเร็จและควรลองอีกครั้งในเวลาอื่นตามนโยบายการลองใหม่
สร้าง WorkRequest
เมื่อกำหนดงานแล้ว คุณต้องกำหนดเวลาด้วยบริการ WorkManager เพื่อให้งานทำงาน WorkManager มีความยืดหยุ่นสูงในการกำหนดเวลาทำงาน คุณสามารถกำหนดเวลาให้ทำงานเป็นระยะๆ ในช่วงเวลาหนึ่ง หรือจะกำหนดเวลาให้ทำงานเพียงครั้งเดียวก็ได้
ไม่ว่าคุณจะเลือกกำหนดเวลางานอย่างไร คุณจะต้องใช้ WorkRequest เสมอ แม้ว่า Worker จะกำหนดหน่วยของงาน แต่ WorkRequest (และคลาสย่อย) จะกำหนดวิธีและเวลาที่ควรเรียกใช้ ในกรณีที่ง่ายที่สุด คุณสามารถใช้ OneTimeWorkRequest ดังที่แสดงในตัวอย่างต่อไปนี้
Kotlin
val uploadWorkRequest: WorkRequest = OneTimeWorkRequestBuilder<UploadWorker>() .build()
Java
WorkRequest uploadWorkRequest = new OneTimeWorkRequest.Builder(UploadWorker.class) .build();
ส่ง WorkRequest ไปยังระบบ
สุดท้าย คุณต้องส่ง WorkRequest ไปยัง WorkManager โดยใช้เมธอด enqueue()
Kotlin
WorkManager .getInstance(myContext) .enqueue(uploadWorkRequest)
Java
WorkManager .getInstance(myContext) .enqueue(uploadWorkRequest);
เวลาที่แน่นอนที่ผู้ปฏิบัติงานจะดำเนินการขึ้นอยู่กับข้อจำกัดที่ใช้ใน WorkRequest และการเพิ่มประสิทธิภาพระบบ
WorkManager ออกแบบมาเพื่อให้ทำงานได้ดีที่สุดภายใต้ข้อจำกัดเหล่านี้
ขั้นตอนถัดไป
คู่มือเริ่มต้นใช้งานนี้เป็นเพียงข้อมูลเบื้องต้นเท่านั้น WorkRequest ยังสามารถรวมข้อมูลเพิ่มเติมได้ด้วย เช่น ข้อจำกัดที่งานควรทำงาน อินพุตของงาน ความล่าช้า และนโยบาย Backoff สำหรับการลองทำงานอีกครั้ง ในส่วนถัดไป กำหนดคำของาน คุณจะได้ดูข้อมูลเพิ่มเติมเกี่ยวกับตัวเลือกเหล่านี้โดยละเอียด รวมถึงทำความเข้าใจวิธีกำหนดเวลางานที่ไม่ซ้ำกันและงานที่เกิดซ้ำ
แหล่งข้อมูลเพิ่มเติม
นอกจากเอกสารประกอบคู่มือแล้ว ยังมีบล็อกและ Codelab อีกหลายรายการที่พร้อมช่วยคุณเริ่มต้นใช้งาน
Codelab
- การทำงานกับ WorkManager (Kotlin) และ (Java)
- WorkManager ขั้นสูง (Kotlin)
บล็อก
- ขอแนะนำ WorkManager
- ข้อมูลเบื้องต้นเกี่ยวกับ WorkManager
- WorkManager และ Kotlin
- ระยะเวลาของ WorkManager
- การปรับแต่ง WorkManager - พื้นฐาน
- ปรับแต่ง WorkManager ด้วย Dagger