Android ndk入门准备－－hello jni

上篇：Linux下JNI调用

下面我就用JNI实现一个经典的“Hello World”程序。该程序在Java中通过JNI调用c函数实现“Hello World”的输出。创建该程序分为以下步骤：

1、创建一个Java程序（HelloWorld.java）定义原生的c/c++函数。

2、用javac编译HelloWorld.java生成HelloWorld.class。

3、用javah带-jni参数编译HelloWorld.class生成HelloWorld.h文件，该文件中定义了c的函数原型。在实现c函数的时候需要。

4、创建HelloWorld.c，实现HelloWorld.h定义的函数。

5、编译HelloWorld.c生成libHelloWorld.so。

6、在java虚拟机运行java程序HelloWorld。 

     下面我们就一步一步来实现这个程序。

创建HelloWorld.java

class HelloWorld{
    private native void print();
    public static void main(String[] args){
    new HelloWorld().print();
}
static{
    System.loadLibrary("HelloWorld");
    }
}

注意print方法的声明，关键字native表明该方法是一个原生代码实现的。另外注意static代码段的System.loadLibrary调用，这段代码表示在程序加载的时候，自动加载libHelloWorld.so库。

编译HelloWorld.java

在命令行中运行如下命令：

javac HelloWorld.java

在当前文件夹编译生成HelloWorld.class。

生成HelloWorld.h

在命令行中运行如下命令：

javah -jni HelloWorld

在当前文件夹中会生成HelloWorld.h。打开HelloWorld.h将会发现如下代码：

/* DO NOT EDIT THIS FILE - it is machine generated */#include <jni.h>/* Header for class HelloWorld */#ifndef _Included_HelloWorld#define _Included_HelloWorld#ifdef __cplusplusextern "C" {#endif/* * Class:     HelloWorld * Method:    print * Signature: ()V */JNIEXPORT void JNICALL Java_HelloWorld_print  (JNIEnv *, jobject);#ifdef __cplusplus}#endif#endif

该文件中包含了一个函数Java_HelloWorld_print的声明。这里面包含两个参数，非常重要，后面讲实现的时候会讲到。

实现HelloWorld.c

创建HelloWorld.c文件输入如下的代码：

#include <jni.h>#include <stdio.h>#include "HelloWorld.h"JNIEXPORT void JNICALL     Java_HelloWorld_print(JNIEnv *env, jobject obj){printf("Hello World!\n");}

注意必须要包含jni.h头文件，该文件中定义了JNI用到的各种类型，宏定义等。

另外需要注意Java_HelloWorld_print的两个参数，本例比较简单，不需要用到这两个参数。但是这两个参数在JNI中非常重要。

env代表java虚拟机环境，Java传过来的参数和c有很大的不同，需要调用JVM提供的接口来转换成C类型的，就是通过调用env方法来完成转换的。

obj代表调用的对象，相当于c++的this。当c函数需要改变调用对象成员变量时，可以通过操作这个对象来完成。

编译生成libHelloWorld.so

在Linux下执行如下命令来完成编译工作：

cc -I/usr/lib/jvm/java-6-sun/include/linux/   -I/usr/lib/jvm/java-6-sun/include/    -fPIC -shared -o libHelloWorld.so HelloWorld.c

（注：合理设置$PATH可以简化编译命令  如gcc -shared -fPIC hello_jni.c -o libHelloWorld.so）

在当前目录生成libHelloWorld.so。注意一定需要包含Java的include目录（请根据自己系统环境设定），因为Helloworld.c中包含了jni.h。

另外一个值得注意的是在HelloWorld.java中我们LoadLibrary方法加载的是“HelloWorld”，可我们生成的Library却是libHelloWorld。这是Linux的链接规定的，一个库的必须要是：lib+库名+.so。链接的时候只需要提供库名就可以了。

运行Java程序HelloWorld

大功告成最后一步，验证前面的成果的时刻到了：

java HelloWorld

如果你这步发生问题，如果这步你收到java.lang.UnsatisfiedLinkError异常，可以通过如下方式指明共享库的路径：

java -Djava.library.path='.' HelloWorld

当然还有其他的方式可以指明路径请参考《在Linux平台下使用JNI》。

我们可以看到久违的“Hello world!”输出了。

sudo cp jni.h /usr/include/

(注：编译是找不到jni.h 或者jni_md.h, 需要把％JAVA_HOME%/include/jni.h 和 %JAVA_HOME%/include/linux/jni_md.h拷贝到 /usr/include/一份）
（注：
         1、 在你载入jni类之前 放入“System.out.println(System.getProperty("java.library.path"));
         2、运行你的程序你将获得java.library.path指向的目录
         3、拷贝你的libxxx.so到java.library.path指向的某个目录下面。
            一定要将linux下的共享库（我暂且这么叫:）命名成libxxx.so的形式，"xxx"是你在System.loadLibrary("xxx")中用到的加载库名称。

             也可以通过设置LINUX下的系统变量LD_LIBRARY_PATH来添加java.library.path，只要在启动~/.bashrc中添加如下代码然后重新登录shell，就可以将动态库放在当前目录下运行你的jni程序了。export LD_LIBRARY_PATH=.:..:$LD_LIBRARY_PATH）

下篇：Android NDK HelloJNI

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

1、 开发环境的搭建

　　1)android的NDK开发需要在linux下进行： 因为需要把C/C++编写的代码生成能在arm上运行的.so文件，这就需要用到交叉编译环境，而交叉编译需要在linux系统下才能完成。

