Mikro Karşılaştırma ve Hilt

Birçok uygulama, farklı derleme varyantlarına farklı davranışlar yerleştirmek için Hilt'i kullanır. Bu, özellikle uygulamanızda mikro karşılaştırma yaparken sonuçları çarpıtabilecek bir bileşeni değiştirmenize olanak tanıdığı için yararlı olabilir. Örneğin, aşağıdaki kod snippet'inde ad listesini getiren ve sıralayan bir depo gösterilmektedir:

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

Karşılaştırma yaparken bir ağ çağrısı eklerseniz daha doğru bir sonuç elde etmek için sahte bir ağ çağrısı uygulayın.

Karşılaştırma yaparken gerçek bir ağ çağrısı eklemek, karşılaştırma sonuçlarını yorumlamayı zorlaştırır. Ağ çağrıları birçok harici faktörden etkilenebilir ve süreleri, karşılaştırma testinin yinelemeleri arasında değişiklik gösterebilir. Ağ çağrılarının süresi, sıralama işleminden daha uzun sürebilir.

Hilt kullanarak sahte bir ağ çağrısı uygulama

Önceki örnekte gösterildiği gibi, dataSource.getPeople() için yapılan çağrı bir ağ çağrısı içerir. Ancak NetworkDataSource örneği Hilt tarafından yerleştirilir ve karşılaştırma için aşağıdaki sahte uygulamayla değiştirebilirsiniz:

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

Bu sahte ağ araması, getPeople() yöntemini aradığınızda olabildiğince hızlı çalışacak şekilde tasarlanmıştır. Hilt'in bunu yerleştirebilmesi için aşağıdaki sağlayıcı kullanılır:

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

Veriler, değişken uzunlukta olabilecek bir G/Ç çağrısı kullanılarak öğelerden yüklenir. Ancak bu işlem başlatma sırasında yapılır ve kıyaslama sırasında getPeople() çağrıldığında herhangi bir düzensizliğe neden olmaz.

Bazı uygulamalar, arka uç bağımlılıklarını kaldırmak için hata ayıklama derlemelerinde zaten sahte veriler kullanıyor. Ancak, mümkün olduğunca yayın sürümüne yakın bir derleme üzerinde karşılaştırma yapmanız gerekir. Bu belgenin geri kalanında, Tam proje kurulumu bölümünde açıklandığı gibi çok modüllü ve çok varyantlı bir yapı kullanılmaktadır.

Üç modül vardır:

• benchmarkable: Karşılaştırma yapılacak kodu içerir.
• benchmark: karşılaştırma kodu içerir.
• app: Kalan uygulama kodunu içerir.

Yukarıdaki modüllerin her birinde, normal debug ve release varyantlarının yanı sıra benchmark adlı bir derleme varyantı bulunur.

Karşılaştırma modülünü yapılandırma

Sahte ağ çağrısının kodu debug modülünün benchmarkable kaynak kümesinde, tam ağ uygulaması ise aynı modülün release kaynak kümesinde yer alır. Sahte uygulama tarafından döndürülen verileri içeren öğe dosyası, debug kaynak kümesinde yer alır. Böylece release derlemesinde APK şişmesi önlenir. benchmark varyantı, release temel alınarak oluşturulmalı ve debug kaynak kümesi kullanılmalıdır. Sahte uygulamayı içeren benchmarkable modülünün benchmark varyantı için derleme yapılandırması aşağıdaki gibidir:

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']
        }
    }
}

benchmark modülüne, testlerin çalıştırılması için Application oluşturan ve Hilt'i aşağıdaki gibi destekleyen özel bir test çalıştırıcı ekleyin:

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

Bu, testlerin çalıştırıldığı Application nesnesinin HiltTestApplication sınıfını genişletmesini sağlar. Derleme yapılandırmasında aşağıdaki değişiklikleri yapın:

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
}

Önceki örnekte şunlar yapılmaktadır:

• Gerekli Gradle eklentilerini derlemeye uygular.
• Testleri çalıştırmak için özel test çalıştırıcısının kullanıldığını belirtir.
• benchmark varyantının bu modül için test türü olduğunu belirtir.
• benchmark varyantını ekler.
• Gerekli bağımlılıkları ekler.

Gradle'ın karşılaştırma işlemini gerçekleştiren connectedBenchmarkAndroidTest görevini oluşturmasını sağlamak için testBuildType değerini değiştirmeniz gerekir.

Mikro karşılaştırma testi oluşturma

Karşılaştırma şu şekilde uygulanır:

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

Önceki örnekte hem karşılaştırma hem de Hilt için kurallar oluşturulur. benchmarkRule, karşılaştırmanın zamanlamasını yapar. hiltRule, karşılaştırma testi sınıfında bağımlılık ekleme işlemini gerçekleştirir. Herhangi bir testi çalıştırmadan önce yerleştirme işlemini gerçekleştirmek için @Before işlevinde Hilt kuralının inject() yöntemini çağırmanız gerekir.

LiveData gözlemcisi kaydedilirken karşılaştırma ölçütü, zamanlamayı duraklatır. Ardından, LiveData güncellenene kadar beklemek için bir kilit kullanır ve işlemi tamamlar. Sıralama, peopleRepository.update() çağrıldıktan sonra ve LiveData güncelleme aldıktan sonraki süre içinde yapıldığından sıralamanın süresi, karşılaştırma zamanlamasına dahil edilir.

Mikro karşılaştırmayı çalıştırma

Karşılaştırmayı birçok yineleme boyunca gerçekleştirmek ve zamanlama verilerini Logcat'e yazdırmak için ./gradlew :benchmark:connectedBenchmarkAndroidTest ile karşılaştırmayı çalıştırın:

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

Önceki örnekte, 1.000 öğelik bir listede sıralama algoritmasını çalıştırmak için 0,6 ms ile 1,4 ms arasında bir karşılaştırma sonucu gösterilmektedir. Ancak ağ çağrısını karşılaştırmaya dahil ederseniz yinelemeler arasındaki varyans, sıralamanın kendisinin çalışması için gereken süreden daha fazla olur. Bu nedenle, sıralamayı ağ çağrısından ayırmak gerekir.

Sıralamayı yalıtılmış olarak çalıştırmayı kolaylaştırmak için kodu her zaman yeniden düzenleyebilirsiniz ancak Hilt'i zaten kullanıyorsanız bunun yerine karşılaştırma için sahte veriler eklemek üzere Hilt'i kullanabilirsiniz.