تستخدم العديد من التطبيقات 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
. في ما يلي إعدادات الإصدار لصيغة benchmark
من وحدة benchmarkable
التي تحتوي على عملية التنفيذ الزائفة:
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")) } } }
رائع
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) }
رائع
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 بالفعل، يمكنك استخدامه لحقن مواد مزيفة لقياس الأداء بدلاً من ذلك.