Firebase Android कोडलैब (कोड बनाना सीखना) - दोस्ताना चैट करना

1. खास जानकारी

स्क्रीनशॉट

इमेज: Working Friendly Chat ऐप्लिकेशन.

Friendly Chat के कोडलैब में आपका स्वागत है. इस कोडलैब में, आपको Android पर चैट ऐप्लिकेशन बनाने के लिए, Firebase प्लैटफ़ॉर्म का इस्तेमाल करने का तरीका पता चलेगा.

आपको क्या जानकारी मिलेगी

  • उपयोगकर्ताओं को साइन इन करने की अनुमति देने के लिए, Firebase Authentication का इस्तेमाल करने का तरीका.
  • Firebase रीयल टाइम डेटाबेस का इस्तेमाल करके डेटा सिंक करने का तरीका.
  • Firebase के लिए Cloud Storage में बाइनरी फ़ाइलें सेव करने का तरीका.
  • Firebase की मदद से Android ऐप्लिकेशन बनाने के लिए, Firebase Local Emulator Suite का इस्तेमाल करने का तरीका.

आपको इन चीज़ों की ज़रूरत होगी

  • Android Studio का नया वर्शन.
  • Android 5.0 या उसके बाद के वर्शन वाला Android Emulator.
  • Emulator Suite का इस्तेमाल करने के लिए, Node.js का 10 या उसके बाद का वर्शन.
  • Java 8 या इसके बाद का वर्शन. Java इंस्टॉल करने के लिए, इन निर्देशों का पालन करें. अपना वर्शन देखने के लिए, java -version चलाएं.
  • Kotlin प्रोग्रामिंग लैंग्वेज के बारे में जानकारी.

2. सैंपल कोड पाना

डेटा स्टोर करने की जगह को क्लोन करना

कमांड लाइन से GitHub के डेटा स्टोर करने की जगह को क्लोन करें:

$ git clone https://github.com/firebase/codelab-friendlychat-android

Android Studio में इंपोर्ट करना

Android Studio में, फ़ाइल > खोलें को चुनें. इसके बाद, उस डायरेक्ट्री से build-android-start डायरेक्ट्री ( android_studio_folder) चुनें जहां से आपने सैंपल कोड डाउनलोड किया था.

अब आपके पास Android Studio में build-android-start प्रोजेक्ट खुला होना चाहिए. अगर आपको google-services.json फ़ाइल मौजूद न होने की चेतावनी दिखती है, तो चिंता न करें. इसे अगले चरण में जोड़ा जाएगा.

डिपेंडेंसी की जांच करना

इस कोडलैब में, आपको ज़रूरी सभी डिपेंडेंसी पहले से ही जोड़ दी गई हैं. हालांकि, अपने ऐप्लिकेशन में Firebase SDK टूल जोड़ने का तरीका समझना ज़रूरी है:

build.gradle.kts

plugins {
    id("com.android.application") version "8.0.0" apply false
    id("com.android.library") version "8.0.0" apply false
    id("org.jetbrains.kotlin.android") version "1.8.20" apply false

    // The google-services plugin is required to parse the google-services.json file
    id("com.google.gms.google-services") version "4.3.15" apply false
}

app/build.gradle.kts

plugins {
    id("com.android.application")
    id("kotlin-android")
    id("com.google.gms.google-services")
}

android {
    // ...
}

dependencies {
    // ...

    // Google Sign In SDK
    implementation("com.google.android.gms:play-services-auth:20.5.0")

    // Firebase SDK
    implementation(platform("com.google.firebase:firebase-bom:32.0.0"))
    implementation("com.google.firebase:firebase-database-ktx")
    implementation("com.google.firebase:firebase-storage-ktx")
    implementation("com.google.firebase:firebase-auth-ktx")

    // Firebase UI Library
    implementation("com.firebaseui:firebase-ui-auth:8.0.2")
    implementation("com.firebaseui:firebase-ui-database:8.0.2")
}

3. Firebase CLI इंस्टॉल करना

इस कोडलैब में, Firebase Auth, रीयलटाइम डेटाबेस, और Cloud Storage को स्थानीय तौर पर एमुलेट करने के लिए, Firebase Emulator Suite का इस्तेमाल किया जाएगा. इससे, ऐप्लिकेशन बनाने के लिए, स्थानीय डेवलपमेंट का ऐसा सुरक्षित, तेज़, और बिना किसी शुल्क वाला प्लैटफ़ॉर्म मिलता है.

Firebase CLI इंस्टॉल करना

सबसे पहले, आपको Firebase CLI इंस्टॉल करना होगा. macOS या Linux का इस्तेमाल करने वाले लोग, cURL का यह कमांड चला सकते हैं:

curl -sL https://firebase.tools | bash

अगर Windows का इस्तेमाल किया जा रहा है, तो स्टैंडअलोन बाइनरी पाने या npm के ज़रिए इंस्टॉल करने के लिए, इंस्टॉल करने के निर्देश पढ़ें.

सीएलआई इंस्टॉल करने के बाद, firebase --version को चलाने पर, 9.0.0 या उसके बाद के वर्शन की जानकारी मिलनी चाहिए:

$ firebase --version
9.0.0

प्रवेश करें

सीएलआई को अपने Google खाते से कनेक्ट करने के लिए, firebase login चलाएं. लॉगिन की प्रोसेस पूरी करने के लिए, एक नई ब्राउज़र विंडो खुलेगी. पक्का करें कि आपने वही खाता चुना है जिसका इस्तेमाल करके, आपने पहले Firebase प्रोजेक्ट बनाया था.

