編譯工具 CMake

在Android Studio 2.2 之后，工具中增加了 CMake 的支持，于是我們有兩種選擇來編譯 c/c++ 代碼。一個是 ndk-build + Android.mk + Application.mk 組合，另一個是 CMake + CMakeLists.txt 組合。這2個組合與 Android 代碼和 c/c++ 代碼無關，只是不同的構建腳本和構建命令。

環境配置

Android Studio 的 SDK Tools 安裝

• CMake
• LLDB
• NDK

Hello World

先新建一個項目，記得要勾選 C++ support，看一下 Android Studio 自動生成的使用了 JNI 的項目是什么樣子的。

目錄結構

可以看到，與普通 Android 項目不同的是，支持 C++ 的項目在 app 目錄下多了一個 .externalNativeBuild 編譯目錄與 CMakeLists.txt，main 目錄下多了 cpp 目錄。

CMakeLists 文件

關于 CMakeLists 文件的作用，我的理解是它指定了編譯 c++ 庫時所用到的一些配置，先來看看項目里 CMakeList.txt 文件：

// 去掉注釋
cmake_minimum_required(VERSION 3.4.1)
add_library(native-lib SHARED src/main/cpp/native-lib.cpp )
find_library(log-lib log)
target_link_libraries(native-lib ${log-lib} )

• cmake_minimum_required(VERSION 3.4.1)
  允許構建的最低版本
• add_library(name path)
  生成鏈接庫，SHARED 表示生成動態庫， STATIC表示生成靜態庫。并指定了參與編譯的文件路徑
• find_library(log-lib log)
  添加在編譯本地文件時依賴的庫（log），并指定別名（log-lib）
• target_link_libraries(lib1 lib2 ...)
  鏈接庫，這里鏈接了我們自己的庫 native-lib 與 log 庫

默認的 so 庫輸出目錄為 app/build/intermediates/cmake/debug/obj/${abi} 下，可以在 CMakeLists 中指定輸出目錄

#設置生成的so動態庫最后輸出的路徑
set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${PROJECT_SOURCE_DIR}/src/main/jniLibs/${ANDROID_ABI})

再來看 cpp 目錄下的 native-lib.cpp 文件：

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

extern "C"
JNIEXPORT jstring

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

第一次看到 .cpp 格式的源文件肯定有點摸不著頭腦，Java 與 C++ 是如何通信的呢？答案就是 JNI。

JNI 規范

JNI (Java Native Interface,Java本地接口)是一種編程框架,使得 Java 虛擬機中的 Java 程序可以調用本地應用/或庫,也可以被其他程序調用。

從上面的 native-lib.cpp 文件我們可以一窺 JNI 中 C/C++ 的使用規范：

• #include
  C 語音中使用 #include <> 直接到系統指定的目錄下查找文件，我將其理解為類似 Java 中的導包。JNI 中首先頭部需要引入 <jni.h> ，由于使用到了字符串，還導入了 <string>。

• JNIEXPORT
  JNIEXPORT 和 JNICALL 都是 JNI 的關鍵字，表示此函數是要被 JNI 調用的。

• jstring
  是 JNI 中作為中介使 JAVA 的 String 與 C/C++ 的 String 交互的數據類型，JNI的數據類型包含兩種，分別是基本類型和引用類型。

• jobject
  指代調用該方法的對象。如果 Java 中該 native 方法是靜態的，則指代該類，即 XXX.class。

• JNIEnv
  這個env可以看做是 JNI 接口本身的一個對象，在頭部引入的 jni.h 頭文件中存在著大量被封裝好的函數，這些函數也是 JNI 編程中經常被使用到的，要想調用這些函數就需要使用JNIEnv這個對象。除了上面使用到的傳遞返回值給 Java，還有獲取類的 class 類型：evn->GetObjectClass()，改變 Java 中對象的某個變量的值 evn-> SetIntField(...) 等方法。

• 命名方式
  Java_com_yazhidev_cmakedemo_MainActivity_stringFromJNI()，JNI 中對命名有規定，命名規范為：Java_包名_class_函數名，包名中的 . 也要改為 _，對應的，在 Java 中引用 Native 函數也需要聲明關鍵字 native。

• std::string、NewStringUTF
  這是 C++ 中字符串的一些寫法，需要用時去翻一下語法，不多延伸。

以上只提到了項目里使用到的一些規范和注意點。下面通過寫個 demo 實際操作一下。

實戰

通過 JNI 對圖片做變色處理。

jnigraphics 庫

這里要使用到 NDK 里提供的 jnigraphics 庫，該庫
提供了基于 C/C++ 的接口，可以訪問 Android 中的 Bitmap 的像素緩沖區（bitmap buffers）。

頭文件中引入 android/bitmap.h，其典型用法如下（摘至 android/bitmap.h 詳解）：

