Отчет о статусе работы

В этом руководстве рассказывается, как сообщить о статусе выполнения запроса на работу в фоновой службе компоненту, который отправил запрос. Это позволяет, например, сообщать о статусе запроса в интерфейсе объекта Activity. Рекомендуемый способ отправки и получения статуса – использовать LocalBroadcastManager, который ограничивает объекты Intent трансляции компонентами в вашем приложении.

Как сообщить о статусе из JobIntentService

Чтобы отправить статус запроса на работу в JobIntentService другим компонентам, сначала создайте Intent, который содержит статус в расширенных данных. При желании вы можете добавить в этот Intent действие и URI данных.

Затем отправьте Intent, вызвав LocalBroadcastManager.sendBroadcast(). В результате Intent будет отправлен любому компоненту приложения, который зарегистрирован для его получения. Чтобы получить экземпляр LocalBroadcastManager, вызовите getInstance().

Пример:

Kotlin

...
// Defines a custom Intent action
const val BROADCAST_ACTION = "com.example.android.threadsample.BROADCAST"
...
// Defines the key for the status "extra" in an Intent
const val EXTENDED_DATA_STATUS = "com.example.android.threadsample.STATUS"
...
class RSSPullService : JobIntentService() {
    ...
    /*
     * Creates a new Intent containing a Uri object
     * BROADCAST_ACTION is a custom Intent action
     */
    val localIntent = Intent(BROADCAST_ACTION).apply {
        // Puts the status into the Intent
        putExtra(EXTENDED_DATA_STATUS, status)
    }
    // Broadcasts the Intent to receivers in this app.
    LocalBroadcastManager.getInstance(this).sendBroadcast(localIntent)
    ...
}

Java

public final class Constants {
    ...
    // Defines a custom Intent action
    public static final String BROADCAST_ACTION =
        "com.example.android.threadsample.BROADCAST";
    ...
    // Defines the key for the status "extra" in an Intent
    public static final String EXTENDED_DATA_STATUS =
        "com.example.android.threadsample.STATUS";
    ...
}
public class RSSPullService extends JobIntentService {
...
    /*
     * Creates a new Intent containing a Uri object
     * BROADCAST_ACTION is a custom Intent action
     */
    Intent localIntent =
            new Intent(Constants.BROADCAST_ACTION)
            // Puts the status into the Intent
            .putExtra(Constants.EXTENDED_DATA_STATUS, status);
    // Broadcasts the Intent to receivers in this app.
    LocalBroadcastManager.getInstance(this).sendBroadcast(localIntent);
...
}

Следующий шаг – обработать входящие объекты Intent в компоненте, который отправил исходный запрос на работу.

Получение трансляций статуса от JobIntentService

Чтобы получать объекты Intent, используйте подкласс BroadcastReceiver. В подклассе реализуйте метод обратного вызова BroadcastReceiver.onReceive(), который вызывается объектом LocalBroadcastManager при получении объекта Intent. LocalBroadcastManager передает входящий Intent в BroadcastReceiver.onReceive().

Пример:

Kotlin

// Broadcast receiver for receiving status updates from the IntentService.
private class DownloadStateReceiver : BroadcastReceiver() {

    override fun onReceive(context: Context, intent: Intent) {
        ...
        /*
         * Handle Intents here.
         */
        ...
    }
}

Java

// Broadcast receiver for receiving status updates from the IntentService.
private class DownloadStateReceiver extends BroadcastReceiver
{
    // Called when the BroadcastReceiver gets an Intent it's registered to receive
    @Override
    public void onReceive(Context context, Intent intent) {
...
        /*
         * Handle Intents here.
         */
...
    }
}

После того как вы определили BroadcastReceiver, вы можете задать для него фильтры, соответствующие определенным действиям, категориям и данным. Для этого создайте объект IntentFilter. В первом фрагменте показано, как определить фильтр:

Kotlin

// Class that displays photos
class DisplayActivity : FragmentActivity() {
    ...
    override fun onCreate(savedInstanceState: Bundle?) {
        ...
        super.onCreate(savedInstanceState)
        ...
        // The filter's action is BROADCAST_ACTION
        var statusIntentFilter = IntentFilter(BROADCAST_ACTION).apply {
            // Adds a data filter for the HTTP scheme
            addDataScheme("http")
        }
        ...

Java

// Class that displays photos
public class DisplayActivity extends FragmentActivity {
    ...
    public void onCreate(Bundle stateBundle) {
        ...
        super.onCreate(stateBundle);
        ...
        // The filter's action is BROADCAST_ACTION
        IntentFilter statusIntentFilter = new IntentFilter(
                Constants.BROADCAST_ACTION);

        // Adds a data filter for the HTTP scheme
        statusIntentFilter.addDataScheme("http");
        ...

Чтобы зарегистрировать BroadcastReceiver и IntentFilter в системе, получите экземпляр LocalBroadcastManager и вызовите его метод registerReceiver(). В следующем фрагменте кода показано, как зарегистрировать BroadcastReceiver и его IntentFilter:

Kotlin

        // Instantiates a new DownloadStateReceiver
        val downloadStateReceiver = DownloadStateReceiver()
        // Registers the DownloadStateReceiver and its intent filters
        LocalBroadcastManager.getInstance(this)
                .registerReceiver(downloadStateReceiver, statusIntentFilter)
        ...

Java

        // Instantiates a new DownloadStateReceiver
        DownloadStateReceiver downloadStateReceiver =
                new DownloadStateReceiver();
        // Registers the DownloadStateReceiver and its intent filters
        LocalBroadcastManager.getInstance(this).registerReceiver(
                downloadStateReceiver,
                statusIntentFilter);
        ...

Один BroadcastReceiver может обрабатывать несколько типов объектов Intent, каждый из которых имеет собственное действие. Это позволяет выполнять разный код для каждого действия, не определяя отдельный объект BroadcastReceiver для каждого действия. Чтобы определить ещё один объект IntentFilter для того же объекта BroadcastReceiver, создайте объект IntentFilter и повторите вызов метода registerReceiver(). Пример:

Kotlin

        /*
         * Instantiates a new action filter.
         * No data filter is needed.
         */
        statusIntentFilter = IntentFilter(ACTION_ZOOM_IMAGE)
        // Registers the receiver with the new filter
        LocalBroadcastManager.getInstance(this)
                .registerReceiver(downloadStateReceiver, statusIntentFilter)

Java

        /*
         * Instantiates a new action filter.
         * No data filter is needed.
         */
        statusIntentFilter = new IntentFilter(Constants.ACTION_ZOOM_IMAGE);
        // Registers the receiver with the new filter
        LocalBroadcastManager.getInstance(this).registerReceiver(
                downloadStateReceiver,
                statusIntentFilter);

Отправка трансляции Intent не запускает и не возобновляет Activity. BroadcastReceiver для Activity получает и обрабатывает объекты Intent, даже когда приложение работает в фоновом режиме, но не переводит его в активный режим. Если вы хотите уведомить пользователя о событии, которое произошло в фоновом режиме, когда приложение не было видно, используйте Notification. Никогда не запускайте Activity в ответ на входящую трансляцию Intent.