Android:清晰講解JNI 與 NDK(含例項教學)

Carson_Ho發表於2017-08-03

Android:清晰講解JNI 與 NDK(含例項教學)


前言

  • Android開發中,使用 NDK開發的需求正逐漸增大
  • 但很多人卻搞不懂 JNINDK 到底是怎麼回事
  • 今天,我將先介紹JNINDK & 之間的區別,手把手進行 NDK的使用教學,希望你們會喜歡

目錄

目錄


1. JNI介紹

1.1 簡介

  • 定義:Java Native Interface,即 Java本地介面
  • 作用: 使得Java 與 本地其他型別語言(如C、C++)互動

即在 Java程式碼 裡呼叫 C、C++等語言的程式碼 或 C、C++程式碼呼叫 Java 程式碼

  • 特別注意:
    1. JNIJava 呼叫 Native 語言的一種特性
    2. JNI 是屬於 Java 的,與 Android 無直接關係

1.2 為什麼要有 JNI

  • 背景:實際使用中,Java 需要與 原生程式碼 進行互動
  • 問題:因為 Java 具備跨平臺的特點,所以Java 與 原生程式碼互動的能力非常弱
  • 解決方案: 採用 JNI特性 增強 Java 與 原生程式碼互動的能力

1.3 實現步驟

  1. Java中宣告Native方法(即需要呼叫的本地方法)
  2. 編譯上述 Java原始檔javac(得到 .class檔案)
  3. 通過 javah 命令匯出JNI的標頭檔案(.h檔案)
  4. 使用 Java需要互動的原生程式碼 實現在 Java中宣告的Native方法

Java 需要與 C++ 互動,那麼就用C++實現 JavaNative方法

  1. 編譯.so庫檔案
  2. 通過Java命令執行 Java程式,最終實現Java呼叫原生程式碼

更加詳細過程請參考本文第4節:具體使用


2. NDK介紹

2.1 簡介

  • 定義:Native Development Kit,是 Android的一個工具開發包

NDK是屬於 Android 的,與Java並無直接關係

  • 作用:快速開發CC++的動態庫,並自動將so和應用一起打包成 APK

即可通過 NDKAndroid中 使用 JNI與原生程式碼(如C、C++)互動

  • 應用場景:在Android的場景下 使用JNI

Android開發的功能需要原生程式碼(C/C++)實現

  • 特點

示意圖

  • 額外注意

示意圖

2.2 使用步驟

  1. 配置 Android NDK環境
  2. 建立 Android 專案,並與 NDK進行關聯
  3. Android 專案中宣告所需要呼叫的 Native方法
  4. 使用 Android需要互動的原生程式碼 實現在Android中宣告的Native方法

比如 Android 需要與 C++ 互動,那麼就用C++ 實現 JavaNative方法

  1. 通過 ndk - bulid 命令編譯產生.so庫檔案
  2. 編譯 Android Studio 工程,從而實現 Android 呼叫原生程式碼

更加詳細過程請參考本文第4節:具體使用


3. NDK與JNI關係

示意圖


4. 具體使用

本文根據版本的不同介紹了兩種在Android Studio中實現 NDK的方法:Android Studio2.2 以下 & 2.2以上

4.1 Android Studio2.2 以下實現NDK

  • 步驟如下

    1. 配置 Android NDK環境
    2. 關聯 Andorid Studio專案 與 NDK
    3. 建立原生程式碼檔案(即需要在 Android專案中呼叫的原生程式碼檔案)
    4. 建立 Android.mk檔案 & Application.mk檔案
    5. 編譯上述檔案,生成.so庫檔案,並放入到工程檔案中
    6. Andoird Studio專案中使用 NDK實現 JNI 功能
  • 步驟詳解

步驟1:配置 Android NDK環境

具體請看文章一定能成功的Android NDK環境配置教程

