将 Conan 集成到 Android Studio

使用 NDK 交叉构建 Android中,我们学习了如何使用 NDK 为 Android 构建包。在本示例中,我们将学习如何在 Android Studio 中执行此操作,以及如何在实际 Android 应用程序中使用这些库。

创建一个新项目

首先,下载并安装Android Studio IDE

然后创建一个 项目,从模板中选择Native C++

在下一个向导窗口中,为您的应用程序选择一个名称,例如MyConanApplication,您可以将“Minimum SDK”保留为建议值(我们的例子中为 21),但请记住该值,因为我们稍后在 Conan 配置文件中使用它,即os.api_level

在“Build configuration language”中,您可以选择Groovy DSL (build.gradle)Kotlin DSL (build.gradle.kts),以便使用下面的conanInstall任务。

在下一个窗口中选择一个“C++ Standard”,同样,请记住该选择,因为我们稍后应在配置文件中使用相同的值,即compiler.cppstd

在用向导生成的项目中,我们有一个文件夹cpp和一个native-lib.cpp。我们将修改该文件以使用zlib并打印一条包含使用的zlib版本的消息。仅复制突出显示的行,保持函数名称很重要。

native-lib.cpp
 #include <jni.h>
 #include <string>
 #include "zlib.h"

 extern "C" JNIEXPORT jstring JNICALL
 Java_com_example_myconanapp_MainActivity_stringFromJNI(
         JNIEnv* env,
         jobject /* this */) {
     std::string hello = "Hello from C++, zlib version: ";
     hello.append(zlibVersion());
     return env->NewStringUTF(hello.c_str());
 }

现在我们将学习如何向zlib库引入一个依赖项,以及如何准备我们的项目。

使用 Conan 引入依赖项

conanfile.txt

我们需要使用 Conan 提供zlib包。在cpp文件夹中创建一个文件conanfile.txt

conanfile.txt
[requires]
zlib/1.2.12

[generators]
CMakeToolchain
CMakeDeps

[layout]
cmake_layout

build.gradle

我们将自动化在构建 Android 项目之前调用conan install,以便准备好所需的依赖项,打开My_Conan_App.app中的build.gradle文件(在 Android 项目视图的Gradle Scripts部分中找到)。将task conanInstall内容粘贴在plugins之后和android元素之前

build.gradle
plugins {
 ...
}

task conanInstall {
    def conanExecutable = "conan" // define the path to your conan installation
    def buildDir = new File("app/build")
    buildDir.mkdirs()
    ["Debug", "Release"].each { String build_type ->
        ["armv7", "armv8", "x86", "x86_64"].each { String arch ->
            def cmd = conanExecutable + " install " +
                      "../src/main/cpp --profile android -s build_type="+ build_type +" -s arch=" + arch +
                      " --build missing -c tools.cmake.cmake_layout:build_folder_vars=['settings.arch']"
            print(">> ${cmd} \n")

            def sout = new StringBuilder(), serr = new StringBuilder()
            def proc = cmd.execute(null, buildDir)
            proc.consumeProcessOutput(sout, serr)
            proc.waitFor()
            println "$sout $serr"
            if (proc.exitValue() != 0) {
                throw new Exception("out> $sout err> $serr" + "\nCommand: ${cmd}")
            }
        }
    }
}

