Android NDK编程入门笔记

为何要用到NDK?  
前段时间，工作中需要用android的应用程序访问android的根文件系统中的文件，但是由于应用程序的权限限制，无法访问这些文件，怎么办？ 所以这就要用到了NDK编程了，既用C/C++代码实现访问系统文件，并将其生成本地库，供android中的java代码调用，这样就可以在java代码中通过调用C/C++编写的库的接口来实现对系统文件的访问。 

下面就介绍下Android NDK的入门学习过程：  
入门的最好办法就是学习Android自带的例子， 这里就通过学习Android的NDK自带的demo程序：hello-jni来达到这个目的。 

代码的编写 

1.首先是写java代码  
建立一个Android应用工程HelloJni，创建HelloJni.java文件： 
HelloJni.java : 

Java代码  

1. /* 
2.  * Copyright (C) 2009 The Android Open Source Project 
3.  * 
4.  * Licensed under the Apache License, Version 2.0 (the "License"); 
5.  * you may not use this file except in compliance with the License. 
6.  * You may obtain a copy of the License at 
7.  * 
8.  *      http://www.apache.org/licenses/LICENSE-2.0 
9.  * 
10.  * Unless required by applicable law or agreed to in writing, software 
11.  * distributed under the License is distributed on an "AS IS" BASIS, 
12.  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
13.  * See the License for the specific language governing permissions and 
14.  * limitations under the License. 
15.  */  
16. package com.example.hellojni;  
17.   
18. import android.app.Activity;  
19. import android.widget.TextView;  
20. import android.os.Bundle;  
21.   
22.   
23. public class HelloJni extends Activity  
24. {  
25.     /** Called when the activity is first created. */  
26.     @Override  
27.     public void onCreate(Bundle savedInstanceState)  
28.     {  
29.         super.onCreate(savedInstanceState);  
30.   
31.         /* Create a TextView and set its content. 
32.          * the text is retrieved by calling a native 
33.          * function. 
34.          */  
35.         TextView  tv = new TextView(this);  
36.         tv.setText( stringFromJNI() );  
37.         setContentView(tv);  
38.     }  
39.   
40.     /* A native method that is implemented by the 
41.      * 'hello-jni' native library, which is packaged 
42.      * with this application. 
43.      */  
44.     public native String  stringFromJNI();  
45.   
46.     /* This is another native method declaration that is *not* 
47.      * implemented by 'hello-jni'. This is simply to show that 
48.      * you can declare as many native methods in your Java code 
49.      * as you want, their implementation is searched in the 
50.      * currently loaded native libraries only the first time 
51.      * you call them. 
52.      * 
53.      * Trying to call this function will result in a 
54.      * java.lang.UnsatisfiedLinkError exception ! 
55.      */  
56.     public native String  unimplementedStringFromJNI();  
57.   
58.     /* this is used to load the 'hello-jni' library on application 
59.      * startup. The library has already been unpacked into 
60.      * /data/data/com.example.HelloJni/lib/libhello-jni.so at 
61.      * installation time by the package manager. 
62.      */  
63.     static {  
64.         System.loadLibrary("hello-jni");  
65.     }  
66. }  

这段代码很简单，注释也很清晰，这里只提两点： 

Java代码  

1. a:  
2. static{  
3. System.loadLibrary("hello-jni");  
4. }  
5. 表明程序开始运行的时候会加载hello-jni, static区声明的代码会先于onCreate方法执行。如果你的程序中有多个类，而且如果HelloJni这个类不是你应用程序的入口，那么hello-jni（完整的名字是libhello-jni.so）这个库会在第一次使用HelloJni这个类的时候加载。  
6. b:  
7. public native String stringFromJNI();  
8. public native String unimplementedStringFromJNI();  
9. 可以看到这两个方法的声明中有 native 关键字， 这个关键字表示这两个方法是本地方法，也就是说这两个方法是通过本地代码（C/C++）实现的，在java代码中仅仅是声明。  

用eclipse编译该工程，生成相应的.class文件，这步必须在下一步之前完成，因为生成.h文件需要用到相应的.class文件。 

2. 编写相应的C/C++代码  
刚开始学的时候，有个问题会让人很困惑，相应的C/C++代码如何编写，函数名如何定义？ 这里讲一个方法，利用javah这个工具生成相应的.h文件，然后根据这个.h文件编写相应的C/C++代码。 

