Ta strona została przetłumaczona przez Cloud Translation API.

Mikroporównanie i Hilt

Wiele aplikacji używa Hilt do wstrzykiwania różnych zachowań w różnych wersjach kompilacji. Może to być szczególnie przydatne podczas mikrotestowania aplikacji, ponieważ umożliwia wymianę komponentu, który może zniekształcać wyniki. Na przykład poniższy fragment kodu pokazuje repozytorium, które pobiera i sortuje listę nazw:

Kotlin

class PeopleRepository @Inject constructor(
    @Kotlin private val dataSource: NetworkDataSource,
    @Dispatcher(DispatcherEnum.IO) private val dispatcher: CoroutineDispatcher
) {
    private val _peopleLiveData = MutableLiveData<List<Person>>()

    val peopleLiveData: LiveData<List<Person>>
        get() = _peopleLiveData

    suspend fun update() {
        withContext(dispatcher) {
            _peopleLiveData.postValue(
                dataSource.getPeople()
                    .sortedWith(compareBy({ it.lastName }, { it.firstName }))
            )
        }
    }
}}

Java

public class PeopleRepository {

    private final MutableLiveData<List<Person>> peopleLiveData = new MutableLiveData<>();

    private final NetworkDataSource dataSource;

    public LiveData<List<Person>> getPeopleLiveData() {
        return peopleLiveData;
    }

    @Inject
    public PeopleRepository(NetworkDataSource dataSource) {
        this.dataSource = dataSource;
    }

    private final Comparator<Person> comparator = Comparator.comparing(Person::getLastName)
            .thenComparing(Person::getFirstName);

    public void update() {
        Runnable task = new Runnable() {

            @Override
            public void run() {
                peopleLiveData.postValue(
                        dataSource.getPeople()
                                .stream()
                                .sorted(comparator)
                                .collect(Collectors.toList())
                );
            }
        };
        new Thread(task).start();
    }
}

Jeśli podczas testu porównawczego uwzględniasz wywołanie sieciowe, zaimplementuj fałszywe wywołanie sieciowe, aby uzyskać dokładniejszy wynik.

Uwzględnianie rzeczywistego wywołania sieci podczas testów porównawczych utrudnia interpretację wyników. Na wywołania sieciowe może wpływać wiele czynników zewnętrznych, a czas ich trwania może się różnić w zależności od iteracji testu porównawczego. Czas trwania połączeń sieciowych może być dłuższy niż sortowanie.

Implementowanie fałszywego wywołania sieciowego za pomocą Hilt

Wywołanie dataSource.getPeople(), jak pokazano w poprzednim przykładzie, zawiera wywołanie sieciowe. Jednak instancja NetworkDataSource jest wstrzykiwana przez Hilt, a na potrzeby testów porównawczych możesz ją zastąpić tą fałszywą implementacją:

Kotlin

class FakeNetworkDataSource @Inject constructor(
    private val people: List<Person>
) : NetworkDataSource {
    override fun getPeople(): List<Person> = people
}

Java

public class FakeNetworkDataSource implements NetworkDataSource{

    private List<Person> people;

    @Inject
    public FakeNetworkDataSource(List<Person> people) {
        this.people = people;
    }

    @Override
    public List<Person> getPeople() {
        return people;
    }
}

To fałszywe wywołanie sieciowe ma działać jak najszybciej, gdy wywołasz metodę getPeople(). Aby Hilt mógł wstrzyknąć ten obiekt, używany jest ten dostawca:

Kotlin

@Module
@InstallIn(SingletonComponent::class)
object FakekNetworkModule {

    @Provides
    @Kotlin
    fun provideNetworkDataSource(@ApplicationContext context: Context): NetworkDataSource {
        val data = context.assets.open("fakedata.json").use { inputStream ->
            val bytes = ByteArray(inputStream.available())
            inputStream.read(bytes)

            val gson = Gson()
            val type: Type = object : TypeToken<List<Person>>() {}.type
            gson.fromJson<List<Person>>(String(bytes), type)
        }
        return FakeNetworkDataSource(data)
    }
}

Java

