Arbeitsstatus melden

In diesem Leitfaden erfahren Sie, wie Sie den Status einer in einem Hintergrunddienst ausgeführten Arbeitsanfrage an die Komponente melden, die die Anfrage gesendet hat. So können Sie beispielsweise den Status der Anfrage in der UI eines Activity-Objekts melden. Die empfohlene Methode zum Senden und Empfangen des Status ist die Verwendung eines LocalBroadcastManager, das Broadcast-Intent-Objekte auf Komponenten in Ihrer eigenen Anwendung einschränkt.

Status von einem JobIntentService melden

Wenn Sie den Status einer Arbeitsanfrage in einer JobIntentService an andere Komponenten senden möchten, müssen Sie zuerst eine Intent erstellen, die den Status in den erweiterten Daten enthält. Optional können Sie dieser Intent eine Aktion und einen Daten-URI hinzufügen.

Senden Sie als Nächstes das Intent, indem Sie LocalBroadcastManager.sendBroadcast() aufrufen. Dadurch wird das Intent an jede Komponente in Ihrer Anwendung gesendet, die für den Empfang registriert ist. Rufen Sie getInstance() auf, um eine Instanz von LocalBroadcastManager abzurufen.

Beispiele:

...
// 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)
    ...
}

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);
...
}

Im nächsten Schritt werden die eingehenden Intent-Broadcast-Objekte in der Komponente verarbeitet, die die ursprüngliche Arbeitsanfrage gesendet hat.

Status-Broadcasts von einem JobIntentService empfangen

Verwenden Sie eine abgeleitete Klasse von BroadcastReceiver, um Intent-Broadcast-Objekte zu empfangen. Implementieren Sie in der Unterklasse die Callback-Methode BroadcastReceiver.onReceive(), die von LocalBroadcastManager aufgerufen wird, wenn es eine Intent empfängt. LocalBroadcastManager übergibt die eingehende Intent an BroadcastReceiver.onReceive().

Beispiele:

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

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

// 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.
         */
...
    }
}

Nachdem Sie die BroadcastReceiver definiert haben, können Sie Filter dafür definieren, die bestimmten Aktionen, Kategorien und Daten entsprechen. Dazu erstellst du ein IntentFilter. Das erste Snippet zeigt, wie der Filter definiert wird:

// 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")
        }
        ...

// 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");
        ...

Um BroadcastReceiver und IntentFilter beim System zu registrieren, rufen Sie eine Instanz von LocalBroadcastManager ab und rufen Sie die zugehörige Methode registerReceiver() auf. Das nächste Snippet zeigt, wie BroadcastReceiver und die zugehörige IntentFilter registriert werden:

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

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

Ein einzelnes BroadcastReceiver kann mehr als einen Typ von Übertragungsobjekten vom Typ Intent verarbeiten, wobei jedes Objekt eine eigene Aktion hat. Mit diesem Feature kannst du für jede Aktion unterschiedlichen Code ausführen, ohne für jede Aktion eine separate BroadcastReceiver definieren zu müssen. Wenn Sie eine weitere IntentFilter für dieselbe BroadcastReceiver definieren möchten, erstellen Sie die IntentFilter und wiederholen Sie den Aufruf von registerReceiver(). Beispiele:

        /*
         * 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)

        /*
         * 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);

Durch das Senden einer Intent wird ein Activity nicht gestartet oder fortgesetzt. Das BroadcastReceiver für ein Activity empfängt und verarbeitet Intent-Objekte, auch wenn die App im Hintergrund ausgeführt wird. Er erzwingt jedoch nicht, dass die App im Vordergrund ausgeführt wird. Wenn du den Nutzer über ein Ereignis informieren möchtest, das im Hintergrund stattgefunden hat, während deine App nicht sichtbar war, verwende Notification. Startet nie ein Activity als Antwort auf einen eingehenden Broadcast Intent.