在 Android Studio 中集成 Conan

在使用 NDK 交叉构建到 Android 中，我们学习了如何使用 NDK 为 Android 构建包。在本示例中，我们将学习如何使用 Android Studio 来实现，以及如何在实际的 Android 应用中使用这些库。

创建新项目

首先，下载并安装 Android Studio IDE。

然后从模板中选择 Native C++ 创建一个 new project。

在下一个向导窗口中，为您的应用选择一个名称，例如 MyConanApplication，您可以保留“Minimum SDK”的建议值（此处为 21），但请记住该值，我们稍后将在 Conan profile 的 os.api_level` 中使用它。

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

在下一个窗口中选择一个“C++ Standard”，同样，请记住您的选择，因为稍后我们将在 profile 的 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 task 会为 Debug/Release 以及我们想要构建的每种架构调用 conan install，您可以根据您的需求调整这些值。

如果我们关注 conan install task，我们可以看到

  1. 我们传递了一个 --profile android 参数，因此我们需要创建该 profile。转到 conan 配置主目录中的 profiles 文件夹（通过运行 conan config home 查看），然后创建一个名为 android 的文件，内容如下：

    include(default)

[settings]
os=Android
os.api_level=21
compiler=clang
compiler.version=12
compiler.libcxx=c++_static
compiler.cppstd=14

[conf]
tools.android:ndk_path=/opt/homebrew/share/android-ndk

    您可能需要修改

    • tools.android:ndk_path conf: 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 版本并调整 profile。

    • compiler.libcxx: 支持的值是 c++_static 和 c++_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 21
        targetSdk 21
        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 的文件，该文件将根据指示 IDE 当前正在运行的构建配置的 ANDROID_ABI 变量负责包含正确的工具链

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 的不同配置。

然后，如果在虚拟设备或通过二维码配对的真实设备上运行应用，我们可以看到

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