AndroidStudio用Cmake方式編譯NDK代碼（cmake配置.a庫）

時間  2019-11-17
標籤 androidstudio cmake 方式 編譯 ndk 代碼 配置 欄目 Android 简体版
原文   原文鏈接

1.cmake是什麼？css

CMake是一個跨平臺的安裝（編譯）工具，能夠用簡單的語句來描述全部平臺的安裝(編譯過程)。他可以輸出各類各樣的makefile或者project文件，能測試編譯器所支持的C++特性,相似UNIX下的automake。html

 

谷歌從AndroidStudio2.2以上就添加了Cmake方式來編譯NDK代碼，並從NDK例子看出，默認編譯的方式就是cmake方式。java

 

2.谷歌官方的用cmake方式編譯NDK的教程android

 

谷歌從AndroidStudio2.2以上就添加了Cmake方式來編譯NDK代碼，並從NDK例子看出，默認編譯的方式就是cmake方式。json

若是您但願向現有項目添加原生代碼，請執行如下步驟：api

  1. 建立新的原生源文件並將其添加到您的 Android Studio 項目中。
    • 若是您已經擁有原生代碼或想要導入預構建的原生庫，則能夠跳過此步驟。
  2. 建立 CMake 構建腳本，將您的原生源代碼構建到庫中。若是導入和關聯預構建庫或平臺庫，您也須要此構建腳本。
    • 若是您的現有原生庫已經擁有 CMakeLists.txt 構建腳本或者使用 ndk-build 幷包含 Android.mk 構建腳本，則能夠跳過此步驟。
  3. 提供一個指向您的 CMake 或 ndk-build 腳本文件的路徑，將 Gradle 關聯到您的原生庫。Gradle 使用構建腳本將源代碼導入您的 Android Studio 項目並將原生庫（SO 文件）封裝到 APK 中。

配置完項目後，您可使用 JNI 框架從 Java 代碼中訪問您的原生函數。要構建和運行應用，只需點擊 Run 從菜單欄運行應用。Gradle 會以依賴項的形式添加您的外部原生構建流程，用於編譯、構建原生庫並將其隨 APK 一塊兒封裝。網絡

建立新的原生源文件

要在應用模塊的主源代碼集中建立一個包含新建原生源文件的 cpp/ 目錄，請按如下步驟操做：架構

  1. 從 IDE 的左側打開 Project 窗格並從下拉菜單中選擇 Project 視圖。
  2. 導航到您的模塊 > src，右鍵點擊 main 目錄，而後選擇 New > Directory。
  3. 爲目錄輸入一個名稱（例如 cpp）並點擊 OK。
  4. 右鍵點擊您剛剛建立的目錄，而後選擇 New > C/C++ Source File。
  5. 爲您的源文件輸入一個名稱，例如 native-lib。
  6. 從 Type 下拉菜單中，爲您的源文件選擇文件擴展名，例如 .cpp。
    • 點擊 Edit File Types ，您能夠向下拉菜單中添加其餘文件類型，例如 .cxx 或 .hxx。在彈出的 C/C++ 對話框中，從 Source Extension 和 Header Extension 下拉菜單中選擇另外一個文件擴展名，而後點擊 OK。
  7. 若是您還但願建立一個標頭文件，請選中 Create an associated header 複選框。
  8. 點擊 OK。

建立 CMake 構建腳本

若是您的原生源文件尚未 CMake 構建腳本，則您須要自行建立一個幷包含適當的 CMake 命令。CMake 構建腳本是一個純文本文件，您必須將其命名爲 CMakeLists.txt。本部分介紹了您應包含到構建腳本中的一些基本命令，用於在建立原生庫時指示 CMake 應使用哪些源文件。oracle

注：若是您的項目使用 ndk-build，則不須要建立 CMake 構建腳本。提供一個指向您的 Android.mk 文件的路徑，將 Gradle 關聯到您的原生庫。app

