הרבה אפליקציות משתמשות ב-Hilt כדי להחדיר התנהגויות שונות לגרסאות שונות של build. האפשרות הזו יכולה להיות שימושית במיוחד כשמבצעים מיקרו-בנצ'מרקינג לאפליקציה, כי היא מאפשרת להחליף רכיב שיכול להטות את התוצאות. לדוגמה, קטע הקוד הבא מציג מאגר שמביא וממיין רשימה של שמות:
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); } }
הנתונים נטענים מנכסים באמצעות קריאת קלט/פלט באורך משתנה.
עם זאת, הפעולה הזו מתבצעת במהלך האתחול ולא תגרום לחריגות כשקוראים ל-getPeople()
במהלך בדיקת ביצועים.
חלק מהאפליקציות כבר משתמשות ב-fakes בגרסאות debug כדי להסיר תלות ב-backend. עם זאת, צריך להשוות לביצועים של גרסת build שדומה ככל האפשר לגרסת ה-release. בהמשך המסמך נעשה שימוש במבנה מרובה מודולים ומרובה וריאציות, כפי שמתואר במאמר בנושא הגדרה מלאה של פרויקט.
יש שלושה מודולים:
-
benchmarkable
: מכיל את הקוד להשוואה. -
benchmark
: מכיל את קוד ההשוואה לשוק. -
app
: מכיל את קוד האפליקציה שנותר.
לכל אחד מהמודולים הקודמים יש וריאנט build בשם benchmark
, בנוסף לווריאנטים הרגילים debug
ו-release
.
הגדרת מודול ההשוואה
הקוד של קריאת הרשת המזויפת נמצא בקבוצת המקור debug
של המודול benchmarkable
, וההטמעה המלאה של הרשת נמצאת בקבוצת המקור release
של אותו מודול. קובץ הנכס שמכיל את הנתונים שהוחזרו על ידי ההטמעה המזויפת נמצא בערכת המקור debug
כדי למנוע ניפוח של קובץ ה-APK בגרסת ה-build release
. benchmark
הווריאנט צריך להתבסס על release
ולהשתמש בdebug
קבוצת המקורות. הגדרת ה-build של וריאנט benchmark
במודול benchmarkable
שמכיל את ההטמעה המדומה היא כדלקמן:
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
. מבצעים את השינויים הבאים בהגדרות ה-build:
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 על ה-build.
- מציינת שמשתמשים בכלי מותאם אישית להרצת בדיקות כדי להריץ את הבדיקות.
- מציין שהווריאנט
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; } }
בדוגמה הקודמת נוצרים כללים גם ל-benchmark וגם ל-Hilt.
הקוד benchmarkRule
מבצע את התזמון של ההשוואה לשוק. hiltRule
מבצעת את הזרקת התלות במחלקת בדיקת ההשוואה לשוק. כדי לבצע את ההזרקה לפני שמריצים בדיקות נפרדות, צריך להפעיל את השיטה inject()
של כלל Hilt בפונקציה @Before
.
התזמון של נקודת ההשוואה מושהה בזמן שהמשקיף 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.6ms ל-1.4ms להרצת אלגוריתם המיון ברשימה של 1,000 פריטים. עם זאת, אם כוללים את קריאת הרשת במדד הביצועים, השונות בין האיטרציות גדולה יותר מזמן ההרצה של המיון עצמו, ולכן צריך לבודד את המיון מקריאת הרשת.
תמיד אפשר לבצע רפקטורינג של הקוד כדי להריץ את המיון בבידוד, אבל אם אתם כבר משתמשים ב-Hilt, אתם יכולים להשתמש בו כדי להחדיר זיופים לצורך השוואה.