步驟2: 關聯Andorid Studio專案 與 NDK

  • 當你的專案每次需要使用 NDK 時,都需要將該專案關聯到 NDK
  1. 此處使用的是Andorid Studio,與Eclipse不同
  2. 還在使用Eclipse的同學請自行查詢資料配置
  • 具體配置如下

a. 在Gradlelocal.properties中新增配置

ndk.dir=/Users/Carson_Ho/Library/Android/sdk/ndk-bundle
複製程式碼

ndk目錄存放在SDK的目錄中,並命名為ndk-bundle,則該配置自動新增

示意圖

b. 在Gradlegradle.properties中新增配置

android.useDeprecatedNdk=true 
// 對舊版本的NDK支援
複製程式碼

示意圖

c. 在Gradle的build.gradle新增ndk節點

示意圖

  • 至此,將Andorid Studio的專案 與 NDK 關聯完畢
  • 下面,將真正開始講解如何在專案中使用NDK

步驟3:建立原生程式碼檔案

  • 即需要在Android專案中呼叫的原生程式碼檔案

此處採用 C++作為展示

test.cpp

# include <jni.h>
# include <stdio.h>

extern "C"
{
   
    JNIEXPORT jstring JNICALL Java_scut_carson_1ho_ndk_1demo_MainActivity_getFromJNI(JNIEnv *env, jobject obj ){
       // 引數說明
       // 1. JNIEnv:代表了VM裡面的環境,本地的程式碼可以通過該引數與Java程式碼進行操作
       // 2. obj:定義JNI方法的類的一個本地引用(this)
    return env -> NewStringUTF("Hello i am from JNI!");
    // 上述程式碼是返回一個String型別的"Hello i am from JNI!"字串
	}
}
複製程式碼

此處需要注意:

  • 如果原生程式碼是C++.cpp或者.cc),要使用extern "C" { }把本地方法括進去
  • JNIEXPORT jstring JNICALL中的JNIEXPORTJNICALL不能省
  • 關於方法名Java_scut_carson_1ho_ndk_1demo_MainActivity_getFromJNI
    1. 格式 = Java _包名 _ 類名_Java需要呼叫的方法名
    2. Java必須大寫
    3. 對於包名,包名裡的.要改成__要改成_1

    如我的包名是:scut.carson_ho.ndk_demo,則需要改成scut_carson_1ho_ndk_1demo

最後,將建立好的test.cpp檔案放入到工程檔案目錄中的src/main/jni資料夾

若無jni資料夾,則手動建立。

下面我講解一下JNI型別與Java型別對應的關係介紹

如下圖

步驟4:建立Android.mk檔案

  • 作用:指定原始碼編譯的配置資訊

如工作目錄,編譯模組的名稱,參與編譯的檔案等

  • 具體使用

Android.mk

LOCAL_PATH       :=  $(call my-dir)
// 設定工作目錄,而my-dir則會返回Android.mk檔案所在的目錄

include              $(CLEAR_VARS)
// 清除幾乎所有以LOCAL——PATH開頭的變數(不包括LOCAL_PATH)

LOCAL_MODULE     :=  hello_jni
// 設定模組的名稱,即編譯出來.so檔名
// 注,要和上述步驟中build.gradle中NDK節點設定的名字相同

LOCAL_SRC_FILES  :=  test.cpp
// 指定參與模組編譯的C/C++原始檔名

include              $(BUILD_SHARED_LIBRARY)
// 指定生成的靜態庫或者共享庫在執行時依賴的共享庫模組列表。
複製程式碼

最後,將上述檔案同樣放在src/main/jni資料夾中。

步驟5:建立Application.mk檔案

  • 作用:配置編譯平臺相關內容
  • 具體使用

Application.mk

APP_ABI := armeabi
// 最常用的APP_ABI欄位:指定需要基於哪些CPU平臺的.so檔案
// 常見的平臺有armeabi x86 mips,其中移動裝置主要是armeabi平臺
// 預設情況下,Android平臺會生成所有平臺的.so檔案,即同APP_ABI := armeabi x86 mips
// 指定CPU平臺型別後,就只會生成該平臺的.so檔案,即上述語句只會生成armeabi平臺的.so檔案
複製程式碼

