Créer des profils de référence pour une bibliothèque

Pour créer des profils de référence pour une bibliothèque, utilisez le plug-in Baseline Profile Gradle.

La création de profils de référence pour une bibliothèque implique trois modules :

  • Module d'application exemple : contient l'application exemple qui utilise votre bibliothèque.
  • Module de bibliothèque : module pour lequel vous souhaitez générer le profil.
  • Module de profil de référence : module de test qui génère les profils de référence.

Pour générer un profil de référence pour une bibliothèque, procédez comme suit :

  1. Créez un nouveau module com.android.test, par exemple, :baseline-profile.
  2. Configurez le fichier build.gradle.kts pour le module :baseline-profile. La configuration est essentiellement la même que pour une application, mais veillez à définir targetProjectPath sur le module d'application exemple.
  3. Créez un test de profil de référence dans le module de test :baseline-profile. Il doit être spécifique à l'application exemple et utiliser toutes les fonctionnalités de la bibliothèque.
  4. Mettez à jour la configuration dans le fichier build.gradle.ktss du module de bibliothèque, dites :library.
    1. Appliquez le plug-in androidx.baselineprofile.
    2. Ajoutez une dépendance baselineProfile au module :baseline-profile.
    3. Appliquez la configuration de plug-in de votre choix, comme illustré dans l'exemple suivant.

    Kotlin

    plugins {
        id("com.android.library")
        id("androidx.baselineprofile")
    }
    
    android { ... }
    
    dependencies {
        ...
        // Add a baselineProfile dependency to the `:baseline-profile` module.
        baselineProfile(project(":baseline-profile"))
    }
    
    // Baseline Profile Gradle plugin configuration.
    baselineProfile {
    
        // Filters the generated profile rules.
        // This example keeps the classes in the `com.library` package all its subpackages.
        filter {
            include "com.mylibrary.**"
        }
    }
    

    Groovy

    plugins {
        id 'com.android.library'
        id 'androidx.baselineprofile'
    }
    
    android { ... }
    
    dependencies {
        ...
        // Add a baselineProfile dependency to the `:baseline-profile` module.
        baselineProfile ':baseline-profile'
    }
    
    // Baseline Profile Gradle plugin configuration.
    baselineProfile {
    
        // Filters the generated profile rules.
        // This example keeps the classes in the `com.library` package all its subpackages.
        filter {
            include 'com.mylibrary.**'
        }
    }
    
  5. Ajoutez le plug-in androidx.baselineprofile au fichier build.gradle.kts dans le module d'application :sample-app.

    Kotlin

    plugins {
        ...
        id("androidx.baselineprofile")
    }
    

    Groovy

    plugins {
        ...
        id 'androidx.baselineprofile'
    }
    
  6. Générez le profil en exécutant le code suivant : ./gradlew :library:generateBaselineProfile.

À la fin de la tâche de génération, le profil de référence est stocké dans library/src/main/generated/baselineProfiles.