माइक्रोबैंचमार्क लिखें

अपने ऐप्लिकेशन कोड में बदलाव करके, माइक्रोबेंचमार्क लाइब्रेरी का इस्तेमाल करने का तरीका जानने के लिए, क्विकस्टार्ट सेक्शन देखें. अपने कोडबेस में ज़्यादा मुश्किल बदलावों के साथ, पूरा सेटअप पूरा करने का तरीका जानने के लिए, पूरे प्रोजेक्ट का सेटअप सेक्शन देखें.

क्विकस्टार्ट

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

एक बार के लिए बेंचमार्किंग करने के लिए, यह तरीका अपनाएं:

1. लाइब्रेरी को अपने मॉड्यूल की build.gradle या build.gradle.kts फ़ाइल में जोड़ें:

   Kotlin

   dependencies {
       implementation("androidx.benchmark:benchmark-junit4:1.2.4")
   }
   

   ग्रूवी

   dependencies {
       implementation 'androidx.benchmark:benchmark-junit4:1.2.4'
   }
   

   androidTestImplementation डिपेंडेंसी के बजाय, implementation डिपेंडेंसी का इस्तेमाल करें. androidTestImplementation का इस्तेमाल करने पर, बेंचमार्क नहीं चलते, क्योंकि लाइब्रेरी मेनिफ़ेस्ट को ऐप्लिकेशन मेनिफ़ेस्ट में मर्ज नहीं किया गया है.

2. debug बिल्ड टाइप को अपडेट करें, ताकि उसे डीबग न किया जा सके:

   Kotlin

   android {
       ...
       buildTypes {
           debug {
               isDebuggable = false
           }
       }
   }
   

   ग्रूवी

   android {
       ...
       buildTypes {
           debug {
               debuggable false
           }
       }
   }
   

3. testInstrumentationRunner को AndroidBenchmarkRunner में बदलें:

   Kotlin

   android {
       ...
       defaultConfig {
           testInstrumentationRunner = "androidx.benchmark.junit4.AndroidBenchmarkRunner"
       }
   }
   

   ग्रूवी

   android {
       ...
       defaultConfig {
           testInstrumentationRunner "androidx.benchmark.junit4.AndroidBenchmarkRunner"
       }
   }
   

4. अपना मानदंड जोड़ने के लिए, androidTest डायरेक्ट्री में मौजूद किसी टेस्ट फ़ाइल में BenchmarkRule का एक इंस्टेंस जोड़ें. बेंचमार्क लिखने के बारे में ज़्यादा जानकारी के लिए, माइक्रोबेंचमार्क क्लास बनाना लेख पढ़ें.

   नीचे दिया गया कोड स्निपेट, किसी अहमियत वाले इंस्ट्रुमेंट में बेंचमार्क जोड़ने का तरीका बताता है परीक्षण:

   Kotlin

   @RunWith(AndroidJUnit4::class)
   class SampleBenchmark {
       @get:Rule
       val benchmarkRule = BenchmarkRule()
   
       @Test
       fun benchmarkSomeWork() {
           benchmarkRule.measureRepeated {
               doSomeWork()
           }
       }
   }
   SampleBenchmark.kt
   

   Java

   @RunWith(AndroidJUnit4.class)
   class SampleBenchmark {
       @Rule
       public BenchmarkRule benchmarkRule = new BenchmarkRule();
   
       @Test
       public void benchmarkSomeWork() {
               BenchmarkRuleKt.measureRepeated(
                   (Function1<BenchmarkRule.Scope, Unit>) scope -> doSomeWork()
               );
          }
       }
   }
   

बेंचमार्क लिखने का तरीका जानने के लिए, माइक्रोबेंचमार्क क्लास बनाना पर जाएं.

प्रोजेक्ट का पूरा सेटअप

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

ध्यान दें: अगर टेस्ट और बेंचमार्क को अलग-अलग नहीं किया जाता है और debuggable=false मॉड्यूल के लिए, डीबगर और प्रोफ़ाइलिंग का इस्तेमाल नहीं किया जा सकता टूल का इस्तेमाल करती हैं.

Microbenchmark आपके कोड को सीधे चलाता है. इसलिए, जिस कोड का आकलन करना है उसे अलग Gradle मॉड्यूल में डालें और उस मॉड्यूल पर डिपेंडेंसी सेट करें, जैसा कि पहले चित्र में दिखाया गया है.

पहली इमेज. :app वाला ऐप्लिकेशन स्ट्रक्चर, :microbenchmark और :benchmarkable Gradle मॉड्यूल की मदद से, Microsoft में :benchmarkable मॉड्यूल.

