รองรับผู้ปฏิบัติงานระยะยาว

WorkManager มีการรองรับในตัวสำหรับผู้ปฏิบัติงานที่ทำงานเป็นเวลานาน ในกรณีดังกล่าว WorkManager สามารถแจ้งสัญญาณแก่ระบบปฏิบัติการว่ากระบวนการควรทำงานอยู่ หากเป็นไปได้ในขณะที่กำลังดำเนินการ ผู้ปฏิบัติงานเหล่านี้สามารถทำงานได้มากกว่า 10 นาที ตัวอย่างกรณีการใช้งานของฟีเจอร์ใหม่นี้ ได้แก่ การอัปโหลดจำนวนมากหรือ ดาวน์โหลด (ที่ไม่สามารถแยกเป็นกลุ่มได้) การดำเนินการกับโมเดล ML ในเครื่อง หรืองาน ที่สำคัญต่อผู้ใช้แอป

ข้อมูลขั้นสูง WorkManager จัดการและเรียกใช้บริการที่ทำงานอยู่เบื้องหน้าในนามของคุณ เพื่อเรียกใช้ WorkRequest ในขณะเดียวกันก็แสดงการกำหนดค่า การแจ้งเตือน

ตอนนี้ ListenableWorker รองรับ setForegroundAsync() API และ CoroutineWorker รองรับ API setForeground() ที่ถูกระงับ เหล่านี้ API ช่วยให้นักพัฒนาซอฟต์แวร์ระบุได้ว่า WorkRequest นี้สำคัญ (จาก มุมมองของผู้ใช้) หรือในระยะยาว

ตั้งแต่ 2.3.0-alpha03 เป็นต้นไป WorkManager ยังอนุญาตให้คุณสร้าง PendingIntent ซึ่งใช้ยกเลิกผู้ปฏิบัติงานได้โดยไม่ต้อง ลงทะเบียนคอมโพเนนต์ Android ใหม่โดยใช้ createCancelPendingIntent() API วิธีการนี้จะเป็นประโยชน์อย่างยิ่งเมื่อใช้ร่วมกับ setForegroundAsync() หรือ setForeground() API ซึ่งสามารถใช้เพื่อเพิ่ม การดำเนินการแจ้งเตือนเพื่อยกเลิกWorker

การสร้างและจัดการผู้ปฏิบัติงานที่ใช้เวลานาน

คุณจะใช้วิธีการที่แตกต่างกันเล็กน้อย ขึ้นอยู่กับว่าคุณเขียนโค้ดไว้ใน Kotlin หรือ Java

Kotlin

นักพัฒนาซอฟต์แวร์ Kotlin ควรใช้ CoroutineWorker แทนที่จะใช้ setForegroundAsync() คุณสามารถใช้เมธอดนั้นในเวอร์ชันที่มีการระงับ setForeground()

class DownloadWorker(context: Context, parameters: WorkerParameters) :
   CoroutineWorker(context, parameters) {

   private val notificationManager =
       context.getSystemService(Context.NOTIFICATION_SERVICE) as
               NotificationManager

   override suspend fun doWork(): Result {
       val inputUrl = inputData.getString(KEY_INPUT_URL)
                      ?: return Result.failure()
       val outputFile = inputData.getString(KEY_OUTPUT_FILE_NAME)
                      ?: return Result.failure()
       // Mark the Worker as important
       val progress = "Starting Download"
       setForeground(createForegroundInfo(progress))
       download(inputUrl, outputFile)
       return Result.success()
   }

   private fun download(inputUrl: String, outputFile: String) {
       // Downloads a file and updates bytes read
       // Calls setForeground() periodically when it needs to update
       // the ongoing Notification
   }
   // Creates an instance of ForegroundInfo which can be used to update the
   // ongoing notification.
   private fun createForegroundInfo(progress: String): ForegroundInfo {
       val id = applicationContext.getString(R.string.notification_channel_id)
       val title = applicationContext.getString(R.string.notification_title)
       val cancel = applicationContext.getString(R.string.cancel_download)
       // This PendingIntent can be used to cancel the worker
       val intent = WorkManager.getInstance(applicationContext)
               .createCancelPendingIntent(getId())

       // Create a Notification channel if necessary
       if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) {
           createChannel()
       }

       val notification = NotificationCompat.Builder(applicationContext, id)
           .setContentTitle(title)
           .setTicker(title)
           .setContentText(progress)
           .setSmallIcon(R.drawable.ic_work_notification)
           .setOngoing(true)
           // Add the cancel action to the notification which can
           // be used to cancel the worker
           .addAction(android.R.drawable.ic_delete, cancel, intent)
           .build()

       return ForegroundInfo(notificationId, notification)
   }

   @RequiresApi(Build.VERSION_CODES.O)
   private fun createChannel() {
       // Create a Notification channel
   }

   companion object {
       const val KEY_INPUT_URL = "KEY_INPUT_URL"
       const val KEY_OUTPUT_FILE_NAME = "KEY_OUTPUT_FILE_NAME"
   }
}

Java

นักพัฒนาแอปที่ใช้ ListenableWorker หรือ Worker สามารถเรียกใช้ setForegroundAsync() API ซึ่งแสดงผล ListenableFuture<Void> คุณ คุณสามารถโทรหา setForegroundAsync() เพื่ออัปเดต Notification ที่ใช้งานอยู่ได้ด้วย

