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類,含指令:

java代碼:
publicclass 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()函數,其程式碼片段為:

java代碼:
//#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\n");
goto bail;
}

assert(env != NULL);
if (register_android_media_MediaPlayer(env) <0) {
LOGE("ERROR: MediaPlayer native registration failed\n");
goto bail;
}

if (register_android_media_MediaRecorder(env) <0) {
LOGE("ERROR: MediaRecorder native registration failed\n");
goto bail;
}

if (register_android_media_MediaScanner(env) <0) {
LOGE("ERROR: MediaScanner native registration failed\n");
goto bail;
}

if (register_android_media_MediaMetadataRetriever(env) <0) {
LOGE("ERROR: MediaMetadataRetriever native registration failed\n");
goto bail;
}

/* success — return valid version number */
result = JNI_VERSION_1_4;
bail:
return result;
}

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

java代碼:
if (register_android_media_MediaPlayer(env) <0) {
LOGE("ERROR: MediaPlayer native registration failed\n");
goto bail;
}
復制代碼
就將此組件提供的各個本地函數(Native Function)登記到VM裡,以便能加快後續呼叫本地函數的效率。
  JNI_OnUnload()函數與JNI_OnLoad()相對應的。在載入C組件時會立即呼叫JNI_OnLoad()來進行組件內的初期動作;而當VM釋放該C組件時,則會呼叫JNI_OnUnload()函數來進行善後清除動作。當VM呼叫JNI_OnLoad()或JNI_Unload()函數時,都會將VM的指針(Pointer)傳遞給它們,其參數如下:

java代碼:
jint JNI_OnLoad(JavaVM* vm, void* reserved) { }

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

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

java代碼:
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\n");
goto bail;
}
}

 

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

java代碼:
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檔案裡的代碼段如下:

java代碼:
//#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},

};

staticint register_android_media_MediaPlayer(JNIEnv *env){
return AndroidRuntime::registerNativeMethods(env,"android/media/MediaPlayer", gMethods, NELEM(gMethods));
}