4. Firebase Emulator Suite से कनेक्ट करना

एमुलेटर शुरू करना

अपने टर्मिनल में, अपनी स्थानीय codelab-friendlychat-android डायरेक्ट्री की रूट से यह कमांड चलाएं:

firebase emulators:start --project=demo-friendlychat-android

आपको कुछ इस तरह के लॉग दिखेंगे. पोर्ट की वैल्यू, firebase.json फ़ाइल में तय की गई थी. इसे क्लोन किए गए सैंपल कोड में शामिल किया गया था.

$ firebase emulators:start --project=demo-friendlychat-android
i  emulators: Starting emulators: auth, database, storage
i  emulators: Detected demo project ID "demo-friendlychat-android", emulated services will use a demo configuration and attempts to access non-emulated services for this project will fail.
i  database: Database Emulator logging to database-debug.log
i  ui: Emulator UI logging to ui-debug.log

┌─────────────────────────────────────────────────────────────┐
│ ✔  All emulators ready! It is now safe to connect your app. │
│ i  View Emulator UI at http://localhost:4000                │
└─────────────────────────────────────────────────────────────┘

┌────────────────┬────────────────┬────────────────────────────────┐
│ Emulator       │ Host:Port      │ View in Emulator UI            │
├────────────────┼────────────────┼────────────────────────────────┤
│ Authentication │ localhost:9099 │ http://localhost:4000/auth     │
├────────────────┼────────────────┼────────────────────────────────┤
│ Database       │ localhost:9000 │ http://localhost:4000/database │
├────────────────┼────────────────┼────────────────────────────────┤
│ Storage        │ localhost:9199 │ http://localhost:4000/storage  │
└────────────────┴────────────────┴────────────────────────────────┘
  Emulator Hub running at localhost:4400
  Other reserved ports: 4500

Issues? Report them at https://github.com/firebase/firebase-tools/issues and attach the *-debug.log files.

Firebase Emulator Suite का यूज़र इंटरफ़ेस (यूआई) देखने के लिए, अपने वेब ब्राउज़र में http://localhost:4000 पर जाएं:

Emulator Suite का यूज़र इंटरफ़ेस (यूआई) होम

कोडलैब के बाकी हिस्से के लिए, emulators:start कमांड को चलने दें.

अपना ऐप्लिकेशन कनेक्ट करना

Android Studio में, MainActivity.kt खोलें. इसके बाद, onCreate तरीके में यह कोड जोड़ें:

// When running in debug mode, connect to the Firebase Emulator Suite.
// "10.0.2.2" is a special IP address which allows the Android Emulator
// to connect to "localhost" on the host computer. The port values (9xxx)
// must match the values defined in the firebase.json file.
if (BuildConfig.DEBUG) {
    Firebase.database.useEmulator("10.0.2.2", 9000)
    Firebase.auth.useEmulator("10.0.2.2", 9099)
    Firebase.storage.useEmulator("10.0.2.2", 9199)
}

5. स्टार्टर ऐप्लिकेशन चलाना

google-services.json जोड़ना

अपने Android ऐप्लिकेशन को Firebase से कनेक्ट करने के लिए, आपको अपने Android प्रोजेक्ट के app फ़ोल्डर में google-services.json फ़ाइल जोड़नी होगी. इस कोडलैब के लिए, हमने एक मॉक JSON फ़ाइल उपलब्ध कराई है. इसकी मदद से, Firebase Emulator Suite से कनेक्ट किया जा सकता है.

mock-google-services.json फ़ाइल को build-android-start/app फ़ोल्डर में google-services.json के तौर पर कॉपी करें:

cp mock-google-services.json build-android-start/app/google-services.json

इस कोडलैब के आखिरी चरण में, आपको असल Firebase प्रोजेक्ट और Firebase Android ऐप्लिकेशन बनाने का तरीका पता चलेगा. इससे, इस मॉक JSON फ़ाइल को अपने कॉन्फ़िगरेशन से बदला जा सकता है.

ऐप्लिकेशन चलाना

प्रोजेक्ट को Android Studio में इंपोर्ट करने और Firebase कॉन्फ़िगरेशन JSON फ़ाइल जोड़ने के बाद, ऐप्लिकेशन को पहली बार चलाया जा सकता है.

  1. अपना Android एम्युलेटर शुरू करें.
  2. Android Studio में, टूलबार में रन करें ( execute) पर क्लिक करें.

ऐप्लिकेशन आपके Android एम्युलेटर पर लॉन्च होना चाहिए. इसके बाद, आपको मैसेज की खाली सूची दिखेगी. साथ ही, मैसेज भेजने और पाने की सुविधा काम नहीं करेगी. इस कोडलैब के अगले चरण में, आपको उपयोगकर्ताओं की पुष्टि करनी होगी, ताकि वे फ़्रेंडली चैट का इस्तेमाल कर सकें.

6. पुष्टि करने की प्रक्रिया चालू करें

यह ऐप्लिकेशन, सभी चैट मैसेज को सेव करने के लिए Firebase रीयलटाइम डेटाबेस का इस्तेमाल करेगा. हालांकि, डेटा जोड़ने से पहले, हमें यह पक्का करना होगा कि ऐप्लिकेशन सुरक्षित है और सिर्फ़ पुष्टि किए गए उपयोगकर्ता ही मैसेज पोस्ट कर सकते हैं. इस चरण में, हम Firebase Authentication को चालू करेंगे और रीयलटाइम डेटाबेस के सुरक्षा नियमों को कॉन्फ़िगर करेंगे.

