Mikro-Benchmark schreiben

Informationen dazu, wie Sie die Microbenchmark-Bibliothek verwenden, indem Sie Änderungen an Ihrem Anwendungscode vornehmen, finden Sie im Abschnitt Schnellstart. Informationen zur vollständigen Einrichtung mit komplexeren Änderungen an der Codebasis finden Sie im Abschnitt Vollständige Projekteinrichtung.

Kurzanleitung

In diesem Abschnitt erfahren Sie, wie Sie Benchmarking ausprobieren und einmalige Messungen ausführen, ohne Code in Module verschieben zu müssen. Für genaue Leistungsergebnisse müssen Sie bei diesen Schritten das Debugging in Ihrer App deaktivieren. Behalten Sie sie daher in einer lokalen Arbeitskopie, ohne die Änderungen in Ihrem Versionskontrollsystem zu übernehmen.

So führen Sie einen einmaligen Benchmark durch:

1. Fügen Sie die Bibliothek der Datei build.gradle oder build.gradle.kts Ihres Moduls hinzu:

   Kotlin

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

   Groovy

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

   Verwenden Sie eine implementation-Abhängigkeit anstelle einer androidTestImplementation-Abhängigkeit. Wenn Sie androidTestImplementation verwenden, werden die Benchmarks nicht ausgeführt, da das Manifest der Bibliothek nicht in das App-Manifest eingefügt wurde.

2. Aktualisieren Sie den Buildtyp von debug, damit er nicht debugbar ist:

   Kotlin

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

   Groovy

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

3. Ändern Sie testInstrumentationRunner in AndroidBenchmarkRunner:

   Kotlin

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

   Groovy

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

4. Fügen Sie eine Instanz von BenchmarkRule in einer Testdatei im Verzeichnis androidTest hinzu, um den Benchmark hinzuzufügen. Weitere Informationen zum Erstellen von Benchmarks finden Sie unter Microbenchmark-Klasse erstellen.

   Das folgende Code-Snippet zeigt, wie Sie einem instrumentierten Test einen Benchmark hinzufügen:

   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()
               );
          }
       }
   }

Informationen zum Erstellen eines Benchmarks finden Sie unter Microbenchmark-Klasse erstellen.

Vollständige Projekteinrichtung

Wenn Sie regelmäßige statt einmalige Benchmarks einrichten möchten, trennen Sie die Benchmarks in ein eigenes Modul. So wird sichergestellt, dass die Konfiguration, z. B. die Einstellung von debuggable auf false, von regulären Tests getrennt ist.

Da Microbenchmark Ihren Code direkt ausführt, platzieren Sie den Code, den Sie benchmarken möchten, in einem separaten Gradle-Modul und legen Sie die Abhängigkeit von diesem Modul fest, wie in Abbildung 1 dargestellt.

Wenn Sie ein neues Gradle-Modul hinzufügen möchten, können Sie den Modulassistenten in Android Studio verwenden. Der Assistent erstellt ein Modul, das für Benchmarks vorkonfiguriert ist. Es wird ein Benchmark-Verzeichnis hinzugefügt und debuggable auf false festgelegt.

1. Klicken Sie in Android Studio im Bereich Project (Projekt) mit der rechten Maustaste auf Ihr Projekt oder Modul und dann auf New > Module (Neu > Modul).

2. Wählen Sie im Bereich Vorlagen die Option Benchmark aus.

3. Wählen Sie als Benchmark-Modultyp Microbenchmark aus.

4. Geben Sie „microbenchmark“ als Modulnamen ein.

5. Klicken Sie auf Fertig.

Ändern Sie nach dem Erstellen des Moduls die Datei build.gradle oder build.gradle.kts und fügen Sie dem Modul mit dem Code für den Benchmark androidTestImplementation hinzu:

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

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

Microbenchmark-Klasse erstellen

Benchmarks sind standardmäßige Instrumentierungstests. Verwenden Sie zum Erstellen eines Benchmarks die von der Bibliothek bereitgestellte Klasse BenchmarkRule. Verwenden Sie ActivityScenario oder ActivityScenarioRule, um Aktivitäten zu vergleichen. Verwenden Sie @UiThreadTest, um den UI-Code zu benchmarken.