java代碼:
jint JNI_OnLoad(JavaVM* vm, void* reserved){

if (register_android_media_MediaPlayer(env) <0) {

LOGE("ERROR: MediaPlayer native registration failed\n");
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,定義如下:

java代碼:
typedef struct {

constchar* name; /*Java中函數的名字*/

constchar* 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類型

java代碼:
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
復制代碼
數組則以"["開始,用兩個字符表示

java代碼:
[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文件:

java代碼:
import android.app.Activity;
import android.os.Bundle;

publicclass jnitest extends Activity {

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

@Override
publicvoid 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文件:
publicclass Nadd {

static {
System.loadLibrary("Nadd");
}
publicnativeint nadd(int a, int b);
}

   以上在windows中完成.

  2.使用javah命令生成C/C++的.h文件.註意類要包含包名,路徑文件夾下要包含所有包中的類,否則會報找不到類的錯誤.classpath參數指定到包名前一級文件夾,文件夾層次結構要符合java類的組織層次結構.
  javah -classpath /jnitest/bin com.hello.jnitest.Nadd
  com_hello_jnitest_Nadd .h文件:

java代碼:
/* DO NOT EDIT THIS FILE – it is machine generated */
#include <jni.h>
/* Header for class com_hello_jnitest_Nadd */
#ifndef _Included_com_hello_jnitest_Nadd

#define _Included_com_hello_jnitest_Nadd

#ifdef __cplusplus

extern"C" {

#endif

/*
* Class: com_hello_jnitest_Nadd
* Method: nadd
* Signature: (II)I
*/

JNIEXPORT jint JNICALL Java_com_hello_jnitest_Nadd_nadd(JNIEnv *, jobject, jint, jint);
#ifdef __cplusplus
}

#endif

#endif
復制代碼
3.編輯.c文件實現native方法.
  com_hello_jnitest_Nadd.c文件:

java代碼:
#include <stdlib.h>
#include "com_hello_jnitest_Nadd.h"
JNIEXPORT jint JNICALL Java_com_hello_jnitest_Nadd_nadd(JNIEnv * env, jobject c, jint a, jint b){
return (a+b);
}
復制代碼
4.編譯.c文件生存動態庫.
  arm-none-linux-gnueabi-gcc -I/home/a/work/android/jdk1.6.0_17/include -I/home/a/work/android/jdk1.6.0_17/include/linux -fpic -c com_hello_jnitest_Nadd.c
  arm-none-linux-gnueabi-ld -T/home/a/CodeSourcery/Sourcery_G++_Lite/arm-none-linux-gnueabi/lib/ldscripts/armelf_linux_eabi.xsc -share -o libNadd.so com_hello_jnitest_Nadd.o
  得到libNadd.so文件.
  以上在ubuntu中完成.

  5.將相應的動態庫文件push到avd的system/lib中:adb push libNadd.so /system/lib.若提示Read-only file system錯誤,運行adb remount命令,即可.
  Adb push libNadd.so /system/lib

  6.在eclipsh中運行原應用程序即可.
  以上在windows中完成.
  對於一中生成的so文件也可采用二中的方法編譯進apk包中.隻需在工程文件夾中建libs\armeabi文件夾(其他文件夾名無效,隻建立libs文件夾也無效),然後將so文件拷入,編譯工程即可.

  二.使用NDK生成本地方法(ubuntu and windows)

  1.安裝NDK:解壓,然後進入NDK解壓後的目錄,運行build/host-setup.sh(需要Make 3.81和awk).若有錯,修改host-setup.sh文件:將#!/bin/sh修改為#!/bin/bash,再次運行即可.

  2.在apps文件夾下建立自己的工程文件夾,然後在該文件夾下建一文件Application.mk和項project文件夾.
  Application.mk文件:
  APP_PROJECT_PATH := $(call my-dir)/project
  APP_MODULES      := myjni

  3.在project文件夾下建一jni文件夾,然後新建Android.mk和myjni.c.這裡不需要用javah生成相應的.h文件,但函數名要包含相應的完整的包、類名.

  4.編輯相應文件內容.
  Android.mk文件:

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.
#

LOCAL_PATH := $(call my-dir)
include $(CLEAR_VARS)
LOCAL_MODULE := myjni
LOCAL_SRC_FILES := myjni.c
include $(BUILD_SHARED_LIBRARY)
復制代碼
myjni.c文件:

java代碼:
#include <string.h>
#include <jni.h>
jstring
Java_com_hello_NdkTest_NdkTest_stringFromJNI( JNIEnv* env,jobject thiz ){
return (*env)->NewStringUTF(env, "Hello from My-JNI !");
}
復制代碼
myjni文件組織:
  a@ubuntu:~/work/android/ndk-1.6_r1/apps$ tree myjni
  myjni
  |– Application.mk
  `– project
  |– jni
  |   |– Android.mk
  |   `– myjni.c
  `– libs
  `– armeabi
  `– libmyjni.so
  4 directories, 4 files
  5.編譯:make APP=myjni.
  以上內容在ubuntu完成.以下內容在windows中完成.當然也可以在ubuntu中完成.
  6.在eclipsh中創建android application.將myjni中自動生成的libs文件夾拷貝到當前工程文件夾中,編譯運行即可.
  NdkTest.java文件:

java代碼:
import android.app.Activity;

import android.os.Bundle;

import android.widget.TextView;

publicclass NdkTest extends Activity {

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

@Override

publicvoid onCreate(Bundle savedInstanceState) {

super.onCreate(savedInstanceState);

TextView tv =new TextView(this);

tv.setText( stringFromJNI() );

setContentView(tv);

}

publicnative String stringFromJNI();

static {

System.loadLibrary("myjni");

}

}

作者:t80t90s

發佈留言