মাইক্রোবেঞ্চমার্ক এবং হিল্ট

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

কোটলিন

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

যদি আপনি বেঞ্চমার্কিংয়ের সময় একটি নেটওয়ার্ক কল অন্তর্ভুক্ত করেন, তাহলে আরও সঠিক ফলাফল পেতে একটি জাল নেটওয়ার্ক কল প্রয়োগ করুন।

বেঞ্চমার্কিংয়ের সময় একটি বাস্তব নেটওয়ার্ক কল অন্তর্ভুক্ত করলে বেঞ্চমার্কের ফলাফল ব্যাখ্যা করা কঠিন হয়ে পড়ে। নেটওয়ার্ক কল অনেক বাহ্যিক বিষয়ের দ্বারা প্রভাবিত হতে পারে এবং বেঞ্চমার্ক চালানোর পুনরাবৃত্তির মধ্যে তাদের সময়কাল পরিবর্তিত হতে পারে। নেটওয়ার্ক কলের সময়কাল বাছাইয়ের চেয়ে বেশি সময় নিতে পারে।

হিল্ট ব্যবহার করে একটি ভুয়া নেটওয়ার্ক কল বাস্তবায়ন করুন

পূর্ববর্তী উদাহরণে দেখানো dataSource.getPeople() এ কলটিতে একটি নেটওয়ার্ক কল রয়েছে। তবে, NetworkDataSource ইনস্ট্যান্সটি Hilt দ্বারা ইনজেক্ট করা হয় এবং আপনি বেঞ্চমার্কিংয়ের জন্য নিম্নলিখিত জাল বাস্তবায়ন দিয়ে এটি প্রতিস্থাপন করতে পারেন:

কোটলিন

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() পদ্ধতিতে কল করলে যত দ্রুত সম্ভব কাজ করতে পারেন। হিল্ট যাতে এটি ইনজেক্ট করতে পারে তার জন্য নিম্নলিখিত প্রোভাইডার ব্যবহার করা হয়:

কোটলিন

@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 : বাকি অ্যাপ কোডটি ধারণ করে।

পূর্ববর্তী প্রতিটি মডিউলে সাধারণ debug এবং release ভেরিয়েন্টের সাথে benchmark নামে একটি বিল্ড ভেরিয়েন্ট রয়েছে।

বেঞ্চমার্ক মডিউল কনফিগার করুন

জাল নেটওয়ার্ক কলের কোডটি benchmarkable মডিউলের debug সোর্স সেটে থাকে এবং সম্পূর্ণ নেটওয়ার্ক বাস্তবায়ন একই মডিউলের release সোর্স সেটে থাকে। release বিল্ডে কোনও APK ব্লোট এড়াতে জাল বাস্তবায়ন দ্বারা ফেরত পাঠানো ডেটা ধারণকারী সম্পদ ফাইলটি debug সোর্স সেটে থাকে। benchmark ভেরিয়েন্টটি release উপর ভিত্তি করে তৈরি করা প্রয়োজন এবং debug সোর্স সেট ব্যবহার করা উচিত। জাল বাস্তবায়ন ধারণকারী benchmarkable মডিউলের benchmark ভেরিয়েন্টের বিল্ড কনফিগারেশন নিম্নরূপ:

কোটলিন

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 তৈরি করে যা হিল্টকে নিম্নরূপ সমর্থন করে:

কোটলিন

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 ক্লাসকে প্রসারিত করে। বিল্ড কনফিগারেশনে নিম্নলিখিত পরিবর্তনগুলি করুন:

কোটলিন

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 পরিবর্তন করতে হবে।

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

বেঞ্চমার্কটি নিম্নরূপ বাস্তবায়িত হয়:

কোটলিন

@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;
    }
}

পূর্ববর্তী উদাহরণটি বেঞ্চমার্ক এবং হিল্ট উভয়ের জন্যই নিয়ম তৈরি করে। benchmarkRule বেঞ্চমার্কের সময় নির্ধারণ করে। hiltRule বেঞ্চমার্ক টেস্ট ক্লাসে নির্ভরতা ইনজেকশন সম্পাদন করে। যেকোনো পৃথক পরীক্ষা চালানোর আগে ইনজেকশন সম্পাদনের জন্য আপনাকে @Before ফাংশনে হিল্ট নিয়মের 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...

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

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