Dipendenze native con il plug-in Android per Gradle

Le librerie AAR possono contenere dipendenze native che il plug-in Android per Gradle può utilizzare. AGP è anche in grado di produrre AAR che espongono librerie native ai loro consumer.

Utilizzo di dipendenze native

A partire dal plug-in Android per Gradle 4.0, le dipendenze C/C++ possono essere importate dagli AAR collegati nel file build.gradle. Gradle li renderà automaticamente disponibili per il sistema di build nativo, ma il sistema di build deve essere configurato per utilizzare le librerie e le intestazioni importate. Poiché le dipendenze C/C++ sono distribuite come AAR, i seguenti link relativi agli AAR generici potrebbero essere utili:

  • Creazione di una libreria Android per la documentazione generica degli AAR e su come integrarla nel tuo progetto, soprattutto se vuoi utilizzare l'AAR come dipendenza C/C++ locale.
  • Aggiungi dipendenze di build per informazioni sull'aggiunta di dipendenze al file build.gradle, in particolare per le dipendenze remote.

Questo documento si concentra sulla configurazione del sistema di build nativo e presuppone che tu abbia già aggiunto un AAR di dipendenza C/C++ all'ambiente di build Gradle del tuo progetto.

Dipendenze native negli AAR

Le dipendenze AAR dei moduli Gradle possono esporre librerie native per l'utilizzo da parte della tua applicazione. All'interno dell'AAR, la directory prefab contiene un pacchetto Prefab, che include le intestazioni e le librerie della dipendenza nativa.

Ogni dipendenza può esporre al massimo un pacchetto Prefab, che comprende uno o più moduli. Un modulo Prefab è una singola libreria, che può essere una libreria condivisa, statica o solo di intestazione.

Per utilizzare le librerie, è necessario conoscere i nomi dei pacchetti e dei moduli. Per convenzione, il nome del pacchetto corrisponderà al nome dell'artefatto Maven e il nome del modulo corrisponderà al nome della libreria C/C++, ma non è obbligatorio. Consulta la documentazione della dipendenza per determinare i nomi che utilizza.

Configurazione del sistema di build

La funzionalità prefab deve essere attivata per il tuo modulo Android Gradle.

Per farlo, aggiungi quanto segue al file gradle.properties del progetto:

android.enablePrefab=true

Facoltativamente, configura una versione nel file gradle.properties del progetto:

android.prefabVersion=2.0.0

In genere, la versione predefinita selezionata di AGP è adatta alle tue esigenze. Dovresti selezionare una versione diversa solo se devi aggirare un bug o se vuoi una nuova funzionalità.

Le dipendenze importate da un file AAR vengono esposte a CMake tramite CMAKE_FIND_ROOT_PATH. Questo valore verrà impostato automaticamente da Gradle quando viene richiamato CMake, quindi se la tua build modifica questa variabile, assicurati di aggiungere il valore anziché assegnarlo.

Ogni dipendenza espone un pacchetto di file di configurazione alla build. Questi vengono importati con il comando find_package. Questo comando cerca i pacchetti config-file corrispondenti al nome e alla versione del pacchetto specificati ed espone le destinazioni che definisce per l'utilizzo nella build. Ad esempio, se la tua applicazione definisce libapp.so e utilizza curl, il tuo CMakeLists.txt deve includere quanto segue:

add_library(app SHARED app.cpp)

# Add these two lines.
find_package(curl REQUIRED CONFIG)
target_link_libraries(app curl::curl)

app.cpp ora è in grado di #include "curl/curl.h", libapp.so verrà collegato automaticamente a libcurl.so durante la creazione e libcurl.so verrà incluso nell'app.

Pubblicazione di librerie native in AAR

La possibilità di creare AAR nativi è stata aggiunta per la prima volta in AGP 4.1.

Per esportare le librerie native, aggiungi quanto segue al blocco android del file build.gradle.kts del progetto della libreria:

Kotlin

buildFeatures {
    prefabPublishing = true
}

prefab {
    create("mylibrary") {
      headers = "src/main/cpp/mylibrary/include"
    }

    create("myotherlibrary") {
        headers = "src/main/cpp/myotherlibrary/include"
    }
}

Alla moda

buildFeatures {
    prefabPublishing true
}

prefab {
    mylibrary {
      headers "src/main/cpp/mylibrary/include"
    }

    myotherlibrary {
        headers "src/main/cpp/myotherlibrary/include"
    }
}

In questo esempio, le librerie mylibrary e myotherlibrary della build nativa esterna ndk-build o CMake verranno pacchettizzate nell'AAR prodotto dalla build ed entrambe esporteranno le intestazioni dalla directory specificata alle relative dipendenze.