एंड्रॉइड पर डिबग प्रदाता के साथ ऐप चेक का उपयोग करें

यदि, अपने ऐप को ऐप चेक के लिए पंजीकृत करने के बाद, आप अपने ऐप को ऐसे वातावरण में चलाना चाहते हैं जिसे ऐप चेक आमतौर पर वैध के रूप में वर्गीकृत नहीं करेगा, जैसे कि विकास के दौरान एक एमुलेटर, या निरंतर एकीकरण (सीआई) वातावरण से, तो आप ऐसा कर सकते हैं अपने ऐप का एक डिबग बिल्ड बनाएं जो वास्तविक सत्यापन प्रदाता के बजाय ऐप चेक डिबग प्रदाता का उपयोग करता है।

एमुलेटर में डिबग प्रदाता का उपयोग करें

अपने ऐप को एमुलेटर में इंटरैक्टिव रूप से चलाने के दौरान (उदाहरण के लिए, विकास के दौरान) डिबग प्रदाता का उपयोग करने के लिए, निम्न कार्य करें:

  1. अपने मॉड्यूल (ऐप-स्तर) ग्रैडल फ़ाइल में (आमतौर पर <project>/<app-module>/build.gradle.kts या <project>/<app-module>/build.gradle ), ऐप चेक के लिए निर्भरता जोड़ें Android के लिए लाइब्रेरी. हम लाइब्रेरी वर्जनिंग को नियंत्रित करने के लिए फायरबेस एंड्रॉइड BoM का उपयोग करने की सलाह देते हैं।

    dependencies {
        // Import the BoM for the Firebase platform
        implementation(platform("com.google.firebase:firebase-bom:32.7.3"))
    
        // Add the dependencies for the App Check libraries
        // When using the BoM, you don't specify versions in Firebase library dependencies
        implementation("com.google.firebase:firebase-appcheck-debug")
    }
    

    फायरबेस एंड्रॉइड बीओएम का उपयोग करके, आपका ऐप हमेशा फायरबेस एंड्रॉइड लाइब्रेरी के संगत संस्करणों का उपयोग करेगा।

    (वैकल्पिक) BoM का उपयोग किए बिना फायरबेस लाइब्रेरी निर्भरताएँ जोड़ें

    यदि आप फायरबेस बीओएम का उपयोग नहीं करना चुनते हैं, तो आपको प्रत्येक फायरबेस लाइब्रेरी संस्करण को उसकी निर्भरता पंक्ति में निर्दिष्ट करना होगा।

    ध्यान दें कि यदि आप अपने ऐप में एकाधिक फायरबेस लाइब्रेरी का उपयोग करते हैं, तो हम लाइब्रेरी संस्करणों को प्रबंधित करने के लिए BoM का उपयोग करने की दृढ़ता से अनुशंसा करते हैं, जो सुनिश्चित करता है कि सभी संस्करण संगत हैं।

    dependencies {
        // Add the dependencies for the App Check libraries
        // When NOT using the BoM, you must specify versions in Firebase library dependencies
        implementation("com.google.firebase:firebase-appcheck-debug:17.1.2")
    }
    
    कोटलिन-विशिष्ट लाइब्रेरी मॉड्यूल खोज रहे हैं? अक्टूबर 2023 (फायरबेस बीओएम 32.5.0) से शुरू होकर, कोटलिन और जावा डेवलपर्स दोनों मुख्य लाइब्रेरी मॉड्यूल पर निर्भर हो सकते हैं (विवरण के लिए, इस पहल के बारे में अक्सर पूछे जाने वाले प्रश्न देखें)।

  2. अपने डिबग बिल्ड में, डिबग प्रदाता फ़ैक्टरी का उपयोग करने के लिए ऐप चेक को कॉन्फ़िगर करें:

    Kotlin+KTX

    Firebase.initialize(context = this)
    Firebase.appCheck.installAppCheckProviderFactory(
        DebugAppCheckProviderFactory.getInstance(),
    )

    Java

    FirebaseApp.initializeApp(/*context=*/ this);
    FirebaseAppCheck firebaseAppCheck = FirebaseAppCheck.getInstance();
    firebaseAppCheck.installAppCheckProviderFactory(
            DebugAppCheckProviderFactory.getInstance());
  3. ऐप लॉन्च करें और फायरबेस बैकएंड सेवा पर कॉल ट्रिगर करें। जब एसडीके बैकएंड पर अनुरोध भेजने का प्रयास करेगा तो एक स्थानीय डिबग टोकन लॉग किया जाएगा। उदाहरण के लिए:

    D DebugAppCheckProvider: Enter this debug secret into the allow list in
    the Firebase Console for your project: 123a4567-b89c-12d3-e456-789012345678
  4. फायरबेस कंसोल के ऐप चेक अनुभाग में, अपने ऐप के ओवरफ्लो मेनू से डिबग टोकन प्रबंधित करें चुनें। फिर, पिछले चरण में आपके द्वारा लॉग किए गए डिबग टोकन को पंजीकृत करें।

    डिबग टोकन प्रबंधित करें मेनू आइटम का स्क्रीनशॉट