要建立一個能夠用做 CMake 構建腳本的純文本文件，請按如下步驟操做：

  1. 從 IDE 的左側打開 Project 窗格並從下拉菜單中選擇 Project 視圖。
  2. 右鍵點擊您的模塊的根目錄並選擇 New > File。

    注：您能夠在所需的任意位置建立構建腳本。不過，在配置構建腳本時，原生源文件和庫的路徑將與構建腳本的位置相關。

  3. 輸入「CMakeLists.txt」做爲文件名並點擊 OK。

如今，您能夠添加 CMake 命令，對您的構建腳本進行配置。要指示 CMake 從原生源代碼建立一個原生庫，請將 cmake_minimum_required() 和 add_library() 命令添加到您的構建腳本中：

# Sets the minimum version of CMake required to build your native library.
# This ensures that a certain set of CMake features is available to
# your build.

cmake_minimum_required(VERSION 3.4.1)

# Specifies a library name, specifies whether the library is STATIC or
# SHARED, and provides relative paths to the source code. You can
# define multiple libraries by adding multiple add.library() commands,
# and CMake builds them for you. When you build your app, Gradle
# automatically packages shared libraries with your APK.

add_library( # Specifies 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 )

 

使用 add_library() 向您的 CMake 構建腳本添加源文件或庫時，Android Studio 還會在您同步項目後在 Project 視圖下顯示關聯的標頭文件。不過，爲了確保 CMake 能夠在編譯時定位您的標頭文件，您須要將 include_directories() 命令添加到 CMake 構建腳本中並指定標頭的路徑：

add_library(...)

# Specifies a path to native header files.
include_directories(src/main/cpp/include/)

CMake 使用如下規範來爲庫文件命名：

lib庫名稱.so

例如，若是您在構建腳本中指定「native-lib」做爲共享庫的名稱，CMake 將建立一個名稱爲 libnative-lib.so 的文件。不過，在 Java 代碼中加載此庫時，請使用您在 CMake 構建腳本中指定的名稱：

static {     System.loadLibrary(「native-lib」); }

注：若是您在 CMake 構建腳本中重命名或移除某個庫，您須要先清理項目，Gradle 隨後纔會應用更改或者從 APK 中移除舊版本的庫。要清理項目，請從菜單欄中選擇 Build > Clean Project。

Android Studio 會自動將源文件和標頭添加到 Project 窗格的 cpp 組中。使用多個 add_library() 命令，您能夠爲 CMake 定義要從其餘源文件構建的更多庫。

添加 NDK API

Android NDK 提供了一套實用的原生 API 和庫。經過將 NDK 庫包含到項目的 CMakeLists.txt 腳本文件中，您可使用這些 API 中的任意一種。

預構建的 NDK 庫已經存在於 Android 平臺上，所以，您無需再構建或將其封裝到 APK 中。因爲 NDK 庫已是 CMake 搜索路徑的一部分，您甚至不須要在您的本地 NDK 安裝中指定庫的位置 - 只須要向 CMake 提供您但願使用的庫的名稱，並將其關聯到您本身的原生庫。

將 find_library() 命令添加到您的 CMake 構建腳本中以定位 NDK 庫，並將其路徑存儲爲一個變量。您可使用此變量在構建腳本的其餘部分引用 NDK 庫。如下示例能夠定位 Android 特定的日誌支持庫並將其路徑存儲在 log-lib 中：

find_library( # Defines the name of the path variable that stores the
              # location of the NDK library.
              log-lib

              # Specifies the name of the NDK library that
              # CMake needs to locate.
              log )

 

爲了確保您的原生庫能夠在 log 庫中調用函數，您須要使用 CMake 構建腳本中的 target_link_libraries() 命令關聯庫：

find_library(...)

# Links your native library against one or more other native libraries.
target_link_libraries( # Specifies the target library.
                       native-lib

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

 

NDK 還以源代碼的形式包含一些庫，您在構建和關聯到您的原生庫時須要使用這些代碼。您可使用 CMake 構建腳本中的 add_library() 命令，將源代碼編譯到原生庫中。要提供本地 NDK 庫的路徑，您可使用 ANDROID_NDK 路徑變量，Android Studio 會自動爲您定義此變量。

如下命令能夠指示 CMake 構建 android_native_app_glue.c，後者會將 NativeActivity 生命週期事件和觸摸輸入置於靜態庫中並將靜態庫關聯到 native-lib：

add_library( app-glue
             STATIC
             ${ANDROID_NDK}/sources/android/native_app_glue/android_native_app_glue.c )

# You need to link static libraries against your shared native library.
target_link_libraries( native-lib app-glue ${log-lib} )

 

添加其餘預構建庫

添加預構建庫與爲 CMake 指定要構建的另外一個原生庫相似。不過，因爲庫已經預先構建，您須要使用 IMPORTED 標誌告知 CMake 您只但願將庫導入到項目中：

add_library( imported-lib
             SHARED
             IMPORTED )

而後，您須要使用 set_target_properties() 命令指定庫的路徑，以下所示。

某些庫爲特定的 CPU 架構（或應用二進制接口 (ABI)）提供了單獨的軟件包，並將其組織到單獨的目錄中。此方法既有助於庫充分利用特定的 CPU 架構，又能讓您僅使用所需的庫版本。要向 CMake 構建腳本中添加庫的多個 ABI 版本，而沒必要爲庫的每一個版本編寫多個命令，您可使用 ANDROID_ABI 路徑變量。此變量使用 NDK 支持的一組默認 ABI，或者您手動配置 Gradle 而讓其使用的一組通過篩選的 ABI。例如：

add_library(...)
set_target_properties( # Specifies the target library.
                       imported-lib

                       # Specifies the parameter you want to define.
                       PROPERTIES IMPORTED_LOCATION

                       # Provides the path to the library you want to import.
                       imported-lib/src/${ANDROID_ABI}/libimported-lib.so )

爲了確保 CMake 能夠在編譯時定位您的標頭文件，您須要使用 include_directories() 命令，幷包含標頭文件的路徑：

include_directories( imported-lib/include/ )

注：若是您但願封裝一個並非構建時依賴項的預構建庫（例如在添加屬於 imported-lib 依賴項的預構建庫時），則不須要執行如下說明來關聯庫。

要將預構建庫關聯到您本身的原生庫，請將其添加到 CMake 構建腳本的 target_link_libraries() 命令中：

target_link_libraries( native-lib imported-lib app-glue ${log-lib} )

在您構建應用時，Gradle 會自動將導入的庫封裝到 APK 中。您可使用 APK 分析器驗證 Gradle 將哪些庫封裝到您的 APK 中。如需瞭解有關 CMake 命令的詳細信息，請參閱 CMake 文檔。

 

導入.a靜態庫

自 android studio 2.2 +後就集成了ndk開發， 自帶cmake 編譯器.  編寫ndk時候，配置很簡單。不再須要用android.mk配置文件。

新建一個帶ndk開發項目的結構是這樣的，

 

 

言歸正傳，那麼要添加第三方的xx.a連接庫呢？

一般咱們把第三方提供的h文件夾，放在cpp的include裏面。這是規範，不是必須。而xxx.a庫放在src/main/jniLibs/armeabi目錄下。

本文章以添加libjsoncpp.a鏈接庫作例子

首先在cpp目錄下創建一個include文件夾，把jsoncpp官方提供的頭文件文件夾拷貝到include裏面(我這個項目有3個連接庫，jsoncpp, curl , openssl，另外2個僅作參考做用，與其無關）

 

 

第二步， 在app的src目錄的main下，創建一個文件夾，jniLibs,而後在jniLibs裏面再創建一個armeabi文件夾。

而後把libjsoncpp.a連接庫拷貝進去。

 

第三步， 動態庫與頭文件拷貝進去時候，是須要告訴編譯器作關聯的。在app目錄的src文件夾下有個CMakeLists.txt文件，咱們經過它編寫配置信息。

將jsoncpp頭文件所在目錄告訴編譯，在裏面添加

  1. include_directories( src/main/cpp/include/jsoncpp)  

若是有多個連接庫，那麼能夠這樣
例若有三個連接庫，jsoncpp， currl ， openssl.

 
  1. include_directories( src/main/cpp/include/jsoncpp  
  2.                      src/main/cpp/include/curl  
  3.                      src/main/cpp/include/openssl  
  4.                      )  
 

而後告訴編譯器，libjsoncppp.a在哪一個目錄下，並指定連接庫的名稱

接着添加

  1. #添加json庫  
  2. add_library(jsoncpp STATIC IMPORTED)  
  3. set_target_properties(jsoncpp  
  4.   PROPERTIES IMPORTED_LOCATION  
  5.   ${CMAKE_SOURCE_DIR}/src/main/jniLibs/${ANDROID_ABI}/libjsoncpp.a)  

而後修改target_link_libraries,加多一行jsoncpp

 
  1. target_link_libraries(native-lib  
  2.                       jsoncpp  
  3.                       ${log-lib})  

若是有多個，那麼能夠屢次添加。如

  1. #添加json庫  
  2. add_library(jsoncpp STATIC IMPORTED)  
  3. set_target_properties(jsoncpp  
  4.   PROPERTIES IMPORTED_LOCATION  
  5.   ${CMAKE_SOURCE_DIR}/src/main/jniLibs/${ANDROID_ABI}/libjsoncpp.a)  
  6.   
  7. #添加curl網絡請求  
  8. add_library(curl STATIC IMPORTED)  
  9. set_target_properties(curl  
  10.   PROPERTIES IMPORTED_LOCATION  
  11.   ${CMAKE_SOURCE_DIR}/src/main/jniLibs/${ANDROID_ABI}/libcurl.a)  
  12.   
  13. #添加加密工具(md5, base64, des, aes , asa) part-1  
  14. add_library(crypto STATIC IMPORTED)  
  15. set_target_properties(crypto  
  16.   PROPERTIES IMPORTED_LOCATION  
  17.   ${CMAKE_SOURCE_DIR}/src/main/jniLibs/${ANDROID_ABI}/libcrypto.a)  
  18.   
  19. #添加加密工具(md5, base64, des, aes , asa) des加密 part-2  
  20. add_library(ssl STATIC IMPORTED)  
  21. set_target_properties(ssl  
  22.   PROPERTIES IMPORTED_LOCATION  
  23.   ${CMAKE_SOURCE_DIR}/src/main/jniLibs/${ANDROID_ABI}/libssl.a)  
 

 
 
     
  
  1. target_link_libraries(native-lib  
    2.  
  
  2.                       jsoncpp  
    3.  
  
  3.                       curl  
    4.  
  
  4.                       crypto  
    5.  
  
  5.                       ssl  
    6.  
  
  6.                       ${log-lib})   
    7.  
 
 

 


而後gradle編譯就可使用了。是否是很簡單？
 

 
 

 
 
 

要將 Gradle 關聯到您的原生庫，您須要提供一個指向 CMake 或 ndk-build 腳本文件的路徑。在您構建應用時，Gradle 會以依賴項的形式運行 CMake 或 ndk-build，並將共享的庫封裝到您的 APK 中。Gradle 還使用構建腳原本瞭解要將哪些文件添加到您的 Android Studio 項目中，以便您能夠從 Project 窗口訪問這些文件。若是您的原生源文件沒有構建腳本，則須要先建立 CMake 構建腳本，而後再繼續。
 

將 Gradle 關聯到原生項目後，Android Studio 會更新 Project 窗格以在 cpp 組中顯示您的源文件和原生庫，在 External Build Files 組中顯示您的外部構建腳本。
 

注：更改 Gradle 配置時，請確保經過點擊工具欄中的 Sync Project  應用更改。此外，若是在將 CMake 或 ndk-build 腳本文件關聯到 Gradle 後再對其進行更改，您應當從菜單欄中選擇 Build > Refresh Linked C++ Projects，將 Android Studio 與您的更改同步。
 
 

您可使用 Android Studio UI 將 Gradle 關聯到外部 CMake 或 ndk-build 項目：
 

     
 
  1. 從 IDE 左側打開 Project 窗格並選擇 Android 視圖。
    2.  
 
  2. 右鍵點擊您想要關聯到原生庫的模塊（例如 app 模塊），並從菜單中選擇 Link C++ Project with Gradle。您應看到一個如圖 4 所示的對話框。
    3.  
 
  3. 從下拉菜單中，選擇 CMake 或 ndk-build。 
  
       
   
    1. 若是您選擇 CMake，請使用 Project Path 旁的字段爲您的外部 CMake 項目指定 CMakeLists.txt 腳本文件。
      2.  
   
    2. 若是您選擇 ndk-build，請使用 Project Path 旁的字段爲您的外部 ndk-build 項目指定 Android.mk 腳本文件。若是 Application.mk 文件與您的 Android.mk 文件位於相同目錄下，Android Studio 也會包含此文件。
      3.  
  
     
    圖 4.使用 Android Studio 對話框關聯外部 C++ 項目。
     
    4.  
 
  4. 點擊 OK。
    5.  

 

手動配置 Gradle
 

要手動配置 Gradle 以關聯到您的原生庫，您須要將 externalNativeBuild {} 塊添加到模塊級 build.gradle 文件中，並使用 cmake {} 或 ndkBuild {}對其進行配置：
 

 
 
android {
  ...
  defaultConfig {...}
  buildTypes {...}

  // Encapsulates your external native build configurations.
  externalNativeBuild {

    // Encapsulates your CMake build configurations.
    cmake {

      // Provides a relative path to your CMake build script.
      path "CMakeLists.txt"
    }
  }
}
 

 

注：若是您想要將 Gradle 關聯到現有 ndk-build 項目，請使用 ndkBuild {} 塊而不是 cmake {}，並提供 Android.mk 文件的相對路徑。若是 Application.mk 文件與您的 Android.mk 文件位於相同目錄下，Gradle 也會包含此文件。
 

指定可選配置
 

您能夠在模塊級 build.gradle 文件的 defaultConfig {} 塊中配置另外一個 externalNativeBuild {} 塊，爲 CMake 或 ndk-build 指定可選參數和標誌。與 defaultConfig {} 塊中的其餘屬性相似，您也能夠在構建配置中爲每一個產品風味重寫這些屬性。
 

例如，若是您的 CMake 或 ndk-build 項目定義多個原生庫，您可使用 targets 屬性僅爲給定產品風味構建和封裝這些庫中的一部分。如下代碼示例說明了您能夠配置的部分屬性：
 

 
 
android {
  ...
  defaultConfig {
    ...
    // This block is different from the one you use to link Gradle
    // to your CMake or ndk-build script.
    externalNativeBuild {

      // For ndk-build, instead use ndkBuild {}
      cmake {

        // Passes optional arguments to CMake.
        arguments "-DANDROID_ARM_NEON=TRUE", "-DANDROID_TOOLCHAIN=clang"

        // Sets optional flags for the C compiler.
        cFlags "-D_EXAMPLE_C_FLAG1", "-D_EXAMPLE_C_FLAG2"

        // Sets a flag to enable format macro constants for the C++ compiler.
        cppFlags "-D__STDC_FORMAT_MACROS"
      }
    }
  }

  buildTypes {...}

  productFlavors {
    ...
    demo {
      ...
      externalNativeBuild {
        cmake {
          ...
          // Specifies which native libraries to build and package for this
          // product flavor. If you don't configure this property, Gradle
          // builds and packages all shared object libraries that you define
          // in your CMake or ndk-build project.
          targets "native-lib-demo"
        }
      }
    }

    paid {
      ...
      externalNativeBuild {
        cmake {
          ...
          targets "native-lib-paid"
        }
      }
    }
  }

  // Use this block to link Gradle to your CMake or ndk-build script.
  externalNativeBuild {
    cmake {...}
    // or ndkBuild {...}
  }
}
 

 

要詳細瞭解配置產品風味和構建變體，請參閱配置構建變體。如需瞭解您可使用 arguments 屬性爲 CMake 配置的變量列表，請參閱使用 CMake 變量。
 

指定 ABI
 

默認狀況下，Gradle 會針對 NDK 支持的 ABI 將您的原生庫構建到單獨的 .so 文件中，並將其所有封裝到您的 APK 中。若是您但願 Gradle 僅構建和封裝原生庫的特定 ABI 配置，您能夠在模塊級 build.gradle 文件中使用 ndk.abiFilters 標誌指定這些配置，以下所示：
 

 
 
android {
  ...
  defaultConfig {
    ...
    externalNativeBuild {
      cmake {...}
      // or ndkBuild {...}
    }

    ndk {
      // Specifies the ABI configurations of your native
      // libraries Gradle should build and package with your APK.
      abiFilters 'x86', 'x86_64', 'armeabi', 'armeabi-v7a',
                   'arm64-v8a'
    }
  }
  buildTypes {...}
  externalNativeBuild {...}
}
 

 

在大多數狀況下，您只須要在 ndk {} 塊中指定 abiFilters（如上所示），由於它會指示 Gradle 構建和封裝原生庫的這些版本。不過，若是您但願控制 Gradle 應當構建的配置，並獨立於您但願其封裝到 APK 中的配置，請在 defaultConfig.externalNativeBuild.cmake {} 塊（或 defaultConfig.externalNativeBuild.ndkBuild {} 塊中）配置另外一個 abiFilters 標誌。Gradle 會構建這些 ABI 配置，不過僅會封裝您在 defaultConfig.ndk{} 塊中指定的配置。
 

爲了進一步下降 APK 的大小，請考慮配置 ABI APK 拆分，而不是建立一個包含原生庫全部版本的大型 APK，Gradle 會爲您想要支持的每一個 ABI 建立單獨的 APK，而且僅封裝每一個 ABI 須要的文件。若是您配置 ABI 拆分，但沒有像上面的代碼示例同樣指定 abiFilters 標誌，Gradle 會構建原生庫的全部受支持 ABI 版本，不過僅會封裝您在 ABI 拆分配置中指定的版本。爲了不構建您不想要的原生庫版本，請爲 abiFilters 標誌和 ABI 拆分配置提供相同的 ABI 列表。
 

 
 


  谷歌從AndroidStudio2.2以上就添加了Cmake方式來編譯NDK代碼，並從NDK例子看出，默認編譯的方式就是cmake方式。 



        

            

        	





    

		

            
相關文章

            

                

                

                    

                

            


            
相關標籤/搜索

            
        


    

        

            

        

        

        
        

        

        

    




	

    





    

    	

    

        每日一句
    

    
    
    	每一个你不满意的现在，都有一个你没有努力的曾经。
    







    

    


    



    

        本站公眾號
    

    

           歡迎關注本站公眾號,獲取更多信息

        
    




    

    




	


	







    

        聯繫我們
        最近搜索
        最新文章
        
        沪ICP备13005482号-10

            MyBatis教程
            SQL 教程
            MySQL教程
            Java 教程
            Thymeleaf 教程
            Hibernate教程
            Spring教程 
            Redis教程