שרת מאגד (bound service) הוא השרת בממשק לקוח-שרת. הוא מאפשר לרכיבים כמו פעילויות להתחבר לשירות, לשלוח בקשות, לקבל תשובות ולבצע תקשורת בין תהליכים (IPC). בדרך כלל, שירות מאגד פועל רק כשהוא משרת רכיב באפליקציה, והוא לא פועל ברקע ללא הגבלת זמן.
במאמר הזה מוסבר איך ליצור שירות מאוגד, כולל איך לאגד את השירות מרכיבים אחרים באפליקציה. ב סקירה הכללית על שירותים מוסבר איך להעביר התראות משירות ולהגדיר את השירות כך שיפעל בחזית.
העקרונות הבסיסיים
שירות מאוגד הוא הטמעה של המחלקה Service שמאפשרת לאפליקציות אחרות להתאגד איתו ולתקשר איתו. כדי לספק קישור לשירות, צריך להטמיע את שיטת הקריאה החוזרת onBind(). השיטה הזו מחזירה אובייקט IBinder שמגדיר את ממשק התכנות שבו הלקוחות יכולים להשתמש כדי ליצור אינטראקציה עם השירות.
קישור לשירות שהופעל
כמו שמוסבר בסקירה הכללית של השירותים, אתם יכולים ליצור שירות שהוא גם מופעל וגם מקושר. כלומר, אפשר להפעיל שירות על ידי קריאה ל-startService(), וכך השירות יכול לפעול ללא הגבלת זמן. אפשר גם לאפשר ללקוח להתחבר לשירות באמצעות קריאה ל-bindService().
אם מאפשרים לשירות להתחיל ולהיות מקושר, כשהשירות מתחיל, המערכת לא משמידה את השירות כשכל הלקוחות מבטלים את הקישור.
במקום זאת, צריך לעצור את השירות באופן מפורש על ידי קריאה ל-stopSelf() או ל-stopService().
בדרך כלל מטמיעים את onBind()
או את onStartCommand(), אבל לפעמים צריך להטמיע את שניהם. לדוגמה, בנגן מוזיקה יכול להיות שימושי לאפשר לשירות לפעול ללא הגבלת זמן וגם לספק קישור. כך, פעילות יכולה להפעיל את השירות כדי להשמיע מוזיקה, והמוזיקה ממשיכה לפעול גם אם המשתמש יוצא מהאפליקציה. לאחר מכן, כשהמשתמש חוזר לאפליקציה, הפעילות יכולה להתחבר לשירות כדי לקבל שוב שליטה על ההפעלה.
מידע נוסף על מחזור החיים של השירות כשמוסיפים קישור לשירות שהופעל זמין בקטע ניהול מחזור החיים של שירות מאוגד.
לקוח מתחבר לשירות באמצעות קריאה ל-bindService(). כשהיא עושה זאת, היא צריכה לספק הטמעה של ServiceConnection, שעוקב אחרי החיבור לשירות. ערך ההחזרה של bindService() מציין אם השירות המבוקש קיים ואם ללקוח יש הרשאת גישה אליו.
כשהמערכת של Android יוצרת את החיבור בין הלקוח לשירות, היא קוראת ל-onServiceConnected() ב-ServiceConnection. ה-method onServiceConnected() כוללת ארגומנט IBinder, שבו הלקוח משתמש כדי לתקשר עם השרת המאגד.
אפשר לחבר כמה לקוחות לשירות בו-זמנית. עם זאת, המערכת שומרת במטמון את ערוץ התקשורת של השירות IBinder.
במילים אחרות, המערכת קוראת ל-method onBind() של השירות כדי ליצור את ה-IBinder רק כשהלקוח הראשון מבצע קישור. לאחר מכן המערכת מעבירה את אותו IBinder לכל הלקוחות הנוספים שמתחברים לאותו שירות, בלי להפעיל שוב את onBind().
כשהלקוח האחרון מבטל את הקישור לשירות, המערכת משמידה את השירות, אלא אם השירות הופעל באמצעות startService().
החלק הכי חשוב בהטמעה של שירות מאגד הוא להגדיר את הממשק ששיטת הקריאה החוזרת (callback) onBind() מחזירה. בקטע הבא מתוארות כמה דרכים להגדיר את הממשק של IBinder בשירות.
יצירת שירות מאוגד (bound service)
כשיוצרים שירות שמספק קישור, צריך לספק IBinder שמספק את ממשק התכנות שבו הלקוחות יכולים להשתמש כדי לקיים אינטראקציה עם השירות. יש שלוש דרכים להגדיר את הממשק:
- הרחבת המחלקה Binder
- אם השירות פרטי לאפליקציה שלכם ופועל באותו תהליך כמו הלקוח, וזה מצב נפוץ, אתם יכולים ליצור את הממשק על ידי הרחבה של המחלקה
Binderוהחזרת מופע שלה מ-onBind(). הלקוח מקבל אתBinderויכול להשתמש בו כדי לגשת ישירות לשיטות ציבוריות שזמינות בהטמעה שלBinderאו ב-Service.זו השיטה המועדפת כשהשירות הוא רק קובץ שירות (service worker) ברקע של האפליקציה שלכם. המקרה היחיד שבו זו לא הדרך המועדפת ליצור את הממשק הוא אם אפליקציות אחרות או תהליכים נפרדים משתמשים בשירות.
- שימוש באפליקציית מסנג'ר
- אם אתם צריכים שהממשק יעבוד בתהליכים שונים, אתם יכולים ליצור ממשק לשירות באמצעות
Messenger. כך השירות מגדירHandlerשמגיב לסוגים שונים של אובייקטים מסוגMessage.ה-
Handlerהזה הוא הבסיס ל-Messengerשיכול לשתףIBinderעם הלקוח, וכך לאפשר ללקוח לשלוח פקודות לשירות באמצעות אובייקטים שלMessage. בנוסף, הלקוח יכול להגדירMessengerמשלו, כדי שהשירות יוכל לשלוח הודעות בחזרה.זו הדרך הפשוטה ביותר לבצע תקשורת בין תהליכים (IPC), כי
Messengerמוסיף את כל הבקשות לתור ב-thread אחד, כך שלא צריך לתכנן את השירות כך שיהיה thread-safe. - שימוש ב-AIDL
- שפת ההגדרה לבניית ממשק Android (AIDL) מפרקת אובייקטים לטיפוסים בסיסיים שמערכת ההפעלה יכולה להבין, ומעבירה אותם בין תהליכים כדי לבצע IPC. השיטה הקודמת, שמשתמשת ב-
Messenger, מבוססת למעשה על AIDL כמבנה הבסיסי שלה.כמו שצוין בקטע הקודם,
Messengerיוצר תור של כל בקשות הלקוח בשרשור יחיד, כך שהשירות מקבל בקשות אחת בכל פעם. אבל אם אתם רוצים שהשירות יטפל בכמה בקשות בו-זמנית, אתם יכולים להשתמש ב-AIDL ישירות. במקרה כזה, השירות צריך להיות thread-safe ובעל יכולת ריבוי הליכי משנה (multithreading).כדי להשתמש ב-AIDL ישירות, צריך ליצור קובץ
.aidlשמגדיר את ממשק התכנות. כלי ה-SDK של Android משתמשים בקובץ הזה כדי ליצור מחלקה מופשטת שמטמיעה את הממשק ומטפלת ב-IPC, ואז אתם יכולים להרחיב אותה בתוך השירות שלכם.
הערה: ברוב האפליקציות, AIDL היא לא האפשרות הכי טובה ליצירת שירות מאוגד, כי יכול להיות שהיא תדרוש יכולות של ריבוי תהליכים (multithreading) ותוביל להטמעה מסובכת יותר. לכן, במאמר הזה לא מוסבר איך להשתמש בו בשירות שלכם. אם אתם בטוחים שאתם צריכים להשתמש ב-AIDL ישירות, עיינו במסמך AIDL.
הרחבת המחלקה Binder
אם רק האפליקציה המקומית משתמשת בשירות שלכם והיא לא צריכה לפעול בין תהליכים, אתם יכולים להטמיע מחלקת Binder משלכם שמספקת ללקוח גישה ישירה לשיטות ציבוריות בשירות.
הערה: זה עובד רק אם הלקוח והשירות נמצאים באותה אפליקציה ובאותו תהליך, וזה המצב הנפוץ ביותר. לדוגמה, זה פועל היטב באפליקציית מוזיקה שצריכה לקשר פעילות לשירות שלה שמפעיל מוזיקה ברקע.
כך מגדירים את זה:
- בשירות, יוצרים מופע של
Binderשמבצע אחת מהפעולות הבאות:- מכיל שיטות ציבוריות שהלקוח יכול להפעיל.
- הפונקציה מחזירה את המופע הנוכחי של
Service, שכולל שיטות ציבוריות שהלקוח יכול להפעיל. - מחזירה מופע של מחלקה אחרת שמתארחת בשירות, עם שיטות ציבוריות שהלקוח יכול לקרוא להן.
- מחזירים את המופע הזה של
Binderמשיטת הקריאה החוזרתonBind(). - בצד הלקוח, מקבלים את
Binderמשיטת הקריאה החוזרת (callback) שלonServiceConnected()ומבצעים קריאות לשרת המאגד באמצעות השיטות שסופקו.
הערה: השירות והלקוח חייבים להיות באותה אפליקציה כדי שהלקוח יוכל להמיר את האובייקט שהוחזר ולקרוא לממשקי ה-API שלו בצורה תקינה. השירות והלקוח צריכים להיות באותו תהליך, כי השיטה הזו לא מבצעת מרשלינג בין תהליכים.
לדוגמה, הנה שירות שמספק ללקוחות גישה לשיטות בשירות באמצעות הטמעה של Binder:
Kotlin
class LocalService : Service() { // Binder given to clients. private val binder = LocalBinder() // Random number generator. private val mGenerator = Random() /** Method for clients. */ val randomNumber: Int get() = mGenerator.nextInt(100) /** * 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. */ inner class LocalBinder : Binder() { // Return this instance of LocalService so clients can call public methods. fun getService(): LocalService = this@LocalService } override fun onBind(intent: Intent): IBinder { return binder } }
Java
public class LocalService extends Service { // Binder given to clients. private final IBinder binder = 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 binder; } /** Method for clients. */ public int getRandomNumber() { return mGenerator.nextInt(100); } }
השירות LocalBinder מספק את השיטה getService() ללקוחות כדי לאחזר את המופע הנוכחי של LocalService. כך הלקוחות יכולים לקרוא ל-methods ציבוריות בשירות. לדוגמה, לקוחות יכולים להתקשר אל getRandomNumber() מהשירות.
זו פעילות שמתחברת אל LocalService וקוראת ל-getRandomNumber() כשלוחצים על כפתור:
Kotlin
class BindingActivity : Activity() { private var mService: LocalService? = null private var mBound: Boolean = false /** Defines callbacks for service binding, passed to bindService(). */ private val connection = object : ServiceConnection { override fun onServiceConnected(className: ComponentName, service: IBinder) { // We've bound to LocalService, cast the IBinder and get LocalService instance. val binder = service as LocalService.LocalBinder mService = binder.getService() mBound = true } override fun onServiceDisconnected(arg0: ComponentName) { mService = null mBound = false } } override fun onCreate(savedInstanceState: Bundle?) { super.onCreate(savedInstanceState) setContentView(R.layout.main) } override fun onStart() { super.onStart() // Bind to LocalService. Intent(this, LocalService::class.java).also { intent -> bindService(intent, connection, Context.BIND_AUTO_CREATE) } } override fun onStop() { super.onStop() unbindService(connection) // Release the reference so the service can be garbage-collected once it's // destroyed. onServiceDisconnected() isn't called when the client unbinds. mService = null mBound = false } /** Called when a button is clicked (the button in the layout file attaches to * this method with the android:onClick attribute). */ fun onButtonClick(v: View) { if (mBound) { // Call a method from the LocalService. // However, if this call is something that might hang, then put this request // in a separate thread to avoid slowing down the activity performance. val num: Int = mService?.randomNumber ?: return Toast.makeText(this, "number: $num", Toast.LENGTH_SHORT).show() } } }
Java
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, connection, Context.BIND_AUTO_CREATE); } @Override protected void onStop() { super.onStop(); unbindService(connection); // Release the reference so the service can be garbage-collected once it's // destroyed. onServiceDisconnected() isn't called when the client unbinds. mService = null; 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 is something that might hang, then put this request // 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 connection = 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) { mService = null; mBound = false; } }; }
בדוגמה שלמעלה אפשר לראות איך הלקוח מתחבר לשירות באמצעות הטמעה של ServiceConnection והקריאה החוזרת (callback) של onServiceConnected(). בקטע הבא מוסבר בהרחבה על תהליך הקישור לשירות.
הערה: בדוגמה הקודמת, ה-method onStop() מבטלת את הקישור של הלקוח לשירות ומשחררת את ההפניה של הלקוח אליו.
לבטל את הקישור של לקוחות לשירותים בזמנים המתאימים, כפי שמתואר בקטע הערות נוספות.
כדי לראות עוד קוד לדוגמה, עיינו במחלקה
LocalService.java ובמחלקה
LocalServiceActivities.java ב-ApiDemos.
שימוש בשליח
אם אתם צריכים שהשירות שלכם יתקשר עם תהליכים מרוחקים, אתם יכולים להשתמש ב-Messenger כדי לספק את הממשק לשירות. השיטה הזו מאפשרת לבצע תקשורת בין תהליכים (IPC) בלי להשתמש ב-AIDL.
שימוש ב-Messenger לממשק פשוט יותר משימוש ב-AIDL, כי Messenger מוסיף את כל הקריאות לשירות לתור. ממשק AIDL טהור שולח בקשות בו-זמנית לשירות, שצריך לטפל בריבוי הליכי משנה.
ברוב האפליקציות, השירות לא צריך לבצע ריבוי תהליכים, כך שהשימוש ב-Messenger מאפשר לשירות לטפל בקריאה אחת בכל פעם. אם חשוב שהשירות יהיה מרובה-תהליכים, צריך להשתמש ב-AIDL כדי להגדיר את הממשק.
כך משתמשים בMessenger:
- השירות מטמיע
Handlerשמקבל קריאה חוזרת (callback) לכל קריאה מלקוח. - השירות משתמש ב-
Handlerכדי ליצור אובייקטMessenger(שהוא הפניה ל-Handler). - ה-
MessengerיוצרIBinderשהשירות מחזיר ללקוחות מ-onBind(). - הלקוחות משתמשים ב-
IBinderכדי ליצור מופע שלMessenger(שמפנה ל-Handlerשל השירות), שבו הלקוח משתמש כדי לשלוח אובייקטים שלMessageלשירות. - השירות מקבל כל
Messageב-Handlerשלו – באופן ספציפי, ב-methodhandleMessage().
כך, אין שיטות שהלקוח יכול להפעיל בשירות. במקום זאת, הלקוח שולח הודעות (אובייקטים מסוג Message) שהשירות מקבל ב-Handler שלו.
הנה דוגמה לשירות שמשתמש בממשק Messenger:
Kotlin
/** Command to the service to display a message. */ private const val MSG_SAY_HELLO = 1 class MessengerService : Service() { /** * Target we publish for clients to send messages to IncomingHandler. */ private lateinit var mMessenger: Messenger /** * Handler of incoming messages from clients. */ internal class IncomingHandler( context: Context, private val applicationContext: Context = context.applicationContext ) : Handler() { override fun handleMessage(msg: Message) { when (msg.what) { MSG_SAY_HELLO -> Toast.makeText(applicationContext, "hello!", Toast.LENGTH_SHORT).show() else -> super.handleMessage(msg) } } } /** * When binding to the service, we return an interface to our messenger * for sending messages to the service. */ override fun onBind(intent: Intent): IBinder? { Toast.makeText(applicationContext, "binding", Toast.LENGTH_SHORT).show() mMessenger = Messenger(IncomingHandler(this)) return mMessenger.binder } }
Java
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. */ static class IncomingHandler extends Handler { private Context applicationContext; IncomingHandler(Context context) { applicationContext = context.getApplicationContext(); } @Override public void handleMessage(Message msg) { switch (msg.what) { case MSG_SAY_HELLO: Toast.makeText(applicationContext, "hello!", Toast.LENGTH_SHORT).show(); break; default: super.handleMessage(msg); } } } /** * Target we publish for clients to send messages to IncomingHandler. */ Messenger mMessenger; /** * 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(); mMessenger = new Messenger(new IncomingHandler(this)); return mMessenger.getBinder(); } }
ה-method handleMessage() ב-Handler היא המקום שבו השירות מקבל את ה-Message הנכנס ומחליט מה לעשות, על סמך האיבר what.
כל מה שהלקוח צריך ל×