NDK:全称为Native Development Kit
为何要用到NDK?
概括来说主要分为以下几种情况:
1. 代码的保护,由于apk的java层代码很容易被反编译,而C/C++库反编译难度较大;
2. 在NDK中调用第三方C/C++库,因为大部分的开源库都是用C/C++代码编写的;
3. 便于移植,用C/C++写的库可以很方便在其它的嵌入式平台上再次使用。
下面通过学习Android NDK自带的demo程序:hello-jni来对Android NDK编程进行一个初步的了解。
一、NDK开发环境的搭建:
直接百度Android NDK,进入https://developer.android.com/tools/sdk/ndk/index.html找到相应的版本后下载,然后解压,此时在dos命令行中输入ndk-build会提示:“ndk-build不是内部或外部命令,也不是可运行的程序或批处理文件”,这是因为没有将android-ndk的路径添加到环境变量Path中。
在环境变量Path中添加NDK的路径(比如:D:\Android\android-ndk-r10b)即可,此时在dos命令行中输入ndk-build会提示:
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.
这说明ndk开发环境已经搭建成功了。
二、代码的编写:
1.首先是写java代码
建立一个Android应用工程JniTest,在包com.example.jnitest中创建JniActivity.java文件:
JniActivity.java:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 |
package com.example.jnitest; import android.app.Activity; import android.os.Bundle; import android.widget.TextView; public class JniActivity extends Activity { @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(); // native关键字:表示这个方法是本地方法 // 也就是说这个方法是通过本地代码(C/C++)实现的,在java代码中仅仅是声明 /** * 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.JniTest/lib/libhello-jni. * so at installation time by the package manager. */ static { System.loadLibrary("hello-jni"); //Loads and links the library with the specified name. } // 程序开始运行的时候会加载hello-jni库(static区声明的代码会先于onCreate方法执行) // 如果JniActivity不是应用程序的入口,那么hello-jni库(即libhello-jni.so)会在第一次使用JniActivity时加载 } |
2. 编写相应的C/C++代码
这里有个问题让人很困惑,那就是相应的C/C++代码如何编写,函数名如何定义?在这里,我们利用javah这个工具生成相应的.h文件(.h文件是C语言的头文件),然后根据这个.h文件编写相应的C/C++代码即可。
2.1 生成相应.h文件:
现在需要在*\JniTest\bin\classes目录下生成com_example_jnitest_JniActivity.h文件,首先将JniActivity.java文件拷贝到*\JniTest\bin\classes\com\example\jnitest\目录下,但是在dos命令行中*\JniTest\bin\classes目录直接输入javah com.example.jnitest.JniActivity可能会提示错误:
错误:无法访问android.app.Activity
找不到android.app.Activity的类文件
此问题的一个解决办法是在*\JniTest\src目录输入javah -d *\JniTest\bin\classes com.example.jnitest.JniActivity,其中-d *\JniTest\bin\classes表示建立一个目录,把生成的文件放进去,可以看到此时*\JniTest\bin\classes目录下已经生成了com_example_jnitest_JniActivity.h文件:
文件的内容如下:
com_example_jnitest_JniActivity.h:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 |
/* DO NOT EDIT THIS FILE - it is machine generated */ #include <jni.h> /* Header for class com_example_jnitest_JniActivity */ #ifndef _Included_com_example_jnitest_JniActivity #define _Included_com_example_jnitest_JniActivity #ifdef __cplusplus extern "C" { #endif /* * Class: com_example_jnitest_JniActivity * Method: stringFromJNI * Signature: ()Ljava/lang/String; */ JNIEXPORT jstring JNICALL Java_com_example_jnitest_JniActivity_stringFromJNI (JNIEnv *, jobject); /* * Class: com_example_jnitest_JniActivity * Method: unimplementedStringFromJNI * Signature: ()Ljava/lang/String; */ JNIEXPORT jstring JNICALL Java_com_example_jnitest_JniActivity_unimplementedStringFromJNI (JNIEnv *, jobject); #ifdef __cplusplus } #endif #endif |
注:上面代码中的JNIEXPORT和JNICALL是jni的宏,在Android的jni中不需要,当然写上去也不会有错。
从上面的源码中可以看出C/C++文件中相应的函数名都特别长,但是其格式为:Java_package_class_method,即Java_包名_类名_方法名。
语句Signature: ()Ljava/lang/String;
()表示函数的参数为空(这里为空是指除了JNIEnv *, jobject这两个参数之外没有其它参数,JNIEnv*, jobject是所有jni函数必定有的两个参数,分别表示jni环境和对应的java类(或对象)本身);而Ljava/lang/String;表示函数的返回值是java的String对象,更加详细对JNI字段描述符的介绍参见:http://blog.csdn.net/jintiaozhuang/article/details/9016889
2.2 编写相应的.c文件:
hello-jni.c:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 |
#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/jnitest/JniActivity.java */ jstring Java_com_example_jnitest_JniActivity_stringFromJNI(JNIEnv * env, jobject this) { return (*env)->NewStringUTF(env, "Hello from JNI!"); }; /* 实现java中com.example.jnitest.JniActivity中的stringFromJNI()方法 返回一个内容为"Hello from JNI!"的jstring对象(对应于java中的String对象) ->表示利用指针env调用NewStringUTF()方法 方法的命名规则为:Java_包名_类名_方法名 两个参数JNIEnv *,jobject分别表示jni环境和对应的Java类(或对象)本身 */ |
这里只实现了Java_com_example_hellojni_JniActivity_stringFromJNI()方法,而Java_com_example_hellojni_JniActivity_unimplementedStringFromJNI()方法并没有实现,因为在JniActivity.java中只调用了stringFromJNI()方法,所以unimplementedStringFromJNI()方法没有实现也没关系,不过建议最好还是把所有java中定义的本地方法都实现了,写个空函数就可以了。 可以看到,Java_com_example_hellojni_JniActivity_stringFromJNI()方法只是简单的返回了一个内容为"Hello from JNI!"的jstring对象(对应于java中的String对象)。 hello-jni.c文件已经编写好了,现在可以把com_example_jnitest_JniActivity.h文件删除掉,当然不删除也不会有任何影响。
3. 编译hello-jni.c 生成相应的库
3.1 编写Android.mk文件:
在jni目录下(即hello-jni.c同级目录下)新建一个Android.mk文件,Android.mk文件是Android 的makefile文件,内容如下:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 |
# 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) |
LOCAL_PATH := $(call my-dir)
一个Android.mk文件首先必须定义好LOCAL_PATH变量。它用于在开发树中查找源文件。在这个例子中,宏函数’my-dir’由编译系统提供,用于返回当前路径(即包含Android.mk文件的目录)。
include $(CLEAR_VARS)
CLEAR_VARS由编译系统提供,指定让GNU MAKEFILE为你清除除LOCAL_PATH以外的其它LOCAL_XXX变量(例如 LOCAL_MODULE,LOCAL_SRC_FILES,LOCAL_STATIC_LIBRARIES等等),这是必要的,因为所有的编译控制文件都在同一个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表示生成可执行文件。
更多Android.mk相关知识可参见:http://www.2cto.com/kf/201310/253386.html
3.2 生成.so动态共享库文件:
Android.mk文件已经编写好了,现在可以用Android NDK开发包中的ndk-build脚本生成对应的.so共享库了。方法如下:
1) 点击Project→Properties→Builders→New,新建一个Builder,在弹出的对话框中点击Program→OK;
2) 在弹出的对话框【Edit Configuration】中,配置选项卡【Main】:
Location中需要填入nkd-build.cmd的路径(NDK的安装目录,比如:D:\Android\android-ndk-r10b)。
WorkingDiretcoty中需要填入JniTest的工程根目录(比如:F:\WorkSpace\JniTest)。
3) 在【EditConfiguration】中,配置选项卡【Refresh】:
勾选【Refresh resources upon completion】
勾选【The entire workspace】
勾选【Recuresively include sub-folders】
4)在【EditConfiguration】中,配置选项卡【Build Options】:
勾选【After a “Clean”】
勾选【During manual builds】
勾选【During auto builds】
勾选【Specify working set of relevant resources】
点击【Specify Resources…】勾选TestNDK工程的“jni“目录,Finish!
保存设置,点击OK即可。
由于我们勾选了【During auto builds】,所以在工程有所改变的时候,so文件便会自动编译,正确生成以后就能在工程目录下发现多了两个文件夹,文件夹libs\armeabi目录下生成了一个叫libhello-jni.so的文件。至此,使用NDK生成动态库so文件的工作就完成了,之后当我们修改hello-jni.c文件中的内容时,动态库so文件也会随之改变,在Console窗口中也可以看到更新信息。
注:本文部分内容转载自:
博客园:http://www.cnblogs.com/hibraincol/archive/2011/05/30/2063847.html#undefined
wilson:http://wilson-wu.iteye.com/blog/1608110
部分内容有做修改,其余部分为本博客原创,转载请注明作者及原文地址。