page.title=Layanan Terikat parent.title=Layanan parent.link=services.html @jd:body

    Dalam dokumen ini

    1. Dasar-Dasar
    2. Membuat Layanan Terikat
      1. Memperluas kelas Binder
      2. Menggunakan Messenger
    3. Mengikat ke Layanan
    4. Mengelola Daur Hidup Layanan Terikat

    Kelas-kelas utama

    1. {@link android.app.Service}
    2. {@link android.content.ServiceConnection}
    3. {@link android.os.IBinder}

    Contoh

    1. {@code RemoteService}
    2. {@code LocalService}

    Lihat juga

    1. Layanan

Layanan terikat adalah server di antarmuka klien-server. Layanan terikat memungkinkan komponen-komponen (seperti aktivitas) untuk diikat ke layanan, mengirim permintaan, menerima respons, dan bahkan melakukan komunikasi antarproses (IPC). Layanan terikat biasanya hidup hanya saat melayani komponen aplikasi lain dan tidak berjalan di latar belakang terus-menerus.

Dokumen ini menampilkan cara membuat layanan terikat, termasuk cara mengikat ke layanan dari komponen aplikasi lain. Akan tetapi, Anda juga harus mengacu dokumen Layanan untuk informasi tambahan tentang layanan secara umum, seperti cara menyampaikan pemberitahuan dari layanan, mengatur layanan agar berjalan di latar depan, dan lain-lain.

Dasar-Dasar

