Android: NDK編程入門筆記

時間 2019-11-07

原文原文鏈接

爲什麼要用到NDK?java

歸納來講主要分爲如下幾種狀況：linux

1. 代碼的保護，因爲apk的java層代碼很容易被反編譯，而C/C++庫反匯難度較大。android

2. 在NDK中調用第三方C/C++庫，由於大部分的開源庫都是用C/C++代碼編寫的。express

3. 便於移植，用C/C++寫得庫能夠方便在其餘的嵌入式平臺上再次使用。apache

下面就介紹下Android NDK的入門學習過程：ubuntu

入門的最好辦法就是學習Android自帶的例子，這裏就經過學習Android的NDK自帶的demo程序：hello-jni來達到這個目的。app

1、開發環境的搭建less

android的NDK開發須要在linux下進行：由於須要把C/C++編寫的代碼生成能在arm上運行的.so文件，這就須要用到交叉編譯環境，而交叉編譯須要在linux系統下才能完成。
安裝android-ndk開發包，這個開發包能夠在google android 官網下載：經過這個開發包的工具才能將android jni 的C/C++的代碼編譯成庫
android應用程序開發環境：包括eclipse、java、 android sdk、 adt等。

如何下載和安裝android-ndk我這裏就不囉嗦了，安裝完以後，須要將android-ndk的路勁加到環境變量PATH中：eclipse

sudo gedit /etc/environmentide

在environment的PATH環境變量中添加你的android-ndk的安裝路勁，而後再讓這個更改的環境變量當即生效：

source /etc/environment

通過了上述步驟，在命令行下敲：

ndk-bulid

彈出以下的錯誤，而不是說ndk-build not found，就說明ndk環境已經安裝成功了。

Android NDK: Could not find application project directory !
Android NDK: Please define the NDK_PROJECT_PATH variable to point to it.
/home/braincol/workspace/android/android-ndk-r5/build/core/build-local.mk:85: *** Android NDK: Aborting    . Stop.

2、代碼的編寫

1.首先是寫java代碼

創建一個Android應用工程HelloJni，建立HelloJni.java文件：

HelloJni.java :

/*  * Copyright (C) 2009 The Android Open Source Project  *  * Licensed under the Apache License, Version 2.0 (the "License");  * you may not use this file except in compliance with the License.  * You may obtain a copy of the License at  *  * http://www.apache.org/licenses/LICENSE-2.0  *  * Unless required by applicable law or agreed to in writing, software  * distributed under the License is distributed on an "AS IS" BASIS,  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  * See the License for the specific language governing permissions and  * limitations under the License.  */ package com.example.hellojni;import android.app.Activity;import android.widget.TextView;import android.os.Bundle;public class HelloJni extends Activity
{
    /** Called when the activity is first created. */     @Override
    public void onCreate(Bundle savedInstanceState)
    {
        super.onCreate(savedInstanceState);

        /* Create a TextView and set its content.  * the text is retrieved by calling a native  * function.  */         TextView  tv = new TextView(this);
        tv.setText( stringFromJNI() );
        setContentView(tv);
    }

    /* A native method that is implemented by the  * 'hello-jni' native library, which is packaged  * with this application.  */     public native String  stringFromJNI();

    /* This is another native method declaration that is *not*  * implemented by 'hello-jni'. This is simply to show that  * you can declare as many native methods in your Java code  * as you want, their implementation is searched in the  * currently loaded native libraries only the first time  * you call them.  *  * Trying to call this function will result in a  * java.lang.UnsatisfiedLinkError exception !  */     public native String  unimplementedStringFromJNI();

    /* this is used to load the 'hello-jni' library on application  * startup. The library has already been unpacked into  * /data/data/com.example.HelloJni/lib/libhello-jni.so at  * installation time by the package manager.  */     static {
        System.loadLibrary("hello-jni");
    }
}

這段代碼很簡單，註釋也很清晰，這裏只提兩點：:

static{
System.loadLibrary("hello-jni");
}

代表程序開始運行的時候會加載hello-jni, static區聲明的代碼會先於onCreate方法執行。若是你的程序中有多個類，並且若是HelloJni這個類不是你應用程序的入口，那麼hello-jni（完整的名字是libhello-jni.so）這個庫會在第一次使用HelloJni這個類的時候加載。

public native String stringFromJNI();
public native String unimplementedStringFromJNI();

能夠看到這兩個方法的聲明中有 native 關鍵字，這個關鍵字表示這兩個方法是本地方法，也就是說這兩個方法是經過本地代碼（C/C++）實現的，在java代碼中僅僅是聲明。

用eclipse編譯該工程，生成相應的.class文件，這步必須在下一步以前完成，由於生成.h文件須要用到相應的.class文件。

2. 編寫相應的C/C++代碼

剛開始學的時候，有個問題會讓人很困惑，相應的C/C++代碼如何編寫，函數名如何定義？這裏講一個方法，利用javah這個工具生成相應的.h文件，而後根據這個.h文件編寫相應的C/C++代碼。

2.1 生成相應.h文件：