@Module
@InstallIn(SingletonComponent.class)
public class FakeNetworkModule {

    @Provides
    @Java
    NetworkDataSource provideNetworkDataSource(
            @ApplicationContext Context context
    ) {
        List<Person> data = new ArrayList<>();
        try (InputStream inputStream = context.getAssets().open("fakedata.json")) {
            int size = inputStream.available();
            byte[] bytes = new byte[size];
            if (inputStream.read(bytes) == size) {
                Gson gson = new Gson();
                Type type = new TypeToken<ArrayList<Person>>() {
                }.getType();
                data = gson.fromJson(new String(bytes), type);

            }
        } catch (IOException e) {
            // Do something
        }
        return new FakeNetworkDataSource(data);
    }
}

Dane są wczytywane z zasobów za pomocą wywołania wejścia/wyjścia o potencjalnie zmiennej długości. Odbywa się to jednak podczas inicjalizacji i nie powoduje żadnych nieprawidłowości, gdy funkcja getPeople() jest wywoływana podczas analizy porównawczej.

Niektóre aplikacje używają już atrap w wersjach debugowania, aby usunąć zależności od backendu. Musisz jednak przeprowadzić test porównawczy na kompilacji jak najbardziej zbliżonej do kompilacji wersji. W pozostałej części tego dokumentu używamy struktury z wieloma modułami i wariantami, jak opisano w sekcji Pełna konfiguracja projektu.

Dostępne są 3 moduły:

benchmarkable: zawiera kod do testu porównawczego.
benchmark: zawiera kod wartości referencyjnej.
app: zawiera pozostały kod aplikacji.

Każdy z powyższych modułów ma wariant kompilacji o nazwie benchmark oraz zwykłe warianty debug i release.

Konfigurowanie modułu testu porównawczego

Kod fałszywego wywołania sieciowego znajduje się w zestawie źródeł debug modułu benchmarkable, a pełna implementacja sieci znajduje się w zestawie źródeł release tego samego modułu. Plik zasobu zawierający dane zwrócone przez fałszywą implementację znajduje się w zestawie źródeł debug, aby uniknąć nadmiernego rozrostu pliku APK w kompilacji release. Wariant benchmark musi być oparty na release i korzystać ze zbioru źródeł debug. Konfiguracja kompilacji wariantu benchmark modułu benchmarkable zawierającego fałszywą implementację jest taka:

Kotlin

android {
    ...
    buildTypes {
        release {
            isMinifyEnabled = false
            proguardFiles(
                getDefaultProguardFile("proguard-android-optimize.txt"),
                "proguard-rules.pro"
            )
        }
        create("benchmark") {
            initWith(getByName("release"))
        }
    }
    ...
    sourceSets {
        getByName("benchmark") {
            java.setSrcDirs(listOf("src/debug/java"))
            assets.setSrcDirs(listOf("src/debug/assets"))
        }
    }
}

Groovy

android {
    ...
    buildTypes {
        release {
            minifyEnabled false
            proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'),
                'proguard-rules.pro'
            )
        }
        benchmark {
            initWith release
        }
    }
    ...
    sourceSets {
        benchmark {
            java.setSrcDirs ['src/debug/java']
            assets.setSrcDirs(listOf ['src/debug/assets']
        }
    }
}

W module benchmark dodaj niestandardowy program do uruchamiania testów, który tworzy element Application, aby testy mogły być uruchamiane w sposób obsługujący Hilt:

Kotlin

class HiltBenchmarkRunner : AndroidBenchmarkRunner() {

    override fun newApplication(
        cl: ClassLoader?,
        className: String?,
        context: Context?
    ): Application {
        return super.newApplication(cl, HiltTestApplication::class.java.name, context)
    }
}

Java

public class JavaHiltBenchmarkRunner extends AndroidBenchmarkRunner {

    @Override
    public Application newApplication(
            ClassLoader cl,
            String className,
            Context context
    ) throws InstantiationException, IllegalAccessException, ClassNotFoundException {
        return super.newApplication(cl, HiltTestApplication.class.getName(), context);
    }
}