最後,將上述檔案同樣放在src/main/jni資料夾中

步驟6:編譯上述檔案,生成.so庫檔案

  • 經過上述步驟,在src/main/jni資料夾中已經有3個檔案

示意圖

  • 開啟終端,輸入以下命令
// 步驟1:進入該資料夾
cd /Users/Carson_Ho/AndroidStudioProjects/NDK_Demo/app/src/main/jni 
// 步驟2:執行NDK編譯命令
ndk-build
複製程式碼

示意圖

  • 編譯成功後,在src/main/會多了兩個資料夾libs & obj,其中libs下存放的是.so庫檔案

示意圖

步驟7:在src/main/中建立一個名為jniLibs的資料夾,並將上述生成的so資料夾放到該目錄下

  1. 要把名為 CPU平臺的資料夾放進去,而不是把.so檔案放進去
  2. 如果本來就有.so檔案,那麼就直接建立名為jniLibs的資料夾並放進去就可以

示意圖

步驟8:在Andoird Studio專案中使用NDK實現JNI功能

  • 此時,我們已經將原生程式碼檔案編譯成.so庫檔案並放入到工程檔案中
  • Java程式碼中呼叫原生程式碼中的方法,具體程式碼如下:

MainActivity.java

public class MainActivity extends AppCompatActivity  {

    // 步驟1:載入生成的so庫檔案
    // 注意要跟.so庫檔名相同
    static {

        System.loadLibrary("hello_jni");
    }
    
    // 步驟2:定義在JNI中實現的方法
    public native String getFromJNI();
    
    // 此處設定了一個按鈕用於觸發JNI方法
    private Button Button;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        // 通過Button呼叫JNI中的方法
        Button = (Button) findViewById(R.id.button);
        Button.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                Button.setText(getFromJNI());
                
            }
        });
    }
複製程式碼

主佈局檔案:activity_main.xml

<RelativeLayout xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:tools="http://schemas.android.com/tools"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    android:paddingBottom="@dimen/activity_vertical_margin"
    android:paddingLeft="@dimen/activity_horizontal_margin"
    android:paddingRight="@dimen/activity_horizontal_margin"
    android:paddingTop="@dimen/activity_vertical_margin"
    tools:context="scut.carson_ho.ndk_demo.MainActivity">

    // 此處設定了一個按鈕用於觸發JNI方法
    <Button
        android:id="@+id/button"
        android:layout_centerInParent="true"
        android:layout_width="300dp"
        android:layout_height="50dp"
        android:text="呼叫JNI程式碼" />

</RelativeLayout>
複製程式碼

結果展示

結果展示


原始碼地址

Carson-Ho的Github地址:NDK_Demo


4.2 Android Studio2.2 以上實現NDK

  • 如果你的Android Studio是2.2以上的,那麼請採用下述方法

因為Android Studio2.2以上已經內部整合 NDK,所以只需要在Android Studio內部進行配置就可以

  • 步驟講解

步驟1:按提示建立工程

在建立工程時,需要配置 NDK,根據提示一步步安裝即可。

示意圖

步驟2:根據需求使用NDK

  • 配置好NDK後,Android Studio會自動生成C++檔案並設定好呼叫的程式碼
  • 你只需要根據需求修改C++檔案 & Android就可以使用了。

示意圖


5. 總結

  • 本文主要講解 JavaJNIAndroidNDK相關知識
  • 下面我將繼續對 Android中的NDK進行深入講解 ,有興趣可以繼續關注Carson_Ho的安卓開發筆記

請點贊!因為你的鼓勵是我寫作的最大動力!


歡迎關注carson_ho的微信公眾號

示意圖

示意圖

相關文章