आपके द्वारा टोकन पंजीकृत करने के बाद, फायरबेस बैकएंड सेवाएं इसे वैध मान लेंगी।

क्योंकि यह टोकन किसी वैध डिवाइस के बिना आपके फायरबेस संसाधनों तक पहुंच की अनुमति देता है, इसलिए यह महत्वपूर्ण है कि आप इसे निजी रखें। इसे किसी सार्वजनिक रिपॉजिटरी के लिए प्रतिबद्ध न करें, और यदि किसी पंजीकृत टोकन के साथ कभी छेड़छाड़ की जाती है, तो इसे तुरंत फायरबेस कंसोल में रद्द कर दें।

सीआई वातावरण में यूनिट परीक्षण के लिए डिबग प्रदाता का उपयोग करें

सतत एकीकरण (सीआई) वातावरण में इकाई परीक्षण के लिए डिबग प्रदाता का उपयोग करने के लिए, निम्नलिखित कार्य करें:

  1. फायरबेस कंसोल के ऐप चेक अनुभाग में, अपने ऐप के ओवरफ्लो मेनू से डिबग टोकन प्रबंधित करें चुनें। फिर, एक नया डिबग टोकन बनाएं। अगले चरण में आपको टोकन की आवश्यकता होगी.

    क्योंकि यह टोकन किसी वैध डिवाइस के बिना आपके फायरबेस संसाधनों तक पहुंच की अनुमति देता है, इसलिए यह महत्वपूर्ण है कि आप इसे निजी रखें। इसे किसी सार्वजनिक रिपॉजिटरी के लिए प्रतिबद्ध न करें, और यदि किसी पंजीकृत टोकन के साथ कभी छेड़छाड़ की जाती है, तो इसे तुरंत फायरबेस कंसोल में रद्द कर दें।

    डिबग टोकन प्रबंधित करें मेनू आइटम का स्क्रीनशॉट

  2. आपके द्वारा अभी बनाए गए डिबग टोकन को अपने CI सिस्टम के सुरक्षित कुंजी स्टोर में जोड़ें (उदाहरण के लिए, GitHub Actions के एन्क्रिप्टेड रहस्य या ट्रैविस CI के एन्क्रिप्टेड वेरिएबल )।

  3. यदि आवश्यक हो, तो अपने डिबग टोकन को सीआई वातावरण में पर्यावरण चर के रूप में उपलब्ध कराने के लिए अपने सीआई सिस्टम को कॉन्फ़िगर करें। वेरिएबल को APP_CHECK_DEBUG_TOKEN_FROM_CI जैसा कुछ नाम दें।

  4. अपने मॉड्यूल (ऐप-स्तर) ग्रैडल फ़ाइल में (आमतौर पर <project>/<app-module>/build.gradle.kts या <project>/<app-module>/build.gradle ), ऐप चेक के लिए निर्भरता जोड़ें Android के लिए लाइब्रेरी. हम लाइब्रेरी वर्जनिंग को नियंत्रित करने के लिए फायरबेस एंड्रॉइड BoM का उपयोग करने की सलाह देते हैं।

    Kotlin+KTX

    dependencies {
        // Import the BoM for the Firebase platform
        implementation(platform("com.google.firebase:firebase-bom:32.7.3"))
    
        // Add the dependency for the App Check library
        // When using the BoM, you don't specify versions in Firebase library dependencies
        implementation("com.google.firebase:firebase-appcheck-debug")
    }
    

    फायरबेस एंड्रॉइड बीओएम का उपयोग करके, आपका ऐप हमेशा फायरबेस एंड्रॉइड लाइब्रेरी के संगत संस्करणों का उपयोग करेगा।

    (वैकल्पिक) BoM का उपयोग किए बिना फायरबेस लाइब्रेरी निर्भरताएँ जोड़ें

    यदि आप फायरबेस बीओएम का उपयोग नहीं करना चुनते हैं, तो आपको प्रत्येक फायरबेस लाइब्रेरी संस्करण को उसकी निर्भरता पंक्ति में निर्दिष्ट करना होगा।

    ध्यान दें कि यदि आप अपने ऐप में एकाधिक फायरबेस लाइब्रेरी का उपयोग करते हैं, तो हम लाइब्रेरी संस्करणों को प्रबंधित करने के लिए BoM का उपयोग करने की दृढ़ता से अनुशंसा करते हैं, जो सुनिश्चित करता है कि सभी संस्करण संगत हैं।

    dependencies {
        // Add the dependency for the App Check library
        // When NOT using the BoM, you must specify versions in Firebase library dependencies
        implementation("com.google.firebase:firebase-appcheck-debug:17.1.2")
    }
    
    कोटलिन-विशिष्ट लाइब्रेरी मॉड्यूल खोज रहे हैं? अक्टूबर 2023 (फायरबेस बीओएम 32.5.0) से शुरू होकर, कोटलिन और जावा डेवलपर्स दोनों मुख्य लाइब्रेरी मॉड्यूल पर निर्भर हो सकते हैं (विवरण के लिए, इस पहल के बारे में अक्सर पूछे जाने वाले प्रश्न देखें)।

    Java

    dependencies {
        // Import the BoM for the Firebase platform
        implementation(platform("com.google.firebase:firebase-bom:32.7.3"))
    
        // Add the dependency for the App Check library
        // When using the BoM, you don't specify versions in Firebase library dependencies
        implementation("com.google.firebase:firebase-appcheck-debug")
    }
    

    फायरबेस एंड्रॉइड बीओएम का उपयोग करके, आपका ऐप हमेशा फायरबेस एंड्रॉइड लाइब्रेरी के संगत संस्करणों का उपयोग करेगा।

    (वैकल्पिक) BoM का उपयोग किए बिना फायरबेस लाइब्रेरी निर्भरताएँ जोड़ें

    यदि आप फायरबेस बीओएम का उपयोग नहीं करना चुनते हैं, तो आपको प्रत्येक फायरबेस लाइब्रेरी संस्करण को उसकी निर्भरता पंक्ति में निर्दिष्ट करना होगा।

    ध्यान दें कि यदि आप अपने ऐप में एकाधिक फायरबेस लाइब्रेरी का उपयोग करते हैं, तो हम लाइब्रेरी संस्करणों को प्रबंधित करने के लिए BoM का उपयोग करने की दृढ़ता से अनुशंसा करते हैं, जो सुनिश्चित करता है कि सभी संस्करण संगत हैं।

    dependencies {
        // Add the dependency for the App Check library
        // When NOT using the BoM, you must specify versions in Firebase library dependencies
        implementation("com.google.firebase:firebase-appcheck-debug:17.1.2")
    }
    
    कोटलिन-विशिष्ट लाइब्रेरी मॉड्यूल खोज रहे हैं? अक्टूबर 2023 (फायरबेस बीओएम 32.5.0) से शुरू होकर, कोटलिन और जावा डेवलपर्स दोनों मुख्य लाइब्रेरी मॉड्यूल पर निर्भर हो सकते हैं (विवरण के लिए, इस पहल के बारे में अक्सर पूछे जाने वाले प्रश्न देखें)।

  5. अपने CI बिल्ड वैरिएंट के कॉन्फ़िगरेशन में निम्नलिखित जोड़ें:

    testInstrumentationRunnerArguments["firebaseAppCheckDebugSecret"] =
        System.getenv("APP_CHECK_DEBUG_TOKEN_FROM_CI") ?: ""
    
  6. अपनी परीक्षण कक्षाओं में, ऐप चेक टोकन की आवश्यकता वाले किसी भी कोड को लपेटने के लिए DebugAppCheckTestHelper का उपयोग करें:

    Kotlin+KTX

    @RunWith(AndroidJunit4::class)
    class MyTests {
        private val debugAppCheckTestHelper =
            DebugAppCheckTestHelper.fromInstrumentationArgs()
    
        @Test
        fun testWithDefaultApp() {
            debugAppCheckTestHelper.withDebugProvider {
                // Test code that requires a debug AppCheckToken.
            }
        }
    
        @Test
        fun testWithNonDefaultApp() {
            debugAppCheckTestHelper.withDebugProvider(
                FirebaseApp.getInstance("nonDefaultApp")
            ) {
                // Test code that requires a debug AppCheckToken.
            }
        }
    }
    

    Java

    @RunWith(AndroidJunit4.class)
    public class YourTests {
        private final DebugAppCheckTestHelper debugAppCheckTestHelper =
                DebugAppCheckTestHelper.fromInstrumentationArgs();
    
        @Test
        public void testWithDefaultApp() {
            debugAppCheckTestHelper.withDebugProvider(() -> {
                // Test code that requires a debug AppCheckToken.
            });
        }
    
        @Test
        public void testWithNonDefaultApp() {
            debugAppCheckTestHelper.withDebugProvider(
                    FirebaseApp.getInstance("nonDefaultApp"),
                    () -> {
                        // Test code that requires a debug AppCheckToken.
                    });
        }
    }
    

जब आपका ऐप सीआई वातावरण में चलता है, तो फायरबेस बैकएंड सेवाएं उसके द्वारा भेजे गए टोकन को मान्य मान लेंगी।