Se usó la API de Cloud Translation para traducir esta página.

Microbenchmark e Hilt

Muchas apps usan Hilt para inyectar diferentes comportamientos en diferentes variantes de compilación. Esto puede ser particularmente útil cuando se hacen microcomparativas de tu app, ya que te permite puedes intercambiar un componente que puede sesgar los resultados. Por ejemplo, el siguiente muestra un repositorio que recupera y ordena una lista de nombres:

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

Si incluyes una llamada de red cuando realizas comparativas, implementa una llamada de red falsa para obtener un resultado más preciso.

Incluir una llamada de red real cuando las comparativas dificultan la interpretación los resultados de las comparativas. Las llamadas de red pueden verse afectadas por muchos factores externos. su duración puede variar entre las iteraciones de ejecución de las comparativas. El la duración de las llamadas de red puede llevar más tiempo que el ordenamiento.

Cómo implementar una llamada de red falsa con Hilt

La llamada a dataSource.getPeople(), como se muestra en el ejemplo anterior, contiene una llamada de red. Sin embargo, la instancia NetworkDataSource se inserta por Hilt, y puedes reemplazarlo con la siguiente implementación falsa para comparativas:

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

Esta llamada de red falsa está diseñada para ejecutarse lo más rápido posible cuando llames el método getPeople() Para que Hilt pueda inyectar esto, los siguientes se usa el siguiente proveedor:

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

Los datos se cargan desde los recursos mediante una llamada de E/S de duración variable. Sin embargo, esto se hace durante la inicialización y no provocará irregularidades Cuando se llama a getPeople() durante las comparativas.

Algunas apps ya usan simulaciones en compilaciones de depuración para quitar cualquier dependencia de backend. Sin embargo, debes crear comparativas en una compilación que sea tan parecida a la de lanzamiento como como sea posible. En el resto de este documento, se usa una estructura de múltiples módulos y variantes. como se describe en Configuración completa del proyecto.

Hay tres módulos:

benchmarkable: Contiene el código para comparar.
benchmark: Contiene el código de las comparativas.
app: Contiene el código de la app restante.

Cada uno de los módulos anteriores tiene una variante de compilación llamada benchmark junto con las variantes habituales de debug y release.

Cómo configurar el módulo de comparativas

El código de la llamada de red falsa se encuentra en el conjunto de orígenes debug de la benchmarkable, y la implementación de red completa se encuentra en release conjunto de orígenes del mismo módulo. El archivo de recurso que contiene los datos devueltos por la implementación falsa está en el conjunto de orígenes debug para evitar un sobredimensionamiento del APK en la compilación release La variante benchmark debe basarse en release y usa el conjunto de orígenes debug. La configuración de compilación para la variante benchmark del módulo benchmarkable que contiene la implementación falsa es la siguiente:

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']
        }
    }
}

En el módulo benchmark, agrega un ejecutor de pruebas personalizado que cree un Application. para ejecutar pruebas compatibles con Hilt de la siguiente manera:

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

Esto hace que el objeto Application en el que se ejecutan las pruebas extienda el HiltTestApplication. Realiza los siguientes cambios en la compilación actual:

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
}

En el ejemplo anterior, se hace lo siguiente:

Aplica los complementos de Gradle necesarios a la compilación.
Especifica que el ejecutor de pruebas personalizado se usa para ejecutar las pruebas.
Especifica que la variante benchmark es el tipo de prueba para este módulo.
Agrega la variante benchmark.
Agrega las dependencias necesarias.

Debes cambiar testBuildType para asegurarte de que Gradle cree el La tarea connectedBenchmarkAndroidTest, que realiza las comparativas.

Cómo crear la microcomparativa

Las comparativas se implementan de la siguiente manera:

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

En el ejemplo anterior, se crean reglas tanto para la comparativa como para Hilt. benchmarkRule realiza el tiempo de la comparativa. hiltRule realiza la inyección de dependencias en la clase de prueba de comparativas. Debes invocar a inject() de la regla de Hilt en una función @Before para realizar la antes de ejecutar pruebas individuales.

La comparativa en sí misma pausa el tiempo mientras el observador de LiveData está registrada. Luego, usa un seguro para esperar hasta que se actualice LiveData antes. que está terminando. Como la ordenación se ejecuta en el tiempo entre cuándo Se llama a peopleRepository.update() y, cuando LiveData recibe una actualización, la duración del ordenamiento se incluye en el tiempo de la comparativa.

Ejecuta las microcomparativas

Ejecuta las comparativas con ./gradlew :benchmark:connectedBenchmarkAndroidTest realizar la comparativa en muchas iteraciones e imprimir los datos de tiempo para Logcat:

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

En el ejemplo anterior, se muestra el resultado comparativo entre 0.6 ms y 1.4 ms que se ejecutará el algoritmo de ordenamiento en una lista de 1,000 elementos. Sin embargo, si incluyes llamada de red en la comparativa, la varianza entre iteraciones es mayor que el tiempo que tarda la ordenación en ejecutarse, por lo que es necesario aislar el ordenamiento de la llamada de red.

Siempre puedes refactorizar el código para que sea más fácil ejecutar el ordenamiento en pero si ya usas Hilt, puedes usarlo para inyectar datos falsos para y comparativas.

Cómo agregar argumentos de instrumentación

Cómo compilar sin Gradle