साइन इन करने की बुनियादी सुविधा जोड़ना

इसके बाद, हम ऐप्लिकेशन में Firebase Authentication का कुछ बुनियादी कोड जोड़ेंगे, ताकि उपयोगकर्ताओं का पता लगाया जा सके और साइन-इन स्क्रीन लागू की जा सके.

मौजूदा उपयोगकर्ता की जांच करना

सबसे पहले, MainActivity.kt क्लास में यह इंस्टेंस वैरिएबल जोड़ें:

MainActivity.kt

// Firebase instance variables
private lateinit var auth: FirebaseAuth

अब MainActivity में बदलाव करके, उपयोगकर्ता को साइन-इन स्क्रीन पर भेजने की सुविधा जोड़ें. ऐसा तब किया जाएगा, जब उपयोगकर्ता ऐप्लिकेशन खोलेगा और उसकी पुष्टि नहीं की गई होगी. binding को व्यू से अटैच करने के बाद, onCreate() तरीके में ये जोड़ें:

MainActivity.kt

// Initialize Firebase Auth and check if the user is signed in
auth = Firebase.auth
if (auth.currentUser == null) {
    // Not signed in, launch the Sign In activity
    startActivity(Intent(this, SignInActivity::class.java))
    finish()
    return
}

हम यह भी देखना चाहते हैं कि onStart() के दौरान, उपयोगकर्ता ने साइन इन किया है या नहीं:

MainActivity.kt

public override fun onStart() {
    super.onStart()
    // Check if user is signed in.
    if (auth.currentUser == null) {
        // Not signed in, launch the Sign In activity
        startActivity(Intent(this, SignInActivity::class.java))
        finish()
        return
    }
}

इसके बाद, पुष्टि किए गए मौजूदा Firebase उपयोगकर्ता के बारे में सही जानकारी दिखाने के लिए, getUserPhotoUrl() और getUserName() तरीके लागू करें:

MainActivity.kt

private fun getPhotoUrl(): String? {
    val user = auth.currentUser
    return user?.photoUrl?.toString()
}

private fun getUserName(): String? {
    val user = auth.currentUser
    return if (user != null) {
        user.displayName
    } else ANONYMOUS
}

इसके बाद, साइन आउट बटन को मैनेज करने के लिए signOut() तरीका लागू करें:

MainActivity.kt

private fun signOut() {
    AuthUI.getInstance().signOut()
    startActivity(Intent(this, SignInActivity::class.java))
    finish()
}

अब हमारे पास ज़रूरत पड़ने पर, उपयोगकर्ता को साइन-इन स्क्रीन पर भेजने के लिए पूरा लॉजिक है. इसके बाद, हमें उपयोगकर्ताओं की पुष्टि करने के लिए, साइन-इन स्क्रीन लागू करनी होगी.

साइन इन स्क्रीन लागू करना

फ़ाइल SignInActivity.kt खोलें. यहां पुष्टि करने के लिए, साइन इन करने के लिए बने सामान्य बटन का इस्तेमाल किया गया है. इस सेक्शन में, साइन इन करने के लॉजिक को लागू करने के लिए, FirebaseUI का इस्तेमाल किया जाएगा.

// Firebase instance variables टिप्पणी के नीचे, SignInActivity क्लास में Auth इंस्टेंस वैरिएबल जोड़ें:

SignInActivity.kt

// Firebase instance variables
private lateinit var auth: FirebaseAuth

इसके बाद, Firebase को शुरू करने के लिए onCreate() तरीके में उसी तरह बदलाव करें जिस तरह आपने MainActivity में किया था:

SignInActivity.kt

// Initialize FirebaseAuth
auth = Firebase.auth

SignInActivity में ActivityResultLauncher फ़ील्ड जोड़ें:

SignInActivity.kt

// ADD THIS
private val signIn: ActivityResultLauncher<Intent> =
        registerForActivityResult(FirebaseAuthUIActivityResultContract(), this::onSignInResult)

override fun onCreate(savedInstanceState: Bundle?) {
    // ...
}

इसके बाद, FirebaseUI साइन इन फ़्लो को शुरू करने के लिए, onStart() तरीके में बदलाव करें:

SignInActivity.kt

public override fun onStart() {
    super.onStart()

    // If there is no signed in user, launch FirebaseUI
    // Otherwise head to MainActivity
    if (Firebase.auth.currentUser == null) {
        // Sign in with FirebaseUI, see docs for more details:
        // https://firebase.google.com/docs/auth/android/firebaseui
        val signInIntent = AuthUI.getInstance()
                .createSignInIntentBuilder()
                .setLogo(R.mipmap.ic_launcher)
                .setAvailableProviders(listOf(
                        AuthUI.IdpConfig.EmailBuilder().build(),
                        AuthUI.IdpConfig.GoogleBuilder().build(),
                ))
                .build()

        signIn.launch(signInIntent)
    } else {
        goToMainActivity()
    }
}

इसके बाद, साइन इन के नतीजे को मैनेज करने के लिए onSignInResult तरीका लागू करें. अगर साइन इन करने की प्रोसेस पूरी हो गई है, तो MainActivity पर जाएं:

SignInActivity.kt

