Chrome 115 से, भरोसेमंद वेब गतिविधियां (टीडब्ल्यूए), postMessage का इस्तेमाल करके मैसेज भेज सकती हैं. इस दस्तावेज़ में, आपके ऐप्लिकेशन और वेब के बीच कम्यूनिकेट करने के लिए ज़रूरी सेटअप के बारे में बताया गया है.
इस गाइड को पढ़ने के बाद, आपको ये चीज़ें पता होंगी:
- क्लाइंट और वेब कॉन्टेंट की पुष्टि करने की प्रोसेस के बारे में जानें.
- क्लाइंट और वेबकॉन्टेंट के बीच कम्यूनिकेशन चैनल को शुरू करने का तरीका जानें.
- वेब कॉन्टेंट को मैसेज भेजने और उससे मैसेज पाने का तरीका जानें.
इस गाइड का पालन करने के लिए, आपके पास ये चीज़ें होनी चाहिए:
- अपनी build.gradle फ़ाइल में, androidx.browser (कम से कम v1.6.0-alpha02) लाइब्रेरी का नया वर्शन जोड़ने के लिए.
- TWA के लिए, Chrome का 115.0.5790.13 या इसके बाद का वर्शन.
window.postMessage() तरीका, Window ऑब्जेक्ट के बीच क्रॉस-ऑरिजिन कम्यूनिकेशन को सुरक्षित तरीके से चालू करता है. उदाहरण के लिए, किसी पेज और उससे जनरेट हुए पॉप-अप के बीच या किसी पेज और उसमें एम्बेड किए गए iframe के बीच.
आम तौर पर, अलग-अलग पेजों पर मौजूद स्क्रिप्ट को सिर्फ़ तब एक-दूसरे को ऐक्सेस करने की अनुमति होती है, जब वे एक ही ऑरिजिन से शुरू होती हैं. साथ ही, वे एक ही प्रोटोकॉल, पोर्ट नंबर, और होस्ट का इस्तेमाल करती हैं. इसे एक ही ऑरिजिन की नीति भी कहा जाता है. window.postMessage() तरीका, अलग-अलग ऑरिजिन के बीच सुरक्षित तरीके से कम्यूनिकेट करने के लिए, कंट्रोल किया गया तरीका उपलब्ध कराता है. यह चैट ऐप्लिकेशन, साथ मिलकर काम करने वाले टूल वगैरह को लागू करने के लिए फ़ायदेमंद हो सकता है. उदाहरण के लिए, चैट ऐप्लिकेशन, अलग-अलग वेबसाइटों पर मौजूद उपयोगकर्ताओं के बीच मैसेज भेजने के लिए postMessage का इस्तेमाल कर सकता है.
भरोसेमंद वेब गतिविधियों (टीडब्ल्यूए) में postMessage का इस्तेमाल करना थोड़ा मुश्किल हो सकता है. इस गाइड में, वेब पेज पर मैसेज भेजने और उससे मैसेज पाने के लिए, टीडब्ल्यूए क्लाइंट में postMessage का इस्तेमाल करने का तरीका बताया गया है.
वेब पर पुष्टि करने के लिए ऐप्लिकेशन जोड़ना
postMessage API की मदद से, दो मान्य ऑरिजिन एक-दूसरे के साथ कम्यूनिकेट कर सकते हैं. इनमें एक सोर्स और एक टारगेट ऑरिजिन होता है. Android ऐप्लिकेशन को टारगेट ऑरिजिन पर मैसेज भेजने के लिए, यह बताना ज़रूरी है कि वह किस सोर्स ऑरिजिन के बराबर है. डिजिटल एसेट लिंक (डीएल) की मदद से, assetlinks.json फ़ाइल में ऐप्लिकेशन के पैकेज का नाम जोड़कर ऐसा किया जा सकता है. साथ ही, use_as_origin के तौर पर संबंध जोड़ें, ताकि यह इस तरह दिखे:
[{
"relation": ["delegate_permission/common.use_as_origin"],
"target" : { "namespace": "android_app", "package_name": "com.example.app", "sha256_cert_fingerprints": [""] }
}]
ध्यान दें कि TWA से जुड़े ऑरिजिन पर सेटअप करने के लिए, MessageEvent.origin फ़ील्ड के लिए ऑरिजिन देना ज़रूरी है. हालांकि, postMessage का इस्तेमाल उन अन्य साइटों के साथ कम्यूनिकेट करने के लिए किया जा सकता है जिनमें डिजिटल ऐसेट लिंक शामिल नहीं है. उदाहरण के लिए, अगर www.example.com आपकी है, तो आपको डीएल के ज़रिए यह साबित करना होगा. हालांकि, आपके पास www.wikipedia.org जैसी किसी भी दूसरी वेबसाइट से संपर्क करने का विकल्प है.
अपने मेनिफ़ेस्ट में PostMessageService जोड़ना
postMessage से सूचनाएं पाने के लिए, आपको सेवा को सेट अप करना होगा. इसके लिए, अपने Android मेनिफ़ेस्ट में PostMessageService जोड़ें:
<service android:name="androidx.browser.customtabs.PostMessageService"
android:exported="true"/>
CustomTabsSession का इंस्टेंस पाना
सेवा को मेनिफ़ेस्ट में जोड़ने के बाद, सेवा को बांधने के लिए CustomTabsClient क्लास का इस्तेमाल करें. कनेक्ट होने के बाद, दिए गए क्लाइंट का इस्तेमाल करके नया सेशन बनाने के लिए, यह तरीका अपनाएं.
postMessage API को मैनेज करने के लिए, CustomTabsSession मुख्य क्लास है. नीचे दिए गए कोड से पता चलता है कि सेवा कनेक्ट होने के बाद, क्लाइंट का इस्तेमाल करके नया सेशन कैसे बनाया जाता है. इस सेशन का इस्तेमाल postMessage के लिए किया जाता है:
private CustomTabsClient mClient;
private CustomTabsSession mSession;
// We use this helper method to return the preferred package to use for
// Custom Tabs.
String packageName = CustomTabsClient.getPackageName(this, null);
// Binding the service to (packageName).
CustomTabsClient.bindCustomTabsService(this, packageName, new CustomTabsServiceConnection() {
@Override
public void onCustomTabsServiceConnected(@NonNull ComponentName name,
@NonNull CustomTabsClient client) {
mClient = client;
// Note: validateRelationship requires warmup to have been called.
client.warmup(0L);
mSession = mClient.newSession(customTabsCallback);
}
@Override
public void onServiceDisconnected(ComponentName componentName) {
mClient = null;
}
});
अब आपके मन में यह सवाल चल रहा होगा कि यह customTabsCallback इंस्टेंस क्या है, है ना? हम अगले सेक्शन में इसे बनाएंगे.
CustomTabsCallback बनाना
CustomTabsCallback, CustomTabsClient के लिए एक कॉलबैक क्लास है. इससे, कस्टम टैब में होने वाले इवेंट के बारे में मैसेज मिलते हैं. इनमें से एक इवेंट onPostMessage है. यह तब ट्रिगर होता है, जब ऐप्लिकेशन को वेब से कोई मैसेज मिलता है. नीचे दिए गए कोड में दिखाए गए तरीके से, बातचीत शुरू करने के लिए postMessage चैनल को शुरू करने के लिए क्लाइंट में कॉलबैक जोड़ें.
private final String TAG = "TWA/CCT-PostMessageDemo";
// The origin the TWA is equivalent to, where the Digital Asset Links file
// was created with the "use_as_origin" relationship.
private Uri SOURCE_ORIGIN = Uri.parse("https://source-origin.example.com");
// The origin the TWA will communicate with. In most cases, SOURCE_ORIGIN and
// TARGET_ORIGIN will be the same.
private Uri TARGET_ORIGIN = Uri.parse("https://target-origin.example.com");
// It stores the validation result so you can check on it before requesting
// postMessage channel, since without successful validation it is not possible
// to use postMessage.
boolean mValidated;
CustomTabsCallback customTabsCallback = new CustomTabsCallback() {
// Listens for the validation result, you can use this for any kind of
// logging purposes.
@Override
public void onRelationshipValidationResult(int relation, @NonNull Uri requestedOrigin,
boolean result, @Nullable Bundle extras) {
// If this fails:
// - Have you called warmup?
// - Have you set up Digital Asset Links correctly?
// - Double check what browser you're using.
Log.d(TAG, "Relationship result: " + result);
mValidated = result;
}
// Listens for any navigation happens, it waits until the navigation finishes
// then requests post message channel using
// CustomTabsSession#requestPostMessageChannel(sourceUri, targetUri, extrasBundle)
// The targetOrigin in requestPostMessageChannel means that you can be certain their messages are delivered only to the website you expect.
@Override
public void onNavigationEvent(int navigationEvent, @Nullable Bundle extras) {
if (navigationEvent != NAVIGATION_FINISHED) {
return;
}
if (!mValidated) {
Log.d(TAG, "Not starting PostMessage as validation didn't succeed.");
}
// If this fails:
// - Have you included PostMessageService in your AndroidManifest.xml ?
boolean result = mSession.requestPostMessageChannel(SOURCE_ORIGIN, TARGET_ORIGIN, new Bundle());
Log.d(TAG, "Requested Post Message Channel: " + result);
}
// This gets called when the channel we requested is ready for sending/receiving messages.
@Override
public void onMessageChannelReady(@Nullable Bundle extras) {
Log.d(TAG, "Message channel ready.");
int result = mSession.postMessage("First message", null);
Log.d(TAG, "postMessage returned: " + result);
}
// Listens for upcoming messages from Web.
@Override
public void onPostMessage(@NonNull String message, @Nullable Bundle extras) {
super.onPostMessage(message, extras);
// Handle the received message.
}
};
वेब से संपर्क करना
अब हम अपने होस्ट ऐप्लिकेशन से मैसेज भेज और पा सकते हैं. वेब से ऐसा कैसे किया जा सकता है? होस्ट ऐप्लिकेशन से ही कम्यूनिकेशन शुरू होना चाहिए. इसके बाद, वेब पेज को पहले मैसेज से पोर्ट मिलना चाहिए. इस पोर्ट का इस्तेमाल, जवाब देने के लिए किया जाता है. आपकी JavaScript फ़ाइल कुछ इस तरह दिखेगी:
window.addEventListener("message", function (event) {
// We are receiveing messages from any origin, you can check of the origin by
// using event.origin
// get the port then use it for communication.
var port = event.ports[0];
if (typeof port === 'undefined') return;
// Post message on this port.
port.postMessage("Test")
// Receive upcoming messages on this port.
port.onmessage = function(event) {
console.log("[PostMessage1] Got message" + event.data);
};
});
इसका पूरा सैंपल यहां देखें
Unsplash पर Joanna Kosinska की फ़ोटो