NDK入门实例，生成.so文件

目标：

利用NDK 生成 SO 库，使用 SO 库进行 JNI 调用，在 Android sdcard 创建文件并写入数据。

工具：NDK　1.6 、Eclipse for java 、android SDK 、Cygwin

一、下载 　Cywin

从Cywin官网　http://www.cygwin.com/　下载所需要的版本，这里仅介绍在Windows下使用 Cywin

二、下载　NDK　

这个直接从Android 官网下载就好了，现在不用翻墙了。

www.android.com

三、安装　Cywin 参考　【eoe特刊】第七期：NDK.pdf　大家可以去看这个PDF

下载到的Cywin 的程序文件为　setup.exe　文件　

1、双击这个文件，启动安装



2、下一步



3、在线安装



4、选择安装路径





5、下载文件缓存路径



6、选择网络连接方式



7、选择下载镜像站点，目前有一个最新的镜像是163.com，大家选择这个速度快，网易提供的源



8、下载安装



9、选择安装项



10、启动　Cywin 测试　



11、输入命令测试



四、配置Cywin

先找到安装路径下的 .bash_profile 文件，

我的环境位于：

2.修改　/home/$your computer's login name$/.bash_profile 在其中添加下面两句

# 这个里面的/d/android-ndk-r9-windows-x86/android-ndk-r9是存放NDK的目录 export ANDROID_NDK_ROOT=/cygdrive/d/android-ndk-r9-windows-x86/android-ndk-r9

其中前一句需要修改为你自己的路径，保存后，重新启动 Cygwin 。

五、编译NDK实例（ hello-jni），测试一下

我们使用NDK自带的一个例子来生成.so文件

生成 .so 的步骤 ①、在Cywin中，首先跳转到NDK实例目录下面,

cd /cygdrive/d/android-ndk-r9-windows-x86/android-ndk-r9/samples/hello-jni/

②、执行下面的命令

$ANDROID_NDK_ROOT/ndk-build

等待片刻，就会有提示

# $ANDROID_NDK_ROOT/ndk-build Gdbserver : [arm-linux-androideabi-4.4.3] libs/armeabi/gdbserver Gdbsetup : libs/armeabi/gdb.setup Gdbsetup : libs/armeabi/gdb.setup SharedLibrary : libhello-jni.so Install : libhello-jni.so => libs/armeabi/libhello-jni.so

此时.so文件生成成功

六、现在我们来写一个自己的程序来试一下.so,本人使用1.6以上版本　

1.用Eclipse 创建一个Android程序，MyNDK



2.

package com.example.myndk.jni;

public class MyJni {
static{
System.loadLibrary("myndk");
}

public native void write();
}

3.

public class MainActivity extends Activity {

@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);

MyJni jni=new MyJni();
jni.write();
}
}

4.

<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>

5. 生成 JNI 头文件

下面生成JNI 头文件啦，使用 javah 命令，对 JNI..java 这个文件生成！

使用cmd 进入 android 项目的 bin /classes目录中，然后执行 javah -classpath . -jni cc.androidos.jni.JNI 这个命令。


执行该命令

生成了一个cc_androidos_jni_JNI.h

打开看看：(里面都是c 语言的头文件声明)

/* DO NOT EDIT THIS FILE - it is machine generated */
#include <jni.h>
/* Header for class com_example_myndk_jni_MyJni */

#ifndef _Included_com_example_myndk_jni_MyJni
#define _Included_com_example_myndk_jni_MyJni
#ifdef __cplusplus
extern "C" {
#endif
/*
* Class:     com_example_myndk_jni_MyJni
* Method:    write
* Signature: ()V
*/
JNIEXPORT void JNICALL Java_com_example_myndk_jni_MyJni_write
(JNIEnv *, jobject);

#ifdef __cplusplus
}
#endif
#endif

6.书写C 代码，写入数据

#include <stdio.h>
#include <stdlib.h>

#include "com_example_myndk_jni_MyJni.h"