private fun onSignInResult(result: FirebaseAuthUIAuthenticationResult) {
    if (result.resultCode == RESULT_OK) {
        Log.d(TAG, "Sign in successful!")
        goToMainActivity()
    } else {
        Toast.makeText(
                this,
                "There was an error signing in",
                Toast.LENGTH_LONG).show()

        val response = result.idpResponse
        if (response == null) {
            Log.w(TAG, "Sign in canceled")
        } else {
            Log.w(TAG, "Sign in error", response.error)
        }
    }
}

बस हो गया! आपने FirebaseUI की मदद से, पुष्टि करने की सुविधा को सिर्फ़ कुछ तरीकों के कॉल में लागू किया है. इसके लिए, आपको सर्वर साइड कॉन्फ़िगरेशन को मैनेज करने की ज़रूरत नहीं पड़ी.

अपने काम की जांच करना

अपने Android एम्युलेटर पर ऐप्लिकेशन चलाएं. इसके बाद, आपको तुरंत साइन-इन स्क्रीन पर भेज दिया जाएगा. ईमेल से साइन इन करें बटन पर टैप करें. इसके बाद, खाता बनाएं. अगर सब कुछ सही तरीके से लागू किया गया है, तो आपको मैसेजिंग स्क्रीन पर भेज दिया जाएगा.

साइन इन करने के बाद, अपने ब्राउज़र में Firebase Emulator Suite का यूज़र इंटरफ़ेस (यूआई) खोलें. इसके बाद, साइन इन किया गया पहला उपयोगकर्ता खाता देखने के लिए, पुष्टि टैब पर क्लिक करें.

7. मैसेज पढ़ना

इस चरण में, हम रीयल टाइम डेटाबेस में सेव किए गए मैसेज पढ़ने और दिखाने की सुविधा जोड़ेंगे.

सैंपल मैसेज इंपोर्ट करना

  1. Firebase Emulator Suite के यूज़र इंटरफ़ेस (यूआई) में, रीयल टाइम डेटाबेस टैब चुनें.
  2. कोडलैब रिपॉज़िटरी की लोकल कॉपी से initial_messages.json फ़ाइल को खींचें और डेटा व्यूअर में छोड़ें.

अब आपके पास डेटाबेस के messages नोड में कुछ मैसेज होने चाहिए.

डेटा पढ़ना

मैसेज सिंक करना

इस सेक्शन में, हम ऐसा कोड जोड़ते हैं जो नए जोड़े गए मैसेज को ऐप्लिकेशन के यूज़र इंटरफ़ेस (यूआई) के साथ सिंक करता है. इसके लिए, यह कोड:

  • Firebase रीयलटाइम डेटाबेस को शुरू करना और डेटा में किए गए बदलावों को मैनेज करने के लिए, एक लिसनर जोड़ना.
  • RecyclerView अडैप्टर को अपडेट करना, ताकि नए मैसेज दिखें.
  • MainActivity क्लास में, अपने अन्य Firebase इंस्टेंस वैरिएबल के साथ डेटाबेस इंस्टेंस वैरिएबल जोड़ना:

MainActivity.kt

// Firebase instance variables
// ...
private lateinit var db: FirebaseDatabase
private lateinit var adapter: FriendlyMessageAdapter

टिप्पणी // Initialize Realtime Database and FirebaseRecyclerAdapter में जाकर, MainActivity के onCreate() तरीके में नीचे दिए गए कोड का इस्तेमाल करके बदलाव करें. यह कोड, रीयलटाइम डेटाबेस से सभी मौजूदा मैसेज जोड़ता है. इसके बाद, आपके Firebase रीयलटाइम डेटाबेस में messages पाथ के तहत नई चाइल्ड एंट्री के लिए सुनता है. यह हर मैसेज के लिए, यूज़र इंटरफ़ेस (यूआई) में एक नया एलिमेंट जोड़ता है:

MainActivity.kt

// Initialize Realtime Database
db = Firebase.database
val messagesRef = db.reference.child(MESSAGES_CHILD)

// The FirebaseRecyclerAdapter class and options come from the FirebaseUI library
// See: https://github.com/firebase/FirebaseUI-Android
val options = FirebaseRecyclerOptions.Builder<FriendlyMessage>()
    .setQuery(messagesRef, FriendlyMessage::class.java)
    .build()
adapter = FriendlyMessageAdapter(options, getUserName())
binding.progressBar.visibility = ProgressBar.INVISIBLE
manager = LinearLayoutManager(this)
manager.stackFromEnd = true
binding.messageRecyclerView.layoutManager = manager
binding.messageRecyclerView.adapter = adapter

// Scroll down when a new message arrives
// See MyScrollToBottomObserver for details
adapter.registerAdapterDataObserver(
    MyScrollToBottomObserver(binding.messageRecyclerView, adapter, manager)
)

इसके बाद, FriendlyMessageAdapter.kt क्लास में, इनर क्लास MessageViewHolder() में bind() तरीका लागू करें:

FriendlyMessageAdapter.kt

inner class MessageViewHolder(private val binding: MessageBinding) : ViewHolder(binding.root) {
    fun bind(item: FriendlyMessage) {
        binding.messageTextView.text = item.text
        setTextColor(item.name, binding.messageTextView)

        binding.messengerTextView.text = if (item.name == null) ANONYMOUS else item.name
        if (item.photoUrl != null) {
            loadImageIntoView(binding.messengerImageView, item.photoUrl!!)
        } else {
            binding.messengerImageView.setImageResource(R.drawable.ic_account_circle_black_36dp)
        }
    }
    ...
}