नया Gradle मॉड्यूल जोड़ने के लिए, Android Studio में मॉड्यूल विज़र्ड का इस्तेमाल किया जा सकता है. विजर्ड, एक ऐसा मॉड्यूल बनाता है जिसे पहले से ही बेंचमार्किंग के लिए कॉन्फ़िगर किया गया है. इसमें, बेंचमार्क डायरेक्ट्री जोड़ी गई है और debuggable को false पर सेट किया गया है.

1. Android Studio में प्रोजेक्ट पैनल में, अपने प्रोजेक्ट या मॉड्यूल पर दायां क्लिक करें. इसके बाद, नया > मॉड्यूल पर क्लिक करें.

2. टेंप्लेट पैनल में मानदंड चुनें.

3. मानदंड मॉड्यूल टाइप के तौर पर, माइक्रोबेंचमार्क चुनें.

4. "माइक्रोबेंचमार्क" लिखें मॉड्यूल का नाम डालें.

5. पूरा करें पर क्लिक करें.

दूसरी इमेज. Android Studio में नया Gradle मॉड्यूल जोड़ें Bumblebee.

मॉड्यूल बनने के बाद, उसका build.gradle या build.gradle.kts बदलें फ़ाइल खोलें और उस मॉड्यूल में androidTestImplementation जोड़ें जिसमें कोड है मानदंड:

Kotlin

dependencies {
    // The module name might be different.
    androidTestImplementation(project(":benchmarkable"))
}

ग्रूवी

dependencies {
    // The module name might be different.
    androidTestImplementation project(':benchmarkable')
}

माइक्रोबेंचमार्क क्लास बनाना

मानदंड, स्टैंडर्ड इंस्ट्रुमेंटेशन टेस्ट हैं. मानदंड बनाने के लिए, लाइब्रेरी से मिली BenchmarkRule क्लास. गतिविधियों की तुलना करने के लिए, ActivityScenario या ActivityScenarioRule का इस्तेमाल करें. बेंचमार्क यूज़र इंटरफ़ेस (यूआई) कोड के लिए, @UiThreadTest का इस्तेमाल करें.

यहां दिए गए कोड में, बेंचमार्क का सैंपल दिखाया गया है:

Kotlin

@RunWith(AndroidJUnit4::class)
class SampleBenchmark {
    @get:Rule
    val benchmarkRule = BenchmarkRule()

    @Test
    fun benchmarkSomeWork() {
        benchmarkRule.measureRepeated {
            doSomeWork()
        }
    }
}
SampleBenchmark.kt
    

Java

@RunWith(AndroidJUnit4.class)
class SampleBenchmark {
    @Rule
    public BenchmarkRule benchmarkRule = new BenchmarkRule();

    @Test
    public void benchmarkSomeWork() {
        final BenchmarkState state = benchmarkRule.getState();
        while (state.keepRunning()) {
            doSomeWork();
        }
    }
}
    

सेटअप के लिए समय बंद करें

कोड के उन सेक्शन के लिए समय को बंद किया जा सकता है जिन्हें आपको runWithTimingDisabled{} ब्लॉक करें. आम तौर पर, ये सेक्शन कुछ कोड दिखाते हैं. आपको बेंचमार्क के हर बार दोहराए जाने पर, इन कोड को चलाना होगा.

Kotlin

// using random with the same seed, so that it generates the same data every run
private val random = Random(0)

// create the array once and just copy it in benchmarks
private val unsorted = IntArray(10_000) { random.nextInt() }

@Test
fun benchmark_quickSort() {
    // ...
    benchmarkRule.measureRepeated {
        // copy the array with timing disabled to measure only the algorithm itself
        listToSort = runWithTimingDisabled { unsorted.copyOf() }

        // sort the array in place and measure how long it takes
        SortingAlgorithms.quickSort(listToSort)
    }

    // assert only once not to add overhead to the benchmarks
    assertTrue(listToSort.isSorted)
}
SortingBenchmarks.kt
    

Java

private final int[] unsorted = new int[10000];

public SampleBenchmark() {
    // Use random with the same seed, so that it generates the same data every
    // run.
    Random random = new Random(0);

    // Create the array once and copy it in benchmarks.
    Arrays.setAll(unsorted, (index) -> random.nextInt());
}

@Test
public void benchmark_quickSort() {
    final BenchmarkState state = benchmarkRule.getState();

    int[] listToSort = new int[0];

    while (state.keepRunning()) {
        
        // Copy the array with timing disabled to measure only the algorithm
        // itself.
        state.pauseTiming();
        listToSort = Arrays.copyOf(unsorted, 10000);
        state.resumeTiming();
        
        // Sort the array in place and measure how long it takes.
        SortingAlgorithms.quickSort(listToSort);
    }

    // Assert only once, not to add overhead to the benchmarks.
    assertTrue(SortingAlgorithmsKt.isSorted(listToSort));
}
    

