1.什么是JNI
JNI全称是Java Native Interface,中文称为Java本地接口。JNI是JAVA语言和C/C++语言沟通的协议,通过JNI,Java代码可以调用C、C++等语言写的代码,或者反过来C、C++等语言代码通过JNI调用Java 写的代码。
为什么使用JNI?
我们知道,Java语言的特性是一次编写,到处运行,跨平台是Java的优点,但有得就有失,跨平台的特性导致了Java和底层交互能力不够强大,而这正是C/C++语言所擅长的,另一方面,Java通过JNI可以复用大量现有的C/C++库文件,避免重复造轮子。
2.什么是NDK
NDK全称是Native Develop Kit,可译为本地开发套件,NDK是Android提供的工具集,用于进行C/C++的开发。
JNI和NDK又是什么关系?
JNI是一个接口协议,NDK是一个开发套件,他们之间有个共同点是英文都包含Native(本地),都和C/C++语言扯上关系,不过以这两点硬说他们有关系就有点太勉强了,事实上,JNI是Java的,NDK是Android的,两者没有相互依存关系,硬要说有什么关系的话,就是使用NDK,可在Android中快速开发符合JNI接口要求的C/C++动态库,方便Java调用。
可能有人会问了,Android开发语言不是Java语言,为何还另外提供C/C++语言开发工具?
要知道,Android开发语言虽然是Java,但内核是Linux,而Linux核心库是用C/C++编写,因此Google提供NDK工具,方便开发者和核心库交互。不过,一般开发纯业务的应用,不会涉及到NDK,如果涉及到以下需求则需要用到NDK:
- 1、提供代码安全性。因为so库文件反编译较难,将核心代码封装成so库文件,大大提高了代码的安全性;
- 2、便于平台间移植其应用。通过NDK,开发人员可以方便生成指定平台的动态库;
- 3、重复使用现有C/C++开源库;
- 4、提升程序执行效率,特别是一些计算密集型应用。
3.JNI开发流程
以两个数相加作为例子,两个数相加使用C/C++实现,再通过JNI调用。这和日常生活中的外包流程很类型,Java自己不想做,发了一个外包需求,C接下了这个活。
- 第一步:第一步是Java发布需求。首先创建包名为
com.test.jnitest
的工程,在工程中创建名为JNIUtils
的class
,并在类中声明一个native方法。代码如下:
package com.test.jnitest;
public class JNIUtils {
static
{
//加载动态库,即加法实现所在的链接库。
System.loadLibrary("jni_method");
}
//native关键字提示该方法由本地方法实现
public static native int add(int a,int b);
}
native关键字表示这是一个要外包实现的函数,那么C完成外包工作后以什么形式给Java交差呢,用so库文件,然后Java通过System.loadLibrary(“jni_method”)加载,so库文件名jni_method值随意,只要Java和C之间约定好就行。
- 第二步:这一步还是Java这边的,是Java这边拿到C交差工作后做的事。我们要实现的功能是在两个文本框分别输入两个数字后,点击相加按钮,然后代码调用C完成的两个数进行相加功能,并把结果显示在界面上,界面布局xml代码如下:
<?xml version="1.0" encoding="utf-8"?>
<androidx.constraintlayout.widget.ConstraintLayout xmlns:android="http://schemas.android.com/apk/res/android"
xmlns:app="http://schemas.android.com/apk/res-auto"
xmlns:tools="http://schemas.android.com/tools"
android:layout_width="match_parent"
android:layout_height="match_parent"
tools:context=".MainActivity">```
<EditText
android:id="@+id/etNum1"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:text="120"
app:layout_constraintStart_toStartOf="parent"
app:layout_constraintTop_toTopOf="parent" />
<EditText
android:id="@+id/etNum2"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:layout_marginStart="60dp"
android:text="240"
app:layout_constraintStart_toStartOf="parent"
app:layout_constraintTop_toTopOf="parent" />
<Button
android:id="@+id/bAdd"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:layout_marginStart="120dp"
android:text="加"
app:layout_constraintStart_toStartOf="parent"
app:layout_constraintTop_toTopOf="parent" />
<TextView
android:id="@+id/textView"
android:layout_width="wrap_content"
android:layout_height="wrap_content"
android:text="相加结果"
app:layout_constraintBottom_toBottomOf="parent"
app:layout_constraintLeft_toLeftOf="parent"
app:layout_constraintRight_toRightOf="parent"
app:layout_constraintTop_toTopOf="parent" />
</androidx.constraintlayout.widget.ConstraintLayout>
Activity里调用本地相加代码如下:
package com.test.jnitest;
import androidx.appcompat.app.AppCompatActivity;
import android.os.Bundle;
import android.view.View;
import android.widget.Button;
import android.widget.EditText;
import android.widget.TextView;
public class MainActivity extends AppCompatActivity {
Button Add;
EditText Num1;
EditText Num2;
TextView Result;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
Add=findViewById(R.id.bAdd);
Num1=findViewById(R.id.etNum1);
Num2=findViewById(R.id.etNum2);
Result=findViewById(R.id.tvResult);
Add.setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View v) {
String sN1=Num1.getText().toString().trim();
String sN2=Num2.getText().toString().trim();
int iN1 = Integer.parseInt(sN1);
int iN2 = Integer.parseInt(sN2);
//调用本地方法进行相加
int iResult=JNIUtils.add(iN1,iN2);
//记得不要直接打印Result.setText(iResult),这样代码会认为iResult是个 资源ID
Result.setText(“相加结果”+iResult);
}
});
}
}
- 第三步:Java这边代码是准备好了,接下来的工作是把外包工作布置给C的过程,因为Java和C是两种语言,他们之间不能直接沟通,需要做一下处理,以下就是沟通过程:首先编译Java源文件得到.class文件,方法是点击Visual Studio的Build菜单下的Make Project,然后在下图的路径找到生成的.class文件,注意,该路径和有些博客所说的不一致,他们生成的.class文件路径在intermediates的classes文件夹下。
-第四步:生成.class文件C语言还是看不懂,因此还是再做一次处理,处理方式是通过.class文件得到C的头文件,这样C语言就能看懂了,生成头文件使用javah命令,可以在终端中执行(我的是MAC)或者使用Android Studio里的终端,两者其实一样。首先进入在终端里进入classes路径下,注意一定要在classes这一级目录,不然会提示找不到class文件。我的环境是:
/Users/lan/AndroidStudioProjects/JNITest/app/build/intermediates/javac/debug/classes,然后执行命令:
javah -jni -cp . com.test.jnitest.JNIUtils
注:命令应包含完整的包名,并且.class文件不能带“.class”后缀,另外之前按照网上其他博客的命令,一直报找不到类的错误,加上-cp参数解决
执行命令成功后,即可得到.h文件,如下图所示。
生成得到的.h文件内容如下:
/* DO NOT EDIT THIS FILE - it is machine generated */
#include <jni.h>
/* Header for class com_test_jnitest_JNIUtils */
#ifndef _Included_com_test_jnitest_JNIUtils
#define _Included_com_test_jnitest_JNIUtils
#ifdef __cplusplus
extern "C" {
#endif
/*
* Class: com_test_jnitest_JNIUtils
* Method: add
* Signature: (II)I
*/
JNIEXPORT jint JNICALL Java_com_test_jnitest_JNIUtils_add
(JNIEnv *, jclass, jint, jint);
#ifdef __cplusplus
}
#endif
#endif
-第五步:得到头文件后,就可以根据.h文件,实现对应的C代码。在java目录下,新建一个jni文件夹,将生产的.h文件拷贝到这个目录下,然后新建一个名为JNIUtils的C文件,在该代码中实现头文件声明的函数,代码实现如下:
#include <jni.h>
#include "com_test_jnitest_JNIUtils.h"
JNIEXPORT jint JNICALL Java_com_test_jnitest__ADD
(JNIEnv *jnienv, jclass obj, jint num1, jint num2)
{
return num1+num2;
}
-第六步:C代码实现后,已经实现了Java发布的外包需求,接下来的工作是C以Java看得懂的形式交差外包工作,在第一步中Java已经说明了,给他交差工作用so库文件的形式,因此接下来的工作就是想办法生成so库文件。首先在jni目录下创建Android.mk文件,Android.mk作用是指定源码编译的配置信息,Android.mk内容如下:
LOCAL_PATH := $(call my-dir)
include $(CLEAR_VARS)
LOCAL_MODULE := jni_cal
LOCAL_SRC_FILES := JNITool.c
include $(BUILD_SHARED_LIBRARY)
其中
-
LOCAL_PATH := $(call my-dir)得到Android.mk文件本身所在的路径,宏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:=jni_method 表示的是要生成的库,这个库就是在java里加载的库,每个库名称必须唯一,且不含任何空格。编译系统在生成最终的库名称里自动添加lib前缀和so后缀。例如,上述示例会生成名为libjni_cal.so,如果在LOCAL_MODULE定义的名称已经带lib了,则编译系统不会再添加lib前缀,例如名称是libmodule,那么编译系统输出的是libmodule.so,而不是liblibmodule.so;
-
LOCAL_SRC_FILES :=JNIUtils.c包含要编译到库中的 C 和/或 C++ 源文件列表,不必列出头文件,编译系统会自动帮我们找出依赖文件;
-
include $(BUILD_SHARED_LIBRARY),其中BUILD_SHARED_LIBRARY 变量指向一个GNU Makefile脚本,该脚本会收集您自最近include以来在 LOCAL_XXX 变量中定义的所有信息。此脚本确定要编译的内容以及编译方式:
- BUILD_STATIC_LIBRARY:编译为静态库
- BUILD_SHARED_LIBRARY:编译为动态库
- BUILD_EXECUTABLE:编译为Native C 可执行程序
- BUILD_PREBUILT:该模块已经预先编译
最后一行帮助系统将所有内容连接到一起:
第七步,在jni目录下创建Application.mk文件,其中内容就一句话:APP_ABI:=all
。在上一步中,Android.mk解决的问题是编译谁,但还没解决编译出来给哪个平台用,这是Application.mk要做的工作,常见的平台有Arm,x86,MIPS,配置方法是在APP_ABI字段设置成对应的值,例如如果想配置成基于Arm平台的so文件,则APP_ABI := armeabi
,至于要生成哪个平台,这就看Java代码准备运行在哪个平台了,我这里设置成配置支持所有平台,对应的字段是APP_ABI := all
。
第八步,到目前为止,生成so文件的准备工作已经差不多了,接下来要做的则是使用NDK工具生成so文件。关于配置NDK环境不再赘述(折腾过程可以写成一篇博客了),这里假设NDK环境已经配置好了。生成NDK过程很简单:在终端进入到jni目录,终端在Android Studio底部,进到目录后,输入ndk-build
命令,编译成功后,在src/main/会多了两个文件夹libs & obj,其中libs下存放的是生成的so库文件,因为我在Application.mk设置的全平台,因此生成所有平台的so文件,如果Application.mk设置成特定平台,则只生成特定平台的so文件。拿到so文件后,C可以给Java交差任务了。
第九步,这一步要做的工作把so库文件交给Java。首先在src/main/中创建一个名为jniLibs的文件夹,并将上一步生成的so文件夹放到该目录下,这里有两点需要注意一下,一是因为要拷贝哪些so库,需要看Android程序准备运行在哪些平台上,如果拷贝的so库文件不正确,则应用不能正常安装,会提示ABI不匹配错误,因为我的模拟器是x86平台,因此我拷贝了x86平台的so库文件到jniLibs下,二是拷贝文件是文件夹一起拷贝,不能单拷贝单个so文件到jniLibs下。
第十步,因为在第一步时,Java端的代码已经准备好了,现在so库文件也拷贝到指定目录下,Java代码可以直接运行,下图是在模拟器上运行的效果。
4.总结
把JNI开发流程当成Java和C之间的一次外包需求开发理解起来就容易了,首先是Java发布需求,使用native
关键字声明函数由外包实现,并声明了外包任务交差以so库文件的形式,Java外包任务通过头文件的形式交给C语言,之后C语言实现后,再想办法生成so库文件来交差任务,最后将so库文件拷贝到指定目录下,Java能正常加载,整个流程也到处结束。