NDK編程入門

yuzaipiaofei

為何要用到NDK?

前段時間，工作中需要用android的應(yīng)用程序訪問android的根文 件系統(tǒng)中的文件，但是由于應(yīng)用程序的權(quán)限限制，無法訪問這些文件，怎么辦？ 所以這就要用到了NDK編程了，既用C/C++代碼實現(xiàn)訪問系統(tǒng)文件，并將其生成本地庫，供android中的java代碼調(diào)用，這樣就可以在java代 碼中通過調(diào)用C/C++編寫的庫的接口來實現(xiàn)對系統(tǒng)文件的訪問。

 

下面就介紹下Android NDK的入門學(xué)習(xí)過程：

入門的最好辦法就是學(xué)習(xí)Android自帶的例子， 這里就通過學(xué)習(xí)Android的NDK自帶的demo程序：hello-jni來達到這個目的。

一、 開發(fā)環(huán)境的搭建

a.  android的NDK開發(fā)需要在linux下進行： 因為需要把C/C++編寫的代碼生成能在arm上運行的.so文件，這就需要用到交叉編譯環(huán)境，而交叉編譯需要在linux系統(tǒng)下才能完成。

b. 安裝android-ndk開發(fā)包，這個開發(fā)包可以在google android 官網(wǎng)下載： 通過這個開發(fā)包的工具才能將android jni 的C/C++的代碼編譯成庫

c. android應(yīng)用程序開發(fā)環(huán)境： 包括eclipse、java、 android sdk、 adt等。

如何下載和安裝android-ndk我這里就不啰嗦了，安裝完之后，需要將android-ndk的路勁加到環(huán)境變量PATH中：

sudo gedit /etc/environment

在environment的PATH環(huán)境變量中添加你的android-ndk的安裝路勁，然后再讓這個更改的環(huán)境變量立即生效：

source  /etc/environment

經(jīng)過了上述步驟，在命令行下敲：

ndk-bulid

彈出如下的錯誤，而不是說ndk-build not found，就說明ndk環(huán)境已經(jīng)安裝成功了。

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.

 

二、代碼的編寫

1.首先是寫java代碼

建立一個Android應(yīng)用工程HelloJni，創(chuàng)建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");
}
}

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

a:

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

表明程序開始運行的時候會加載hello-jni, static區(qū)聲明的代碼會先于onCreate方法執(zhí)行。如果你的程序中有多個類，而且如果HelloJni這個類不是你應(yīng)用程序的入口，那么 hello-jni（完整的名字是libhello-jni.so）這個庫會在第一次使用HelloJni這個類的時候加載。

b:

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

可以看到這兩個方法的聲明中有 native 關(guān)鍵字， 這個關(guān)鍵字表示這兩個方法是本地方法，也就是說這兩個方法是通過本地代碼（C/C++）實現(xiàn)的，在java代碼中僅僅是聲明。

用eclipse編譯該工程，生成相應(yīng)的.class文件，這步必須在下一步之前完成，因為生成.h文件需要用到相應(yīng)的.class文件。

2. 編寫相應(yīng)的C/C++代碼

剛開始學(xué)的時候，有個問題會讓人很困惑，相應(yīng)的C/C++代碼如何編寫，函數(shù)名如何定義？ 這里講一個方法，利用javah這個工具生成相應(yīng)的.h文件，然后根據(jù)這個.h文件編寫相應(yīng)的C/C++代碼。

2.1 生成相應(yīng).h文件：

就拿我這的環(huán)境來說，首先在終端下進入剛剛建立的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應(yīng)用程序的文件（夾）。

首先我們在工程目錄下建立一個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

下面就可以生成相應(yīng)的.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 則是完整類名

這一步的成功要建立在已經(jīng)在 bin/com/example/hellojni/  目錄下生成了 HelloJni.class的基礎(chǔ)之上。

現(xiàn)在可以看到j(luò)ni目錄下多了個.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的內(nèi)容：

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 __cplusplus
extern "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中不需要，當然寫上去也不會有錯。

從上面的源碼中可以看出這個函數(shù)名那是相當?shù)拈L啊。。。。 不過還是很有規(guī)律的， 完全按照：java_pacakege_class_mathod 形式來命名。