Dzięki temu obiekt Application, w którym są uruchamiane testy, rozszerza klasę HiltTestApplication. Wprowadź te zmiany w konfiguracji kompilacji:

Kotlin

plugins {
    alias(libs.plugins.android.library)
    alias(libs.plugins.benchmark)
    alias(libs.plugins.jetbrains.kotlin.android)
    alias(libs.plugins.kapt)
    alias(libs.plugins.hilt)
}

android {
    namespace = "com.example.hiltmicrobenchmark.benchmark"
    compileSdk = 34

    defaultConfig {
        minSdk = 24

        testInstrumentationRunner = "com.example.hiltbenchmark.HiltBenchmarkRunner"
    }

    testBuildType = "benchmark"
    buildTypes {
        debug {
            // Since isDebuggable can't be modified by Gradle for library modules,
            // it must be done in a manifest. See src/androidTest/AndroidManifest.xml.
            isMinifyEnabled = true
            proguardFiles(
                getDefaultProguardFile("proguard-android-optimize.txt"),
                "benchmark-proguard-rules.pro"
            )
        }
        create("benchmark") {
            initWith(getByName("debug"))
        }
    }
}

dependencies {
    androidTestImplementation(libs.bundles.hilt)
    androidTestImplementation(project(":benchmarkable"))
    implementation(libs.androidx.runner)
    androidTestImplementation(libs.androidx.junit)
    androidTestImplementation(libs.junit)
    implementation(libs.androidx.benchmark)
    implementation(libs.google.dagger.hiltTesting)
    kaptAndroidTest(libs.google.dagger.hiltCompiler)
    androidTestAnnotationProcessor(libs.google.dagger.hiltCompiler)
}

Groovy

plugins {
    alias libs.plugins.android.library
    alias libs.plugins.benchmark
    alias libs.plugins.jetbrains.kotlin.android
    alias libs.plugins.kapt
    alias libs.plugins.hilt
}

android {
    namespace = 'com.example.hiltmicrobenchmark.benchmark'
    compileSdk = 34

    defaultConfig {
        minSdk = 24

        testInstrumentationRunner 'com.example.hiltbenchmark.HiltBenchmarkRunner'
    }

    testBuildType "benchmark"
    buildTypes {
        debug {
            // Since isDebuggable can't be modified by Gradle for library modules,
            // it must be done in a manifest. See src/androidTest/AndroidManifest.xml.
            minifyEnabled true
            proguardFiles(
                getDefaultProguardFile('proguard-android-optimize.txt'),
                'benchmark-proguard-rules.pro'
            )
        }
        benchmark {
            initWith debug"
        }
    }
}

dependencies {
    androidTestImplementation libs.bundles.hilt
    androidTestImplementation project(':benchmarkable')
    implementation libs.androidx.runner
    androidTestImplementation libs.androidx.junit
    androidTestImplementation libs.junit
    implementation libs.androidx.benchmark
    implementation libs.google.dagger.hiltTesting
    kaptAndroidTest libs.google.dagger.hiltCompiler
    androidTestAnnotationProcessor libs.google.dagger.hiltCompiler
}

W przykładzie powyżej:

Stosuje do kompilacji niezbędne wtyczki Gradle.
Określa, że do uruchamiania testów używany jest niestandardowy mechanizm wykonawczy testów.
Określa, że wariant benchmark jest typem testu dla tego modułu.
Dodaje wariant benchmark.
Dodaje wymagane zależności.

Musisz zmienić testBuildType, aby Gradle utworzył zadanie connectedBenchmarkAndroidTest, które przeprowadzi testy porównawcze.

Tworzenie mikrobenczmarku

Analiza porównawcza jest realizowana w ten sposób:

Kotlin

@RunWith(AndroidJUnit4::class)
@HiltAndroidTest
class PeopleRepositoryBenchmark {

    @get:Rule
    val benchmarkRule = BenchmarkRule()

    @get:Rule
    val hiltRule = HiltAndroidRule(this)

    private val latch = CountdownLatch(1)

    @Inject
    lateinit var peopleRepository: PeopleRepository

    @Before
    fun setup() {
        hiltRule.inject()
    }