हमें इमेज वाले मैसेज भी दिखाने हैं. इसलिए, इनर क्लास ImageMessageViewHolder() में bind() तरीका भी लागू करें:

FriendlyMessageAdapter.kt

inner class ImageMessageViewHolder(private val binding: ImageMessageBinding) :
    ViewHolder(binding.root) {
    fun bind(item: FriendlyMessage) {
        loadImageIntoView(binding.messageImageView, item.imageUrl!!)

        binding.messengerTextView.text = if (item.name == null) ANONYMOUS else item.name
        if (item.photoUrl != null) {
            loadImageIntoView(binding.messengerImageView, item.photoUrl!!)
        } else {
            binding.messengerImageView.setImageResource(R.drawable.ic_account_circle_black_36dp)
        }
    }
}

आखिर में, MainActivity में वापस जाकर, Firebase रीयलटाइम डेटाबेस से अपडेट सुनना शुरू और बंद करें. MainActivity में onPause() और onResume() तरीकों को अपडेट करें, जैसा कि यहां दिखाया गया है:

MainActivity.kt

public override fun onPause() {
    adapter.stopListening()
    super.onPause()
}

public override fun onResume() {
    super.onResume()
    adapter.startListening()
}

मैसेज सिंक करने की सुविधा की जांच करना

  1. चालू करें ( execute) पर क्लिक करें.
  2. Emulator Suite के यूज़र इंटरफ़ेस (यूआई) में, रीयल टाइम डेटाबेस टैब पर वापस जाएं. इसके बाद, मैन्युअल तरीके से नया मैसेज जोड़ें. पुष्टि करें कि मैसेज आपके Android ऐप्लिकेशन में दिख रहा है:

बधाई हो, आपने अपने ऐप्लिकेशन में रीयल टाइम डेटाबेस जोड़ दिया है!

8. मैसेज भेजना

मैसेज भेजने की सुविधा लागू करना

इस सेक्शन में, आपको ऐप्लिकेशन के उपयोगकर्ताओं के लिए टेक्स्ट मैसेज भेजने की सुविधा जोड़नी होगी. नीचे दिया गया कोड स्निपेट, भेजें बटन पर क्लिक इवेंट को सुनता है. साथ ही, मैसेज फ़ील्ड के कॉन्टेंट के साथ एक नया FriendlyMessage ऑब्जेक्ट बनाता है और मैसेज को डेटाबेस में पुश करता है. push() तरीका, पुश किए गए ऑब्जेक्ट के पाथ में अपने-आप जनरेट होने वाला आईडी जोड़ता है. ये आईडी क्रम में होते हैं. इससे यह पक्का होता है कि नए मैसेज, सूची के आखिर में जोड़े जाएंगे.

MainActivity क्लास में onCreate() तरीके में, भेजें बटन के क्लिक लिसनर को अपडेट करें. यह कोड, onCreate() तरीके के सबसे नीचे पहले से मौजूद है. नीचे दिए गए कोड से मैच करने के लिए, onClick() बॉडी को अपडेट करें:

MainActivity.kt

// Disable the send button when there's no text in the input field
// See MyButtonObserver for details
binding.messageEditText.addTextChangedListener(MyButtonObserver(binding.sendButton))

// When the send button is clicked, send a text message
binding.sendButton.setOnClickListener {
    val friendlyMessage = FriendlyMessage(
        binding.messageEditText.text.toString(),
        getUserName(),
        getPhotoUrl(),
        null /* no image */
    )
    db.reference.child(MESSAGES_CHILD).push().setValue(friendlyMessage)
    binding.messageEditText.setText("")
}

इमेज मैसेज भेजने की सुविधा लागू करना

इस सेक्शन में, आपको ऐप्लिकेशन के उपयोगकर्ताओं के लिए इमेज मैसेज भेजने की सुविधा जोड़नी होगी. इमेज मैसेज बनाने के लिए, यह तरीका अपनाएं:

  • इमेज चुनें
  • इमेज के चुने गए हिस्से को हैंडल करना
  • रीयल टाइम डेटाबेस में कुछ समय के लिए दिखने वाली इमेज का मैसेज लिखना
  • चुनी गई इमेज अपलोड करना
  • अपलोड पूरा होने के बाद, इमेज मैसेज का यूआरएल, अपलोड की गई इमेज के यूआरएल से बदलें

इमेज चुनें

इस कोडलैब में इमेज जोड़ने के लिए, Firebase के लिए Cloud Storage का इस्तेमाल किया जाता है. अपने ऐप्लिकेशन का बाइनरी डेटा सेव करने के लिए, Cloud Storage एक अच्छा विकल्प है.

इमेज चुनना और टेम्परेरी मैसेज लिखना

जब कोई उपयोगकर्ता कोई इमेज चुनता है, तो इमेज चुनने की सुविधा Intent लॉन्च हो जाती है. यह onCreate() तरीके के आखिर में, कोड में पहले से ही लागू है. इसके पूरा होने पर, यह MainActivity के onImageSelected() मेथड को कॉल करता है. नीचे दिए गए कोड स्निपेट का इस्तेमाल करके, डेटाबेस में इमेज के अस्थायी यूआरएल के साथ एक मैसेज लिखा जाएगा. इससे यह पता चलेगा कि इमेज अपलोड की जा रही है.

MainActivity.kt

