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

कई ऐप्लिकेशन, बिल्ड के अलग-अलग वैरिएंट में अलग-अलग तरह के व्यवहार जोड़ने के लिए, 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 सोर्स सेट में होता है. release बिल्ड में APK के साइज़ में बढ़ोतरी से बचने के लिए, debug सोर्स सेट में फ़र्ज़ी तरीके से लागू किए गए डेटा वाली एसेट फ़ाइल मौजूद होती है. 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 मॉड्यूल में, कस्टम टेस्ट रनर जोड़ें. यह Hilt के साथ काम करने वाले टेस्ट चलाने के लिए, Application बनाता है. ऐसा करने के लिए, यह तरीका अपनाएं:

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 को कोई अपडेट मिलता है, क्रम में लगने की अवधि, मानदंड समय में शामिल होती है.

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

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