CMake基本配置与注意事项

CMake基本配置与注意事项

目录

• CMake基本配置与注意事项
  • CMake
  • message打印日志
  • find_library查找一个NDK工具中的库
  • 添加多个源文件
  • CMake中引用其他的 CMake
  • 添加其他预编译库
  • 常用指令：
  • 5.0及以下与6.0及以上的注意事项：
    • Android.mk
    • CMake

• CMake手册 https://www.zybuluo.com/khan-lau/note/254724
• Makefile语法详解 https://quanzhuo.github.io/2016/06/06/Makefile

CMake

​ 在android studio 2.2及以上，构建原生库的默认工具是 CMake。

​ CMake是一个跨平台的构建工具，可以用简单的语句来描述所有平台的安装(编译过程)。能够输出各种各样的makefile或者project文件。Cmake 并不直接建构出最终的软件，而是产生其他工具的脚本（如Makefile ），然后再依这个工具的构建方式使用。

​ CMake是一个比make更高级的编译配置工具，它可以根据不同平台、不同的编译器，生成相应的Makefile或者vcproj项目。从而达到跨平台的目的。Android Studio利用CMake生成的是ninja，ninja是一个小型的关注速度的构建系统。我们不需要关心ninja的脚本，知道怎么配置cmake就可以了。从而可以看出cmake其实是一个跨平台的支持产出各种不同的构建脚本的一个工具。

CMake的脚本名默认是CMakeLists.txt

#cmake最低版本
cmake_minimum_required(VERSION 3.6.0)

#指定项目
project(Main)

#生成可执行文件 main
add_executable(main main.c)

#执行cmake . 生成makefile
#再执行make即可生成main程序

message打印日志

可以使用message("打印日志")来打印日志

# log 信息输出的查看
# 以前的Cmake版本都是在output.txt, 现在最新版本Cmake在metadata_generation_stderr.txt或cmake_server_log,
# 路径`./app/.cxx/cmake/debug/armeabi-v7a/cmake_server_log.txt`
# 想及时更新你的日志，请安装一次即可 or Linked_C++_Projects
# 在Build也可以查看，注意：是点击Sync Now 才会看到

#[[
(无) = 重要消息；
STATUS = 非重要消息；
WARNING = CMake 警告, 会继续执行；
AUTHOR_WARNING = CMake 警告 (dev), 会继续执行；
SEND_ERROR = CMake 错误, 继续执行，但是会跳过生成的步骤；
FATAL_ERROR = CMake 错误, 终止所有处理过程；
]]

message(STATUS "1SuccessD>>>>>>>>>>>>>>>>>>>>>>>>>>>>")
message(STATUS "2SuccessD>>>>>>>>>>>>>>>>>>>>>>>>>>>>")
message(STATUS "3SuccessD>>>>>>>>>>>>>>>>>>>>>>>>>>>>")
message(STATUS "4SuccessD>>>>>>>>>>>>>>>>>>>>>>>>>>>>")
message(STATUS "5SuccessD>>>>>>>>>>>>>>>>>>>>>>>>>>>>")
message(STATUS "6SuccessD>>>>>>>>>>>>>>>>>>>>>>>>>>>>")
message(STATUS "7SuccessD>>>>>>>>>>>>>>>>>>>>>>>>>>>>")
message(STATUS "8SuccessD>>>>>>>>>>>>>>>>>>>>>>>>>>>>")
message(STATUS "9SuccessD>>>>>>>>>>>>>>>>>>>>>>>>>>>>")
message(STATUS "0SuccessD>>>>>>>>>>>>>>>>>>>>>>>>>>>>")
message("10 OldCmakeVersion:output.txt, NewCmakeVersion:cmake_server_log.txt")

find_library查找一个NDK工具中的库

在创建一个新的C++项目工程后，在CMakeLists.txt中都会有find_library(log-lib log )这个函数，表示的是查找一个NDK工具中的log的动态库。

思考：我如何知道哪些库是可以写的，你怎么知道些一个log就可以？