JNIEXPORT void JNICALL Java_com_example_myndk_jni_MyJni_write(JNIEnv *e,jobject j){
FILE *v =fopen("/sdcard/jni/lbj.log","w+");
fprintf(v,"aaaa");
fclose(v);
}

在这里的代码会在运行的时候向sdcard /jni/lbj.log写入 数据”aaaa“。

7. 编译SO 文件

在NDK的主目录　android-ndk-r6b　下面有个　sources　文件夹中创建一个名为 myndk　的文件夹

我这里需要在myndk 文件夹下面再创建一个名为jni的文件夹,文件夹中有如下三个文件



执行过程中



执行后，结果如　



8、把生成的so库，放到Android 工程下面



把 libs文件夹，复制到android中MyNDK工程的主目录

9、启动测试：注明这里的jni文件夹和lbj.log文件是原来创建好的

增加说明

（1）对于Android工程Eclipse里编译好的.so文件放到 libs\armeabi下以后，.so文件就可以打包到apk文件里，在apk装到手机上以后在libs\armeabi下的.so文件应该就会解压到/data/data/(比如com.first.second)/lib下。

a) 用loadLibrary调用的时候需要去掉lib前缀
System.loadLibrary("JNITest");

b) 用load调用的时候需要写全路径名 且不能去掉lib前缀 因为这里是当成一个普通文件读取的 System.load("/data/data/com.test.test/libJNITest.so");

（2）在拿到别人已经编译好的.so文件后，可首先新建一个java类，所在package的名称和class名称都与.so文件中函数签名提示的一致，在这个类中加入native方法的声明。这样在别处就可以用这个wrapper调用so库中的函数了。

（3）

Android系统不允许一个纯粹使用C/C++的程序出现，它要求必须是通过Java代码嵌入Native C/C++——即通过JNI的方式来使用本地（Native）代码。因此JNI对Android底层开发人员非常重要。

准备编写自己的JNI模块

JNI是Java平台定义的用于和宿主平台上的本地代码进行交互的“Java标准”，它通常有两个使用场景：1.使用(之前使用c/c++、delphi开发的)遗留代码；2.为了更好、更直接地与硬件交互并获得更高性能 。

编译——两种不同的编译环境

以上的C语言代码要编译成最终.so动态库文件，有两种途径：

Android NDK ：全称是Native Developer Kit，是用于编译本地JNI源码的工具，为开发人员将本地方法整合到Android应用中提供了方便。事实上NDK和完整源码编译环境一样，都使用Android的编译系统——即通过Android.mk文件控制编译。NDK可以运行在Linux、Mac、Window(+cygwin)三个平台上。

完整源码编译环境 ：Android平台提供有基于make的编译系统，为App编写正确的Android.mk文件就可使用该编译系统。该环境需要通过git从官方网站获取完整源码副本并成功编译，更多细节请参考：http://source.android.com/index.html

不管你选择以上两种方法的哪一个，都必须编写自己的Android.mk文件，有关该文件的编写请参考相关文档。

JNI组件的入口函数——JNI_OnLoad()、JNI_OnUnload()

JNI组件被成功加载和卸载时，会进行函数回调，当VM执行到System.loadLibrary(xxx)函数时，首先会去执行JNI组件中的JNI_OnLoad()函数，而当VM释放该组件时会呼叫JNI_OnUnload()函数。先看示例代码：

//onLoad方法，在System.loadLibrary()执行时被调用
jint JNI_OnLoad(JavaVM* vm, void* reserved){
LOGI("JNI_OnLoad startup~~!");
return JNI_VERSION_1_4;
}

//onUnLoad方法，在JNI组件被释放时调用
void JNI_OnUnload(JavaVM* vm, void* reserved){
LOGE("call JNI_OnUnload ~~!!");
}

JNI_OnLoad()有两个重要的作用：

