【移动开发】Service类onStartCommand()返回值和参数

时间：2022-06-01 05:18:42
Android开发的过程中，每次调用startService(Intent)的时候，都会调用该Service对象的onStartCommand(Intent,int,int)方法，然后在onStartCommand方法中做一些处理。然后我们注意到这个函数有一个int的返回值，这篇文章就是简单地讲讲int返回值的作用。
返回值
从Android官方文档中，知道onStartCommand有4种返回值：
START_STICKY：如果service进程被kill掉，保留service的状态为开始状态，但不保留递送的intent对象。随后系统会尝试重新创建service，由于服务状态为开始状态，所以创建服务后一定会调用onStartCommand(Intent,int,int)方法。如果在此期间没有任何启动命令被传递到service，那么参数Intent将为null。
START_NOT_STICKY：“非粘性的”。使用这个返回值时，如果在执行完onStartCommand后，服务被异常kill掉，系统不会自动重启该服务。
START_REDELIVER_INTENT：重传Intent。使用这个返回值时，如果在执行完onStartCommand后，服务被异常kill掉，系统会自动重启该服务，并将Intent的值传入。
START_STICKY_COMPATIBILITY：START_STICKY的兼容版本，但不保证服务被kill后一定能重启。

http://developer.android.com/reference/android/app/Service.html

    /**

     * Constant to return from {@link #onStartCommand}: compatibility

     * version of {@link #START_STICKY} that does not guarantee that

     * {@link #onStartCommand} will be called again after being killed.

     */

    public static final int START_STICKY_COMPATIBILITY = 0;

    /**

     * Constant to return from {@link #onStartCommand}: if this service's

     * process is killed while it is started (after returning from

     * {@link #onStartCommand}), then leave it in the started state but

     * don't retain this delivered intent.  Later the system will try to

     * re-create the service.  Because it is in the started state, it will

     * guarantee to call {@link #onStartCommand} after creating the new

     * service instance; if there are not any pending start commands to be

     * delivered to the service, it will be called with a null intent

     * object, so you must take care to check for this.

     *

     * <p>This mode makes sense for things that will be explicitly started

     * and stopped to run for arbitrary periods of time, such as a service

     * performing background music playback.

     */

    public static final int START_STICKY = 1;

    /**

     * Constant to return from {@link #onStartCommand}: if this service's

     * process is killed while it is started (after returning from

     * {@link #onStartCommand}), and there are no new start intents to

     * deliver to it, then take the service out of the started state and

     * don't recreate until a future explicit call to

     * {@link Context#startService Context.startService(Intent)}.  The

     * service will not receive a {@link #onStartCommand(Intent, int, int)}

     * call with a null Intent because it will not be re-started if there

     * are no pending Intents to deliver.

     *

     * <p>This mode makes sense for things that want to do some work as a

     * result of being started, but can be stopped when under memory pressure

     * and will explicit start themselves again later to do more work.  An

     * example of such a service would be one that polls for data from

     * a server: it could schedule an alarm to poll every N minutes by having

     * the alarm start its service.  When its {@link #onStartCommand} is

     * called from the alarm, it schedules a new alarm for N minutes later,

     * and spawns a thread to do its networking.  If its process is killed

     * while doing that check, the service will not be restarted until the

     * alarm goes off.

     */

    public static final int START_NOT_STICKY = 2;

    /**

     * Constant to return from {@link #onStartCommand}: if this service's

     * process is killed while it is started (after returning from

     * {@link #onStartCommand}), then it will be scheduled for a restart

     * and the last delivered Intent re-delivered to it again via

     * {@link #onStartCommand}.  This Intent will remain scheduled for

     * redelivery until the service calls {@link #stopSelf(int)} with the

     * start ID provided to {@link #onStartCommand}.  The

     * service will not receive a {@link #onStartCommand(Intent, int, int)}

     * call with a null Intent because it will will only be re-started if

     * it is not finished processing all Intents sent to it (and any such

     * pending events will be delivered at the point of restart).

     */

    public static final int START_REDELIVER_INTENT = 3;

