JNI實戰

引子

對於剛入門的Android開發者來講，JNI是較難掌握的。JNI有一層神祕面紗，讓人敬而遠之。須要同時掌握C/C++語言與Android應用開發技術也提升了進入門檻。
讓咱們揭開面紗，由淺入深地學習JNI技術。

JNI是什麼

JNI是Java Native Interface的縮寫，直譯成中文就是Java本地接口。JNI並非Android特有的技術。在Android以前就在Java中獲得普遍應用。Java能作到平臺無關是由於運行在虛擬機上，而不一樣虛擬機在各自平臺的實現，大多采用C/C++語言。經過JNI技術，Java代碼能夠調用C/C++的函數，反過來，C/C++也能夠調用Java層的函數。JNI是溝通Java世界與Native世界的橋樑。
<!--more-->

JNI與Android

JNI在Android開發中佔有重要地位。
你們都知道Android系統的四層結構。

1. 最底層是Linux內核層。

2. 第二層Native層包括了運行時庫和其餘動態庫，好比OpenGL ES，WebKit庫等，都是用C或C++寫的。

3. 再上一層系統框架層是使用Java寫的，它與Native層的交互，就大量使用了JNI技術，好比文件操做和socket操做等。

4. 在最上層應用層，NDK開發組件使得開發者可使用C++來編寫核心算法，提升性能和代碼複用性。應用須要使用到Android平臺特性的地方，經過JNI來與Java層溝通，調用Android系統庫提供的、Java語言編寫的API，好比播放音樂視頻，獲取用戶地理位置信息或者發送短信。

咱們用JNI來作什麼

目前，市面上大部分手機遊戲因爲性能和跨平臺的考慮，核心部分使用C/C++語言編寫。並且，開發過程當中或多或少會使用到開源庫或遊戲引擎，包括渲染引擎，物理引擎和音樂音效引擎等，它們大都使用C/C++編寫。在製做Android平臺的版本時，前端與手機特性相關的功能使用Java語音編寫。兩部分交互時須要使用JNI技術。

JNI開發流程

這裏介紹咱們平時經常使用的，在C++部分調用Java方法的場景。假設咱們的遊戲須要獲取用戶當前的地理位置信息，用來匹配附近玩家。獲取地理位置信息須要從Android的LocationManager中獲取，匹配工做在C++代碼中完成。

直接上代碼

MainActivity.java

package com.samxu.hello_jni;
public class MainActivity extends Activity {
    public LocationUtil locationUtil;
    public LocationManager mLocationManager;
    public Button button1;
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        // Get a reference to the LocationManager object.
        mLocationManager = (LocationManager) getSystemService(Context.LOCATION_SERVICE);
        locationUtil = new LocationUtil();
        locationUtil.mLocationManager = mLocationManager;

        //調用Native方法stringFromJNI()
        Log.v("hello_jni", stringFromJNI());

        button1 = (Button) findViewById(R.id.button1);
        button1.setOnClickListener(new OnClickListener() {
            @Override
            public void onClick(View v) {
                //調用Native方法callSetupFromJNI()
                Log.v("hello_jni", callSetupFromJNI());
            }
         });
    }
    public native String stringFromJNI();
    public native String callSetupFromJNI();

    static {
        System.loadLibrary("hellojni"); //加載JNI庫
    }
}

LocationUtil.java

package com.samhxu.hello_jni;

public class LocationUtil {
    public LocationManager mLocationManager;
    private Location mLocation;

    public void setup() {
        Log.v("hello_jni", "initial setup");
        //init location
        mLocation = requestUpdatesFromProvider(LocationManager.GPS_PROVIDER);
    }
    public String getLocation() {
        return mLocation.getLatitude() + "," + mLocation.getLongitude();
    }
    private final LocationListener listener = new LocationListener() {
        @Override
        public void onLocationChanged(Location location) {
            // A new location update is received.  Do something useful with it.  Update the UI with 
            // the location update.
            mLocation = location;
        }
        //.......other override methods omitted
    };

    private Location requestUpdatesFromProvider(final String provider) {
        Location location = null;
        if (mLocationManager.isProviderEnabled(provider)) {
            mLocationManager.requestLocationUpdates(provider, TEN_SECONDS, TEN_METERS, listener);
            location = mLocationManager.getLastKnownLocation(provider);
        } else {
            //Toast.makeText(this, errorResId, Toast.LENGTH_LONG).show();
        }
        return location;
    }
}

hello_jni.c

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

jmethodID g_setupID = 0;
jfieldID g_locationUtilID = 0;
jobject g_locationUtil = 0;
jmethodID g_getLocaitonID = 0;

jstring Java_com_samhxu_hello_1jni_MainActivity_stringFromJNI( JNIEnv* env, jobject thiz ){
    jclass clazz = (*env)->FindClass(env, "com/samhxu/hello_jni/LocationUtil");
    //jobject locationUtil = getInstance(env, clazz);
    g_setupID = (*env)->GetMethodID(env, clazz, "setup", "()V");
    g_getLocaitonID = (*env)->GetMethodID(env,clazz, "getLocation", "()Ljava/lang/String;");
    jclass mainClazz = (*env)->FindClass(env, "com/samhxu/hello_jni/MainActivity");
    g_locationUtilID = (*env)->GetFieldID(env, mainClazz, "locationUtil", "Lcom/samhxu/hello_jni/LocationUtil;");
    jobject _locationUtil = (*env)->GetObjectField(env,thiz, g_locationUtilID);
    g_locationUtil = (*env)->NewGlobalRef(env, _locationUtil);

    (*env)->CallVoidMethod(env, g_locationUtil, g_setupID );

    return (*env)->NewStringUTF(env, "Hello from JNI !");
}