private fun onImageSelected(uri: Uri) {
    Log.d(TAG, "Uri: $uri")
    val user = auth.currentUser
    val tempMessage = FriendlyMessage(null, getUserName(), getPhotoUrl(), LOADING_IMAGE_URL)
    db.reference
            .child(MESSAGES_CHILD)
            .push()
            .setValue(
                    tempMessage,
                    DatabaseReference.CompletionListener { databaseError, databaseReference ->
                        if (databaseError != null) {
                            Log.w(
                                    TAG, "Unable to write message to database.",
                                    databaseError.toException()
                            )
                            return@CompletionListener
                        }

                        // Build a StorageReference and then upload the file
                        val key = databaseReference.key
                        val storageReference = Firebase.storage
                                .getReference(user!!.uid)
                                .child(key!!)
                                .child(uri.lastPathSegment!!)
                        putImageInStorage(storageReference, uri, key)
                    })
}

इमेज अपलोड करना और मैसेज अपडेट करना

putImageInStorage() को MainActivity में जोड़ें. चुने गए इमेज को अपलोड करने के लिए, इसे onImageSelected() में कॉल किया जाता है. अपलोड पूरा होने के बाद, आपको सही इमेज का इस्तेमाल करने के लिए मैसेज अपडेट करना होगा.

MainActivity.kt

private fun putImageInStorage(storageReference: StorageReference, uri: Uri, key: String?) {
    // First upload the image to Cloud Storage
    storageReference.putFile(uri)
        .addOnSuccessListener(
            this
        ) { taskSnapshot -> // After the image loads, get a public downloadUrl for the image
            // and add it to the message.
            taskSnapshot.metadata!!.reference!!.downloadUrl
                .addOnSuccessListener { uri ->
                    val friendlyMessage =
                        FriendlyMessage(null, getUserName(), getPhotoUrl(), uri.toString())
                    db.reference
                        .child(MESSAGES_CHILD)
                        .child(key!!)
                        .setValue(friendlyMessage)
                }
        }
        .addOnFailureListener(this) { e ->
            Log.w(
                TAG,
                "Image upload task was unsuccessful.",
                e
            )
        }
}

मैसेज भेजने की जांच करना

  1. Android Studio में, executeचालू करें बटन पर क्लिक करें.
  2. अपने Android एमुलेटर में कोई मैसेज डालें. इसके बाद, भेजें बटन पर टैप करें. नया मैसेज, ऐप्लिकेशन के यूज़र इंटरफ़ेस (यूआई) और Firebase Emulator Suite के यूज़र इंटरफ़ेस (यूआई) में दिखना चाहिए.
  3. अपने डिवाइस से कोई इमेज चुनने के लिए, Android एमुलेटर में "+" इमेज पर टैप करें. नया मैसेज, सबसे पहले प्लेसहोल्डर इमेज के साथ दिखेगा. इसके बाद, इमेज अपलोड होने के बाद, चुनी गई इमेज के साथ दिखेगा. नया मैसेज, एमुलेटर सुइट के यूज़र इंटरफ़ेस (यूआई) में भी दिखना चाहिए. खास तौर पर, रीयल टाइम डेटाबेस टैब में ऑब्जेक्ट के तौर पर और स्टोरेज टैब में ब्लॉब के तौर पर.

9. बधाई हो!

आपने Firebase का इस्तेमाल करके, रीयल-टाइम चैट ऐप्लिकेशन बना लिया है!

आपको क्या सीखने को मिला

  • Firebase से पुष्टि करना
  • Firebase रीयल टाइम डेटाबेस
  • Firebase के लिए Cloud Storage

इसके बाद, अपने Android ऐप्लिकेशन में Firebase जोड़ने के लिए, इस कोडलैब में मिली जानकारी का इस्तेमाल करें! Firebase के बारे में ज़्यादा जानने के लिए, firebase.google.com पर जाएं.

अगर आपको असल Firebase प्रोजेक्ट सेट अप करने और असल Firebase संसाधनों का इस्तेमाल करने का तरीका जानना है, तो अगले चरण पर जाएं. डेमो प्रोजेक्ट और सिर्फ़ एमुलेट किए गए संसाधनों का इस्तेमाल करने के बजाय, असल संसाधनों का इस्तेमाल करें.

ध्यान दें: हमारा सुझाव है कि Firebase का कोई असल प्रोजेक्ट सेट अप करने के बाद भी, डेवलपमेंट और टेस्टिंग के लिए Firebase Local Emulator Suite का इस्तेमाल करें. खास तौर पर, किसी असल ऐप्लिकेशन को बनाने के दौरान ऐसा करना ज़रूरी है.

10. ज़रूरी नहीं: Firebase प्रोजेक्ट बनाना और सेट अप करना

इस चरण में, आपको इस कोडलैब के साथ इस्तेमाल करने के लिए, एक असल Firebase प्रोजेक्ट और Firebase Android ऐप्लिकेशन बनाना होगा. आपको अपने ऐप्लिकेशन में, ऐप्लिकेशन के हिसाब से Firebase कॉन्फ़िगरेशन भी जोड़ना होगा. आखिर में, आपको अपने ऐप्लिकेशन के साथ इस्तेमाल करने के लिए, Firebase के असली संसाधन सेट अप करने होंगे.