Layanan terikat adalah implementasi kelas {@link android.app.Service} yang memungkinkan aplikasi lain diikat padanya dan berinteraksi dengannya. Untuk menyediakan pengikatan bagi sebuah layanan, Anda harus mengimplementasikan metode callback {@link android.app.Service#onBind onBind()}. Metode ini menghasilkan objek {@link android.os.IBinder} yang mendefinisikan antarmuka pemprograman yang bisa digunakan klien untuk berinteraksi dengan layanan.

Klien bisa mengikat ke layanan dengan memanggil {@link android.content.Context#bindService bindService()}. Bila itu dilakukan, klien harus menyediakan implementasi {@link android.content.ServiceConnection}, yang memantau koneksi dengan layanan. Metode {@link android.content.Context#bindService bindService()} kembali dengan serta-merta tanpa sebuah nilai, namun bila sistem Android membuat koneksi antara klien dan layanan, sistem akan memanggil {@link android.content.ServiceConnection#onServiceConnected onServiceConnected()} pada {@link android.content.ServiceConnection} untuk mengirim {@link android.os.IBinder} yang bisa digunakan klien untuk berkomunikasi dengan layanan.

Beberapa klien bisa terhubung ke layanan dengan serentak. Akan tetapi, sistem akan memanggil metode {@link android.app.Service#onBind onBind()} layanan Anda untuk mengambil {@link android.os.IBinder} hanya bila klien pertama mengikat. Sistem lalu memberikan {@link android.os.IBinder} yang sama ke setiap klien tambahan yang mengikat, tanpa memanggil {@link android.app.Service#onBind onBind()} lagi.

Bila klien terakhir melepas ikatan dari layanan, sistem akan menghapus layanan (kecuali jika layanan juga dimulai oleh {@link android.content.Context#startService startService()}).

Bila Anda mengimplementasikan layanan terikat, yang terpenting adalah mendefinisikan antarmuka yang dihasilkan metode callback {@link android.app.Service#onBind onBind()} Anda. Ada sedikit cara mendefinisikan antarmuka {@link android.os.IBinder} layanan Anda dan bagian berikut akan membahas masing-masing teknik.

Membuat Layanan Terikat

Saat membuat layanan yang menyediakan pengikatan, Anda harus menyediakan {@link android.os.IBinder} yang menyediakan antarmuka pemrograman yang bisa digunakan klien untuk berinteraksi dengan layanan. Ada tiga cara untuk mendefinisikan antarmuka:

Memperluas kelas Binder
Jika layanan Anda bersifat privat untuk aplikasi Anda sendiri dan berjalan dalam proses yang sama dengan klien (biasanya), Anda harus membuat antarmuka dengan memperluas kelas {@link android.os.Binder} dan menghasilkan instance dari {@link android.app.Service#onBind onBind()}. Klien akan menerima {@link android.os.Binder} dan bisa menggunakannya untuk mengakses langsung metode publik yang tersedia dalam implementasi {@link android.os.Binder} atau bahkan {@link android.app.Service}.

Inilah teknik yang lebih disukai bila layanan Anda sekadar pekerja latar belakang untuk aplikasi Anda sendiri. Satu-satunya alasan tidak membuat antarmuka dengan cara ini adalah karena layanan Anda akan digunakan oleh aplikasi lain atau pada proses-proses terpisah.

Menggunakan Messenger
Jika antarmuka Anda perlu bekerja lintas proses, Anda bisa membuat antarmuka untuk layanan dengan {@link android.os.Messenger}. Dengan cara ini, layanan mendefinisikan {@link android.os.Handler} yang akan merespons aneka tipe objek {@link android.os.Message}. {@link android.os.Handler} ini adalah dasar bagi {@link android.os.Messenger} yang nanti bisa berbagi {@link android.os.IBinder} dengan klien, sehingga memungkinkan klien mengirim perintah ke layanan dengan menggunakan objek {@link android.os.Message}. Selain itu, klien bisa mendefinisikan sendiri {@link android.os.Messenger} sehingga layanan bisa mengirim balik pesan.

Inilah cara termudah melakukan komunikasi antarproses (IPC), karena {@link android.os.Messenger} akan mengantre semua permintaan ke dalam satu thread sehingga Anda tidak perlu mendesain layanan agar thread-safe.

Menggunakan AIDL
AIDL (Android Interface Definition Language) melakukan semua pekerjaan untuk mengurai objek menjadi primitif yang bisa dipahami dan diarahkan oleh sistem operasi ke berbagai proses untuk melakukan IPC. Teknik sebelumnya, dengan menggunakan {@link android.os.Messenger}, sebenarnya berdasarkan AIDL sebagai struktur yang mendasarinya. Seperti disebutkan di atas, {@link android.os.Messenger} membuat antrean semua permintaan klien dalam satu thread, sehingga layanan akan menerima permintaan satu per satu. Akan tetapi, jika ingin layanan Anda menangani beberapa permintaan sekaligus, Anda bisa menggunakan AIDL secara langsung. Dalam hal ini, layanan Anda harus mampu multi-thread dan dibuat thread-safe.

Untuk menggunakan AIDL secara langsung, Anda harus membuat file {@code .aidl} yang mendefinisikan antarmuka pemrograman. Alat Android SDK menggunakan file ini untuk menghasilkan kelas abstrak yang mengimplementasikan antarmuka dan menangani IPC, yang nanti bisa Anda perluas dalam layanan.

Catatan: Umumnya aplikasi tidak boleh menggunakan AIDL untuk membuat layanan terikat, karena hal itu mungkin memerlukan kemampuan multi-thread dan bisa mengakibatkan implementasi yang lebih rumit. Dengan demikian, AIDL tidak cocok untuk sebagian besar aplikasi dan dokumen ini tidak membahas cara menggunakannya untuk layanan Anda. Jika Anda yakin perlu menggunakan AIDL secara langsung, lihat dokumen AIDL .

Memperluas kelas Binder

Jika layanan Anda hanya digunakan oleh aplikasi lokal dan tidak perlu bekerja lintas proses, maka Anda bisa mengimplementasikan kelas {@link android.os.Binder} Anda sendiri yang memberi klien Anda akses langsung ke metode publik dalam layanan.

Catatan: Hal ini hanya berhasil jika klien dan layanan berada dalam aplikasi dan proses yang sama, suatu kondisi yang paling umum. Misalnya, cara ini sangat cocok untuk sebuah aplikasi musik yang perlu mengikat aktivitas ke layanannya sendiri, yakni memutar musik di latar belakang.

Berikut cara menyiapkannya:

  1. Dalam layanan Anda, buat sebuah instance {@link android.os.Binder} yang:
  2. Hasilkan instance {@link android.os.Binder} ini dari metode callback {@link android.app.Service#onBind onBind()}.
  3. Di klien, terima {@link android.os.Binder} dari metode callback {@link android.content.ServiceConnection#onServiceConnected onServiceConnected()} dan buat panggilan ke layanan terikat dengan menggunakan metode yang disediakan.

Catatan: Alasan layanan dan klien harus berada dalam aplikasi yang sama adalah agar klien bisa mengkonversi objek yang dihasilkan dan memanggil API-nya dengan benar. Layanan dan klien juga harus berada dalam proses yang sama, karena teknik ini tidak melakukan pengarahan (marshalling) apa pun untuk lintas proses.

Misalnya, berikut ini adalah layanan yang memberi klien akses ke metode-metode dalam layanan melalui implementasi {@link android.os.Binder}:

public class LocalService extends Service {
    // Binder given to clients
    private final IBinder mBinder = new LocalBinder();
    // Random number generator
    private final Random mGenerator = new Random();

    /**
     * Class used for the client Binder.  Because we know this service always
     * runs in the same process as its clients, we don't need to deal with IPC.
     */
    public class LocalBinder extends Binder {
        LocalService getService() {
            // Return this instance of LocalService so clients can call public methods
            return LocalService.this;
        }
    }

    @Override
    public IBinder onBind(Intent intent) {
        return mBinder;
    }

    /** method for clients */
    public int getRandomNumber() {
      return mGenerator.nextInt(100);
    }
}

{@code LocalBinder} menyediakan {@code getService()} metode bagi klien untuk mengambil instance {@code LocalService} saat ini. Cara ini memungkinkan klien memanggil metode publik dalam layanan. Misalnya, klien bisa memanggil {@code getRandomNumber()} dari layanan.

Berikut ini adalah aktivitas yang mengikat ke {@code LocalService} dan memanggil {@code getRandomNumber()} bila tombol diklik:

public class BindingActivity extends Activity {
    LocalService mService;
    boolean mBound = false;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.main);
    }

    @Override
    protected void onStart() {
        super.onStart();
        // Bind to LocalService
        Intent intent = new Intent(this, LocalService.class);
        bindService(intent, mConnection, Context.BIND_AUTO_CREATE);
    }

    @Override
    protected void onStop() {
        super.onStop();
        // Unbind from the service
        if (mBound) {
            unbindService(mConnection);
            mBound = false;
        }
    }

    /** Called when a button is clicked (the button in the layout file attaches to
      * this method with the android:onClick attribute) */
    public void onButtonClick(View v) {
        if (mBound) {
            // Call a method from the LocalService.
            // However, if this call were something that might hang, then this request should
            // occur in a separate thread to avoid slowing down the activity performance.
            int num = mService.getRandomNumber();
            Toast.makeText(this, "number: " + num, Toast.LENGTH_SHORT).show();
        }
    }

    /** Defines callbacks for service binding, passed to bindService() */
    private ServiceConnection mConnection = new ServiceConnection() {

        @Override
        public void onServiceConnected(ComponentName className,
                IBinder service) {
            // We've bound to LocalService, cast the IBinder and get LocalService instance
            LocalBinder binder = (LocalBinder) service;
            mService = binder.getService();
            mBound = true;
        }

        @Override
        public void onServiceDisconnected(ComponentName arg0) {
            mBound = false;
        }
    };
}

Contoh di atas menampilkan cara klien mengikat ke layanan dengan menggunakan implementasi {@link android.content.ServiceConnection} dan callback {@link android.content.ServiceConnection#onServiceConnected onServiceConnected()}. Bagian berikut menyediakan informasi selengkapnya tentang proses pengikatan ke layanan.

Catatan: Contoh di atas tidak secara eksplisit melepas ikatan dari layanan, namun semua klien harus melepas ikatan pada waktu yang tepat (seperti saat aktivitas sedang jeda).

Untuk contoh kode selengkapnya, lihat kelas {@code LocalService.java} dan kelas {@code LocalServiceActivities.java} dalam ApiDemos.

Menggunakan Messenger

Jika layanan perlu berkomunikasi dengan proses jauh, Anda bisa menggunakan {@link android.os.Messenger} untuk menyediakan antarmuka bagi layanan Anda. Teknik ini memungkinkan Anda melakukan komunikasi antarproses (IPC) tanpa harus menggunakan AIDL.

Berikut ini rangkuman cara menggunakan {@link android.os.Messenger}:

Dengan cara ini, tidak ada "metode" untuk dipanggil klien pada layanan. Sebagai gantinya, klien mengirim "pesan" (objek-objek {@link android.os.Message}) yang diterima layanan dalam {@link android.os.Handler}-nya.

Berikut ini contoh layanan sederhana yang menggunakan antarmuka {@link android.os.Messenger}:

public class MessengerService extends Service {
    /** Command to the service to display a message */
    static final int MSG_SAY_HELLO = 1;

    /**
     * Handler of incoming messages from clients.
     */
    class IncomingHandler extends Handler {
        @Override
        public void handleMessage(Message msg) {
            switch (msg.what) {
                case MSG_SAY_HELLO:
                    Toast.makeText(getApplicationContext(), "hello!", Toast.LENGTH_SHORT).show();
                    break;
                default:
                    super.handleMessage(msg);
            }
        }
    }

    /**
     * Target we publish for clients to send messages to IncomingHandler.
     */
    final Messenger mMessenger = new Messenger(new IncomingHandler());

    /**
     * When binding to the service, we return an interface to our messenger
     * for sending messages to the service.
     */
    @Override
    public IBinder onBind(Intent intent) {
        Toast.makeText(getApplicationContext(), "binding", Toast.LENGTH_SHORT).show();
        return mMessenger.getBinder();
    }
}

Perhatikan bahwa metode {@link android.os.Handler#handleMessage handleMessage()} dalam {@link android.os.Handler} adalah tempat layanan menerima {@link android.os.Message} yang masuk dan memutuskan aksi yang harus dilakukan, berdasarkan anggota {@link android.os.Message#what}.

Klien tinggal membuat {@link android.os.Messenger} berdasarkan {@link android.os.IBinder} yang dihasilkan layanan dan mengirim pesan menggunakan {@link android.os.Messenger#send send()}. Misalnya, berikut ini adalah aktivitas sederhana yang mengikat ke layanan dan mengirim pesan {@code MSG_SAY_HELLO} ke layanan:

public class ActivityMessenger extends Activity {
    /** Messenger for communicating with the service. */
    Messenger mService = null;

    /** Flag indicating whether we have called bind on the service. */
    boolean mBound;

    /**
     * Class for interacting with the main interface of the service.
     */
    private ServiceConnection mConnection = new ServiceConnection() {
        public void onServiceConnected(ComponentName className, IBinder service) {
            // This is called when the connection with the service has been
            // established, giving us the object we can use to
            // interact with the service.  We are communicating with the
            // service using a Messenger, so here we get a client-side
            // representation of that from the raw IBinder object.
            mService = new Messenger(service);
            mBound = true;
        }

        public void onServiceDisconnected(ComponentName className) {
            // This is called when the connection with the service has been
            // unexpectedly disconnected -- that is, its process crashed.
            mService = null;
            mBound = false;
        }
    };

    public void sayHello(View v) {
        if (!mBound) return;
        // Create and send a message to the service, using a supported 'what' value
        Message msg = Message.obtain(null, MessengerService.MSG_SAY_HELLO, 0, 0);
        try {
            mService.send(msg);
        } catch (RemoteException e) {
            e.printStackTrace();
        }
    }

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.main);
    }

    @Override
    protected void onStart() {
        super.onStart();
        // Bind to the service
        bindService(new Intent(this, MessengerService.class), mConnection,
            Context.BIND_AUTO_CREATE);
    }

    @Override
    protected void onStop() {
        super.onStop();
        // Unbind from the service
        if (mBound) {
            unbindService(mConnection);
            mBound = false;
        }
    }
}

Perhatikan bahwa contoh ini tidak menampilkan cara layanan merespons klien. Jika ingin layanan merespons, Anda juga perlu membuat {@link android.os.Messenger} di klien. Lalu saat menerima callback {@link android.content.ServiceConnection#onServiceConnected onServiceConnected()}, klien akan mengirim {@link android.os.Message} ke layanan yang berisi {@link android.os.Messenger} klien dalam parameter {@link android.os.Message#replyTo} metode {@link android.os.Messenger#send send()}.

Anda bisa melihat contoh cara menyediakan pertukaran pesan dua arah dalam contoh {@code MessengerService.java} (layanan) dan {@code MessengerServiceActivities.java} (klien).

Mengikat ke Layanan

Komponen-komponen aplikasi (klien) bisa mengikat ke layanan dengan memanggil {@link android.content.Context#bindService bindService()}. Sistem Android lalu memanggil metode {@link android.app.Service#onBind onBind()} layanan, yang menghasilkan {@link android.os.IBinder} untuk berinteraksi dengan layanan.

Pengikatan ini bersifat asinkron. {@link android.content.Context#bindService bindService()} segera kembali dan tidak mengembalikan {@link android.os.IBinder} ke klien. Untuk menerima {@link android.os.IBinder}, klien harus membuat instance {@link android.content.ServiceConnection} dan meneruskannya ke {@link android.content.Context#bindService bindService()}. {@link android.content.ServiceConnection} berisi metode callback yang dipanggil sistem untuk mengirim {@link android.os.IBinder}.

Catatan: Hanya aktivitas, layanan, dan penyedia konten yang bisa mengikat ke layanan yang—Anda tidak bisa ikat ke layanan dari penerima siaran.

Jadi, untuk mengikat ke layanan dari klien, Anda harus:

  1. Mengimplementasikan {@link android.content.ServiceConnection}.

    Implementasi Anda harus mengesampingkan dua metode callback:

    {@link android.content.ServiceConnection#onServiceConnected onServiceConnected()}
    Sistem memanggil ini untuk mengirim {@link android.os.IBinder} yang dihasilkan oleh metode {@link android.app.Service#onBind onBind()} layanan.
    {@link android.content.ServiceConnection#onServiceDisconnected onServiceDisconnected()}
    Sistem Android memanggil ini bila koneksi ke layanan putus tanpa terduga, seperti ketika layanan mengalami crash atau dimatikan. Ini tidak dipanggil ketika klien melepas ikatan.
  2. Panggil {@link android.content.Context#bindService bindService()}, dengan meneruskan implementasi {@link android.content.ServiceConnection}.
  3. Bila sistem memanggil metode callback {@link android.content.ServiceConnection#onServiceConnected onServiceConnected()}, Anda bisa mulai membuat panggilan ke layanan, dengan menggunakan metode yang didefinisikan oleh antarmuka.
  4. Untuk memutus koneksi dari layanan, panggil {@link android.content.Context#unbindService unbindService()}.

    Bila telah dimusnahkan (destroyed), klien Anda akan melepas ikatan dari layanan, namun Anda harus selalu melepas ikatan bila sudah selesai berinteraksi dengan layanan atau bila aktivitas Anda sedang jeda sehingga layanan bisa dimatikan saat tidak sedang digunakan. (Waktu yang tepat untuk mengikat dan melepas ikatan dibahas selengkapnya di bawah ini.)

Misalnya, cuplikan berikut menghubungkan klien ke layanan yang dibuat di atas dengan memperluas kelas Binder, sehingga tinggal mengkonversi {@link android.os.IBinder} yang dihasilkan ke kelas {@code LocalService} dan meminta instance {@code LocalService}:

LocalService mService;
private ServiceConnection mConnection = new ServiceConnection() {
    // Called when the connection with the service is established
    public void onServiceConnected(ComponentName className, IBinder service) {
        // Because we have bound to an explicit
        // service that is running in our own process, we can
        // cast its IBinder to a concrete class and directly access it.
        LocalBinder binder = (LocalBinder) service;
        mService = binder.getService();
        mBound = true;
    }

    // Called when the connection with the service disconnects unexpectedly
    public void onServiceDisconnected(ComponentName className) {
        Log.e(TAG, "onServiceDisconnected");
        mBound = false;
    }
};

Dengan {@link android.content.ServiceConnection} ini, klien bisa mengikat ke layanan dengan meneruskannya ke {@link android.content.Context#bindService bindService()}. Misalnya:

Intent intent = new Intent(this, LocalService.class);
bindService(intent, mConnection, Context.BIND_AUTO_CREATE);

Catatan tambahan

Berikut ini beberapa catatan penting tentang mengikat ke layanan:

Untuk contoh kode selengkapnya, yang menampilkan cara mengikat ke layanan, lihat kelas {@code RemoteService.java} dalam ApiDemos.

Mengelola Daur Hidup Layanan Terikat

Bila layanan dilepas ikatannya dari semua klien, sistem Android akan menghapusnya (kecuali jika layanan juga dimulai dengan {@link android.app.Service#onStartCommand onStartCommand()}). Dengan demikian, Anda tidak harus mengelola daur hidup layanan jika layanan itu murni sebuah layanan terikat—yang dikelola sistem Android untuk Anda berdasarkan apakah layanan terikat ke klien atau tidak.

Akan tetapi, Jika Anda memilih untuk mengimplementasikan metode callback {@link android.app.Service#onStartCommand onStartCommand()}, maka Anda harus menghentikan layanan secara eksplisit, karena layanan sekarang dianggap telah dimulai. Dalam hal ini, layanan akan berjalan hingga layanan menghentikan dirinya sendiri dengan {@link android.app.Service#stopSelf()} atau panggilan komponen lain {@link android.content.Context#stopService stopService()}, terlepas dari apakah layanan terikat ke klien atau tidak.

Selain itu, jika layanan Anda telah dimulai dan menerima pengikatan, maka saat sistem memanggil metode {@link android.app.Service#onUnbind onUnbind()}, Anda bisa memilih untuk mengembalikan {@code true} jika ingin menerima panggilan ke {@link android.app.Service#onRebind onRebind()} bila nanti klien mengikat ke layanan (sebagai ganti menerima panggilan ke {@link android.app.Service#onBind onBind()}). {@link android.app.Service#onRebind onRebind()} akan menghasilkan void, namun klien tetap menerima {@link android.os.IBinder} dalam callback {@link android.content.ServiceConnection#onServiceConnected onServiceConnected()}. Di bawah ini adalah gambar 1 yang mengilustrasikan logika untuk jenis daur hidup ini.

Gambar 1. Daur hidup untuk layanan yang dimulai dan juga memungkinkan pengikatan.

Untuk informasi selengkapnya tentang daur hidup layanan yang telah dimulai, lihat dokumen Layanan.