Home

在 Android Studio 中使用 Cmake 来构建 C,C++ 应用

今天尝试了学习使用 ffmpeg 来编写播放器，需要使用 C,C++ 来编写代码，所有学习一下 Cmake 的使用。

Cmake 是一个开源，跨平台的工具，被用来构建、测试、打包软件。Cmake 使用了简单的和平台、编译器无关的配置文件，来生成当前平台的软件、链接库。

# 用法

举个栗子：
我有一个 jni 接口，Java 层调用这个接口，返回一个字符串 hello Cmake

1
2
3
4
5
6
7
8
9
10
11
12
libnative2/src/main/cpp/nativelib.cpp

#include <jni.h>  
#include <string>  
  
extern "C" JNIEXPORT jstring JNICALL  
Java_com_xzq_nativelib2_NativeLib_stringFromJNI(  
        JNIEnv* env,  
        jobject /* this */) {  
    std::string hello = "hello Cmake";  
    return env->NewStringUTF(hello.c_str());  
}

这个 cpp 文件对应的 java 类是 com/xzq/nativelib2/NativeLib.kt 这个类

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
libnative2/src/main/kotlin/com/xzq/nativelib2/NativeLib.kt

package com.xzq.nativelib2  
  
class NativeLib {  
  	//external对应的是Java中的native方法
	external fun stringFromJNI(): String  
  
    companion object {  
        // Used to load the 'nativelib2' library on application startup.  
        init {
			//它会去加载名为libnativelib2.so的动态库文件
            System.loadLibrary("nativelib2")  
        }  
    }  
}

我想要将这个 cpp 编译成 so 文件 libnativelib2.so ，在 app 模块中 MainActivity 中去调用 NativeLib 接口去访问本地 cpp 代码。

Cmake 有两种用法：gradle 配置和命令行

# 1.gradle 配置

CMake 可以通过 android build tool 脚本进行配置，在启动 gradle 构建后自动生成对应的文件。

1. 在 android 配置块中将 gradle 链接到你的 CMake 脚本
2. 在 defaultConfig 配置块中可以指定 CMake 可选的参数 (args) 和标记 (flags)
3. 在 productFlavor 中针对不同产品来替换对应属性

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
plugins {  
    id 'com.android.library'  
    or
	id 'com.android.application'  
}

android {  ...  
	defaultConfig {
		...
		
	}  
	buildTypes {...}  
	
	productFlavors {    
		...    
		create("demo") { 
			...
			externalNativeBuild {
				cmake {     
					... 
					// 指定gradle只编译target指定的模块。如果不指定target，那么CMake配置中的所有模块都会被进行编译和打包。
					targets += listOf("native-lib-demo",                 
				     //可执行文件是可选的，一般情况，仅编译动态库文件能满足要求。	
					"my-executible-demo")       
				}      
			}   
		}    
		create("paid") {     
			... 
			externalNativeBuild { 
				cmake {     
					... 
					targets += listOf("native-lib-paid",      
					"my-executible-paid")     
				}     
			}   
		}  
	}
	
	// 本地编译配置，可以配置ndk-bundle和CMake
	externalNativeBuild {    
		//CMake编译配置    
		cmake {   
			//指定CMakeLists.txt文件路径
			path = file("CMakeLists.txt")    
		}  
	}  
}

# 2. 命令行

使用命令行方式编译本地代码，

1
2
3
4
5
$ cmake \
-DCMAKE_TOOLCHAIN_FILE=$NDK/build/cmake/android.toolchain.cmake \    
-DANDROID_ABI=$ABI \    
-DANDROID_PLATFORM=android-$MINSDKVERSION \    
$OTHER_ARGS

上面命令行中几个参数的含义：

  • -DCMAKE_TOLLCHAIN_FILE=$NDK/build/cmake/android.toolchain.cmake 指定 ndk 中 CMake 编译工具链文件地址
  • -DANDROID_ABI=$ABI 指定目标平台的应用程序二进制接口 2022 年 最常见的应该是 arm64-v8a
  • -DANDROID_PLATFORM=android-$MINSDKVERSION 指定应用或库支持的最低 Android 平台版本，例如 android-31,android-29

还有更多的参数可以参考 Android 指南 - CMake

# CMakeLists.txt 配置文件编写

CMake 的执行已经知道了，但是我们没讲到如何将 cpp 文件编译成可执行文件或是库文件，CMakeLists.txt 就是用来告诉 CMake, 要如何编译，按照什么规则进行编译，编译需要使用的依赖项目，好像很类似与 Makefile 文件。下面是一个栗子：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
#指定了Cmake的最小支持版本
cmake_minimum_required(VERSION 3.10.2)  
  
#设置这个Cmake项目名，可以通过变量PROJECT_NAME进行访问
  
project("nativelib2")  
  
#创建并命名一个库
add_library( 
		# 设置这个库的名称  
        nativelib2  
  
        # 这个生成的库的类型，静态库，动态库等 
        SHARED  
  
        # 指定库的源文件相对路径，当在cpp中新增了文件中，需要在这个进行声明，cmake才会将新文件打包进库中。除了可以指定cpp源文件，还可以指定库文件路径
        nativelib2.cpp)  
  
# 搜索ndk环境中的库并自定义命名路径变量
find_library( 
		# 定义变量log-lib存储log这个库的路径
        log-lib  
  
        # 指定ndk环境中库的名称     
		log)  
  

#指定所有需要被链接到目标库的库名称  
target_link_libraries(
		# 目标库
        nativelib2  
  		
		#被链接的库，可以新增多个库名称
		
     	${log-lib})

配置好了之后，我们直接使用 Android Studio 编译安装 apk，打开 app，能看到打印成功

1
2

2022-05-11 01:25:51.546 20065-20065/com.luffy.mulmedia D/NavigationActivity: stringFromJNI2 hello Cmake

# 注意事项

我在学习过程中发现，如果 Android Studio 项目存在多个模块，如果有一个模块需要设置 cmake 的 abiFilter 为 armeabi-v7a，那么每一个模块都要设置 abiFilter，不然就会存在找不到 so 的情况。
我猜测，可能是因为如果某个模块不设置，那么就会在最终的 apk 的 jniLibs 中创建默认的 arm64-v8a 文件夹，然后运行中，发现了有 arm64-v8a 的文件夹，那么就只会在这个路径下搜索全部的 so 文件；又由于其他指定了 abiFilter 的模块会编译出指定的 armeabi-v7a 架构的文件，所有在 arm64-v8a 中找不到，最终抛出异常。如果有大佬知道原因的话可以告诉我一下。

Edited on Views times