Firebase प्रोजेक्ट बनाना

  1. अपने ब्राउज़र में, Firebase कंसोल पर जाएं.
  2. प्रोजेक्ट जोड़ें को चुनें.
  3. प्रोजेक्ट का नाम चुनें या डालें. आपके पास अपनी पसंद का कोई भी नाम इस्तेमाल करने का विकल्प है.
  4. इस कोडलैब के लिए, आपको Google Analytics की ज़रूरत नहीं है. इसलिए, अपने प्रोजेक्ट के लिए इसे चालू करने की ज़रूरत नहीं है.
  5. प्रोजेक्ट बनाएं पर क्लिक करें. जब आपका प्रोजेक्ट तैयार हो जाए, तो जारी रखें पर क्लिक करें.

Firebase के प्लान की कीमत अपग्रेड करना

'Firebase के लिए Cloud Storage' का इस्तेमाल करने के लिए, आपका Firebase प्रोजेक्ट पे-ऐज़-यू-गो (Blaze) कीमत वाले प्लान पर होना चाहिए. इसका मतलब है कि यह Cloud Billing खाते से लिंक होना चाहिए.

  • Cloud Billing खाते के लिए, क्रेडिट कार्ड जैसा पेमेंट का कोई तरीका होना ज़रूरी है.
  • अगर आपने Firebase और Google Cloud का इस्तेमाल पहले कभी नहीं किया है, तो देखें कि क्या आपको 300 डॉलर का क्रेडिट और मुफ़्त में आज़माने के लिए Cloud Billing खाता मिल सकता है.
  • अगर आपने किसी इवेंट के तहत यह कोडलैब किया है, तो इवेंट के आयोजक से पूछें कि क्या कोई Cloud क्रेडिट उपलब्ध है.

अपने प्रोजेक्ट को Blaze प्लान पर अपग्रेड करने के लिए, यह तरीका अपनाएं:

  1. Firebase कंसोल में, अपना प्लान अपग्रेड करें को चुनें.
  2. ब्लेज़ प्लान चुनें. अपने प्रोजेक्ट से क्लाउड बिलिंग खाता लिंक करने के लिए, स्क्रीन पर दिए गए निर्देशों का पालन करें.
    अगर आपको इस अपग्रेड के तहत क्लाउड बिलिंग खाता बनाना पड़ा है, तो अपग्रेड पूरा करने के लिए, आपको Firebase Console में अपग्रेड फ़्लो पर वापस जाना पड़ सकता है.

अपने Android प्रोजेक्ट में Firebase जोड़ना

यह चरण शुरू करने से पहले, अपने ऐप्लिकेशन का SHA1 हैश पाएं. अपनी स्थानीय build-android-start डायरेक्ट्री से यह कमांड चलाकर, डीबग पासकोड का SHA1 पता लगाएं:

./gradlew signingReport

Store: /Users/<username>/.android/debug.keystore
Alias: AndroidDebugKey
MD5: A5:88:41:04:8F:06:59:6A:AE:33:76:87:AA:AD:19:23
SHA1: A7:89:F5:06:A8:07:A1:22:EC:90:6A:A6:EA:C3:D4:8B:3A:30:AB:18
SHA-256: 05:A2:2A:35:EE:F2:51:23:72:4D:72:67:A5:6A:8A:58:22:2C:00:A6:AB:F6:45:D5:A1:82:D8:90:A4:69:C8:FE
Valid until: Wednesday, August 10, 2044

आपको ऊपर जैसा आउटपुट दिखेगा. SHA1 हैश, अहम लाइन है. अगर आपको अपना SHA1 हैश नहीं मिल रहा है, तो ज़्यादा जानकारी के लिए यह पेज देखें.

Firebase कंसोल पर वापस जाएं और अपने Android प्रोजेक्ट को Firebase प्रोजेक्ट के साथ रजिस्टर करने के लिए, यह तरीका अपनाएं:

  1. अपने नए प्रोजेक्ट की खास जानकारी वाली स्क्रीन पर, सेटअप वर्कफ़्लो लॉन्च करने के लिए, Android आइकॉन पर क्लिक करें: Android ऐप्लिकेशन जोड़ना
  2. अगली स्क्रीन पर, अपने ऐप्लिकेशन के पैकेज के तौर पर com.google.firebase.codelab.friendlychat डालें.
  3. Firebase कॉन्फ़िगरेशन फ़ाइल डाउनलोड करने के लिए, ऐप्लिकेशन रजिस्टर करें पर क्लिक करें. इसके बाद, google-services.json डाउनलोड करें पर क्लिक करें.
  4. google-services.json फ़ाइल को अपने Android प्रोजेक्ट की app डायरेक्ट्री में कॉपी करें.
  5. कंसोल के सेटअप वर्कफ़्लो में दिखाए गए अगले चरणों को छोड़ें. ये चरण, build-android-start प्रोजेक्ट में आपके लिए पहले ही पूरे कर लिए गए हैं.
  6. अपने प्रोजेक्ट को Gradle फ़ाइलों के साथ सिंक करके, पक्का करें कि आपके ऐप्लिकेशन के लिए सभी डिपेंडेंसी उपलब्ध हों. Android Studio टूलबार में, फ़ाइल > Gradle फ़ाइलों के साथ प्रोजेक्ट सिंक करें चुनें. कॉन्फ़िगरेशन में किए गए बदलावों को लागू करने के लिए, आपको प्रोजेक्ट बनाएं/साफ़ करें और प्रोजेक्ट बनाएं/फिर से बनाएं को भी चलाना पड़ सकता है.

Firebase Authentication को कॉन्फ़िगर करना