    @Test
    fun benchmarkSort() {
        benchmarkRule.measureRepeated {
            runBlocking {
                benchmarkRule.getStart().pauseTiming()
                withContext(Dispatchers.Main.immediate) {
                    peopleRepository.peopleLiveData.observeForever(observer)
                }
                benchmarkRule.getStart().resumeTiming()
                peopleRepository.update()
                latch.await()
                assert(peopleRepository.peopleLiveData.value?.isNotEmpty() ?: false)
           }
        }
    }

    private val observer: Observer<List<Person>> = object : Observer<List<Person>> {
        override fun onChanged(people: List<Person>?) {
            peopleRepository.peopleLiveData.removeObserver(this)
            latch.countDown()
        }
    }
}

Java

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

    @Rule
    public HiltAndroidRule hiltRule = new HiltAndroidRule(this);

    private CountdownLatch latch = new CountdownLatch(1);

    @Inject
    JavaPeopleRepository peopleRepository;

    @Before
    public void setup() {
        hiltRule.inject();
    }

    @Test
    public void benchmarkSort() {
        BenchmarkRuleKt.measureRepeated(benchmarkRule, (Function1<BenchmarkRule.Scope, Unit>) scope -> {
            benchmarkRule.getState().pauseTiming();
            new Handler(Looper.getMainLooper()).post(() -> {
                awaitValue(peopleRepository.getPeopleLiveData());
            });
            benchmarkRule.getState().resumeTiming();
            peopleRepository.update();
            try {
                latch.await();
            } catch (InterruptedException e) {
                throw new RuntimeException(e);
            }
            assert (!peopleRepository.getPeopleLiveData().getValue().isEmpty());
            return Unit.INSTANCE;
        });
    }

    private <T> void awaitValue(LiveData<T> liveData) {
        Observer<T> observer = new Observer<T>() {
            @Override
            public void onChanged(T t) {
                liveData.removeObserver(this);
                latch.countDown();
            }
        };
        liveData.observeForever(observer);
        return;
    }
}

W powyższym przykładzie tworzone są reguły zarówno dla testu porównawczego, jak i dla Hilta. benchmarkRule mierzy czas testu porównawczego. hiltRule przeprowadza wstrzykiwanie zależności w klasie testu porównawczego. Aby przeprowadzić wstrzykiwanie przed uruchomieniem poszczególnych testów, musisz wywołać metodę inject() reguły Hilt w funkcji @Before.

Samo testowanie porównawcze wstrzymuje pomiar czasu, gdy zarejestrowany jest obserwator LiveData. Następnie używa zatrzasku, aby poczekać na zaktualizowanie LiveData przed zakończeniem. Sortowanie odbywa się w czasie między wywołaniem funkcji peopleRepository.update() a otrzymaniem aktualizacji przez funkcję LiveData, dlatego czas trwania sortowania jest uwzględniany w czasie testu porównawczego.

Uruchamianie mikrobenczmarku

Uruchom test porównawczy za pomocą polecenia ./gradlew :benchmark:connectedBenchmarkAndroidTest, aby przeprowadzić go w wielu iteracjach i wydrukować dane o czasie w Logcat:

PeopleRepositoryBenchmark.log[Metric (timeNs) results: median 613408.3952380952, min 451949.30476190476, max 1412143.5142857144, standardDeviation: 273221.2328680522...

W przykładzie powyżej wynik testu porównawczego wynosi od 0,6 ms do 1,4 ms w przypadku uruchomienia algorytmu sortowania na liście 1000 elementów. Jeśli jednak uwzględnisz w teście porównawczym wywołanie sieciowe, odchylenie między iteracjami będzie większe niż czas potrzebny na samo sortowanie. Dlatego konieczne jest odseparowanie sortowania od wywołania sieciowego.

Zawsze możesz przekształcić kod, aby ułatwić uruchamianie sortowania w izolacji, ale jeśli używasz już Hilta, możesz go użyć do wstrzykiwania fałszywych obiektów na potrzeby testów porównawczych.

Wstecz

Argumenty instrumentacji mikroporównawczej

Dalej

Tworzenie bez Gradle