在Android中嵌入C語言程序

情況處理：在編寫OCR軟件時，處理從camera得到的圖片，需要使用c編寫的程序。整個OCR的編碼來自google開源代碼，軟件名Wordsnap。在文件夾目錄中有一個名為jni的文件夾，下有mk文件，c文件，h頭文件。這些是什麼呢?

android JNI知識簡介

Java Native Interface (JNI)標准是java平台的一部分，它允許Java代碼和其他語言寫的代碼進行交互。JNI 是本地編程接口，它使得在 Java 虛擬機 (VM) 內部運行的 Java 代碼能夠與用其它編程語言(如 C、C++ 和匯編語言)編寫的應用程序和庫進行交互操作。

1.從如何載入.so檔案談起

由於android的應用層的類都是以Java寫的，這些Java類編譯為Dex型式的Bytecode之後，必須靠Dalvik虛擬機(VM: Virtual Machine)來執行。VM在android平台裡，扮演很重要的角色。

此外，在執行Java類的過程中，如果Java類需要與C組件溝通時，VM就會去載入C組件，然後讓Java的函數順利地調用到C組件的函數。此時，VM扮演著橋梁的角色，讓Java與C組件能通過標准的JNI介面而相互溝通。

應用層的Java類是在虛擬機(VM: Vitual Machine)上執行的，而C件不是在VM上執行，那麼Java程式又如何要求VM去載入(Load)所指定的C組件呢? 可使用下述指令：

System.loadLibrary(*.so的檔案名);

例如，android框架裡所提供的MediaPlayer.Java類，含指令：

public class MediaPlayer{

static {

System.loadLibrary("media_jni");

}

}

這要求VM去載入android的/system/lib/libmedia_jni.so檔案。載入*.so之後，Java類與*.so檔案就匯合起來，一起執行了。

2.如何撰寫*.so的入口函數

---- JNI_OnLoad()與JNI_OnUnload()函數的用途

當android的VM(Virtual Machine)執行到System.loadLibrary()函數時，首先會去執行C組件裡的JNI_OnLoad()函數。它的用途有二：

(1) 告訴VM此C組件使用那一個JNI版本。如果你的*.so檔沒有提供JNI_OnLoad()函數，VM會默認該*.so檔是使用最老的JNI 1.1版本。由於新版的JNI做了許多擴充，如果需要使用JNI的新版功能，例如JNI 1.4的Java.nio.ByteBuffer,就必須藉由JNI_OnLoad()函數來告知VM。

(2)由於VM執行到System.loadLibrary()函數時，就會立即先呼叫JNI_OnLoad()，所以C組件的開發者可以藉由JNI_OnLoad()來進行C組件內的初期值之設定(Initialization)

例如，在android的/system/lib/libmedia_jni.so檔案裡，就提供了JNI_OnLoad()函數，其程式碼片段為：

//#define LOG_NDEBUG 0

#define LOG_TAG "MediaPlayer-JNI"

jint JNI_OnLoad(JavaVM* vm, void* reserved)

{

JNIEnv* env = NULL;

jint result = -1;

if (vm->GetEnv((void**) &env, JNI_VERSION_1_4) != JNI_OK) {

LOGE("ERROR: GetEnv failed ");

goto bail;

}

assert(env != NULL);

if (register_android_media_MediaPlayer(env) < 0) {

LOGE("ERROR: MediaPlayer native registration failed ");

goto bail;

}

if (register_android_media_MediaRecorder(env) < 0) {

LOGE("ERROR: MediaRecorder native registration failed ");

goto bail;

}

if (register_android_media_MediaScanner(env) < 0) {

LOGE("ERROR: MediaScanner native registration failed ");

goto bail;

}

if (register_android_media_MediaMetadataRetrIEver(env) < 0) {

LOGE("ERROR: MediaMetadataRetrIEver native registration failed ");

goto bail;

}

/* success -- return valid version number */

result = JNI_VERSION_1_4;

bail:

return result;

}

此函數回傳JNI_VERSION_1_4值給VM，於是VM知道了其所使用的JNI版本了。此外，它也做了一些初期的動作(可呼叫任何本地函數)，例如指令：

if (register_android_media_MediaPlayer(env) < 0) {

LOGE("ERROR: MediaPlayer native registration failed ");

goto bail;

}

就將此組件提供的各個本地函數(Native Function)登記到VM裡，以便能加快後續呼叫本地函數的效率。

