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

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

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 ইন্সট্যান্স হিল্ট দ্বারা ইনজেকশন করা হয়েছে, এবং আপনি বেঞ্চমার্কিংয়ের জন্য নিম্নলিখিত জাল বাস্তবায়নের সাথে এটি প্রতিস্থাপন করতে পারেন:

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 একটি আপডেট পায়, তখন বাছাইয়ের সময়কাল বেঞ্চমার্ক টাইমিং-এ অন্তর্ভুক্ত করা হয়।

মাইক্রোবেঞ্চমার্ক চালান

./gradlew :benchmark:connectedBenchmarkAndroidTest দিয়ে বেঞ্চমার্ক চালান বহু পুনরাবৃত্তির উপর বেঞ্চমার্ক সম্পাদন করতে এবং Logcat- এ টাইমিং ডেটা প্রিন্ট করতে:

PeopleRepositoryBenchmark.log[Metric (timeNs) results: median 613408.3952380952, min 451949.30476190476, max 1412143.5142857144, standardDeviation: 273221.2328680522...

1,000 আইটেমের তালিকায় সাজানোর অ্যালগরিদম চালানোর জন্য পূর্ববর্তী উদাহরণটি 0.6ms এবং 1.4ms এর মধ্যে বেঞ্চমার্ক ফলাফল দেখায়। যাইহোক, যদি আপনি বেঞ্চমার্কে নেটওয়ার্ক কল অন্তর্ভুক্ত করেন, তাহলে পুনরাবৃত্তির মধ্যে পার্থক্যটি সর্টটি চালানোর জন্য যে সময়ের চেয়ে বেশি, তাই নেটওয়ার্ক কল থেকে বাছাইকে আলাদা করার প্রয়োজন।

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