android {
    compileSdk 32

    defaultConfig {

...

conanInstall任务正在调用conan install用于 Debug/Release 以及我们想要构建的每个架构,您可以调整这些值以满足您的要求。

如果我们将重点放在conan install任务上,我们可以看到

  1. 我们传递了一个--profile android,因此我们需要创建配置文件。转到 conan 配置主目录中的profiles文件夹(通过运行conan config home检查它),并创建一个名为android的文件,内容如下

    include(default)
    
    [settings]
    os=Android
    os.api_level=27
    compiler=clang
    compiler.version=18
    compiler.libcxx=c++_static
    compiler.cppstd=17
    
    [conf]
    tools.android:ndk_path=/opt/homebrew/share/android-ndk
    

    您可能需要修改

    • tools.android:ndk_path 配置:Android Studio 提供的 NDK 的位置。如果您在 IDE 中打开cpp/includes文件夹,您应该能够看到 NDK 的路径。

    • compiler.version:检查 NDK 文档或找到包含编译器可执行文件(如x86_64-linux-android31-clang)的bin文件夹。在 Macos 安装中,它位于 NDK 路径 + toolchains/llvm/prebuilt/darwin-x86_64/bin。运行./x86_64-linux-android31-clang --version以检查正在运行的clang版本并调整配置文件。

    • compiler.libcxx:支持的值是c++_staticc++_shared

    • compiler.cppstd:C++ 标准版本,这应该是在向导中选择的值。

    • os.api_level:使用您在向导中选择的相同值。

  2. 我们传递了-c tools.cmake.cmake_layout:build_folder_vars=['settings.arch'],因此 Conan 将为指定的settings.arch创建一个不同的文件夹,以便我们可以同时使用所有配置。

为了使 Conan 正常工作,我们需要将一个自定义工具链传递给 CMake。我们可以在同一个文件中添加一行来完成此操作,在android/defaultConfig/externalNativeBuild/cmake元素中

build.gradle
android {
    compileSdk 32

    defaultConfig {
        applicationId "com.example.myconanapp"
        minSdk 27
        targetSdk 27
        versionCode 1
        versionName "1.0"

        testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
        externalNativeBuild {
            cmake {
                cppFlags '-v'
                arguments("-DCMAKE_TOOLCHAIN_FILE=conan_android_toolchain.cmake")
            }
        }

conan_android_toolchain.cmake

cpp文件夹中创建一个名为conan_android_toolchain.cmake的文件,该文件将负责根据ANDROID_ABI变量(指示 IDE 当前正在运行的构建配置)包含正确的工具链

conan_android_toolchain.cmake
 # During multiple stages of CMake configuration, the toolchain file is processed and command-line
 # variables may not be always available. The script exits prematurely if essential variables are absent.

 if ( NOT ANDROID_ABI OR NOT CMAKE_BUILD_TYPE )
     return()
 endif()
 if(${ANDROID_ABI} STREQUAL "x86_64")
     include("${CMAKE_CURRENT_LIST_DIR}/build/x86_64/${CMAKE_BUILD_TYPE}/generators/conan_toolchain.cmake")
 elseif(${ANDROID_ABI} STREQUAL "x86")
     include("${CMAKE_CURRENT_LIST_DIR}/build/x86/${CMAKE_BUILD_TYPE}/generators/conan_toolchain.cmake")
 elseif(${ANDROID_ABI} STREQUAL "arm64-v8a")
     include("${CMAKE_CURRENT_LIST_DIR}/build/armv8/${CMAKE_BUILD_TYPE}/generators/conan_toolchain.cmake")
 elseif(${ANDROID_ABI} STREQUAL "armeabi-v7a")
     include("${CMAKE_CURRENT_LIST_DIR}/build/armv7/${CMAKE_BUILD_TYPE}/generators/conan_toolchain.cmake")
 else()
     message(FATAL "Not supported configuration")
 endif()

CMakeLists.txt

最后,我们需要修改CMakeLists.txt以链接到zlib

CMakeLists.txt
cmake_minimum_required(VERSION 3.18.1)
project("myconanapp")
add_library(myconanapp SHARED native-lib.cpp)

find_library(log-lib log)

find_package(ZLIB CONFIG)

target_link_libraries(myconanapp ${log-lib} ZLIB::ZLIB)

构建应用程序

如果构建我们的项目,我们可以看到conan install被多次调用,构建了zlib的不同配置。

然后,如果我们在虚拟设备或通过配对 QR 码在真实设备上运行该应用程序,我们可以看到

Android application showing the zlib 1.2.11

配置完我们的项目后,很容易更改我们的依赖项并继续开发应用程序,例如,我们可以编辑conanfile.txt文件并将zlib更改为版本1.12.2

[requires]
zlib/1.2.12

[generators]
CMakeToolchain
CMakeDeps

[layout]
cmake_layout

如果单击构建然后运行该应用程序,我们将看到 zlib 依赖项已更新

Android application showing the zlib 1.2.12