答：请查看 D:\Android\Sdk\ndk\21.4.7075529\build\cmake\system_libs.cmake

思考：D:\Android\Sdk\ndk\21.0.6113669\toolchains\llvm\prebuilt\windows-x86_64\sysroot\usr\lib\arm-linux-androideabi\16\liblog.so

问题1:你怎么知道是在 21.4.7075529？，问题2:为啥是arm-linux-androideabi？，问题3；为啥是16？

答：?1 (因为local.properties指定了NDK版本，或者是你当前的NDK版本)

答：?2 (因为我的手机是arm32的，而且在项目的build.gradle中配置了"armeabi-v7a" 所以是arm-linux-androideabi)

答：?3 (因为项目中的minSdkVersion是16)

添加多个源文件

如果源文件很多，那么一个个写进去是一件很麻烦的事情，这里有两种方法：

1. file(GLOB source src/main/cmake/*.c src/main/cmake/*.cpp) # GLOB是固定的写法，source是一个变量名,表示src/main/cmake/下面的所有.c和.cpp文件添加到source里面来
2. aux_source_directory(. DIR_SRCS)# 查找当前目录所有源文件 并将名称保存到 DIR_SRCS 变量,不能查找子目录

cmake_minimum_required(VERSION 3.6.0)
project(Main)
#查找当前目录所有源文件 并将名称保存到 DIR_SRCS 变量
#不能查找子目录
aux_source_directory(. DIR_SRCS)
message(${DIR_SRCS})

#也可以
file(GLOB DIR_SRCS *.c)

add_executable(main ${DIR_SRCS})

CMake中引用其他的 CMake

如果在cmake中需要使用其他目录的cmakelist

cmake_minimum_required (VERSION 3.6.0)
project (Main)
aux_source_directory(. DIR_SRCS)
# 添加 child 子目录下的cmakelist
add_subdirectory(child)
# 指定生成目标
add_executable(main ${DIR_SRCS})
# 添加链接库
target_link_libraries(main child)
#===========================================================================================
#child目录下的cmake就是：
cmake_minimum_required (VERSION 3.6.0)
aux_source_directory(. DIR_LIB_SRCS)
# 生成链接库 默认生成静态库
add_library (child ${DIR_LIB_SRCS})
#指定编译为静态库
add_library (child STATIC ${DIR_LIB_SRCS})
#指定编译为动态库
add_library (child SHARED ${DIR_LIB_SRCS})

在上面的例子中都是生成可执行文件，让我们对cmakelist有了一定的了解。现在到android studio中使用cmakelist

#NDK中已经有一部分预构建库 ndk库已经是被配置为cmake搜索路径的一部分 所以可以
findLibrary(log-lib log)
target_link_libraries( native-lib
                       ${log-lib} )
#设置cflag和cxxflag
#定义预编译宏：TEST，-D就是定义预编译宏的意思
set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -DTEST"  )
set(CMAKE_Cxx_FLAGS "${CMAKE_Cxx_FLAGS} -DTEST"  )
#其实直接这样就行
target_link_libraries( native-lib
                       log )

添加其他预编译库

添加其他预编译库(已经提前编译好的库)

#使用 IMPORTED 标志告知 CMake 只希望将库导入到项目中
#如果是静态库则将shared改为static
add_library( imported-lib
             SHARED
             IMPORTED )
# 参数分别为：库、属性、导入地址、so所在地址
set_target_properties(
                       imported-lib
                       PROPERTIES
                       IMPORTED_LOCATION
                       ${CMAKE_SOURCE_DIR}/src/${ANDROID_ABI}/libimported-lib.so )
#为了确保 CMake 可以在编译时定位头文件
#这样就可以使用 #include <xx> 引入
#否则需要使用 #include "path/xx"
include_directories( imported-lib/include/ )

#native-lib 是自己编写的源码最终要编译出的so库
target_link_libraries(native-lib imported-lib)
#===========================================================================================
# 添加其他预编译库还可以使用这种方式
# 使用-L指导编译时库文件的查找路径
# set方法相当于定义一个变量
# 变量名 CMAKE_C_FLAGS = ${CMAKE_C_FLAGS} + 自己设置的值(${CMAKE_C_FLAGS} （原来的CMAKE_C_FLAGS变量的值 + 自己定义的值)
# 如果有多个路径：set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS}" -LXXX -LXXX -LXXX)
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Lxx")
# 为了确保 CMake 可以在编译时定位您的标头文件
include_directories( imported-lib/include/ )

# native-lib 是自己编写的源码最终要编译出的so库
target_link_libraries(native-lib imported-lib)

像这些CMAKE_SOURCE_DIR和ANDROID_ABI等都是CMake内部预设好了的,它们是在.../Android/sdk/cmake/3.6.4111459/android.toolchain.cmake这个文件，我们在执行CMakeLists.txt的时候，会去读取android.toolchain.cmake这个文件

常用指令：

#set命令表示声明一个变量source 变量的值是后面的可变参数
set（source a b c）
message(${source})

#逻辑判断 计较字符串
set(ANDROID_ABI "areambi-v7a")
if(${ANDROID_ABI} STREQUAL "areambi")
  	message("armv5")
elseif(${ANDROID_ABI} STREQUAL "areambi-v7a")
	message("armv7a")
else()

endif()

//还可以在gradle中使用 arguments  设置一些配置
externalNativeBuild {
      cmake {
        arguments "-DANDROID_TOOLCHAIN=clang",	//使用的编译器clang/gcc
                  "-DANDROID_STL=gnustl_static" //cmake默认就是 gnustl_static
        cFlags "" //这里也可以指定cflag和cxxflag,效果和之前的cmakelist里使用一样
        cppFlags ""
      }
    }

5.0及以下与6.0及以上的注意事项：

​ 存在两个动态库 libhello-jni.so 与 libTest.so。

libhello-jni.so依赖于libTest.so (使用NDK下的ndk-depends可查看依赖关系)，则：

//<=5.0:
	System.loadLibrary("Test");
	System.loadLibrary("hello-jni");
//>=6.0:
	System.loadLibrary("hello-jni");

• 在4.4上 如果load一个动态库 ，需要先将这个动态库的依赖的其他动态库load进来
• 在6.0以下 System.loadLibrary 不会自动为我们加载依赖的动态库
• 在6.0以上 System.loadLibrary 会自动为我们加载依赖的动态库

Android.mk

​ 使用Android.mk在 >=6.0 设备上不能再使用预编译动态库(静态库没问题)：

LOCAL_PATH := $(call my-dir)

include $(CLEAR_VARS)
LOCAL_MODULE := Test
#libTest.so放在当前文件同目录
LOCAL_SRC_FILES := libTest.so
#预编译库
include $(PREBUILT_SHARED_LIBRARY)

include $(CLEAR_VARS)
#引入上面的Test模块
LOCAL_SHARED_LIBRARIES := Test
LOCAL_MODULE := hello-jni
LOCAL_SRC_FILES := hello-jni.c
include $(BUILD_SHARED_LIBRARY)

上面这段配置生成的libhllo-jni在>=6.0设备中无法执行。目前还没有找到在>=6.0设备的解决方法，最好是使用CMake

CMake

​ 使用CMakeList.txt在 >=6.0 设备上引入预编译动态库:

cmake_minimum_required(VERSION 3.4.1)

file(GLOB SOURCE *.c )
add_library(
             hello-jni
             SHARED
            ${SOURCE} )

#这段配置在6.0依然没问题
set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -L[SO所在目录]")

#这段配置只能在6.0以下使用 原因和android.mk一样
#add_library(Test SHARED IMPORTED)
#set_target_properties(Test PROPERTIES IMPORTED_LOCATION [SO绝对地址])

target_link_libraries(  hello-jni Test )

Android NDK 开发：CMake 使用

CMake 入门实战

CMake 使用教程

CMake使用简介及CMakeList.txt编写