মাইক্রোবেঞ্চমার্ক ও Hilt

অনেক অ্যাপ বিভিন্ন বিল্ড ভ্যারিয়েন্টে আলাদা আলাদা আচরণ ইনজেক্ট করতে Hilt ব্যবহার করে। আপনার অ্যাপ Microbenchmarking করার সময় এটি বিশেষভাবে উপযোগী হতে পারে কারণ এটি আপনাকে এমন একটি কম্পোনেন্ট পরিবর্তন করতে দেয় যা ফলাফলকে প্রভাবিত করতে পারে। যেমন, নিম্নলিখিত কোড স্নিপেট এমন একটি রিপোজিটরি দেখায় যা নামের তালিকা ফেচ করে সাজায়:

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 }))
            )
        }
    }
}}

জাভা

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
}

জাভা

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)
    }
}

জাভা

@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"))
        }
    }
}

গ্ৰুভি

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)
    }
}

জাভা

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
}

আগের উদাহরণটি নিম্নলিখিত কাজ করে:

  • বিল্ডে প্রয়োজনীয় গ্রেডেল প্লাগ-ইন প্রয়োগ করে।
  • টেস্ট রান করার জন্য কাস্টম টেস্ট রানার ব্যবহার করা হয় বলে উল্লেখ করে।
  • benchmark ভেরিয়েন্টটি এই মডিউলের জন্য টেস্টের ধরন হিসেবে নির্দিষ্ট করে।
  • benchmark ভেরিয়েন্ট যোগ করে।
  • প্রয়োজনীয় ডিপেন্ডেন্সি যোগ করে।

Gradle যাতে connectedBenchmarkAndroidTest টাস্ক তৈরি করে তা নিশ্চিত করতে আপনাকে testBuildType পরিবর্তন করতে হবে, যা বেঞ্চমার্কিং করে।

মাইক্রোবেঞ্চমার্ক তৈরি করুন

বেঞ্চমার্ক নিম্নলিখিতভাবে প্রয়োগ করা হয়:

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()
        }
    }
}

জাভা

@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...

আগের উদাহরণে ১,০০০টি আইটেমের তালিকায় সর্টিং অ্যালগরিদম রান করার জন্য ০.৬ms থেকে ১.৪ms-এর মধ্যে বেঞ্চমার্ক ফলাফল দেখানো হয়েছে। তবে, আপনি যদি বেঞ্চমার্কে নেটওয়ার্ক কল অন্তর্ভুক্ত করেন, তাহলে ইটারেশনের মধ্যে পার্থক্য, সর্ট রান করতে যে সময় লাগে তার চেয়ে বেশি হয়, তাই নেটওয়ার্ক কল থেকে সর্টিং আলাদা করতে হয়।

আপনি সবসময় কোড রিফ্যাক্টর করতে পারেন যাতে আইসোলেশনে সর্টিং রান করা আরও সহজ হয়, তবে আপনি আগে থেকেই Hilt ব্যবহার করলে, এর পরিবর্তে বেঞ্চমার্কিংয়ের জন্য ফেক ইনজেক্ট করতে এটি ব্যবহার করতে পারেন।