JNI学习笔记之ndk-build手动编译并集成流程

2022-06-15 12:01:05

参考

一天掌握Android JNI本地编程快速入门
 Android开发实践：常用NDK命令行参数
 Secrets of Android.mk

JNI

JNI是啥？

JNI(Java Native Interface):Java本地开发接口，JNI是一个协议，用来沟通Java代码和外部的本地代码（c/c++），外部的c/c++代码也可以调用Java代码

为什么使用JNI

效率上C/C++是本地语言，比Java更高效
代码移植，如果之前用C语言开发过模块，可以复用已经存在的C代码
Java反编译比C语言更容易，一般加密算法都是用C语言编写，不容易被反编译

Java基本数据类型与C语言基本数据类型的对应

Java引用类型对应

堆内存和栈内存的概念

栈内存

系统自动分配和释放，保存全局，静态，局部变量，在栈上分配内存叫今天内存，大小一般是固定的。

堆内存

程序员手动分配（mallc/new）和释放(free/java不用手动释放，有GC回收)，在堆上分配内存叫动态分配，一般硬件内存有多大内存就有多大。

交叉编译

交叉编译的概念

交叉编译记载一个平台，编译出另一个平台能够执行的二进制代码
主流平台：Windows,Mac os,Linux
主流处理器：X86,arm,mips

交叉编译的原理

即在一个平台上，模拟其它平台的特性
编译的流程：源代码》编译》链接》可执行程序

交叉编译的工具链

多个工具的集合，一个工具使用完后接着调用下一个工具

常见的交叉编译工具

NDK（Native Development Kit）：开发JNI必备工具，就是模拟其它平台特性类编译代码的工具
CDP(C/C++ Development Tools):是Eclipse开发C语言的一个插件，高亮显示C语言的语法
Cygwin:一个Windows平台的Unix模拟器

NDK的目录结构

这里我下的ndk版本是15.2.4203891 比较新了，配置NDK环境变量大家应该都会，这里我就不提了

目前NDK最新的目录

ndk-build方式手动编译出so库文件

一个简单的例子

1.编写java代码

这个直接在工程目录下正常编辑你的代码，比如我的这个JNIUtils是在com.newtrekwang.ndkpractice包下的，这个类声明了一个方法，功能就是获取从C层传来的字符串。方法的具体实现当然是在C层实现啦。所以这个就跟java的接口定义差不多。

package com.newtrekwang.ndkpractice;

public class JNIUtils {
    public static native String getStringFromC();
}

2.编写c层代码

这里如果想快速写一个与之关联的头文件的话，（java7）可以使用javah命令生成，不过命令要在你的类的所在包的根路径执行
比如我这个：

javah

可以看下头文件的代码：

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

#ifndef _Included_com_newtrekwang_ndkpractice_JNIUtils
#define _Included_com_newtrekwang_ndkpractice_JNIUtils
#ifdef __cplusplus
extern "C" {
#endif
/*
 * Class:     com_newtrekwang_ndkpractice_JNIUtils
 * Method:    getStringFromC
 * Signature: ()Ljava/lang/String;
 */
JNIEXPORT jstring JNICALL Java_com_newtrekwang_ndkpractice_JNIUtils_getStringFromC
  (JNIEnv *, jclass);

#ifdef __cplusplus
}
#endif
#endif

可以看到里面已经帮我们写好了一个与Java类getStringFromC对应的Native函数Java_com_newtrekwang_ndkpractice_JNIUtils_getStringFromC，命名格式就是Java加完整类名加方法名

然后我把这个头文件剪切到另一个新建的文件夹prac1里，这个文件夹专门存放c/c++真个编译过程的产物，比如最后我要得到so文件，就从这里面拿

然后我们新建一个hello.c实现头文件里面的函数

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

JNIEXPORT jstring JNICALL Java_com_newtrekwang_ndkpractice_JNIUtils_getStringFromC
  (JNIEnv* env, jclass obj){
      char* str="Hello from C!";
      jstring result=(*env)->NewStringUTF(env,str);
      return result;
  }

（1）JNIEXPORT ：在Jni编程中所有本地语言实现Jni接口的方法前面都有一个"JNIEXPORT",这个可以看做是Jni的一个标志，至今为止没发现它有什么特殊的用处。

（2）void ：这个学过编程的人都知道，当然是方法的返回值了。

（3）JNICALL ：这个可以理解为Jni 和Call两个部分，和起来的意思就是 Jni调用XXX（后面的XXX就是JAVA的方法名）。

