שימוש ב-Wi-Fi ישיר (P2P) לחיפוש שירות

השיעור הראשון בכיתה הזו, שימוש בשירות רשת Discovery, הראו לכם לגלות שירותים שמחוברים לרשת מקומית. אבל, באמצעות התכונה 'גילוי שירות' של Wi-Fi ישיר (P2P) מאפשרת לך לגלות שירותים של מכשירים בקרבת מקום ישירות, בלי להתחבר לרשת. אפשר גם לפרסם את השירותים. שפועלת במכשיר שלכם. היכולות האלה עוזרות לכם לתקשר בין אפליקציות, גם כשאין רשת מקומית או נקודה לשיתוף אינטרנט זמינים.

אומנם המטרה של קבוצת ממשקי ה-API הזו דומה למטרות של גילוי שירותי הרשת ממשקי ה-API שמתוארים בשיעור קודם שונה מאוד מההטמעה שלהם בקוד. בשיעור הזה נסביר איך לגלות שירותים שזמינים במכשירים אחרים, באמצעות Wi-Fi ישיר. השיעור מניח שאתם כבר מכירים את ממשק API של Wi-Fi ישיר.

הגדרת המניפסט

כדי להשתמש ב-Wi-Fi P2P, צריך להוסיף את CHANGE_WIFI_STATE, ACCESS_WIFI_STATE, ACCESS_FINE_LOCATION, וINTERNET הרשאות למניפסט. אם האפליקציה מטרגטת את Android 13 (רמת API 33) ואילך, צריך להוסיף גם את הקוד NEARBY_WIFI_DEVICES, למניפסט. למרות ש-Wi-Fi ישיר לא מחייב בחיבור לאינטרנט, הוא משתמש בשקעי Java רגילים, ומשתמש בהם ב-Android נדרשות ההרשאות הנדרשות.

<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    package="com.example.android.nsdchat"
    ...

    <uses-permission
        android:required="true"
        android:name="android.permission.ACCESS_WIFI_STATE"/>
    <uses-permission
        android:required="true"
        android:name="android.permission.CHANGE_WIFI_STATE"/>
    <uses-permission
        android:required="true"
        android:name="android.permission.INTERNET"/>
    <!-- If your app targets Android 13 (API level 33)
         or higher, you must declare the NEARBY_WIFI_DEVICES permission. -->
    <uses-permission
        android:name="android.permission.NEARBY_WIFI_DEVICES"
        <!-- If your app derives location information from Wi-Fi APIs,
             don't include the "usesPermissionFlags" attribute. -->
        android:usesPermissionFlags="neverForLocation" />
    <uses-permission
        android:required="true"
        android:name="android.permission.ACCESS_FINE_LOCATION"
        <!-- If any feature in your app relies on precise location information,
             don't include the "maxSdkVersion" attribute. -->
        android:maxSdkVersion="32" />
    ...

מלבד ההרשאות הקודמות, ממשקי ה-API הבאים מחייבים גם להפעיל את מצב המיקום:

הוספת שירות מקומי

אם העסק שלך מספק שירות מקומי, עליך לרשום אותו בתור גילוי שירותים. לאחר הרישום של השירות המקומי, ה-framework מגיב באופן אוטומטי לבקשות לקבלת שירות מעמיתים.

כדי ליצור שירות מקומי:

  1. לכתוב אובייקט WifiP2pServiceInfo.
  2. מאכלסים אותו במידע על השירות שלכם.
  3. יש להתקשר אל addLocalService() כדי לרשום את המכשיר המקומי לחיפוש שירותים.

Kotlin

    private fun startRegistration() {
        //  Create a string map containing information about your service.
        val record: Map<String, String> = mapOf(
                "listenport" to SERVER_PORT.toString(),
                "buddyname" to "John Doe${(Math.random() * 1000).toInt()}",
                "available" to "visible"
        )

        // Service information.  Pass it an instance name, service type
        // _protocol._transportlayer , and the map containing
        // information other devices will want once they connect to this one.
        val serviceInfo =
                WifiP2pDnsSdServiceInfo.newInstance("_test", "_presence._tcp", record)

        // Add the local service, sending the service info, network channel,
        // and listener that will be used to indicate success or failure of
        // the request.
        manager.addLocalService(channel, serviceInfo, object : WifiP2pManager.ActionListener {
            override fun onSuccess() {
                // Command successful! Code isn't necessarily needed here,
                // Unless you want to update the UI or add logging statements.
            }

            override fun onFailure(arg0: Int) {
                // Command failed.  Check for P2P_UNSUPPORTED, ERROR, or BUSY
            }
        })
    }

