美文网首页CMakeList
Android Cmakelist

Android Cmakelist

作者: 交大小丑 | 来源:发表于2018-10-22 20:29 被阅读0次

    一、背景:Cmakelist的使用

    项目创建好以后我们可以看到和普通Android项目有以下4个不同。

    1. main 下面增加了 cpp 目录,即放置 c/c++ 代码的地方
    2. module-level 的 build.gradle 有修改
    3. 增加了 CMakeLists.txt 文件
    4. 多了一个 .externalNativeBuild 目录
    image.png

    二、正文第一章:CMakeLists.txt 文件 讲解

    2.1 一个基本的Cmakelist文件

    cmake_minimum_required(VERSION 3.4.1)
    # 编译出一个动态库 native-lib,源文件只有 src/main/cpp/native-lib.cpp
    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).
                 src/main/cpp/native-lib.cpp )
    # 找到预编译库 log_lib 并link到我们的动态库 native-lib中
    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 )
    target_link_libraries( # Specifies the target library.
                           native-lib
                           # Links the target library to the log library
                           # included in the NDK.
                           ${log-lib} )
    

    2.1.1 add_library - 添加库(三方库.so 或者编译C/C++文件)

    2.1.1 .1 添加库的第一种方法

    add_library(
        avcodec-lib
        SHARED
        IMPORTED)
    set_target_properties( avcodec-lib
                           PROPERTIES IMPORTED_LOCATION
                           ${distribution_DIR}/${ANDROID_ABI}/libavcodec-56.so)
    

    添加库,也就是:add_library函数,里面要传入三个参数;第一个是要引入的库别名,第二个是库的类型,是静态库还是动态库。第三个是通过什么样方式引入进来,第三方的一般都是通过包含进来,所以第三个参数基本也是固定的都是写“IMPORTED”。
    add_library后,就要设置.so的详细路径了,通过set_target_properties()函数来设置;该函数也是要传入三参数来指定.so库的路径。第一个参数和add_library的第一个参数一样,不过这里的库别名要和add_library的库别名要一致,要不然在编译时会报找不到库的错误。第二个参数是固定的,都是写“ PROPERTIES IMPORTED_LOCATION”主要用来指定库的引入方式。都是通过本地引入。第三个就是库的具体路径,这个不能写错,如果写错了,编译时也同样会找不到库的。只要是引入第三方的库使用add_library就要使用set_target_propeties这个组合,所以它们是成对出现的。add_library还有一种写法那就是CMakeList.txt中默认写法

    2.1.1.2 添加库的第二种方法

    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).
                 src/main/cpp/native-lib.cpp )
    

    这样是就是编译我们自己在项目中写的c/c++文件。这里就不用set_target_propeties()。add_library用来设置编译生成的本地库的名字为native-lib,SHARED表示编译生成的是动态链接库(这个概念前面已经提到过了),src/main/cpp/native-lib.cpp表示参与编译的文件的路径,这里面可以写多个文件的路径。

    2.1.2 find_library - 查找库

    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 )
    

    find_library 看到这个名字相信都会知道它是干嘛用的,查找库用的,是用来添加一些我们在编译我们的本地库的时候需要依赖的一些库,这个主要是查找系统库用的,如果项目里面有用到系统的.so库就是要把库名写到这个函数里面去找到相对应的为。由于cmake已经知道系统库的路径,所以我们这里只是指定使用log库,然后给log库起别名为log-lib便于我们后面引用,此处的log库是我们后面调试时需要用来打log日志的库,是NDK为我们提供的。

    2.1.3 target_link_libraries

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

    函数target_link_libraries()这个是干嘛用的呢,讲到这个函数就要讲到c/c++的编译原理了,在linux中c/c++的编译一般都是用gcc来编译的,c/c++编译时会产生.o文件要通过make工具来把这些.o文件链接起来,这样才能得一个可执行程序。所以.so在编译时要把所有库链接起来才能编译。target_link_libraries()就是干这个事,target_link_libraries 是为了关联我们自己的库和一些第三方库或者系统库。把要链接的库别名都写到这里就可以了,如果是系统的库要用这个格式${库的名字}。

    2.2 更多参数的Cmakelist文件

    #指定需要CMAKE的最小版本
    cmake_minimum_required(VERSION 3.4.1)
    
    #C的编译选项是 CMAKE_C_FLAGS
    #指定编译参数,可选
    #SET(CMAKE_CXX_FLAGS "-Wno-error=format-security -Wno-error=pointer-sign")
    
    #设置生成的so动态库最后输出的路径
    #set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${PROJECT_SOURCE_DIR}/../jniLibs/${ANDROID_ABI})
    
    #调用指定目录下的cmakelist
    add_subdirectory(src/main/cpp/mbedtls)
    
    #设置需要引用的库的类型(动/静态库),库的地址,名称
    #add_library(lib SHARED/STATIC IMPORTED)
    #set_target_properties(lib PROPERTIES IMPORTED_LOCATION ${LIB_DIR}/lib.a)
    
    #设置头文件搜索路径(和此txt同个路径的头文件无需设置),可选
    INCLUDE_DIRECTORIES(${CMAKE_CURRENT_SOURCE_DIR}/src/main/cpp/mbedtls/include)
    
    #指定用到的系统库或者NDK库或者第三方库的搜索路径,可选。
    #LINK_DIRECTORIES(/usr/local/lib)
    add_library( nodepp
                 SHARED
                 src/main/cpp/utils.c
                 src/main/cpp/xxtea.c
                 src/main/cpp/mbed_client.c)
    target_link_libraries( nodepp
                 mbedcrypto
                 mbedx509
                 mbedtls
                 log )
    
    
    

    三、正文第二章:NDK自定义配置

    3.1 添加多个参与编译的C/C++文件

    首先,我们发现我们上面的例子都是涉及到一个C++文件,那么我们实际的项目不可能只有一个C++文件,所以我们首先要改变CMakeLists.txt文件,如下 :

    add_library( HelloNDK
                 SHARED
                 src/main/cpp/HelloNDK.c
                 src/main/cpp/HelloJNI.c)
    

    简单吧,简单明了,但是这里要注意的是,你在写路径的时候一定要注意当前的CMakeLists.txt在项目中的位置,上面的路径是相对于CMakeLists.txt 写的。

    3.2 我们想编译出多个so库

    大家会发现,我们上面这样写,由于只有一个CMakeLists.txt文件,所以我们会把所有的C/C++文件编译成一个so库,这是很不合适的,这里我们就试着学学怎么编译出多个so库。

    先放上我的项目文件夹结构图:

    image.png
    然后看看我们每个CMakeLists.txt文件是怎么写的:
    one文件夹内的CMakeLists.txt文件的内容:
    ADD_LIBRARY(one-lib SHARED one-lib.c)
    target_link_libraries(one-lib log)
    

    two文件夹内的CMakeLists.txt文件的内容:

    ADD_LIBRARY(two-lib SHARED two-lib.c)
    target_link_libraries(two-lib log)
    

    app目录下的CMakeLists.txt文件的内容

    # Sets the minimum version of CMake required to build the native library.
    cmake_minimum_required(VERSION 3.4.1)
    add_library( HelloNDK
                 SHARED
                 src/main/cpp/HelloNDK.c
                 src/main/cpp/HelloJNI.c)
    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 )
    target_link_libraries(HelloNDK log)
    ADD_SUBDIRECTORY(src/main/cpp/one)
    ADD_SUBDIRECTORY(src/main/cpp/two)
    

    通过以上的配置我们可以看出CMakeLists.txt 文件的配置是支持继承的,所以我们在子配置文件中只是写了不同的特殊配置项的配置,最后在最上层的文件中配置子配置文件的路径即可,现在编译项目,我们会在 <项目目录>\app\build\intermediates\cmake\debug\obj\armeabi 下面就可以看到生成的动态链接库。而且是三个动态链接库.

    3.3 更改动态链接库生成的目录

    我们是不是发现上面的so库的路径太深了,不好找,没事,可以配置,我们只需要在顶层的CMakeLists.txt文件中加入下面这句就可以了

    设置生成的so动态库最后输出的路径

    set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${PROJECT_SOURCE_DIR}/src/main/jniLibs/${ANDROID_ABI})
    

    然后我们就可以在app/src/main下看到jniLibs目录,在其中看到我们的动态链接库的文件夹和文件(这里直接配置到了系统默认的路径,如果配置到其他路径需要在gradle文件中使用jinLibs.srcDirs = ['newDir']进行指定)。

    四、正文第三章:Cmakelist综合运用

    4.1 native-lib文件调用一个第三方库

    第三方库是被编译成so库直接调用的,配置so库的时候,对应的头文件也要添加上

    (1)指定头文件目录:

    image.png

    (2)添加库:

    image.png

    (3)链接到本地库:

    image.png

    譬如加载一个FFMPEG模块

    include_directories(${pathToFFMPEG}/include)
     #添加ffmpeg对应的头文件目录,${pathToFFMPEG}为前面配置过的路径,可以替换为include_directories(E:/ffmpeg/include)这种路径格式
    add_library( ffmpeg 
                 SHARED 
                 IMPORTED)
     #添加库文件,实际上就是引入so文件,IMPORT代表从第三方引入的意思
    set_target_properties( ffmpeg 
                           PROPERTIES IMPORTED_LOCATION 
                           ${pathToProject}/app/src/main/jniLibs/
                           ${ANDROID_ABI}/libffmpeg.so
    #这句话是ffmpeg对应的so文件,so文件是放到JNILibs这个文件夹中 
    target_link_libraries( $\{log-lib} 
                           native-lib 
                           ffmpeg) 
    #为native-lib加载ffmpeg库.
    

    4.2使用两个依赖库,然后生成两个工具库

    4. 主要有: 添加库的数目,C/C++文件数目,生成so库的数目

    五、正文第四章:Cmakelist使用常见问题

    5.1 missing and no known rule to make it 问题

    很蛋疼,就是一个很简单的.so路径不对。但是路径放哪儿对呢,要看项目的build.gradle中设置的lib文件夹在哪儿。当你没有设置时,默认是jniLibs文件夹,所以要把so放在这里面,但是如果你设置了,那就要把文件夹放在那个指定的目录下面,就是下面这个设置。

     sourceSets {
            main {
                jniLibs.srcDirs = ["libs"]
            }
        }
    

    参考文章:

    CMAKE手册 - 作业部落 Cmd Markdown 编辑阅读器 https://www.zybuluo.com/khan-lau/note/254724

    相关文章

      网友评论

        本文标题:Android Cmakelist

        本文链接:https://www.haomeiwen.com/subject/cgzgzftx.html