Mikroporównanie i Hilt

Wiele aplikacji używa Hilt do wstrzykiwania różnych zachowań do różnych wersji. Może to być szczególnie przydatne przy przeprowadzaniu mikroporównań aplikacji, ponieważ pozwala komponent, który może zniekształcać wyniki. Na przykład poniższy fragment kodu pokazuje repozytorium, które pobiera i sortuje listę nazw:

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

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 w analizach porównawczych uwzględnisz wywołanie sieciowe, zaimplementuj fałszywe wywołanie sieciowe aby uzyskać dokładniejszy wynik.

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

Wdrażanie fałszywego wywołania sieciowego za pomocą Hilt

Wywołanie funkcji dataSource.getPeople() zgodnie z powyższym przykładem zawiera wywołanie sieciowe. Jednak instancja NetworkDataSource jest wstrzykiwana przez Hilt, ale można go zastąpić tą fałszywą implementacją analiza porównawcza:

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

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 połączenie sieciowe zostało zaprojektowane tak, aby przebiegać jak najszybciej, gdy dzwonisz metodę getPeople(). Aby Hilt mógł wstrzyknąć ten kod, używa się tego dostawcy:

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

@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ą ładowane z komponentów za pomocą wywołania I/O o potencjalnie zmiennej długości. Odbywa się to jednak podczas inicjowania i nie spowoduje żadnych nieprawidłowości gdy funkcja getPeople() jest wywoływana podczas testu porównawczego.

Niektóre aplikacje już korzystają z podróbek w kompilacji debugowej, aby usunąć zależności od zaplecza. Benchmarki muszą jednak być przeprowadzane na wersji jak najbardziej zbliżonej do wersji produkcyjnej. W dalszej części tego dokumentu używamy struktury z wieloma modułami i wersjami, jak opisano w artykule Pełna konfiguracja projektu.

Dostępne są 3 moduły:

• benchmarkable: zawiera kod do porównania.
• benchmark: zawiera kod benchmarku.
• app: zawiera pozostały kod aplikacji.

Każdy z poprzednich 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 sieci znajduje się w zbiorze debug źródłowym modułu benchmarkable, a pełna implementacja sieci – w zbiorze release źródeł tego samego modułu. Plik zasobu zawierający dane zwrócone przez fałszywe wdrożenie znajduje się w zestawie źródeł debug, aby uniknąć rozrostu pliku APK w komponencie release. Wariant benchmark musi być oparty na release i wykorzystywać zbiór źródeł debug. Konfiguracja kompilacji dla wariantu benchmark modułu benchmarkable zawierającego fałszywą implementację:

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

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 moduł testowy, który tworzy Application dla testów, które mają być wykonywane w modułach obsługujących Hilt. Aby to zrobić:

class HiltBenchmarkRunner : AndroidBenchmarkRunner() {

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

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 zakres Zajęcia: HiltTestApplication. Wprowadź te zmiany w kompilacji Konfiguracja:

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

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
}

Poprzedni przykład:

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

Musisz zmienić parametr testBuildType, aby Gradle utworzył zadanie connectedBenchmarkAndroidTest, które wykonuje test porównawczy.

Tworzenie mikroanalizy

Benchmark jest implementowany w ten sposób:

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

@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 reguły są tworzone zarówno dla benchmarku, jak i dla Hilta. benchmarkRule wykonuje test porównawczy z uwzględnieniem czasu trwania testu. hiltRule wykonuje wstrzykiwanie zależności w klasie testowej. Aby wykonać wstrzyknięcie, musisz wywołać metodę inject() reguły Hilt w funkcji @Before przed uruchomieniem poszczególnych testów.

Sam test porównawczy zatrzymuje czas, gdy obserwator LiveData zarejestrowano. Następnie używa zatrzasku do oczekiwania na aktualizację LiveData przed wykończenia. Sortowanie jest wykonywane w czasie między momentem Usługa peopleRepository.update() jest wywoływana, a gdy LiveData otrzyma aktualizację, czas trwania sortowania jest uwzględniany w czasie analizy porównawczej.

Przeprowadź mikrotest porównawczy

Uruchom test porównawczy z opcją ./gradlew :benchmark:connectedBenchmarkAndroidTest, aby przeprowadzić go w wielu iteracjach i wydrukować dane dotyczące czasu w Logcat:

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

Poprzedni przykład pokazuje wynik testu porównawczego w zakresie od 0,6 ms do 1,4 ms dla uruchomienia algorytmu sortowania na liście 1000 elementów. Jeśli jednak dodasz parametr wywołania sieci w teście porównawczym, różnica między iteracjami jest większa. niż czas potrzebny na przeprowadzenie tego procesu, więc konieczność izolowania na podstawie danych z wywołań sieciowych.

Zawsze możesz przeprowadzić refaktoryzację kodu, aby ułatwić sortowanie izolacji, ale jeśli już używasz Hilt, możesz go użyć do wstrzykiwania fałszywych analiz porównawczych.