आपका ऐप्लिकेशन, उपयोगकर्ताओं की ओर से Firebase Authentication API को ऐक्सेस करने से पहले, आपको Firebase Authentication और उन साइन-इन प्रोवाइडर को चालू करना होगा जिनका इस्तेमाल आपको अपने ऐप्लिकेशन में करना है.

  1. Firebase कंसोल में, बाईं ओर मौजूद नेविगेशन पैनल से पुष्टि चुनें.
  2. साइन इन करने का तरीका टैब चुनें.
  3. ईमेल/पासवर्ड पर क्लिक करें. इसके बाद, स्विच को 'चालू है' (नीले रंग में) पर टॉगल करें.
  4. Google पर क्लिक करें. इसके बाद, स्विच को चालू (नीले) पर टॉगल करें और प्रोजेक्ट के लिए सहायता ईमेल पता सेट करें.

अगर आपको इस कोडलैब में बाद में "CONFIGURATION_NOT_FOUND" मैसेज के साथ गड़बड़ियां मिलती हैं, तो इस चरण पर वापस आएं और अपने काम की दोबारा जांच करें.

रीयलटाइम डेटाबेस सेट अप करना

इस कोडलैब में मौजूद ऐप्लिकेशन, चैट मैसेज को Firebase रीयलटाइम डेटाबेस में सेव करता है. इस सेक्शन में, हम एक डेटाबेस बनाएंगे और Firebase के सुरक्षा नियमों नाम की JSON कॉन्फ़िगरेशन भाषा का इस्तेमाल करके, उसकी सुरक्षा को कॉन्फ़िगर करेंगे.

  1. Firebase कंसोल के बाएं पैनल में, बिल्ड करें को बड़ा करें. इसके बाद, रीयल टाइम डेटाबेस चुनें.
  2. डेटाबेस बनाएं पर क्लिक करें.
  3. अपने डेटाबेस के लिए कोई जगह चुनें. इसके बाद, आगे बढ़ें पर क्लिक करें.
    असल ऐप्लिकेशन के लिए, आपको ऐसी जगह चुननी होगी जो आपके उपयोगकर्ताओं के आस-पास हो.
  4. टेस्ट मोड में शुरू करें पर क्लिक करें. सुरक्षा नियमों के बारे में डिसक्लेमर पढ़ें.
    इस कोडलैब के अगले चरणों में, आपको अपने डेटा को सुरक्षित रखने के लिए सुरक्षा नियम जोड़ने होंगे. अपने डेटाबेस के लिए सुरक्षा नियम जोड़े बिना, ऐप्लिकेशन को सार्वजनिक तौर पर डिस्ट्रिब्यूट या एक्सपोज़ करें.
  5. बनाएं पर क्लिक करें.
  6. डेटाबेस इंस्टेंस बन जाने के बाद, नियम टैब चुनें. इसके बाद, नियमों के कॉन्फ़िगरेशन को इनके साथ अपडेट करें:
     {
       "rules": {
         "messages": {
           ".read": "auth.uid != null",
           ".write": "auth.uid != null"
         }
       }
     }
    

सुरक्षा नियमों के काम करने के तरीके के बारे में ज़्यादा जानने के लिए, रीयल टाइम डेटाबेस की सुरक्षा से जुड़ा दस्तावेज़ देखें. इसमें "auth" वैरिएबल के बारे में भी जानकारी दी गई है.

Firebase के लिए Cloud Storage सेट अप करना

  1. Firebase कंसोल के बाएं पैनल में, बिल्ड को बड़ा करें. इसके बाद, स्टोरेज चुनें.
  2. शुरू करें पर क्लिक करें.
  3. अपनी डिफ़ॉल्ट स्टोरेज बकेट के लिए कोई जगह चुनें.
    US-WEST1, US-CENTRAL1, और US-EAST1 में मौजूद बकेट, Google Cloud Storage के लिए "हमेशा मुफ़्त" टीयर का फ़ायदा ले सकती हैं. अन्य सभी जगहों की बकेट के लिए, Google Cloud Storage की कीमत और इस्तेमाल लागू होता है.
  4. टेस्ट मोड में शुरू करें पर क्लिक करें. सुरक्षा नियमों के बारे में डिसक्लेमर पढ़ें.
    इस कोडलैब में आगे, आपको अपने डेटा को सुरक्षित रखने के लिए सुरक्षा नियम जोड़ने होंगे. अपनी स्टोरेज बकेट के लिए सुरक्षा नियम जोड़े बिना, किसी ऐप्लिकेशन को सार्वजनिक तौर पर डिस्ट्रिब्यूट या एक्सपोज़ करें.
  5. बनाएं पर क्लिक करें.

Firebase के संसाधनों से कनेक्ट करना

इस कोडलैब के पिछले चरण में, आपने MainActivity.kt में यह जानकारी जोड़ी थी. इस कंडीशनल ब्लॉक ने आपके Android प्रोजेक्ट को Firebase Emulator Suite से कनेक्ट किया.

// REMOVE OR DISABLE THIS
if (BuildConfig.DEBUG) {
    Firebase.database.useEmulator("10.0.2.2", 9000)
    Firebase.auth.useEmulator("10.0.2.2", 9099)
    Firebase.storage.useEmulator("10.0.2.2", 9199)
}

अगर आपको अपने ऐप्लिकेशन को अपने नए असल Firebase प्रोजेक्ट और उसके असल Firebase संसाधनों से कनेक्ट करना है, तो इस ब्लॉक को हटाएं या अपने ऐप्लिकेशन को रिलीज़ मोड में चलाएं, ताकि BuildConfig.DEBUG false हो.