2.1 生成相应.h文件：  
就拿我这的环境来说，首先在终端下进入刚刚建立的HelloJni工程的目录： 

引用

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

ls查看工程文件 

引用

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

可以看到目前仅仅有几个标准的android应用程序的文件（夹）。 
首先我们在工程目录下建立一个jni文件夹： 

引用

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

下面就可以生成相应的.h文件了： 

引用

iaiai@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文件： 

引用

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

我们来看看com_example_hellojni_HelloJni.h的内容： 
com_example_hellojni_HelloJni.h : 

Java代码  

1. /* DO NOT EDIT THIS FILE - it is machine generated */  
2. #include <jni.h>  
3. /* Header for class com_example_hellojni_HelloJni */  
4.   
5. #ifndef _Included_com_example_hellojni_HelloJni  
6. #define _Included_com_example_hellojni_HelloJni  
7. #ifdef __cplusplus  
8. extern "C" {  
9. #endif  
10. /* 
11.  * Class:     com_example_hellojni_HelloJni 
12.  * Method:    stringFromJNI 
13.  * Signature: ()Ljava/lang/String; 
14.  */  
15. JNIEXPORT jstring JNICALL Java_com_example_hellojni_HelloJni_stringFromJNI  
16.   (JNIEnv *, jobject);  
17.   
18. /* 
19.  * Class:     com_example_hellojni_HelloJni 
20.  * Method:    unimplementedStringFromJNI 
21.  * Signature: ()Ljava/lang/String; 
22.  */  
23. JNIEXPORT jstring JNICALL Java_com_example_hellojni_HelloJni_unimplementedStringFromJNI  
24.   (JNIEnv *, jobject);  
25.   
26. #ifdef __cplusplus  
27. }  
28. #endif  
29. #endif  

上面代码中的JNIEXPORT 和 JNICALL 是jni的宏，在android的jni中不需要，当然写上去也不会有错。 
从上面的源码中可以看出这个函数名那是相当的长啊。。。。 不过还是很有规律的， 完全按照：java_pacakege_class_mathod 形式来命名。 
也就是说： 

Java代码  

1. Hello.java中 stringFromJNI() 方法对应于 C/C++中的 Java_com_example_hellojni_HelloJni_stringFromJNI() 方法  
2. 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 : 

Java代码  

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

这里只是实现了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文件，内容如下： 

Java代码  

1. # Copyright (C) 2009 The Android Open Source Project  
2. #  
3. # Licensed under the Apache License, Version 2.0 (the "License");  
4. # you may not use this file except in compliance with the License.  
5. # You may obtain a copy of the License at  
6. #  
7. #      http://www.apache.org/licenses/LICENSE-2.0  
8. #  
9. # Unless required by applicable law or agreed to in writing, software  
10. # distributed under the License is distributed on an "AS IS" BASIS,  
11. # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  
12. # See the License for the specific language governing permissions and  
13. # limitations under the License.  
14. #  
15. LOCAL_PATH := $(call my-dir)  
16.   
17. include $(CLEAR_VARS)  
18.   
19. LOCAL_MODULE    := hello-jni  
20. LOCAL_SRC_FILES := hello-jni.c  
21.   
22. include $(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共享库文件  
Android.mk文件已经编写好了，现在可以用android NDK开发包中的 ndk-build脚本生成对应的.so共享库了，方法如下： 

Java代码  

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

可以看到已经正确的生成了libhello-jni.so共享库了， 我们去 libs/armeabi/ 目录下看看： 

Java代码  

1. iaiai@ubuntu:~/workspace/android/NDK/hello-jni$ cd libs/  
2. iaiai@ubuntu:~/workspace/android/NDK/hello-jni/libs$ ls  
3. armeabi  
4. iaiai@ubuntu:~/workspace/android/NDK/hello-jni/libs$ cd armeabi/  
5. iaiai@ubuntu:~/workspace/android/NDK/hello-jni/libs/armeabi$ ls  
6. gdbserver  gdb.setup  libhello-jni.so  

4. 在eclipse重新编译HelloJni工程，生成apk  
在eclipse中刷新下HelloJni工程，重新编译生成apk，libhello-jni.so共享库会一起打包在apk文件内。 
在模拟器中看看运行结果：