也就是說：

Hello.java中 stringFromJNI() 方法對應(yīng)于 C/C++中的 Java_com_example_hellojni_HelloJni_stringFromJNI() 方法

HelloJni.java中的 unimplementedStringFromJNI() 方法對應(yīng)于 C/C++中的 Java_com_example_hellojni_HelloJni_unimplementedStringFromJNI() 方法

注意下其中的注釋：

Signature: ()Ljava/lang/String;

()Ljava/lang/String;

()表示函數(shù)的參數(shù)為空（這里為空是指除了JNIEnv *, jobject 這兩個參數(shù)之外沒有其他參數(shù)，JNIEnv*, jobject是所有jni函數(shù)必有的兩個參數(shù)，分別表示jni環(huán)境和對應(yīng)的java類（或?qū)ο螅┍旧恚��?/font>

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

 

2.2 編寫相應(yīng)的.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 !");
}

這里只是實現(xiàn)了 Java_com_example_hellojni_HelloJni_stringFromJNI方法，而 Java_com_example_hellojni_HelloJni_unimplementedStringFromJNI 方法并沒有實現(xiàn)，因為在HelloJni.java中只調(diào)用了stringFromJNI()方法，所以 unimplementedStringFromJNI()方法沒有實現(xiàn)也沒關(guān)系，不過建議最好還是把所有java中定義的本地方法都實現(xiàn)了，寫個空函數(shù) 也行啊。。。有總比沒有好。

Java_com_example_hellojni_HelloJni_stringFromJNI() 函數(shù)只是簡單的返回了一個內(nèi)容為 "Hello from JNI !" 的jstring對象（對應(yīng)于java中的String對象）。

hello-jni.c文件已經(jīng)編寫好了，現(xiàn)在可以把com_example_hellojni_HelloJni.h文件給刪了，當然留著也行，只是我還是習(xí)慣把不需要的文件給清理干凈了。

 

3. 編譯hello-jni.c 生成相應(yīng)的庫

3.1 編寫Android.mk文件

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

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

include $(BUILD_SHARED_LIBRARY)

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

LOCAL_PATH := $(call my-dir)

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

include $( CLEAR_VARS)

CLEAR_VARS由編譯系統(tǒng)提供，指定讓GNU MAKEFILE為你清除許多LOCAL_XXX變量（例如 LOCAL_MODULE, LOCAL_SRC_FILES, LOCAL_STATIC_LIBRARIES, 等等...),
除LOCAL_PATH 。這是必要的，因為所有的編譯控制文件都在同一個GNU MAKE執(zhí)行環(huán)境中，所有的變量都是全局的。

LOCAL_MODULE := hello-jni

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

注意：編譯系統(tǒng)會自動產(chǎn)生合適的前綴和后綴，換句話說，一個被命名為'hello-jni'的共享庫模塊，將會生成'libhello-jni.so'文件。

重要注意事項：

如果你把庫命名為‘libhello-jni’，編譯系統(tǒng)將不會添加任何的lib前綴，也會生成libfoo.so，這是為了支持來源于Android平臺的源代碼的Android.mk文件，如果你確實需要這么做的話。

LOCAL_SRC_FILES := hello-jni.c

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

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

include $(BUILD_SHARED_LIBRARY)

BUILD_SHARED_LIBRARY表示編譯生成共享庫，是編譯系統(tǒng)提供的變量，指向一個GNU Makefile腳本，負責(zé)收集自從上次調(diào)用'include $(CLEAR_VARS)'以來，定義在LOCAL_XXX變量中的所有信息，并且決定編譯什么，如何正確地去做。還有 BUILD_STATIC_LIBRARY變量表示生成靜態(tài)庫：lib$(LOCAL_MODULE).a， BUILD_EXECUTABLE 表示生成可執(zhí)行文件。

 

3.2 生成.so共享庫文件

Android.mk文件已經(jīng)編寫好了，現(xiàn)在可以用android NDK開發(fā)包中的 ndk-build腳本生成對應(yīng)的.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

可以看到已經(jīng)正確的生成了libhello-jni.so共享庫了， 我們?nèi)?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文件內(nèi)。

在模擬器中看看運行結(jié)果：