تستخدم العديد من التطبيقات 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، يمكنك استخدامها لإدخال بيانات مزيفة لقياس الأداء بدلاً من ذلك.