measureRepeated ब्लॉक में कम से कम काम करने की कोशिश करें और runWithTimingDisabled में. measureRepeated ब्लॉक को कई बार चलाया जाता है. इससे, बेंचमार्क को चलाने में लगने वाले कुल समय पर असर पड़ सकता है. अगर आपको को बेंचमार्क के कुछ नतीजों की पुष्टि करनी है, तो पिछले नतीजे पर दावा किया जा सकता है करने के बजाय बेंचमार्क की तमाम चीज़ें कर दी हैं.

मानक कीमत तय करें

Android Studio में, अपने बेंचमार्क को ठीक वैसे ही चलाएं जैसे किसी भी @Test के साथ किया जाता है. इसके लिए, अपनी टेस्ट क्लास या तरीके के बगल में मौजूद गटर ऐक्शन का इस्तेमाल करें, जैसा कि तीसरे चित्र में दिखाया गया है.

तीसरी इमेज. टेस्ट क्लास के बगल में मौजूद गटर ऐक्शन का इस्तेमाल करके, माइक्रोबेंचमार्क टेस्ट चलाएं.

इसके अलावा, कमांड लाइन से, सभी को चलाने के लिए connectedCheck को चलाएं Gradle मॉड्यूल से कितनी जांच की जा सकती हैं:

./gradlew benchmark:connectedCheck

या एक टेस्ट:

./gradlew benchmark:connectedCheck -P android.testInstrumentationRunnerArguments.class=com.example.benchmark.SampleBenchmark#benchmarkSomeWork

बेंचमार्क नतीजे

माइक्रोबेंचमार्क चलाने के बाद, मेट्रिक सीधे Android पर दिखती हैं Studio और अतिरिक्त मेट्रिक और डिवाइस के साथ पूरी मानदंड वाली रिपोर्ट जानकारी JSON फ़ॉर्मैट में उपलब्ध है.

चौथी इमेज. माइक्रोबेंचमार्क के नतीजे.

JSON रिपोर्ट और प्रोफ़ाइलिंग के किसी भी ट्रेस को डिवाइस से होस्ट पर भी अपने-आप कॉपी किया जाता है. ये कोड, होस्ट मशीन पर नीचे दी गई जगह पर लिखे जाते हैं:

project_root/module/build/outputs/connected_android_test_additional_output/debugAndroidTest/connected/device_id/

डिफ़ॉल्ट रूप से, JSON रिपोर्ट को डिवाइस पर मौजूद डिस्क में सेव किया जाता है. इसके लिए, शेयर किया गया बाहरी मीडिया फ़ोल्डर है, जो आम तौर पर /storage/emulated/0/Android/media/**app_id**/**app_id**-benchmarkData.json.

कॉन्फ़िगरेशन से जुड़ी गड़बड़ियां

लाइब्रेरी इन शर्तों का पता लगाती है, ताकि आपके प्रोजेक्ट और एनवायरमेंट को रिलीज़ के हिसाब से सटीक परफ़ॉर्मेंस के लिए सेट अप किया जाता है:

• डीबग करने लायक, false पर सेट है.
• किसी फ़िज़िकल डिवाइस का इस्तेमाल किया जा रहा है. एम्युलेटर का इस्तेमाल नहीं किया जा सकता.
• डिवाइस रूट होने पर, घड़ियां लॉक हो जाती हैं.
• डिवाइस की बैटरी कम से कम 25% होनी चाहिए.

अगर ऊपर दी गई कोई भी जांच पूरी नहीं होती है, तो बेंचमार्क गड़बड़ी की जानकारी देता है, ताकि गलत मेज़रमेंट को रोका जा सके.

गड़बड़ी के कुछ खास टाइप को चेतावनियों के तौर पर दिखाने और उन्हें बेंचमार्क को रोकने से रोकने के लिए, गड़बड़ी के टाइप को कॉमा से अलग की गई सूची में, इंस्ट्रूमेंटेशन आर्ग्युमेंट androidx.benchmark.suppressErrors में पास करें.

इसे अपनी ग्रेडल स्क्रिप्ट से सेट किया जा सकता है, जैसा कि नीचे दिए गए उदाहरण में दिखाया गया है:

Kotlin

android {
    defaultConfig {
       …
      testInstrumentationRunnerArguments["androidx.benchmark.suppressErrors"] = "DEBUGGABLE,LOW-BATTERY"
    }
}

ग्रूवी

android {
    defaultConfig {
       …
      testInstrumentationRunnerArguments["androidx.benchmark.suppressErrors"] = "DEBUGGABLE,LOW-BATTERY"
    }
}

कमांड लाइन से भी गड़बड़ियों को छिपाया जा सकता है:

$ ./gradlew :benchmark:connectedCheck -P andoidtestInstrumentationRunnerArguments.androidx.benchmark.supperssErrors=DEBUGGABLE,LOW-BATTERY

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