Banyak aplikasi menggunakan Hilt untuk menginjeksikan perilaku yang berbeda ke varian build yang berbeda. Ini bisa sangat berguna saat melakukan Microbenchmark pada aplikasi Anda karena memungkinkan Anda mengganti komponen yang dapat mengganggu hasilnya. Misalnya, cuplikan kode berikut menampilkan repositori yang mengambil dan mengurutkan daftar nama:
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(); } }
Jika Anda menyertakan panggilan jaringan saat melakukan benchmark, terapkan panggilan jaringan palsu untuk mendapatkan hasil yang lebih akurat.
Menyertakan panggilan jaringan nyata saat benchmark akan mempersulit penafsiran hasil tolok ukur. Panggilan jaringan dapat dipengaruhi oleh banyak faktor eksternal, dan durasinya dapat bervariasi di antara iterasi saat menjalankan benchmark. Durasi panggilan jaringan dapat memerlukan waktu lebih lama daripada pengurutan.
Mengimplementasikan panggilan jaringan palsu menggunakan Hilt
Panggilan ke dataSource.getPeople()
, seperti yang ditunjukkan dalam contoh sebelumnya,
berisi panggilan jaringan. Namun, instance NetworkDataSource
dimasukkan
oleh Hilt, dan Anda dapat menggantinya dengan implementasi palsu berikut untuk
benchmarking:
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; } }
Panggilan jaringan palsu ini dirancang untuk berjalan secepat mungkin saat Anda menelepon
metode getPeople()
. Agar Hilt dapat memasukkannya, penyedia
berikut digunakan:
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); } }
Data dimuat dari aset menggunakan panggilan I/O yang panjangnya berpotensi bervariasi.
Namun, ini dilakukan selama inisialisasi dan tidak akan menyebabkan ketidakteraturan
saat getPeople()
dipanggil selama benchmark.
Beberapa aplikasi sudah menggunakan tiruan pada build debug untuk menghapus dependensi backend. Namun, Anda perlu menjalankan benchmark pada build yang sedekat mungkin dengan build rilis sebaik mungkin. Bagian selanjutnya dari dokumen ini menggunakan struktur multi-varian dan multi-modul seperti yang dijelaskan dalam Penyiapan project lengkap.
Ada tiga modul:
benchmarkable
: berisi kode untuk diukur.benchmark
: berisi kode benchmark.app
: berisi kode aplikasi yang tersisa.
Setiap modul sebelumnya memiliki varian build bernama benchmark
beserta
varian debug
dan release
biasa.
Mengonfigurasi modul benchmark
Kode untuk panggilan jaringan palsu ada dalam set sumber debug
modul benchmarkable
, dan implementasi jaringan lengkap ada dalam set sumber
release
modul yang sama. File aset yang berisi data yang ditampilkan oleh
implementasi palsu ada di set sumber debug
untuk menghindari APK yang membengkak
build release
. Varian benchmark
harus didasarkan pada release
dan
gunakan set sumber debug
. Konfigurasi build untuk varian benchmark
dari modul benchmarkable
yang berisi implementasi palsu adalah sebagai berikut:
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'] } } }
Dalam modul benchmark
, tambahkan runner pengujian kustom yang membuat Application
untuk pengujian yang mendukung Hilt sebagai berikut:
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); } }
Hal ini membuat objek Application
tempat pengujian dijalankan memperluas
class HiltTestApplication
. Lakukan perubahan berikut pada konfigurasi
build:
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 }
Contoh sebelumnya melakukan hal berikut:
- Menerapkan plugin gradle yang diperlukan ke build.
- Menentukan bahwa runner pengujian kustom digunakan untuk menjalankan pengujian.
- Menentukan bahwa varian
benchmark
adalah jenis pengujian untuk modul ini. - Menambahkan varian
benchmark
. - Menambahkan dependensi yang diperlukan.
Anda perlu mengubah testBuildType
untuk memastikan Gradle membuat
tugas connectedBenchmarkAndroidTest
, yang melakukan benchmark.
Membuat microbenchmark
Benchmark diimplementasikan sebagai berikut:
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; } }
Contoh sebelumnya membuat aturan untuk tolok ukur dan Hilt.
benchmarkRule
menjalankan pengaturan waktu benchmark. hiltRule
melakukan
injeksi dependensi pada class pengujian benchmark. Anda harus memanggil
metode inject()
dari aturan Hilt dalam fungsi @Before
untuk melakukan
injeksi sebelum menjalankan setiap pengujian.
Benchmark itu sendiri menjeda pengaturan waktu saat pengamat LiveData
didaftarkan. Kemudian, fungsi ini menggunakan latch untuk menunggu hingga LiveData
diupdate sebelum
selesai. Karena pengurutan dijalankan dalam waktu antara saat
peopleRepository.update()
dipanggil dan saat LiveData
menerima update,
durasi pengurutan disertakan dalam pengaturan waktu benchmark.
Menjalankan microbenchmark
Jalankan benchmark dengan ./gradlew :benchmark:connectedBenchmarkAndroidTest
untuk melakukan benchmark selama banyak iterasi dan mencetak data pengaturan waktu ke
Logcat:
PeopleRepositoryBenchmark.log[Metric (timeNs) results: median 613408.3952380952, min 451949.30476190476, max 1412143.5142857144, standardDeviation: 273221.2328680522...
Contoh sebelumnya menunjukkan hasil benchmark antara 0,6 md dan 1,4 md untuk menjalankan algoritma pengurutan pada daftar 1.000 item. Namun, jika Anda menyertakan panggilan jaringan dalam benchmark, varian antara iterasi akan lebih besar dari waktu yang diperlukan pengurutan itu sendiri untuk berjalan, sehingga perlu mengisolasi pengurutan dari panggilan jaringan.
Anda selalu dapat memfaktorkan ulang kode untuk mempermudah menjalankan penyortiran dalam isolasi, tetapi jika sudah menggunakan Hilt, Anda dapat menggunakannya untuk tolok ukur.