Java

    private void startRegistration() {
        //  Create a string map containing information about your service.
        Map record = new HashMap();
        record.put("listenport", String.valueOf(SERVER_PORT));
        record.put("buddyname", "John Doe" + (int) (Math.random() * 1000));
        record.put("available", "visible");

        // Service information.  Pass it an instance name, service type
        // _protocol._transportlayer , and the map containing
        // information other devices will want once they connect to this one.
        WifiP2pDnsSdServiceInfo serviceInfo =
                WifiP2pDnsSdServiceInfo.newInstance("_test", "_presence._tcp", record);

        // Add the local service, sending the service info, network channel,
        // and listener that will be used to indicate success or failure of
        // the request.
        manager.addLocalService(channel, serviceInfo, new ActionListener() {
            @Override
            public void onSuccess() {
                // Command successful! Code isn't necessarily needed here,
                // Unless you want to update the UI or add logging statements.
            }

            @Override
            public void onFailure(int arg0) {
                // Command failed.  Check for P2P_UNSUPPORTED, ERROR, or BUSY
            }
        });
    }

מידע על שירותים בקרבת מקום

מערכת Android משתמשת בשיטות התקשרות חזרה כדי לשלוח התראות לאפליקציה לגבי שירותים זמינים, לכן הדבר הראשון שצריך לעשות הוא להגדיר אותם. יצירת WifiP2pManager.DnsSdTxtRecordListener להאזנה רשומות נכנסות. ניתן לשדר את הרשומה הזו באופן אופציונלי על ידי אדם אחר מכשירים. כשהמכשיר נכנס, צריך להעתיק את כתובת המכשיר של המידע הרלוונטי שרוצים בתוך מבנה נתונים חיצוני כדי שתוכלו לגשת אליה מאוחר יותר. הדוגמה הבאה מניחה הרשומה מכילה שם חבר שמאוכלס בזהות המשתמש.

Kotlin

private val buddies = mutableMapOf<String, String>()
...
private fun discoverService() {
    /* Callback includes:
     * fullDomain: full domain name: e.g. "printer._ipp._tcp.local."
     * record: TXT record dta as a map of key/value pairs.
     * device: The device running the advertised service.
     */
    val txtListener = DnsSdTxtRecordListener { fullDomain, record, device ->
        Log.d(TAG, "DnsSdTxtRecord available -$record")
        record["buddyname"]?.also {
            buddies[device.deviceAddress] = it
        }
    }
}

Java

final HashMap<String, String> buddies = new HashMap<String, String>();
...
private void discoverService() {
    DnsSdTxtRecordListener txtListener = new DnsSdTxtRecordListener() {
        @Override
        /* Callback includes:
         * fullDomain: full domain name: e.g. "printer._ipp._tcp.local."
         * record: TXT record dta as a map of key/value pairs.
         * device: The device running the advertised service.
         */

        public void onDnsSdTxtRecordAvailable(
                String fullDomain, Map record, WifiP2pDevice device) {
                Log.d(TAG, "DnsSdTxtRecord available -" + record.toString());
                buddies.put(device.deviceAddress, record.get("buddyname"));
            }
        };
}

כדי לקבל את פרטי השירות, צריך ליצור WifiP2pManager.DnsSdServiceResponseListener. הזה מקבל את התיאור ופרטי החיבור בפועל. הקוד הקודם קטע קוד יישם אובייקט Map כדי להתאים כתובת מכשיר לחבר שם. ה-service listener לתגובת השירות משתמש באפשרות הזו כדי לקשר את רשומת ה-DNS עם פרטי השירות המתאימים. אחרי ששניהם המאזינים מוטמעים, צריך להוסיף אותם ל-WifiP2pManager באמצעות השיטה setDnsSdResponseListeners().

Kotlin

private fun discoverService() {
    ...

    val servListener = DnsSdServiceResponseListener { instanceName, registrationType, resourceType ->
        // Update the device name with the human-friendly version from
        // the DnsTxtRecord, assuming one arrived.
        resourceType.deviceName = buddies[resourceType.deviceAddress] ?: resourceType.deviceName

        // Add to the custom adapter defined specifically for showing
        // wifi devices.
        val fragment = fragmentManager
                .findFragmentById(R.id.frag_peerlist) as WiFiDirectServicesList
        (fragment.listAdapter as WiFiDevicesAdapter).apply {
            add(resourceType)
            notifyDataSetChanged()
        }

        Log.d(TAG, "onBonjourServiceAvailable $instanceName")
    }

    manager.setDnsSdResponseListeners(channel, servListener, txtListener)
    ...
}