a) 用 AndroidBitmap_getInfo() 函數從位圖句柄（從JNI得到）獲得信息（寬度、高度、像素格式）
b) 用 AndroidBitmap_lockPixels() 對像素緩存上鎖，即獲得該緩存的指針。
c) 用C/C++ 對這個緩沖區進行讀寫
d) 用 AndroidBitmap_unlockPixels() 解鎖

我們利用該用法對 bitmap 做處理。

新建 Module

首先新建個 module，并新建類 BitmapUtil：

static {
  // 不要忘記加載庫
  System.loadLibrary("bitmap-util");
}

public class BitmapUtil {
    public static native void processBitmap(Bitmap bitmap;
}

并在 main 目錄下新建 cpp 目錄，新建類 bitmap-util.cpp：

#include <jni.h>
#include <android/bitmap.h>

extern "C"

JNIEXPORT void JNICALL
Java_com_yazhidev_ndkdemo_BitmapUtil_processBitmap(JNIEnv *env, jobject /* this */, jobject bitmap) {
    //構造 AndroidBitmapInfo
    AndroidBitmapInfo info = {0};
    //將 bitmp 的信息填充給 info
    AndroidBitmap_getInfo(env, bitmap, &info);
    int *buf=NULL;
    //對 bitmap 解碼并獲取解碼后的像素保存在內存中的地址指針，賦值給 srcBuf
    AndroidBitmap_lockPixels(env, bitmap, (void **) &buf);
    //處理像素
    int w = info.width;
    int h = info.height;
    int32_t *srcPixs = (int32_t *) buf;
    int alpha = 0xFF << 24;
    int i, j;
    int color;
    int red;
    int green;
    int blue;
    for (i = 0; i < h; i++) {
        for (j = 0; j < w; j++) {
            // get the color of per pixel
            color = srcPixs[w * i + j];
            red = ((color & 0x00FF0000) >> 16);
            green = ((color & 0x0000FF00) >> 8);
            blue = color & 0x000000FF;
            color = (red + green + blue) / 3;
            color = alpha | (color << 16) | (color << 8) | color;
            srcPixs[w * i + j] = color;
        }
    }
    //釋放鎖定，顯示出被修改的像素數據
    AndroidBitmap_unlockPixels(env, bitmap);
}

module 根目錄下新建 CMakeLists.txt 文件：

cmake_minimum_required(VERSION 3.4.1)
add_library(bitmap-util SHARED src/main/cpp/bitmap-util.cpp )
# 鏈接 jnigraphics 庫
target_link_libraries(native-lib jnigraphics)

在 module 的 build.gradle 中引用 CMakeLists 文件：

android {
  ...
  externalNativeBuild {
        cmake {
            path "CMakeLists.txt"
        }
    }
}

Java 中調用：

// Kotlin image -> ImageView(android:id="@+id/image")
val drawable = resources.getDrawable(R.mipmap.google) as BitmapDrawable
val bitmap = drawable.bitmap
BitmapUtil.processBitmap(bitmap)
image.setImageBitmap(bitmap)

遇到的問題

java.lang.UnsatisfiedLinkError: No implementation found

extern "C"

擴展

項目中導入 so 庫

在使用 JNI 時有時可能只有編譯好的 so 庫，那么如何在項目中使用 so 庫呢？

右鍵 app 目錄，選擇 new - Folder -JNI Folder，新建一個 JNI 目錄用于存放 so 文件。

so 庫（CPU）的兼容

使用 CMake 編譯 so 庫時，可通過配置 gradle 文件指定編譯的 so 庫架構

android {
  defaultConfig {
    externalNativeBuild {
      cmake {
        cppFlags ""
        // 生成.so庫的目標平臺
        abiFilters "armeabi-v7a", "armeabi", "x86"
      }
    }
  }
}

對于CPU來說，不同的架構并不意味著一定互不兼容，根據目前Android共支持七種不同類型的CPU架構，其兼容特點可總結如下：

armeabi設備只兼容armeabi；
armeabi-v7a設備兼容armeabi-v7a、armeabi；
arm64-v8a設備兼容arm64-v8a、armeabi-v7a、armeabi；
X86設備兼容X86、armeabi；
X86_64設備兼容X86_64、X86、armeabi；
mips64設備兼容mips64、mips；
mips只兼容mips；

根據以上的兼容總結，我們還可以得到一些規律：
armeabi的SO文件基本上可以說是萬金油，它能運行在除了mips和mips64的設備上，但在非armeabi設備上運行性能還是有所損耗；
64位的CPU架構總能向下兼容其對應的32位指令集，如：x86_64兼容X86，arm64-v8a兼容armeabi-v7a，mips64兼容mips。

更多 so 文件的信息可參考：Android SO文件的兼容和適配

參考

AndroidStudio項目CMakeLists解析
JNI技術規范
Android NDK之旅——圖片高斯模糊
Jni接口-深入研究參數的傳遞（一）
android/bitmap.h 詳解