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

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

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

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

फ़ेक नेटवर्क कॉल का कोड, 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"))
        }
    }
}

शानदार

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