Mikro Karşılaştırma ve Hilt

Birçok uygulama, farklı derleme varyantlarına farklı davranışlar eklemek için Hilt'i kullanır. Bu, özellikle uygulamanızda Mikro Karşılaştırma yapılırken faydalı olabilir çünkü sonuçları çarpıtabilecek bir bileşeni değiştirirsiniz. Örneğin, kod snippet'i, adların listesini getirip sıralayan bir depo gösterir:

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

Karşılaştırma sırasında bir ağ çağrısı eklerseniz sahte bir ağ çağrısı uygulayın kullanabilirsiniz.

Karşılaştırma sırasında gerçek bir ağ araması dahil etmek, verilerin yorumlanmasını zorlaştırır. karşılaştırma sonuçlarını sağlar. Ağ aramaları, birçok harici faktörden etkilenebilir ve süre, karşılaştırmayı çalıştırma yinelemeleri arasında farklılık gösterebilir. İlgili içeriği oluşturmak için kullanılan süre, sıralamaya göre daha uzun olabilir.

Hilt'i kullanarak sahte ağ çağrısı uygulama

Önceki örnekte gösterildiği gibi, dataSource.getPeople() çağrısı bir ağ çağrısı içeriyor. Ancak NetworkDataSource örneği yerleştirilmiş ve bunu aşağıdaki sahte uygulama ile değiştirebilirsiniz: karşılaştırma:

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

Bu sahte ağ çağrısı, şu numarayı aradığınızda mümkün olduğu kadar hızlı çalışacak şekilde tasarlanmıştır: getPeople() yöntemi. Hilt'in bunu enjekte edebilmesi için aşağıdaki kullanılan sağlayıcı:

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

Veriler, potansiyel olarak değişken uzunlukta G/Ç çağrısı kullanan öğelerden yüklenir. Ancak bu işlem başlatma sırasında yapılır ve herhangi bir düzensizliğe neden olmaz Karşılaştırma sırasında getPeople() çağrıldığında.

Bazı uygulamalar, arka uç bağımlılıklarını kaldırmak için hata ayıklama derlemelerinde zaten sahte veriler kullanıyor. Ancak bunun için yayın derlemesine olabildiğince yakın bir derlemeyle yapmasını sağlar. Bu belgenin geri kalanında çok modüllü, çok değişkenli bir yapı kullanılmıştır Tam proje kurulumu bölümünde açıklandığı gibi.

Üç modül vardır:

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

Önceki modüllerin her birinde benchmark adlı bir derleme varyantı ve her zamanki debug ve release varyantları.

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

Sahte ağ çağrısının kodu debug benchmarkable modülünde, tam ağ uygulaması ise release aynı modülün kaynak kümesidir. Google Etiket Yöneticisi'nin herhangi bir APK'nın şişmesini önlemek için sahte uygulama, debug kaynağında release derlemesi. benchmark varyantının release ve debug kaynak kümesini kullanın. benchmark varyantı için derleme yapılandırması sahte bir uygulama içeren benchmarkable modülü aşağıdaki gibidir:

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

benchmark modülünde, Application oluşturan özel bir test çalıştırıcısı ekleyin testlerin çalıştırılması için aşağıdaki adımları uygulayın:

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

Bu, testlerin çalıştırıldığı Application nesnesinin HiltTestApplication sınıfı. Derlemede aşağıdaki değişiklikleri yapın yapılandırma:

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
}

Yukarıdaki örnek şunları yapar:

• Gerekli gradle eklentilerini derlemeye uygular.
• Özel test çalıştırıcının testleri çalıştırmak için kullanılacağı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 şunu oluşturduğundan emin olmak için testBuildType ayarını değiştirmeniz gerekir: Karşılaştırmayı gerçekleştiren connectedBenchmarkAndroidTest görevi.

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

Karşılaştırma aşağıdaki gibi uygulanır:

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

Yukarıdaki örnek, hem karşılaştırma hem de Hilt için kurallar oluşturur. benchmarkRule, karşılaştırmanın zamanlamasını gerçekleştirir. hiltRule şunları gerçekleştirir: bağımlılık eklemesidir. Şunu çağırmanız gerekir: @Before işlevinde Hilt kuralının inject() yöntemini kullanarak enjeksiyon işlemine tabi tutun.

LiveData gözlemcisi şu anda karşılaştırma yaparken zamanlamayı duraklatır: kayıtlı. Sonra, mandalı kullanarak LiveData güncellenmeden önce bitiriliyor. Sıralama işlemi, 2008'in sonuna kadar peopleRepository.update() çağrılır ve LiveData bir güncelleme aldığında, karşılaştırma zamanına dahil edilir.

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

./gradlew :benchmark:connectedBenchmarkAndroidTest ile karşılaştırma yapın Karşılaştırmayı birçok yinelemede gerçekleştirmek ve zamanlama verilerini Logcat:

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

Yukarıdaki örnekte, çalıştırılması için 0,6 ms ile 1,4 ms arasında karşılaştırma sonucu gösterilmektedir ilkesini ekledik. Ancak, ağ çağrısında bulunuyorsa yinelemeler arasındaki fark daha büyüktür. için gereken süreden daha uzun sürede iyileştirilmesi gerekir; bu nedenle, sıralanmasını sağlayabilirsiniz.

Sıralamayı daha kolay hale getirmek için istediğiniz zaman kodu yeniden düzenleyebilirsiniz. ancak yine de Hilt kullanıyorsanız, yüksek kaliteli çeşitli alanlar için sahte resimler eklemek kıyaslamaya çalışırız.