Birçok uygulama, farklı derleme varyantlarına farklı davranışlar eklemek için Hilt kullanır. Bu, sonuçları çarpıtabilecek bir bileşeni değiştirmenize olanak tanıdığından özellikle uygulamanızda MikroKarşılaştırma yaparken yararlı olabilir. Örneğin, aşağıdaki kod snippet'i ad listesini getiren ve sıralayan bir depoyu göstermektedir:
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ı dahil ederseniz daha doğru sonuç almak için sahte 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ın yorumlanmasını zorlaştırır. Ağ aramaları birçok harici faktörden etkilenebilir ve çağrıların süresi, karşılaştırmanın çalıştırıldığı yinelemelere göre değişebilir. Ağ çağrılarının süresi, sıralamadan daha uzun sürebilir.
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çerir. Bununla birlikte, NetworkDataSource
örneği Hilt tarafından yerleştirilir ve bunu, 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ğ çağrısı, getPeople()
yöntemini çağırdığınızda mümkün olduğunca hızlı çalışacak şekilde tasarlanmıştır. Hilt'in bunu ekleyebilmesi 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, potansiyel olarak değişken uzunlukta G/Ç çağrısı kullanılarak öğelerden yüklenir.
Bununla birlikte, bu işlem başlatma sırasında yapılır ve karşılaştırma sırasında getPeople()
çağrıldığında düzensizliklere neden olmaz.
Bazı uygulamalar, arka uç bağımlılıklarını ortadan kaldırmak için hata ayıklama derlemelerinde zaten sahte ürünler kullanır. Ancak sürüm derlemesine mümkün olduğunca yakın bir derlemeyi karşılaştırmanız gerekir. Bu belgenin geri kalanında, Tam proje kurulumu bölümünde açıklandığı gibi çok modüllü ve çok değişkenli bir yapı kullanılmaktadır.
Üç modül vardır:
benchmarkable
: Karşılaştırma kodunu içerir.benchmark
: Karşılaştırma kodunu içerir.app
: Kalan uygulama kodunu içerir.
Önceki modüllerin her biri, normal debug
ve release
varyantlarıyla birlikte benchmark
adında bir derleme varyantına sahiptir.
Karşılaştırma modülünü yapılandırma
Sahte ağ çağrısının kodu, benchmarkable
modülünün debug
kaynak grubunda, tam ağ uygulaması ise aynı modülün release
kaynak kümesindedir. Sahte uygulama tarafından döndürülen verileri içeren öğe dosyası, release
derlemesinde APK şişirmesini önlemek için debug
kaynağında ayarlanır. benchmark
varyantının release
temelli olması ve debug
kaynak grubunu kullanması gerekir. 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")) } } }
Modern
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, aşağıdaki gibi Hilt'i destekleyen testlerin çalıştırılması için Application
oluşturan bir özel test çalıştırıcısı 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 şu 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) }
Modern
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 aşağıdakileri yapar:
- Gerekli gradle eklentilerini derlemeye uygular.
- Testleri çalıştırmak için özel test çalıştırıcının kullanıldığını belirtir.
benchmark
varyantının bu modülün test türü olduğunu belirtir.benchmark
varyantını ekler.- Gerekli bağımlılıkları ekler.
Gradle'ın karşılaştırmayı 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 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; } }
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
, karşılaştırma testi sınıfında bağımlılık yerleştirme işlemi gerçekleştirir. Herhangi bir bağımsız test ç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özlemleyicisi kaydedilirken karşılaştırmanın kendisi zamanlamayı duraklatır. Ardından, işlemi bitirmeden önce LiveData
güncellenmesini beklemek için bir mandal kullanır. Sıralama, peopleRepository.update()
çağrıldığı zaman ile LiveData
ürününün güncelleme aldığı zaman arasındaki zamanda çalıştırı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ı ./gradlew :benchmark:connectedBenchmarkAndroidTest
ile çalıştırarak birçok yinelemede karşılaştırma yapın ve zamanlama verilerini Logcat'e yazdırın:
PeopleRepositoryBenchmark.log[Metric (timeNs) results: median 613408.3952380952, min 451949.30476190476, max 1412143.5142857144, standardDeviation: 273221.2328680522...
Yukarıdaki örnekte, sıralama algoritmasını 1.000 öğeden oluşan bir listede çalıştırmak için 0,6 ms ile 1,4 ms.arasındaki karşılaştırma sonucu gösterilmektedir. Bununla birlikte, ağ çağrısını karşılaştırmaya dahil ederseniz iterasyonlar arasındaki sapma, sıralamanın çalıştırılması için gereken süreden fazla olur. Bu nedenle, sıralamayı ağ çağrısından izole etmeniz gerekir.
Sıralamayı izole halde çalıştırmayı kolaylaştırmak için kodu her zaman yeniden düzenleyebilirsiniz. Ancak halihazırda Hilt kullanıyorsanız bunun yerine karşılaştırma için sahte öğeler eklemek üzere kodu kullanabilirsiniz.