Java

private void discoverService() {
...

    DnsSdServiceResponseListener servListener = new DnsSdServiceResponseListener() {
        @Override
        public void onDnsSdServiceAvailable(String instanceName, String registrationType,
                WifiP2pDevice resourceType) {

                // Update the device name with the human-friendly version from
                // the DnsTxtRecord, assuming one arrived.
                resourceType.deviceName = buddies
                        .containsKey(resourceType.deviceAddress) ? buddies
                        .get(resourceType.deviceAddress) : resourceType.deviceName;

                // Add to the custom adapter defined specifically for showing
                // wifi devices.
                WiFiDirectServicesList fragment = (WiFiDirectServicesList) getFragmentManager()
                        .findFragmentById(R.id.frag_peerlist);
                WiFiDevicesAdapter adapter = ((WiFiDevicesAdapter) fragment
                        .getListAdapter());

                adapter.add(resourceType);
                adapter.notifyDataSetChanged();
                Log.d(TAG, "onBonjourServiceAvailable " + instanceName);
        }
    };

    manager.setDnsSdResponseListeners(channel, servListener, txtListener);
    ...
}

עכשיו צריך ליצור בקשת שירות ולהתקשר אל addServiceRequest(). השיטה הזו גם לוקחת את המאזינים לדווח על הצלחה או כישלון.

Kotlin

        serviceRequest = WifiP2pDnsSdServiceRequest.newInstance()
        manager.addServiceRequest(
                channel,
                serviceRequest,
                object : WifiP2pManager.ActionListener {
                    override fun onSuccess() {
                        // Success!
                    }

                    override fun onFailure(code: Int) {
                        // Command failed.  Check for P2P_UNSUPPORTED, ERROR, or BUSY
                    }
                }
        )

Java

        serviceRequest = WifiP2pDnsSdServiceRequest.newInstance();
        manager.addServiceRequest(channel,
                serviceRequest,
                new ActionListener() {
                    @Override
                    public void onSuccess() {
                        // Success!
                    }

                    @Override
                    public void onFailure(int code) {
                        // Command failed.  Check for P2P_UNSUPPORTED, ERROR, or BUSY
                    }
                });

לסיום, התקשרו אל discoverServices().

Kotlin

        manager.discoverServices(
                channel,
                object : WifiP2pManager.ActionListener {
                    override fun onSuccess() {
                        // Success!
                    }

                    override fun onFailure(code: Int) {
                        // Command failed. Check for P2P_UNSUPPORTED, ERROR, or BUSY
                        when (code) {
                            WifiP2pManager.P2P_UNSUPPORTED -> {
                                Log.d(TAG, "Wi-Fi Direct isn't supported on this device.")
                            }
                        }
                    }
                }
        )

Java

        manager.discoverServices(channel, new ActionListener() {

            @Override
            public void onSuccess() {
                // Success!
            }

            @Override
            public void onFailure(int code) {
                // Command failed.  Check for P2P_UNSUPPORTED, ERROR, or BUSY
                if (code == WifiP2pManager.P2P_UNSUPPORTED) {
                    Log.d(TAG, "Wi-Fi Direct isn't supported on this device.");
                else if(...)
                    ...
            }
        });

אם הכל בסדר, הידד, סיימת! אם תיתקלו בבעיות, חשוב לזכור שהשיחות האסינכרוניות שביצעתם WifiP2pManager.ActionListener כארגומנט, וגם כך תקבלו קריאות חוזרות (callback) שמצביעות על הצלחה או כישלון. כדי לאבחן לשים את הקוד לניפוי באגים ב-onFailure(). קוד השגיאה שמסופקים על ידי השיטה, מרמזים על הבעיה. ערכי השגיאה האפשריים ומה המשמעות שלהם

P2P_UNSUPPORTED
אין תמיכה ב-Wi-Fi ישיר של
במכשיר שהאפליקציה פועלת בו.
BUSY
המערכת עסוקה מדי ולא יכולה לעבד את הבקשה.
ERROR
הפעולה נכשלה עקב שגיאה פנימית.