jstring Java_com_samhxu_hello_1jni_MainActivity_callSetupFromJNI( JNIEnv* env, jobject thiz ){
    jstring location = (jstring) (*env)->CallObjectMethod(env, g_locationUtil, g_getLocaitonID, NULL);
    return location;
}

Android.mk

#LOCAL_PATH := $(call my-dir)
include $(CLEAR_VARS)
LOCAL_MODULE    := hellojni
LOCAL_SRC_FILES := src/hello_jni.c
include $(BUILD_SHARED_LIBRARY)

代碼分析

項目怎樣搭建起來，網上有不少資料，就再也不贅述。咱們只分析上述代碼的要點。

Java代碼中，System.loadLibrary("hellojni");加載了JNI庫。System.loadLibrary("libname")用來加載Android.mk中定義的Module庫名。public native String stringFromJNI();聲明瞭native函數，native關鍵字表示函數由JNI層來實現。
C代碼中，實現了兩個native函數。對於函數命名規則，咱們採用了較爲簡單的靜態註冊法，即Java_PackageName_ClassName_MethodName,這樣Java就能找到對應的native方法，並創建對應關係。在兩個JNI方法中，參數列表都包含了JNIEnv*和jobject，返回值都爲jstring。JNIEnv是JNI環境指針，後面會有詳細表述。jobject是Java層調用方的對象類型，thiz表示由哪一個對象來調用該函數。返回值類型jstring表示在Java層是String類型。數據類型的對應關係，可見下一小節。

JNI數據類型

Java中的數據類型和JNI的數據類型存在一種對應關係。JNI的數據類型在jni.h中能夠找到定義。
下面的表能夠歸納：

Java類型	本地類型	JNI中定義的別名
int	long	jint
long	_int64	jlong
byte	signed char	jbyte
boolean	unsigned char	jboolean
char	unsigned short	jchar
short	short	jshort
float	float	jfloat
double	double	jdouble
Object	_jobject*	jobject

<<圖>>

JNIEnv介紹

JNIEnv能夠說是JNI中的主角。JNIEnv是與線程相關的表明JNI環境的結構體。每一個線程都有一份JNIEnv。在使用時，應稍加註意線程一致性。本文不詳細展開。
JNIEnv提供了一系列JNI系統函數，能夠用來調用Java函數或者操做jobject對象等。操做jobject對象，實質上就是操做該對象的成員變量和成員方法。
JNIEnv獲取對象的成員變量和成員方法的兩個函數：
jfieldID GetFieldID(jclass clazz, const char* name, const char* sig);
jmethodID GetMethodID(jclass clazz, const char* name, const char* sig);
有了成員變量的句柄，咱們就能夠對成員變量進行get和set操做。
NativeType Get<type>Field(JNIEnv* env, jobject obj, jfieldID fieldID);
void Set<type>Field(JNIEnv* env, jobject obj, jfieldID fieldID, NativeType value);
有了成員方法的句柄，咱們能夠進行函數調用。
NativeType Call<type>Method(JNIEnv* env, jobject obj, jmethodID methodID, … );
對於靜態方法，則使用CallStatic<type>Method系列方法。
NativeType CallStatic<type>Method(JNIEnv* env, jobject obj, jmethodID methodID, … );

jstring使用

stringFromJNI方法的最後一行，return (*env)->NewStringUTF(env, "Hello from JNI")用來返回一個C的字符串。
JNI中的jstring對應Java的String。而在C/C++中的string是另外一種類型。二者的構成方式和屬性徹底不一樣。JNIEnv的NewStringUTF方法會把native的一個UTF-8字符串轉換而獲得一個jstring對象。這樣就能夠被Java層識別了。

JNI類型簽名

看到前面的GetMethodID的最後一個參數，表示方法的參數和返回值。必定以爲這種表現形式奇怪吧。實際上是根據轉換規則來構成的。

基礎類型的JNI描述符

JNI字段描述符	java編程語言
Z	boolean
B	byte
C	char
S	short
I	int
J	long
F	float
D	double

一個引用類型的簽名，例如java.lang.String，由L字母開頭，而且以分號結束，包名」java.lang.String「中的」.「被」/「替換。因此java.lang.String被表示爲：」Ljava/lang/String;"
下表提供了一個關於如何格式話方法描述符的完整的描述：

方法描述符	java語言類型
"()Ljava/lang/String"	String f();
"(ILjava/lang/Class)J"	long f(int i, Class c);
"([B)v"	void f(byte[ ] bytes);

括號中的表示參數列表，括號後跟着返回值類型。

引用與資源回收

咱們知道Java中建立的對象會由垃圾回收器來回收和釋放對象。
·jobject g_locationUtil·是一個引用對象，在聲明的scope結束時會被釋放。stringFromJNI方法中g_locationUtil = (*env)->NewGlobalRef(env, _locationUtil)就是來解決這個問題的。這樣，在callSetupFromJni方法中使用g_locationUtil的時候，就不會有問題。

小結

本文結合Android開發中使用JNI的實際問題，主要介紹了JNI的相關內容。想要全面瞭解JNI的知識，還須要認真閱讀JDK文檔中關於< < Java Native Interface Specification > >部分和Android開發文檔中NDK開發部分，並結合大量實際使用。