　　2)安装android-ndk开发包，这个开发包可以在google android 官网下载： 通过这个开发包的工具才能将android jni 的C/C++的代码编译成库

　　3)android应用程序开发环境： 包括eclipse、java、 android sdk、 adt等。

　　如何下载和安装android-ndk我这里就不啰嗦了，安装完之后，需要将android-ndk的路劲加到环境变量PATH中：

　　　　sudo gedit /etc/environment

　　在environment的PATH环境变量中添加你的android-ndk的安装路劲，然后再让这个更改的环境变量立即生效：

　　　　 source  /etc/environment

　　经过了上述步骤，在命令行下敲：

　　　　ndk-bulid

　　弹出如下的错误，而不是说ndk-build not found，就说明ndk环境已经安装成功了。

　　　　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.

 2.代码的编写

　　1)首先是写java代码

　　建立一个Android应用工程HelloJni，创建HelloJni.java文件：

　　HelloJni.java :

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);

        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();

    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");
    }
}

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

?

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

　　表明程序开始运行的时候会加载hello-jni, static区声明的代码会先于onCreate方法执行。如果你的程序中有多个类，而且如果HelloJni这个类不是你应用程序的入口，那么hello-jni（完整的名字是libhello-jni.so）这个库会在第一次使用HelloJni这个类的时候加载。

?

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

　　可以看到这两个方法的声明中有 native 关键字， 这个关键字表示这两个方法是本地方法，也就是说这两个方法是通过本地代码（C/C++）实现的，在java代码中仅仅是声明。

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

2)编写相应的C/C++代码

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

　　a. 生成相应.h文件：

　　就拿我这的环境来说，首先在终端下进入刚刚建立的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应用程序的文件（夹）。

　　首先我们在工程目录下建立一个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

　　下面就可以生成相应的.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 则是完整类名

　　这一步的成功要建立在已经在 bin/com/example/hellojni/  目录下生成了 HelloJni.class的基础之上。现在可以看到jni目录下多了个.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的内容：

　　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中不需要，当然写上去也不会有错。从上面的源码中可以看出这个函数名那是相当的长啊。。。。 不过还是很有规律的， 完全按照：java_pacakege_class_mathod 形式来命名。

　　也就是说：

　　Hello.java中 stringFromJNI() 方法对应于 C/C++中的 Java_com_example_hellojni_HelloJni_stringFromJNI() 方法

　　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对象。

 

b. 编写相应的.c文件：

　　hello-jni.c :

#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 !");
}

　　这里只是实现了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 生成相应的库

a 编写Android.mk文件

　　在jni目录下（即hello-jni.c 同级目录下）新建一个Android.mk文件，Android.mk 文件是Android 的 makefile文件，内容如下：

# 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变量。它用于在开发树中查找源文件。在这个例子中，宏函数’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 表示生成可执行文件。

 

b. 生成.so共享库文件

　　Andro文件已经编写好了，现在可以用android NDK开发包中的 ndk-build脚本生成对应的.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 

　　可以看到已经正确的生成了libhello-jni.so共享库了， 我们去 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文件内。在模拟器中看看运行结果。

(注：如果上述mk文件编译提示Android NDK: /home/long/urza/workspace/MyHelloJni/jni/Android.mk:hello-jni: LOCAL_MODULE_FILENAME should not include file extensions   
Android NDK: /home/long/urza/workspace/MyHelloJni/jni/Android.mk:hello-jni: LOCAL_MODULE_FILENAME must not contain a file extension 错误的时候，可以显式指定一下LOCAL_MODULE_FILENAME...如下：

LOCAL_PATH:=$(call my-dir)

include $(clear_VARS)

LOCAL_MODULE:=hello-jni

LOCAL_MODULE_FILENAME:=libhello-jni

LOCAL_SRC_FILES:=hello-jni.c

include $(BUILD_SHARED_LIBRARY)
)

上述文字中有提到生成.h文件的命令形如：javah -classpath bin -d jni com.inspur.ndk.SerialPort

已经提到命令生成了一个报名类名组成的.h文件   在jni文件夹中，文件名是比较长的，可以用下面这个命令给其生成.h的同时重命名

javah -o jni/serial_port.h -classpath bin  com.inspur.ndk.SerialPort

Note：如果com/inpur/ndk在bin/classes目录下面所以javah命令变为：javah -classpath bin/classes -d jni com.inspur.ndk.SerialPort

或javah -o jni/serial_port.h -classpath bin/classes  com.inspur.ndk.SerialPort