JNI_OnUnload() 函數與JNI_OnLoad()相對應的。在載入C組件時會立即呼叫JNI_OnLoad()來進行組件內的初期動作;而當 VM釋放該C組件時，則會呼叫JNI_OnUnload()函數來進行善後清除動作。當VM呼叫JNI_OnLoad()或JNI_Unload()函數時，都會將VM的指針(Pointer)傳遞給它們，其參數如下：

jint JNI_OnLoad(JavaVM* vm, void* reserved) { }

jint JNI_OnUnload(JavaVM* vm, void* reserved){ }

在JNI_OnLoad()函數裡，就透過VM之指標而取得JNIEnv之指標值，並存入env指標變數裡，如下述指令：

jint JNI_OnLoad(JavaVM* vm, void* reserved){

JNIEnv* env = NULL;

jint result = -1;

if (vm->GetEnv((void**) &env, JNI_VERSION_1_4) != JNI_OK) {

LOGE("ERROR: GetEnv failed ");

goto bail;

}

}

由於VM通常是多執行緒(Multi-threading)的執行環境。每一個執行緒在呼叫JNI_OnLoad()時，所傳遞進來的JNIEnv指標值都是不同的。為了配合這種多執行緒的環境，C組件開發者在撰寫本地函數時，可藉由JNIEnv指標值之不同而避免執行緒的資料沖突問題，才能確保所寫的本地函數能安全地在android的多執行緒VM裡安全地執行。基於這個理由，當在呼叫C組件的函數時，都會將JNIEnv指標值傳遞給它，如下：

jint JNI_OnLoad(JavaVM* vm, void* reserved)

{

JNIEnv* env = NULL;

if (register_android_media_MediaPlayer(env) < 0) {

}

}

這 JNI_OnLoad()呼叫register_android_media_MediaPlayer(env)函數時，就將env指標值傳遞過去。如此，在register_android_media_MediaPlayer()函數就能藉由該指標值而區別不同的執行緒，以便化解資料沖突的問題。

例如，在register_android_media_MediaPlayer()函數裡，可撰寫下述指令：

if ((*env)->MonitorEnter(env, obj) != JNI_OK) {

}

查看是否已經有其他執行緒進入此物件，如果沒有，此執行緒就進入該物件裡執行了。還有，也可撰寫下述指令：

if ((*env)->MonitorExit(env, obj) != JNI_OK) {

}

查看是否此執行緒正在此物件內執行，如果是，此執行緒就會立即離開。

3.registerNativeMethods()函數的用途

應用層級的Java類別透過VM而呼叫到本地函數。一般是仰賴VM去尋找*.so裡的本地函數。如果需要連續呼叫很多次，每次都需要尋找一遍，會多花許多時間。此時，組件開發者可以自行將本地函數向VM進行登記。例如，在android的/system/lib/libmedia_jni.so檔案裡的代碼段如下：

//#define LOG_NDEBUG 0

#define LOG_TAG "MediaPlayer-JNI"

static JNINativeMethod gMethods[] = {

{"setDataSource", "(LJava/lang/String;)V",

(void *)android_media_MediaPlayer_setDataSource},

{"setDataSource", "(LJava/io/FileDescriptor;JJ)V",

(void *)android_media_MediaPlayer_setDataSourceFD},

{"prepare", "()V", (void *)android_media_MediaPlayer_prepare},

{"prepareAsync", "()V", (void *)android_media_MediaPlayer_prepareAsync},

{"_start", "()V", (void *)android_media_MediaPlayer_start},

{"_stop", "()V", (void *)android_media_MediaPlayer_stop},

{"getVideoWidth", "()I", (void *)android_media_MediaPlayer_getVideoWidth},

{"getVideoHeight", "()I", (void *)android_media_MediaPlayer_getVideoHeight},

{"seekTo", "(I)V", (void *)android_media_MediaPlayer_seekTo},

{"_pause", "()V", (void *)android_media_MediaPlayer_pause},

{"isPlaying", "()Z", (void *)android_media_MediaPlayer_isPlaying},

{"getCurrentPosition", "()I", (void *)android_media_MediaPlayer_getCurrentPosition},

{"getDuration", "()I", (void *)android_media_MediaPlayer_getDuration},

{"_release", "()V", (void *)android_media_MediaPlayer_release},

{"_reset", "()V", (void *)android_media_MediaPlayer_reset},

{"setAudiOStreamType","(I)V", (void *)android_media_MediaPlayer_setAudiOStreamType},

{"setLooping", "(Z)V", (void *)android_media_MediaPlayer_setLooping},

{"setVolume", "(FF)V", (void *)android_media_MediaPlayer_setVolume},

{"getFrameAt", "(I)Landroid/graphics/Bitmap;",

(void *)android_media_MediaPlayer_getFrameAt},

{"native_setup", "(LJava/lang/Object;)V",

(void *)android_media_MediaPlayer_native_setup},

{"native_finalize", "()V", (void *)android_media_MediaPlayer_native_finalize},

};