指定JNI版本：告诉VM该组件使用那一个JNI版本(若未提供JNI_OnLoad()函数，VM会默认该使用最老的JNI 1.1版)，如果要使用新版本的JNI，例如JNI 1.4版，则必须由JNI_OnLoad()函数返回常量JNI_VERSION_1_4(该常量定义在jni.h中) 来告知VM。

初始化设定，当VM执行到System.loadLibrary()函数时，会立即先呼叫JNI_OnLoad()方法，因此在该方法中进行各种资源的初始化操作最为恰当。

JNI_OnUnload()的作用与JNI_OnLoad()对应，当VM释放JNI组件时会呼叫它，因此在该方法中进行善后清理，资源释放的动作最为合适。

使用registerNativeMethods方法

对Java程序员来说，可能我们总是会遵循：1.编写带有native方法的Java类；--->2.使用javah命令生成.h头文件；--->3.编写代码实现头文件中的方法，这样的“官方” 流程，但也许有人无法忍受那“丑陋”的方法名称，RegisterNatives方法能帮助你把c/c++中的方法隐射到Java中的native方法，而无需遵循特定的方法命名格式。来看一段示例代码吧：

//定义目标类名称
static const char *className = "com/okwap/testjni/MyJNI";
//定义方法隐射关系
static JNINativeMethod methods[] = {
{"sayHello", "(Ljava/lang/String;)Ljava/lang/String;", (void*)sayHello},
};
jint JNI_OnLoad(JavaVM* vm, void* reserved){
//声明变量
jint result = JNI_ERR;
JNIEnv* env = NULL;
jclass clazz;
int methodsLenght;
//获取JNI环境对象
if ((*vm)->GetEnv(vm, (void**) &env, JNI_VERSION_1_4) != JNI_OK) {
LOGE("ERROR: GetEnv failed\n");
return JNI_ERR;
}
assert(env != NULL);
//注册本地方法.Load 目标类
clazz = (*env)->FindClass(env,className);
if (clazz == NULL) {
LOGE("Native registration unable to find class '%s'", className);
return JNI_ERR;
}
//建立方法隐射关系
//取得方法长度
methodsLenght = sizeof(methods) / sizeof(methods[0]);
if ((*env)->RegisterNatives(env,clazz, methods, methodsLenght) < 0) {
LOGE("RegisterNatives failed for '%s'", className);
return JNI_ERR;
}
//
result = JNI_VERSION_1_4;
return result;
}

建立c/c++方法和Java方法之间映射关系的关键是 JNINativeMethod 结构，该结构定义在jni.h中，具体定义如下：

typedef struct {
const char* name;//java方法名称
const char* signature; //java方法签名
void*       fnPtr;//c/c++的函数指针
} JNINativeMethod

参照上文示例中初始化该结构的代码：

//定义方法隐射关系
static JNINativeMethod methods[] = {
{"sayHello", "(Ljava/lang/String;)Ljava/lang/String;", (void*)sayHello},
};

其中比较难以理解的是第二个参数——signature字段的取值，实际上这些字符与函数的参数类型/返回类型一一对应，其中"()" 中的字符表示参数，后面的则代表返回值。例如"()V" 就表示void func()，"(II)V" 表示 void func(int, int)，具体的每一个字符的对应关系如下：

字符 Java类型 C/C++类型

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类型 c/c++类型

