تستخدم العديد من التطبيقات Hilt لإدخال سلوكيات مختلفة في إصدارات مختلفة من الإصدارات. ويمكن أن يكون ذلك مفيدًا بشكل خاص عند إجراء اختبارات الأداء الدقيق لتطبيقك، لأنّه يتيح لك استبدال أحد المكوّنات التي يمكن أن تؤدي إلى تحريف النتائج. على سبيل المثال، يعرض مقتطف الرمز التالي مستودعًا يجلب قائمة بالأسماء ويفرزها:
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(); } }
إذا تضمّنت عملية قياس الأداء طلب شبكة، عليك تنفيذ طلب شبكة وهمي للحصول على نتيجة أكثر دقة.
يؤدي تضمين طلب شبكة حقيقي عند إجراء قياس الأداء إلى صعوبة تفسير نتائج قياس الأداء. يمكن أن تتأثر طلبات الشبكة بالعديد من العوامل الخارجية، ويمكن أن يختلف مدتها بين عمليات تكرار تنفيذ مقياس الأداء. قد يستغرق وقت تنفيذ طلبات الشبكة وقتًا أطول من وقت الترتيب.
تنفيذ طلب شبكة وهمي باستخدام Hilt
يتضمّن الاستدعاء إلى dataSource.getPeople()
، كما هو موضّح في المثال السابق، استدعاء شبكة. ومع ذلك، يتم إدخال مثيل NetworkDataSource
من خلال Hilt، ويمكنك استبداله بالتنفيذ الوهمي التالي لأغراض قياس الأداء:
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; } }
تم تصميم مكالمة الشبكة الوهمية هذه ليتم تنفيذها بأسرع ما يمكن عند استدعاء الطريقة getPeople()
. لكي يتمكّن Hilt من إدخال هذا النوع، يتم استخدام موفّر البيانات التالي:
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); } }
يتم تحميل البيانات من مواد العرض باستخدام طلب إدخال/إخراج قد يكون متغير الطول.
ومع ذلك، يتم ذلك أثناء عملية الإعداد ولن يتسبّب في أي مخالفات
عند استدعاء getPeople()
أثناء عملية قياس الأداء.
تستخدم بعض التطبيقات بالفعل بيانات وهمية في إصدارات تصحيح الأخطاء لإزالة أي تبعيات من الخلفية. ومع ذلك، عليك إجراء قياس الأداء على إصدار قريب قدر الإمكان من إصدار التطبيق. يستخدم الجزء المتبقي من هذا المستند بنية متعددة الوحدات ومتعددة الصيغ كما هو موضّح في إعداد المشروع الكامل.
تتضمّن هذه الحزمة ثلاث وحدات:
-
benchmarkable
: يحتوي على الرمز المراد قياس أدائه. -
benchmark
: يحتوي على رمز مقياس الأداء. -
app
: يحتوي على رمز التطبيق المتبقي.
يحتوي كل من الوحدات السابقة على صيغة إنشاء باسم benchmark
بالإضافة إلى الصيغتين المعتادتين debug
وrelease
.
ضبط وحدة مقاييس الأداء
يقع رمز طلب الشبكة الوهمي في مجموعة المصادر debug
الخاصة بالوحدة benchmarkable
، بينما تقع عملية تنفيذ الشبكة الكاملة في مجموعة المصادر release
الخاصة بالوحدة نفسها. يقع ملف مواد العرض الذي يحتوي على البيانات التي تعرضها عملية التنفيذ الوهمية في مجموعة المصادر debug
لتجنُّب أي تضخّم في حِزم APK في الإصدار release
. يجب أن تستند الصيغة benchmark
إلى release
وأن تستخدم مجموعة المصادر debug
. في ما يلي إعدادات الإصدار لوحدة benchmarkable
التي تحتوي على التنفيذ الوهمي، وتحديدًا الإصدار benchmark
:
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
، أضِف أداة تشغيل اختبار مخصّصة تنشئ Application
لكي يتم تشغيل الاختبارات في تلك الوحدة التي تتوافق مع Hilt على النحو التالي:
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); } }
يؤدي ذلك إلى جعل عنصر Application
الذي يتم تشغيل الاختبارات فيه يوسّع فئة HiltTestApplication
. أجرِ التغييرات التالية على إعدادات الإصدار:
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 }
ينفّذ المثال السابق ما يلي:
- تطبيق مكوّنات Gradle الإضافية اللازمة على الإصدار
- تحدّد هذه السمة أنّه يتم استخدام أداة تشغيل الاختبار المخصّصة لتنفيذ الاختبارات.
- تحدّد هذه السمة أنّ الصيغة
benchmark
هي نوع الاختبار لهذه الوحدة. - تضيف هذه السمة الصيغة
benchmark
. - تضيف هذه السمة العناصر التابعة المطلوبة.
عليك تغيير testBuildType
لضمان أنّ Gradle ينشئ مهمة connectedBenchmarkAndroidTest
التي تنفّذ قياس الأداء.
إنشاء اختبار الأداء المصغّر
يتم تنفيذ مقياس الأداء على النحو التالي:
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; } }
ينشئ المثال السابق قواعد لكل من معيار القياس وHilt.
تُجري benchmarkRule
عملية تحديد توقيت مقياس الأداء. تنفّذ hiltRule
عملية إدخال التبعية في فئة اختبار قياس الأداء. يجب استدعاء طريقة
inject()
لقاعدة Hilt في دالة @Before
لتنفيذ عملية
الإدخال قبل تشغيل أي اختبارات فردية.
يتم إيقاف التوقيت مؤقتًا في مقياس الأداء الأساسي نفسه أثناء تسجيل أداة مراقبة LiveData
. بعد ذلك، يستخدم قفل انتظار إلى أن يتم تحديث LiveData
قبل الانتهاء. بما أنّ عملية الترتيب تتم في الفترة الزمنية بين وقت استدعاء peopleRepository.update()
ووقت تلقّي LiveData
تحديثًا، يتم تضمين مدة الترتيب في التوقيت المعياري.
تشغيل الاختبار المعياري الصغير
نفِّذ اختبار الأداء باستخدام ./gradlew :benchmark:connectedBenchmarkAndroidTest
لإجراء اختبار الأداء على مدار عدة تكرارات وطباعة بيانات التوقيت في
Logcat:
PeopleRepositoryBenchmark.log[Metric (timeNs) results: median 613408.3952380952, min 451949.30476190476, max 1412143.5142857144, standardDeviation: 273221.2328680522...
يعرض المثال السابق نتيجة قياس الأداء بين 0.6 و1.4 ملي ثانية لتشغيل خوارزمية الترتيب على قائمة تضم 1,000 عنصر. ومع ذلك، إذا تضمّنت مكالمة الشبكة في مقياس الأداء، سيكون التباين بين التكرارات أكبر من الوقت الذي يستغرقه الفرز نفسه، وبالتالي يجب عزل الفرز عن مكالمة الشبكة.
يمكنك دائمًا إعادة تصميم الرمز البرمجي لتسهيل تنفيذ عملية الترتيب بشكل منفصل، ولكن إذا كنت تستخدم Hilt، يمكنك استخدامه لتضمين بيانات وهمية لأغراض قياس الأداء بدلاً من ذلك.