static int register_android_media_MediaPlayer(JNIEnv *env){

return androidRuntime::registerNativeMethods(env,

"android/media/MediaPlayer", gMethods, NELEM(gMethods));

}

jint JNI_OnLoad(JavaVM* vm, void* reserved){

if (register_android_media_MediaPlayer(env) < 0) {

LOGE("ERROR: MediaPlayer native registration failed ");

goto bail;

}

}

當 VM載入libmedia_jni.so檔案時，就呼叫JNI_OnLoad()函數。接著，JNI_OnLoad()呼叫 register_android_media_MediaPlayer()函數。此時，就呼叫到 AndroidRuntime::registerNativeMethods()函數，向VM(即androidRuntime)登記 gMethods[]表格所含的本地函數了。簡而言之，registerNativeMethods()函數的用途有二：

(1)更有效率去找到函數。

(2)可在執行期間進行抽換。由於gMethods[]是一個<名稱，函數指針>對照表，在程序執行時，可多次呼叫registerNativeMethods()函數來更換本地函數之指針，而達到彈性抽換本地函數之目的。

4.Andoird 中使用了一種不同傳統Java JNI的方式來定義其native的函數。其中很重要的區別是Andorid使用了一種Java 和 C 函數的映射表數組，並在其中描述了函數的參數和返回值。這個數組的類型是JNINativeMethod，定義如下：

typedef struct {

const char* name; /*Java中函數的名字*/

const char* signature; /*描述了函數的參數和返回值*/

void* fnPtr; /*函數指針，指向C函數*/

} JNINativeMethod;

其中比較難以理解的是第二個參數，例如

"()V"

"(II)V"

"(Ljava/lang/String;LJava/lang/String;)V"

實際上這些字符是與函數的參數類型一一對應的。

"()" 中的字符表示參數，後面的則代表返回值。例如"()V" 就表示void Func();

"(II)V" 表示 void Func(int, int);

具體的每一個字符的對應關系如下

字符 Java類型 C類型

V void void

Z jboolean boolean

I jint int

J jlong long

D jdouble double

F jfloat float

B jbyte byte

C jchar char

S JShort short

數組則以"["開始，用兩個字符表示

[I jintArray int[]

[F jfloatArray float[]

[B jbyteArray byte[]

[C jcharArray char[]

[S JShortArray short[]

[D jdoubleArray double[]

[J jlongArray long[]

[Z jbooleanArray boolean[]

上面的都是基本類型。如果Java函數的參數是class，則以"L"開頭，以";"結尾，中間是用"/" 隔開的包及類名。而其對應的C函數名的參數則為jobject. 一個例外是String類，其對應的類為JString

LJava/lang/String; String JString

LJava/net/Socket; Socket jobject

如果Java函數位於一個嵌入類，則用$作為類名間的分隔符。

例如 "(LJava/lang/String;Landroid/os/FileUtils$FileStatus;)Z"

android JNI編程實踐

一、直接使用Java本身jni接口(Windows/ubuntu)

1.在Eclipsh中新建一個android應用程序。兩個類：一個繼承於Activity，UI顯示用。另一個包含native方法。編譯生成所有類。

jnitest.Java文件：

package com.hello.jnitest;

import android.app.Activity;

import android.os.Bundle;

public class jnitest extends Activity {

/** Called when the activity is first created. */

@Override

public void onCreate(Bundle savedInstanceState) {

super.onCreate(savedInstanceState);

setContentVIEw(R.layout.main);

Nadd cal = new Nadd();

setTitle("The Native Add Result is " + String.valueOf(cal.nadd(10, 19)));

}

}

Nadd.Java文件：

package com.hello.jnitest;

public class Nadd {

static {

System.loadLibrary("Nadd");

}

public native int nadd(int a, int b);

}

以上在Windows中完成。

2.使用javah命令生成C/C++的.h文件。注意類要包含包名，路徑文件夾下要包含所有包中的類，否則會報找不到類的錯誤。classpath參數指定到包名前一級文件夾，文件夾層次結構要符合Java類的組織層次結構。