Der folgende Code zeigt einen Beispiel-Benchmark:

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

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

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

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

Zeitplan für die Einrichtung deaktivieren

Mit dem Block runWithTimingDisabled{} können Sie die Zeitmessung für Codeabschnitte deaktivieren, die nicht erfasst werden sollen. Diese Abschnitte enthalten in der Regel Code, der bei jeder Iteration des Benchmarks ausgeführt werden muss.

// 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
    

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));
}
    

Versuchen Sie, die Arbeitslast im Block measureRepeated und in runWithTimingDisabled zu minimieren. Der Block measureRepeated wird mehrmals ausgeführt und kann sich auf die Gesamtzeit auswirken, die für die Ausführung des Benchmarks erforderlich ist. Wenn Sie einige Ergebnisse eines Benchmarks prüfen möchten, können Sie das letzte Ergebnis prüfen, anstatt dies bei jeder Iteration des Benchmarks zu tun.

Benchmark ausführen

Führen Sie in Android Studio Ihren Benchmark wie bei jeder @Test aus, indem Sie die Aktion in der Leiste neben Ihrer Testklasse oder ‑methode ausführen, wie in Abbildung 3 dargestellt.

Alternativ können Sie in der Befehlszeile connectedCheck ausführen, um alle Tests aus dem angegebenen Gradle-Modul auszuführen:

./gradlew benchmark:connectedCheck

Oder für einen einzelnen Test:

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

Benchmark-Ergebnisse

Nach einem erfolgreichen Microbenchmark-Lauf werden die Messwerte direkt in Android Studio angezeigt und ein vollständiger Benchmarkbericht mit zusätzlichen Messwerten und Geräteinformationen ist im JSON-Format verfügbar.

JSON-Berichte und alle Profiling-Traces werden ebenfalls automatisch vom Gerät auf den Host kopiert. Sie werden an folgendem Ort auf dem Hostcomputer geschrieben:

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

Standardmäßig wird der JSON-Bericht auf dem Gerät im externen freigegebenen Medienordner des Test-APKs auf die Festplatte geschrieben. Dieser Ordner befindet sich normalerweise unter /storage/emulated/0/Android/media/**app_id**/**app_id**-benchmarkData.json.

Konfigurationsfehler

Die Bibliothek erkennt die folgenden Bedingungen, um sicherzustellen, dass Ihr Projekt und Ihre Umgebung für eine leistungsstarke Release-Umgebung eingerichtet sind:

• „Debuggable“ ist auf false festgelegt.
• Es wird ein physisches Gerät verwendet. Emulatoren werden nicht unterstützt.
• Die Uhren sind gesperrt, wenn das Gerät gerootet ist.
• Der Akkustand des Geräts muss mindestens 25 % betragen.

Wenn eine der vorherigen Prüfungen fehlschlägt, meldet der Benchmark einen Fehler, um ungenaue Messungen zu vermeiden.

Wenn Sie bestimmte Fehlertypen als Warnungen unterdrücken und verhindern möchten, dass der Benchmark dadurch beendet wird, übergeben Sie den Fehlertyp in einer durch Kommas getrennten Liste an das Instrumentierungsargument androidx.benchmark.suppressErrors.

Sie können dies in Ihrem Gradle-Script festlegen, wie im folgenden Beispiel gezeigt:

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

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

Sie können Fehler auch über die Befehlszeile unterdrücken:

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

Wenn Fehler unterdrückt werden, wird der Benchmark in einem fehlerhaft konfigurierten Zustand ausgeführt. Die Ausgabe des Benchmarks wird absichtlich umbenannt, indem Testnamen mit dem Fehler vorangestellt werden. Wenn Sie beispielsweise einen debuggbaren Benchmark mit der Unterdrückung im vorherigen Snippet ausführen, wird den Testnamen DEBUGGABLE_ vorangestellt.