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

कई ऐप्लिकेशन, अलग-अलग बिल्ड वैरिएंट में अलग-अलग तरह के व्यवहार को इंजेक्ट करने के लिए, 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 का इस्तेमाल किया जा रहा है, तो बेंचमार्किंग के लिए फ़ेक ऑब्जेक्ट इंजेक्ट करने के लिए इसका इस्तेमाल किया जा सकता है.