Android Cmake添加C/C++代码

2020-04-06 本文已影响0人付凯强

1. 序言

通过创建和分析Native C++项目，来更多了解Cmake构建工具。

2. 目录

添加 C 和 C++ 代码到项目的三大步骤
Android Studio 创建 Native C++ 开发项目
Cmake 编译基础语法和实践
在Java中调用Jni方法

3. 添加 C 和 C++ 代码到项目的三大步骤

如果想要将原生代码添加到现有项目，则需要按以下步骤操作：

创建新的原生源代码文件，并将其添加到 Android Studio 项目。
配置 Cmake 构建脚本，以将原生源代码构建入库。
在 Gradle 中配置 Cmake 或 ndk-build 脚本文件的路径。

4. Android Studio 创建 Native C++ 开发项目

创建
New Project > Native C++ > Next > Next > Finish
分解默认项目

2.1 源文件main/cpp/native-lib.cpp

#include <jni.h>
#include <string>

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

将相应的代码添加到项目模块的 cpp 目录中。

2.2 配置 Cmake 构建脚本

2.3 在Gradle配置 Cmake 构建脚本的路径

...
android {
    ...
    defaultConfig {
        ...
        externalNativeBuild {
            cmake {
                cppFlags "-std=c++11"
            }
        }
    }
    ...
    externalNativeBuild {
        cmake {
            path "src/main/cpp/CMakeLists.txt"
            version "3.6.0"
        }
    }
}
...

① 上述代码定义了 Cmake 的版本以及构建脚本所在位置，以及C++规范。
② Android Studio 支持适用于跨平台项目的 CMake，以及速度比 CMake 更快但仅支持 Android 的 ndk-build。目前不支持在同一模块中同时使用 CMake 和 ndk-build。
③ 提供 CMake 或 ndk-build 脚本文件的路径以配置 Gradle。Gradle 使用构建脚本将源代码导入 Android Studio 项目并将原生库（SO 文件）打包到 APK 中。
④ SDK 管理器包含 CMake 的 3.6.0 派生版本和版本 3.10.2。未在 build.gradle 中设置特定 CMake 版本的项目均使用 CMake 3.6.0 进行构建。要使用后来包含的版本，请在模块的 build.gradle 文件中指定 CMake 版本 3.10.2.

2.4 查看 native-lib so库存在的位置

so库的名字与cpp名字保持一致

默认为arm64-v8a和armeabi-v7a架构处理器生成so，如果想要支持x86，可以在buidl中进行配置。

    defaultConfig {
       ...
        externalNativeBuild {
            cmake {
                cppFlags "-std=c++11"
            }
        }
        ndk{
            abiFilters "x86"
        }
    }

2.5 使用 JNI 框架从 Java 或 Kotlin 代码中访问原生函数

    // Used to load the 'native-lib' library on application startup.
    static {
        System.loadLibrary("native-lib");
    }

加载编译好的 native-lib so 库。

    /**
     * A native method that is implemented by the 'native-lib' native library,
     * which is packaged with this application.
     */
    public native String stringFromJNI();

通过 Jni 获取来自 native-lib so 库的字符串.

5. CMake 编译基础语法和实践

5.1 解析 Cmake 构建脚本的结构

以 CMakeLists.txt 为例，构建脚本主要由4个部分组成:

# Sets the minimum version of CMake required to build the native library.
cmake_minimum_required(VERSION 3.4.1)

设置编译原生库所需要的 Cmake 的最低版本

# Creates and names a library, sets it as either STATIC
# or SHARED, and provides the relative paths to its source code.
# You can define multiple libraries, and CMake builds them for you.
# Gradle automatically packages shared libraries with your APK.

add_library( # Sets the name of the library.
        native-lib
        # Sets the library as a shared library.
        SHARED
        # Provides a relative path to your source file(s).
        native-lib.cpp)

① 创建并命名库，将其设置为静态或共享，并提供其源代码的相对路径。
② 您可以定义多个库，CMake会为您构建它们。
③ Gradle会自动将共享库打包到APK中。

# Searches for a specified prebuilt library and stores the path as a
# variable. Because CMake includes system libraries in the search path by
# default, you only need to specify the name of the public NDK library
# you want to add. CMake verifies that the library exists before
# completing its build.

find_library( # Sets the name of the path variable.
        log-lib
        # Specifies the name of the NDK library that
        # you want CMake to locate.
        log)

① 搜索指定的预构建库并将其路径存储为变量。因为CMake在默认情况下，在其搜索路径中会包含系统库的路径，所以只需要指定#你要添加的公共NDK库的名称。CMake 在完成编译之前，会验证库是否存在。
② 这里log库被命名为log-lib。