（4）Java_com_test01_Test_firstTest：这个就是被上一步中被调用的部分，也就是Java中的native 方法名，这里起名字的方式比较特别，是：包名+类名+方法名。

（5）JNIEnv * env：这个env可以看做是Jni接口本身的一个对象，在上一篇中提到的jni.h头文件中存在着大量被封装好的函数，这些函数也是Jni编程中经常被使用到的，要想调用这些函数就需要使用JNIEnv这个对象。例如：env->GetObjectClass()。（详情请查看jni.h）

3.编写Android.mk

Android.mk 里面就是些设置编译配置的脚本
例如我的这个：

LOCAL_PATH := $(call my-dir)
include $(CLEAR_VARS)
LOCAL_MODULE :=hello
LOCAL_SRC_FILES := hello.c com_newtrekwang_ndkpractice_JNIUtils.h
include $(BUILD_SHARED_LIBRARY)

常见Android.mk语句解释

LOCAL_PATH := $(call my-dir)
一个Android.mk文件必须以LOCAL_PATH变量的定义开始,它用于在开发树中查找源文件。在这个例子中，构建系统提供的宏函数'my-dir'被用来返回当前目录的路径（即包含Android.mk文件本身的目录）。
include $(CLEAR_VARS)
CLEAR_VARS变量由构建系统提供，并指向一个特殊的GNU Makefile，它将清除许多LOCAL_XXX变量（例如LOCAL_MODULE，LOCAL_SRC_FILES，LOCAL_STATIC_LIBRARIES等），但除了LOCAL_PATH，这个是需要的，因为所有的构建控制文件在单个GNU Make执行上下文中解析，其中所有变量都是全局的。
LOCAL_MODULE :=hello
定义LOCAL_MODULE变量来标识您在Android.mk中描述的每个模块，构建系统为自动为模块添加前缀和后缀，例如我这个是hello,他最终会生成libhello.so
LOCAL_SRC_FILES := hello.c com_newtrekwang_ndkpractice_JNIUtils.h
LOCAL_SRC_FILES变量必须包含C和/或C ++源文件的列表，这些文件将被构建并组装到一个模块中。这里可以只列出源文件，不需要头文件，头文件构建系统会自动查找

更多Android.mk功能请见Secrets of Android.mk

然后我的prac1文件现在有这个三个文件了

prac1

然后在此目录下执行ndk-build NDK_PROJECT_PATH=. APP_BUILD_SCRIPT=./Android.mk
如图：

image.png

然后再看我们的文件夹就是这样了：

image.png

常见ndk-build命令行参数

NDK_LOG=1:配置log级别，打印ndk编译时的详细输出信息
NDK_PROJECT_PATH=.:制定NDK编译的代码路径为当前目录，如果不配置，则必须把工程代码放到Android工程的jni目录下
APP_BUILD_SCRIPT=./Android.mk:指定NDK编译使用的Android.mk文件
NDK_APP_APPLICATION_MK=./Application.mk:指定NDK编译使用的Application.mk文件
CLEAN:清除所有编译出来的临时文件和目标文件
-B:强制重新编译已经编译完成的的代码
NDK_DEBUG=1:执行 debug build
NDK_DEBUG=0:执行release build
NDK_OUT=./mydir:指定编译生成的文件的存放位置
-C /opt/myTest/:到指定目录编译native代码

4.在Android项目中集成so文件

首先把那些so文件拷到Android工程的libs目录下

拷so文件

gradle配置库文件目录

在android块下设置sourceSets块即可，比如我这里设置的是libs文件夹，说明我的so库文件在libs文件夹里。

 sourceSets {
        main {
            jniLibs.srcDirs=["libs"] //指定库文件的目录，java代码编译时链接用
        }
    }

然后gradle同步一下，即可在Android模式目录下看到jniLibs文件包，证明gradle已经识别了so库文件

jniLibs

完善java代码

就是在原来的基础上加了个静态块，里面的System.loadLibrary("hello")功能就是加载hello这个库文件，不然下面的native方法不能正常执行

package com.newtrekwang.ndkpractice;

public class JNIUtils {
        static {
            System.loadLibrary("hello");
        }
    public static native String getStringFromC();
}

然后就可以愉快的使用调方法了
比如我这里这个TextView显示的字符串就是就是从JNIUtils类的native方法调出来的。

实例

码农公寓

参考

JNI