在 Android Studio 中集成 Conan

使用 NDK 交叉构建 Android中,我们学习了如何使用 NDK 构建 Android 包。在本示例中,我们将学习如何使用 Android Studio 进行构建,以及如何在真实的 Android 应用程序中使用这些库。

创建新项目

首先,下载并安装Android Studio IDE

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

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

在“构建配置语言”中,你可以选择Groovy DSL (build.gradle)Kotlin DSL (build.gradle.kts),以便使用下面的conanInstall任务。

在下一个窗口中选择一个“C++ 标准”,同样,请记住此选择,因为稍后我们应该在配置文件中的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任务正在为 Debug/Release 以及我们想要构建的每个架构调用conan install,你可以调整这些值以匹配你的需求。

如果我们专注于conan install任务,我们可以看到

  1. 我们正在传递--profile android,所以我们需要创建该配置文件。转到 Conan 配置主目录(通过运行conan config home检查)中的profiles文件夹,并创建一个名为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版本并调整配置文件。

    • 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 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