مقياس الأداء الصغرى وأداة Hilt

تستخدم العديد من التطبيقات 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 من حقن هذا العنصر، يتم استخدام العبارة التالية provider:

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 ملي ثانية لتشغيلها خوارزمية الفرز على قائمة من 1000 عنصر. ومع ذلك، إذا قمت بتضمين الحقل الاتصال بالشبكة في المعيار، فإن الفرق بين التكرارات أكبر من الوقت الذي يستغرقه إجراء الفرز نفسه، وبالتالي هناك حاجة إلى عزل الفرز من استدعاء الشبكة.

يمكنك دائمًا إعادة ضبط التعليمات البرمجية لتسهيل تشغيل الفرز العزل، ولكن إذا كنتم تستخدمون Hilt، يمكنكم استخدامها لحقن مزيفات لقياس الأداء بدلاً من ذلك.