माइक्रोबैंचमार्क और हिल्ट

कई ऐप्लिकेशन, बिल्ड के अलग-अलग वैरिएंट में अलग-अलग तरह के व्यवहार इंजेक्ट करने के लिए, 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);
    }
}

डेटा को ऐसेट से लोड किया जाता है. इसके लिए, अलग-अलग लंबाई वाले I/O कॉल का इस्तेमाल किया जाता है. हालांकि, ऐसा इनिशलाइज़ेशन के दौरान किया जाता है. इसलिए, मानदंड के दौरान getPeople() को कॉल करने पर, कोई गड़बड़ी नहीं होगी.

कुछ ऐप्लिकेशन, डीबग के लिए बिल्ड पर पहले से ही नकली डेटा का इस्तेमाल करते हैं, ताकि बैकएंड पर निर्भरता को हटाया जा सके. हालांकि, आपको रिलीज़ के लिए तैयार बिल्ड के सबसे करीब वाले बिल्ड पर मानदंड तय करना होगा. इस दस्तावेज़ के बाकी हिस्से में, कई मॉड्यूल और कई वैरिएंट वाले स्ट्रक्चर का इस्तेमाल किया गया है. इसके बारे में पूरे प्रोजेक्ट सेटअप में बताया गया है.

इसमें तीन मॉड्यूल हैं:

• benchmarkable: इसमें मानदंड के लिए कोड होता है.
• benchmark: इसमें मानदंड कोड शामिल होता है.
• app: इसमें ऐप्लिकेशन का बाकी कोड होता है.

ऊपर दिए गए हर मॉड्यूल में, benchmark नाम का एक बिल्ड वैरिएंट होता है. साथ ही, इसमें सामान्य debug और release वैरिएंट भी होते हैं.

बेंचमार्क मॉड्यूल को कॉन्फ़िगर करना

नकली नेटवर्क कॉल का कोड, benchmarkable मॉड्यूल के debug सोर्स सेट में मौजूद है. साथ ही, नेटवर्क को पूरी तरह से लागू करने का कोड, इसी मॉड्यूल के release सोर्स सेट में मौजूद है. नकली तरीके से लागू किए गए डेटा वाली ऐसेट फ़ाइल, debug सोर्स सेट में मौजूद होती है. इससे release बिल्ड में किसी भी APK ब्लोट से बचा जा सकता है. 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, बेंचमार्क टेस्ट क्लास पर डिपेंडेंसी इंजेक्शन को लागू करता है. किसी भी टेस्ट को चलाने से पहले, आपको @Before फ़ंक्शन में Hilt नियम के inject() तरीके को कॉल करना होगा, ताकि इंजेक्शन को लागू किया जा सके.

LiveData ऑब्ज़र्वर के रजिस्टर होने के दौरान, मानदंड खुद ही समय को रोक देता है. इसके बाद, यह लैच का इस्तेमाल करके, LiveData के अपडेट होने का इंतज़ार करता है. सॉर्ट करने की प्रोसेस, peopleRepository.update() को कॉल करने और LiveData को अपडेट मिलने के बीच के समय में चलती है. इसलिए, सॉर्ट करने में लगने वाला समय, मानदंड के समय में शामिल होता है.

माइक्रोबेंचमार्क चलाएं

बेंचमार्क को कई बार चलाने और समय के डेटा को Logcat में प्रिंट करने के लिए, ./gradlew :benchmark:connectedBenchmarkAndroidTest के साथ बेंचमार्क चलाएं:

PeopleRepositoryBenchmark.log[Metric (timeNs) results: median 613408.3952380952, min 451949.30476190476, max 1412143.5142857144, standardDeviation: 273221.2328680522...

ऊपर दिए गए उदाहरण में, 1,000 आइटम की सूची पर सॉर्टिंग एल्गोरिदम को चलाने के लिए, 0.6 मि॰से॰ और 1.4 मि॰से॰ के बीच का मानदंड नतीजा दिखाया गया है. हालांकि, अगर मानदंड में नेटवर्क कॉल को शामिल किया जाता है, तो इटरेशन के बीच का अंतर, क्रम से लगाने में लगने वाले समय से ज़्यादा होता है. इसलिए, क्रम से लगाने की प्रोसेस को नेटवर्क कॉल से अलग करना ज़रूरी है.

कोड को हमेशा रीफ़ैक्टर किया जा सकता है, ताकि सॉर्टिंग को अलग से चलाना आसान हो. हालांकि, अगर पहले से ही Hilt का इस्तेमाल किया जा रहा है, तो बेंचमार्किंग के लिए नकली डेटा इंजेक्ट करने के लिए इसका इस्तेमाल किया जा सकता है.