# Specifies libraries CMake should link to your target library. You
# can link multiple libraries, such as libraries you define in this
# build script, prebuilt third-party libraries, or system libraries.

target_link_libraries( # Specifies the target library.
        native-lib

        # Links the target library to the log library
        # included in the NDK.
        ${log-lib})

指定CMake应链接到目标库的库。你可以链接多个库，例如构建脚本、预构建的第三方库或系统库。

5.2 解析 Cmake 语法

变量

# 自定义变量
set(var hello)
message("var = ${var}")
# 原有常量
message("CMAKE_CURRENT_LIST_FILE = ${CMAKE_CURRENT_LIST_FILE}")

debug|x86_64 :var = hello
debug|x86_64 :CMAKE_CURRENT_LIST_FILE = /Users/fukq/AndroidProject/C++/Cmake/app/src/main/cpp/CMakeLists.txt

用set定义变量var，用message打印变量var。
注意：如果打印不出来，检查是否build.gradle配置的cmake的version是否是3.6.0.另外在build（AndroidStudio 右侧 Gradle CmakeTest > app > Tasks > build > build) 之前请先删除app下的缓存文件夹“.cxx"和build。

逻辑操作

if(TRUE)
    message("I am true")
elseif(FALSE)
    message("I am false")
endif()

编译自己的动态库

然后在构建文件CMakeLists.txt添加配置即可

add_library(
        person-lib
        SHARED
        person/Person.cpp
)

动态库会编译到如下位置：

关联库

target_link_libraries( # Specifies the target library.
        native-lib
        person-lib
        # Links the target library to the log library
        # included in the NDK.
        ${log-lib})

只需要在target_link_libraries添加我们的动态库即可。

库与库之间的关联

#include <string>

class Person {
public:
    std::string getName();
};

修改Person.h，定义了一个公共的方法，返回一个字符串。

#include "Person.h"
std::string Person::getName(){
    return "I am fukaiqiang";
}

修改Person.cpp，具体实现这个方法。

#include <jni.h>
#include <string>
#include "person/Person.h"

extern "C" JNIEXPORT jstring JNICALL
Java_com_example_cmaketest_MainActivity_stringFromJNI(
        JNIEnv *env,
        jobject /* this */) {
    Person person;
    return env->NewStringUTF(person.getName().c_str());
}

改造native-lib.cpp，引入Person.h头文件，调用Person的getName方法即可。

6. 在Java中调用Jni方法

Java 方法中加载动态库 so

    // Used to load the 'native-lib' library on application startup.
    static {
        System.loadLibrary("native-lib");
    }

Java 方法中调用 native 方法的函数类型

    /**
     * A native method that is implemented by the 'native-lib' native library,
     * which is packaged with this application.
     */
    public native String stringFromJNI();

Jni 头文件的创建方式以及命名方式

#include <jni.h>
#include <string>
#include "person/Person.h"

extern "C" JNIEXPORT jstring JNICALL
Java_com_example_cmaketest_MainActivity_stringFromJNI(
        JNIEnv *env,
        jobject /* this */) {
    Person person;
    return env->NewStringUTF(person.getName().c_str());
}

Jni 方法的定义遵循 Java + 包名 + 类名 + 方法名，中间用"_"隔开，Java首字母记得大写。
但是AndroidStudio可以快捷生成对应的native jni方法，使用Alt或者Command + Enter 即可。

 public native String getName();

extern "C"
JNIEXPORT jstring JNICALL
Java_com_example_cmaketest_MainActivity_getName(JNIEnv *env, jobject thiz) {
    // TODO: implement getName()
}

extern "C"的主要作用就是为了能够正确实现C++代码调用其他C语言代码。加上extern "C"后，会指示编译器这部分代码按C语言（而不是C++）的方式进行编译。由于C++支持函数重载，因此编译器编译函数的过程中会将函数的参数类型也加到编译后的代码中，而不仅仅是函数名；而C语言并不支持函数重载，因此编译C语言代码的函数时不会带上函数的参数类型，一般只包括函数名。
这个功能十分有用处，因为在C++出现以前，很多代码都是C语言写的，而且很底层的库也是C语言写的，为了更好的支持原来的C代码和已经写好的C语言库，需要在C++中尽可能的支持C，而extern "C"就是其中的一个策略。

7. 后续

如果大家喜欢这篇文章，欢迎点赞！
如果想看更多 C/C++ 方面的文章，欢迎关注!