[Z jbooleanArray boolean[]

[I jintArray int[]

[F jfloatArray float[]

[B jbyteArray byte[]

[C jcharArray char[]

[S jshortArray short[]

[D jdoubleArray double[]

[J jlongArray long[]

上面的都是基本类型，如果参数是Java类，则以"L"开头，以";"结尾，中间是用"/"隔开包及类名，而其对应的C函数的参数则为jobject，一个例外是String类，它对应C类型jstring，例如：Ljava/lang /String; 、Ljava/net/Socket; 等，如果JAVA函数位于一个嵌入类（也被称为内部类），则用$作为类名间的分隔符，例如："Landroid/os/FileUtils$FileStatus;"。

使用registerNativeMethods方法不仅仅是为了改变那丑陋的长方法名，最重要的是可以提高效率，因为当Java类别透过VM呼叫到本地函数时，通常是依靠VM去动态寻找.so中的本地函数(因此它们才需要特定规则的命名格式)，如果某方法需要连续呼叫很多次，则每次都要寻找一遍，所以使用RegisterNatives将本地函数向VM进行登记，可以让其更有效率的找到函数。

registerNativeMethods方法的另一个重要用途是，运行时动态调整本地函数与Java函数值之间的映射关系，只需要多次调用registerNativeMethods()方法，并传入不同的映射表参数即可。

JNI中的日志输出

你一定非常熟悉在Java代码中使用Log.x(TAG,“message”)系列方法，在c/c++代码中也一样，不过首先你要include相关头文件。遗憾的是你使用不同的编译环境( 请参考上文中两种编译环境的介绍) ，对应的头文件略有不同。。

如果是在完整源码编译环境下，只要include <utils/Log.h>头文件，就可以使用对应的LOGI、LOGD等方法了，同时请定义LOG_TAG，LOG_NDEBUG等宏值，示例代码如下：

#define LOG_TAG "HelloJni"
#define LOG_NDEBUG 0
#define LOG_NIDEBUG 0
#define LOG_NDDEBUG 0
#include <string.h>
#include <jni.h>
#include <utils/Log.h>
jstring Java_com_inc_android_ime_HelloJni_stringFromJNI(JNIEnv* env,jobject thiz){
LOGI("Call stringFromJNI!\n");
return (*env)->NewStringUTF(env, "Hello from JNI （中文）!");
}

与日志相关的.h头文件，在以下源码路径：

myeclair\frameworks\base\include\utils\Log.h
myeclair\system\core\include\cutils\log.h

如果你是在NDK环境下编译，则需要#include <android/log.h>，示例代码如下：

/*
* jnilogger.h
*
*  Created on: 2010-11-15
*      Author: INC062805
*/
#ifndef __JNILOGGER_H_
#define __JNILOGGER_H_
#include <android/log.h>
#ifdef _cplusplus
extern "C" {
#endif
#ifndef LOG_TAG
#define LOG_TAG    "MY_LOG_TAG"
#endif
#define LOGD(...)  __android_log_print(ANDROID_LOG_DEBUG,LOG_TAG,__VA_ARGS__)
#define LOGI(...)  __android_log_print(ANDROID_LOG_INFO,LOG_TAG,__VA_ARGS__)
#define LOGW(...)  __android_log_print(ANDROID_LOG_WARN,LOG_TAG,__VA_ARGS__)
#define LOGE(...)  __android_log_print(ANDROID_LOG_ERROR,LOG_TAG,__VA_ARGS__)
#define LOGF(...)  __android_log_print(ANDROID_LOG_FATAL,LOG_TAG,__VA_ARGS__)
#ifdef __cplusplus
}
#endif
#endif /* __JNILOGGER_H_ */

你可以下载以上头文件，来统一两种不同环境下的使用差异。另外，不要忘了在你的Android.mk文件中加入对类库的应用，两种环境下分别是

ifeq ($(HOST_OS),windows)

#NDK环境下

LOCAL_LDLIBS := -llog

else

#完整源码环境下

LOCAL_SHARED_LIBRARIES := libutils

endif

Android为JNI提供的助手方法

myeclair\dalvik\libnativehelper\include\nativehelper

在完整源码编译环境下，Android在myeclair\dalvik\libnativehelper\include\nativehelper\JNIHelp.h头文件中 提供了助手函数 ，用于本地方法注册、异常处理等任务，还有一个用于计算方法隐射表长度的宏定义：

#ifndef NELEM
# define NELEM(x) ((int) (sizeof(x) / sizeof((x)[0])))
#endif
//有了以上宏定义后，注册方法可以按如下写，该宏定义可以直接copy到NDK环境下使用：
(*env)->RegisterNatives(env,clazz, methods,NELEM(methods));