ต่อไปนี้เป็นตัวอย่างง่ายๆ ของผู้ปฏิบัติงานที่ทำงานเป็นเวลานานซึ่งดาวน์โหลดไฟล์ ช่วงเวลานี้ ผู้ปฏิบัติงานติดตามความคืบหน้าเพื่ออัปเดต Notification ที่ดำเนินอยู่ซึ่งแสดง ความคืบหน้าในการดาวน์โหลด

public class DownloadWorker extends Worker {
   private static final String KEY_INPUT_URL = "KEY_INPUT_URL";
   private static final String KEY_OUTPUT_FILE_NAME = "KEY_OUTPUT_FILE_NAME";

   private NotificationManager notificationManager;

   public DownloadWorker(
       @NonNull Context context,
       @NonNull WorkerParameters parameters) {
           super(context, parameters);
           notificationManager = (NotificationManager)
               context.getSystemService(NOTIFICATION_SERVICE);
   }

   @NonNull
   @Override
   public Result doWork() {
       Data inputData = getInputData();
       String inputUrl = inputData.getString(KEY_INPUT_URL);
       String outputFile = inputData.getString(KEY_OUTPUT_FILE_NAME);
       // Mark the Worker as important
       String progress = "Starting Download";
       setForegroundAsync(createForegroundInfo(progress));
       download(inputUrl, outputFile);
       return Result.success();
   }

   private void download(String inputUrl, String outputFile) {
       // Downloads a file and updates bytes read
       // Calls setForegroundAsync(createForegroundInfo(myProgress))
       // periodically when it needs to update the ongoing Notification.
   }

   @NonNull
   private ForegroundInfo createForegroundInfo(@NonNull String progress) {
       // Build a notification using bytesRead and contentLength

       Context context = getApplicationContext();
       String id = context.getString(R.string.notification_channel_id);
       String title = context.getString(R.string.notification_title);
       String cancel = context.getString(R.string.cancel_download);
       // This PendingIntent can be used to cancel the worker
       PendingIntent intent = WorkManager.getInstance(context)
               .createCancelPendingIntent(getId());

       if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) {
           createChannel();
       }

       Notification notification = new NotificationCompat.Builder(context, id)
               .setContentTitle(title)
               .setTicker(title)
               .setSmallIcon(R.drawable.ic_work_notification)
               .setOngoing(true)
               // Add the cancel action to the notification which can
               // be used to cancel the worker
               .addAction(android.R.drawable.ic_delete, cancel, intent)
               .build();

       return new ForegroundInfo(notificationId, notification);
   }

   @RequiresApi(Build.VERSION_CODES.O)
   private void createChannel() {
       // Create a Notification channel
   }
}

เพิ่มประเภทบริการที่ทำงานอยู่เบื้องหน้าให้กับผู้ปฏิบัติงานที่ใช้เวลานาน

หากแอปกำหนดเป้าหมายเป็น Android 14 (API ระดับ 34) ขึ้นไป คุณต้องระบุ ประเภทบริการที่ทำงานอยู่เบื้องหน้าสำหรับผู้ปฏิบัติงานระยะยาวทั้งหมด หากแอปกำหนดเป้าหมายเป็น Android 10 (API ระดับ 29) ขึ้นไปและมี ผู้ปฏิบัติงานเป็นเวลานานที่ต้องใช้สิทธิ์เข้าถึงตำแหน่ง โปรดระบุว่าผู้ปฏิบัติงานรายนั้น ใช้บริการที่ทำงานอยู่เบื้องหน้าประเภท location

หากแอปกำหนดเป้าหมายเป็น Android 11 (API ระดับ 30) ขึ้นไป และมีพนักงานที่ทำงานมานานซึ่งต้องเข้าถึงกล้องหรือไมโครโฟน ประกาศเบื้องหน้า camera หรือ microphone ประเภทบริการตามลำดับ

หากต้องการเพิ่มประเภทบริการที่ทำงานอยู่เบื้องหน้าเหล่านี้ ให้ทำตามขั้นตอนที่อธิบายไว้ใน ส่วนต่างๆ ต่อไปนี้

ประกาศประเภทบริการที่ทำงานอยู่เบื้องหน้าในไฟล์ Manifest ของแอป

ประกาศประเภทบริการที่ทำงานอยู่เบื้องหน้าของผู้ปฏิบัติงานในไฟล์ Manifest ของแอป ใน ดังตัวอย่างต่อไปนี้ ผู้ปฏิบัติงานต้องสามารถเข้าถึงตำแหน่งและไมโครโฟน

AndroidManifest.xml

<service
   android:name="androidx.work.impl.foreground.SystemForegroundService"
   android:foregroundServiceType="location|microphone"
   tools:node="merge" />

ระบุประเภทบริการที่ทำงานอยู่เบื้องหน้าขณะรันไทม์

เมื่อโทรหา setForeground() หรือ setForegroundAsync() โปรดตรวจสอบว่าคุณระบุ ประเภทบริการที่ทำงานอยู่เบื้องหน้า

ผู้ปฏิบัติงานตำแหน่งของฉันและไมโครโฟน

Kotlin

private fun createForegroundInfo(progress: String): ForegroundInfo {
   // ...
   return ForegroundInfo(NOTIFICATION_ID, notification,
           FOREGROUND_SERVICE_TYPE_LOCATION or
FOREGROUND_SERVICE_TYPE_MICROPHONE) }

Java

@NonNull
private ForegroundInfo createForegroundInfo(@NonNull String progress) {
   // Build a notification...
   Notification notification = ...;
   return new ForegroundInfo(NOTIFICATION_ID, notification,
           FOREGROUND_SERVICE_TYPE_LOCATION | FOREGROUND_SERVICE_TYPE_MICROPHONE);
}