就拿我這的環境來講，首先在終端下進入剛剛創建的HelloJni工程的目錄：

braincol@ubuntu :~$ cd workspace/android/NDK/hello-jni/

ls查看工程文件

braincol@ubuntu :~/workspace/android/NDK/hello-jni$ ls
AndroidManifest.xml assets bin default.properties gen res src

能夠看到目前僅僅有幾個標準的android應用程序的文件（夾）。

首先咱們在工程目錄下創建一個jni文件夾：

braincol@ubuntu :~/workspace/android/NDK/hello-jni$ mkdir jni
braincol@ubuntu :~/workspace/android/NDK/hello-jni$ ls
AndroidManifest.xml assets bin default.properties gen jni res src

下面就能夠生成相應的.h文件了：

braincol@ubuntu :~/workspace/android/NDK/hello-jni$ javah -classpath bin -d jni com.example.hellojni.HelloJni

-classpath bin：表示類的路勁

-d jni: 表示生成的頭文件存放的目錄

com.example.hellojni.HelloJni 則是完整類名

這一步的成功要創建在已經在 bin/com/example/hellojni/ 目錄下生成了 HelloJni.class的基礎之上。

如今能夠看到jni目錄下多了個.h文件：

braincol@ubuntu :~/workspace/android/NDK/hello-jni$ cd jni/
braincol@ubuntu :~/workspace/android/NDK/hello-jni/jni$ ls
com_example_hellojni_HelloJni.h

咱們來看看com_example_hellojni_HelloJni.h的內容：

com_example_hellojni_HelloJni.h :

/* DO NOT EDIT THIS FILE - it is machine generated */ #include <jni.h>/* Header for class com_example_hellojni_HelloJni */ #ifndef _Included_com_example_hellojni_HelloJni#define _Included_com_example_hellojni_HelloJni#ifdef __cplusplusextern "C" {#endif /*  * Class: com_example_hellojni_HelloJni  * Method: stringFromJNI  * Signature: ()Ljava/lang/String;  */ JNIEXPORT jstring JNICALL Java_com_example_hellojni_HelloJni_stringFromJNI
  (JNIEnv *, jobject);/*  * Class: com_example_hellojni_HelloJni  * Method: unimplementedStringFromJNI  * Signature: ()Ljava/lang/String;  */ JNIEXPORT jstring JNICALL Java_com_example_hellojni_HelloJni_unimplementedStringFromJNI
  (JNIEnv *, jobject);#ifdef __cplusplus
}#endif #endif

上面代碼中的JNIEXPORT 和 JNICALL 是jni的宏，在android的jni中不須要，固然寫上去也不會有錯。

從上面的源碼中能夠看出這個函數名那是至關的長啊。。。。不過仍是頗有規律的，徹底按照：java_pacakege_class_mathod 形式來命名。

也就是說：

Hello.java中 stringFromJNI() 方法對應於 C/C++中的 Java_com_example_hellojni_HelloJni_stringFromJNI() 方法

HelloJni.java中的 unimplementedStringFromJNI() 方法對應於 C/C++中的 Java_com_example_hellojni_HelloJni_unimplementedStringFromJNI() 方法

注意下其中的註釋：

Signature: ()Ljava/lang/String;

()Ljava/lang/String;

()表示函數的參數爲空（這裏爲空是指除了JNIEnv *, jobject 這兩個參數以外沒有其餘參數，JNIEnv*, jobject是全部jni函數必有的兩個參數，分別表示jni環境和對應的java類（或對象）自己），

Ljava/lang/String; 表示函數的返回值是java的String對象。

2.2 編寫相應的.c文件：

hello-jni.c :

/*  * Copyright (C) 2009 The Android Open Source Project  *  * Licensed under the Apache License, Version 2.0 (the "License");  * you may not use this file except in compliance with the License.  * You may obtain a copy of the License at  *  * http://www.apache.org/licenses/LICENSE-2.0  *  * Unless required by applicable law or agreed to in writing, software  * distributed under the License is distributed on an "AS IS" BASIS,  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  * See the License for the specific language governing permissions and  * limitations under the License.  *  */ #include <string.h>#include <jni.h>/* This is a trivial JNI example where we use a native method  * to return a new VM String. See the corresponding Java source  * file located at:  *  * apps/samples/hello-jni/project/src/com/example/HelloJni/HelloJni.java  */ jstring
Java_com_example_hellojni_HelloJni_stringFromJNI( JNIEnv* env,
                                                  jobject thiz )
{
    return (*env)->NewStringUTF(env, "Hello from JNI !");
}

這裏只是實現了Java_com_example_hellojni_HelloJni_stringFromJNI方法，而 Java_com_example_hellojni_HelloJni_unimplementedStringFromJNI 方法並無實現，由於在HelloJni.java中只調用了stringFromJNI()方法，因此unimplementedStringFromJNI()方法沒有實現也不要緊，不過建議最好仍是把全部java中定義的本地方法都實現了，寫個空函數也行啊。。。有總比沒有好。