参数
onStartCommand()的函数原型，代码如下： 

    /**

     * Called by the system every time a client explicitly starts the service by calling

     * {@link android.content.Context#startService}, providing the arguments it supplied and a

     * unique integer token representing the start request.  Do not call this method directly.

     *

     * <p>For backwards compatibility, the default implementation calls

     * {@link #onStart} and returns either {@link #START_STICKY}

     * or {@link #START_STICKY_COMPATIBILITY}.

     *

     * <p>If you need your application to run on platform versions prior to API

     * level 5, you can use the following model to handle the older {@link #onStart}

     * callback in that case.  The <code>handleCommand</code> method is implemented by

     * you as appropriate:

     *

     * {@sample development/samples/ApiDemos/src/com/example/android/apis/app/ForegroundService.java

     *   start_compatibility}

     *

     * <p class="caution">Note that the system calls this on your

     * service's main thread.  A service's main thread is the same

     * thread where UI operations take place for Activities running in the

     * same process.  You should always avoid stalling the main

     * thread's event loop.  When doing long-running operations,

     * network calls, or heavy disk I/O, you should kick off a new

     * thread, or use {@link android.os.AsyncTask}.</p>

     *

     * @param intent The Intent supplied to {@link android.content.Context#startService},

     * as given.  This may be null if the service is being restarted after

     * its process has gone away, and it had previously returned anything

     * except {@link #START_STICKY_COMPATIBILITY}.

     * @param flags Additional data about this start request.  Currently either

     * 0, {@link #START_FLAG_REDELIVERY}, or {@link #START_FLAG_RETRY}.

     * @param startId A unique integer representing this specific request to

     * start.  Use with {@link #stopSelfResult(int)}.

     *

     * @return The return value indicates what semantics the system should

     * use for the service's current started state.  It may be one of the

     * constants associated with the {@link #START_CONTINUATION_MASK} bits.

     *

     * @see #stopSelfResult(int)

     */

    public int onStartCommand(Intent intent, int flags, int startId) {

        onStart(intent, startId);

        return mStartCompatibility ? START_STICKY_COMPATIBILITY : START_STICKY;

    }

官方解释如下：

public int onStartCommand (Intent intent, int flags, int startId)

Added in API level 5

Called by the system every time a client explicitly starts the service by calling startService(Intent), providing the arguments it supplied and a unique integer token representing the start request. Do not call this method directly.

For backwards compatibility, the default implementation calls onStart(Intent, int) and returns either START_STICKY or START_STICKY_COMPATIBILITY.

If you need your application to run on platform versions prior to API level 5, you can use the following model to handle the older onStart(Intent, int) callback in that case. The handleCommand method is implemented by you as appropriate:

// This is the old onStart method that will be called on the pre-2.0

// platform.  On 2.0 or later we override onStartCommand() so this

// method will not be called.

@Override

public void onStart(Intent intent, int startId) {

    handleCommand(intent);

}

@Override

public int onStartCommand(Intent intent, int flags, int startId) {

    handleCommand(intent);

    // We want this service to continue running until it is explicitly

    // stopped, so return sticky.

    return START_STICKY;

}

Note that the system calls this on your service's main thread. A service's main thread is the same thread where UI operations take place for Activities running in the same process. You should always avoid stalling the main thread's event loop. When doing long-running operations, network calls, or heavy disk I/O, you should kick off a new thread, or use AsyncTask.

Parameters
intent The Intent supplied to startService(Intent), as given. This may be null if the service is being restarted after its process has gone away, and it had previously returned anything except START_STICKY_COMPATIBILITY.
flags Additional data about this start request. Currently either 0, START_FLAG_REDELIVERY, or START_FLAG_RETRY.
startId A unique integer representing this specific request to start. Use with stopSelfResult(int).
Returns
  • The return value indicates what semantics the system should use for the service's current started state. It may be one of the constants associated with the START_CONTINUATION_MASK bits.
See Also

flags有3种取值，flags值和onStartCommand()的返回值有着直接的关系。如果Service被系统意外终止，重启的时候，传入的flags。官方文档描述：

public static final int START_FLAG_REDELIVERY

Added in API level 5

This flag is set in onStartCommand(Intent, int, int) if the Intent is a re-delivery of a previously delivered intent, because the service had previously returned START_REDELIVER_INTENT but had been killed before calling stopSelf(int) for that Intent.

Constant Value: 1 (0x00000001)

public static final int START_FLAG_RETRY

Added in API level 5

This flag is set in onStartCommand(Intent, int, int) if the Intent is a a retry because the original attempt never got to or returned from onStartCommand(Intent, int, int).

Constant Value: 2 (0x00000002)

相关文章