Java_com_example_hellojni_HelloJni_stringFromJNI() 函數只是簡單的返回了一個內容爲 "Hello from JNI !" 的jstring對象（對應於java中的String對象）。

hello-jni.c文件已經編寫好了，如今能夠把com_example_hellojni_HelloJni.h文件給刪了，固然留着也行，只是我仍是習慣把不須要的文件給清理乾淨了。

3. 編譯hello-jni.c 生成相應的庫

3.1 編寫Android.mk文件

在jni目錄下（即hello-jni.c 同級目錄下）新建一個Android.mk文件，Android.mk 文件是Android 的 makefile文件，內容以下：

# Copyright (C) 2009 The Android Open Source Project # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. # LOCAL_PATH := $(call my-dir)include $(CLEAR_VARS)

LOCAL_MODULE    := hello-jni
LOCAL_SRC_FILES := hello-jni.cinclude $(BUILD_SHARED_LIBRARY)

這個Androd.mk文件很短，下面咱們來逐行解釋下：

LOCAL_PATH := $(call my-dir)

一個Android.mk 文件首先必須定義好LOCAL_PATH變量。它用於在開發樹中查找源文件。在這個例子中，宏函數’my-dir’, 由編譯系統提供，用於返回當前路徑（即包含Android.mk file文件的目錄）。

include $( CLEAR_VARS)

CLEAR_VARS由編譯系統提供，指定讓GNU MAKEFILE爲你清除許多LOCAL_XXX變量（例如 LOCAL_MODULE, LOCAL_SRC_FILES, LOCAL_STATIC_LIBRARIES, 等等...),
除LOCAL_PATH 。這是必要的，由於全部的編譯控制文件都在同一個GNU MAKE執行環境中，全部的變量都是全局的。

LOCAL_MODULE := hello-jni

編譯的目標對象，LOCAL_MODULE變量必須定義，以標識你在Android.mk文件中描述的每一個模塊。名稱必須是惟一的，並且不包含任何空格。

注意：編譯系統會自動產生合適的前綴和後綴，換句話說，一個被命名爲'hello-jni'的共享庫模塊，將會生成'libhello-jni.so'文件。

重要注意事項：

若是你把庫命名爲‘libhello-jni’，編譯系統將不會添加任何的lib前綴，也會生成 'libhello-jni.so'，這是爲了支持來源於Android平臺的源代碼的Android.mk文件，若是你確實須要這麼作的話。

LOCAL_SRC_FILES := hello-jni.c

LOCAL_SRC_FILES變量必須包含將要編譯打包進模塊中的C或C++源代碼文件。注意，你不用在這裏列出頭文件和包含文件，由於編譯系統將會自動爲你找出依賴型的文件；僅僅列出直接傳遞給編譯器的源代碼文件就好。

注意，默認的C++源碼文件的擴展名是’.cpp’. 指定一個不一樣的擴展名也是可能的，只要定義LOCAL_DEFAULT_CPP_EXTENSION變量，不要忘記開始的小圓點（也就是’.cxx’,而不是’cxx’）

include $(BUILD_SHARED_LIBRARY)

BUILD_SHARED_LIBRARY表示編譯生成共享庫，是編譯系統提供的變量，指向一個GNU Makefile腳本，負責收集自從上次調用'include $(CLEAR_VARS)'以來，定義在LOCAL_XXX變量中的全部信息，而且決定編譯什麼，如何正確地去作。還有 BUILD_STATIC_LIBRARY變量表示生成靜態庫：lib$(LOCAL_MODULE).a， BUILD_EXECUTABLE 表示生成可執行文件。

3.2 生成.so共享庫文件

Andro文件已經編寫好了，如今能夠用android NDK開發包中的 ndk-build腳本生成對應的.so共享庫了，方法以下：

braincol@ubuntu :~/workspace/android/NDK/hello-jni/jni$ cd ..
braincol@ubuntu :~/workspace/android/NDK/hello-jni$ ls
AndroidManifest.xml assets bin default.properties gen jni libs obj res src
braincol@ubuntu :~/workspace/android/NDK/hello-jni$ ndk-build
Gdbserver      : [arm-linux-androideabi-4.4.3] libs/armeabi/gdbserver
Gdbsetup       : libs/armeabi/gdb.setup
Install        : libhello-jni.so => libs/armeabi/libhello-jni.so

能夠看到已經正確的生成了libhello-jni.so共享庫了，咱們去 libs/armeabi/ 目錄下看看：

braincol@ubuntu :~/workspace/android/NDK/hello-jni$ cd libs/
braincol@ubuntu :~/workspace/android/NDK/hello-jni/libs$ ls
armeabi
braincol@ubuntu :~/workspace/android/NDK/hello-jni/libs$ cd armeabi/
braincol@ubuntu :~/workspace/android/NDK/hello-jni/libs/armeabi$ ls
gdbserver gdb.setup libhello-jni.so

4. 在eclipse從新編譯HelloJni工程，生成apk

eclipse中刷新下HelloJni工程，從新編譯生成apk，libhello-jni.so共享庫會一塊兒打包在apk文件內。

在模擬器中看看運行結果：