前言
之前一直是用Eclipse开发的,后来转AndroidStudio的时候遇到了一些坑,其中比较麻烦的就是NDK的编译。
代码已上传至GitHub
myExample是我创建专门用来放小例子的,以后我写文章需要的例子就都放这里面了。
正文
1.原理
之前用Eclipse的时候都是手动创建一个jni文件夹,然后自己添加Android.mk
和Application.mk
2个文件,最后通过执行ndk-build
命令生成so库。
但是AndroidStudio自带编译so库功能,它会通过build.gradle里面的android.ndk
项自动生成Android.mk
文件然后生成so库,我们需要做的就是禁止它自带的功能,使用我们自己的mk文件。
实现步骤
- 禁止AndroidStudio自带的ndk功能。
- 添加gradle task自动调用
ndk-build
命令。
首先看下文件目录
2.配置
1.禁止AndroidStudio自带的ndk功能
完整配置请看build.gradle sourceSets
android {
//... 省略其他配置
sourceSets {
main {
jni.srcDirs = [] //禁止自带的ndk功能
jniLibs.srcDir 'src/main/libs' //重定向so目录为src/main/libs
}
}
}
2.添加gradle task自动调用ndk-build命令
完整配置请看build.gradle task
android {
//... 省略其他配置
tasks.withType(JavaCompile) {
compileTask -> compileTask.dependsOn ndkBuild
}
task ndkBuild(type: Exec, description: 'Compile JNI source with NDK') {
Properties properties = new Properties()
properties.load(project.rootProject.file('local.properties').newDataInputStream())
def ndkDir = properties.getProperty('ndk.dir')//获得ndk目录
//执行ndk-build命令
if (Os.isFamily(Os.FAMILY_WINDOWS)) {//如果是win系统
//commandLine "$ndkDir/ndk-build.cmd", 'NDK_DEBUG=1', '-C', file('src/main/jni').absolutePath //debug命令,如果需要做调试可以使用这条命令
commandLine "$ndkDir/ndk-build.cmd", '-C', file('src/main/jni').absolutePath//这里指定了jni的目录位置
} else {
//commandLine "$ndkDir/ndk-build", 'NDK_DEBUG=1', '-C', file('src/main/jni').absolutePath
commandLine "$ndkDir/ndk-build", '-C', file('src/main/jni').absolutePath
}
}
task ndkClean(type: Exec, description: 'Clean NDK Binaries') {
Properties properties = new Properties()
properties.load(project.rootProject.file('local.properties').newDataInputStream())
def ndkDir = properties.getProperty('ndk.dir')//获得ndk目录
//执行ndk-build clear命令
if (Os.isFamily(Os.FAMILY_WINDOWS)) {//如果是win系统
commandLine "$ndkDir/ndk-build.cmd", 'clean', '-C', file('src/main/jni').absolutePath
} else {
commandLine "$ndkDir/ndk-build", 'clean', '-C', file('src/main/jni').absolutePath
}
}
clean.dependsOn 'ndkClean'
}
- 在生成so库后可以把它注释了,不然jni文件多了生成会比较慢。
- 千万别忘了在
local.properties
里配置ndk.dir
不然会找不到ndk。
3.实现
在build.gradle
配置了上述语句后就可以自动生成so库了。
接下来让我们来实现一个HelloJni试下。
1.创建Application.mk和Android.mk文件
Application.mk文件非常简单,就是一句APP_ABI := all
,它的意思是生成所有架构的so库,在平常使用中我们一般会有选择性的设置为APP_ABI := armeabi armeabi-v7a x86
。
Android.mk文件比较复杂,推荐看《Android.mk、Application.mk》写的比较详细,我这里写的比较简单。
LOCAL_PATH := $(call my-dir)
include $(CLEAR_VARS)
LOCAL_MODULE := HelloJni#模块的名称,会在生成的so库前面加上lib,最终名称就是libHelloJni.so
LOCAL_SRC_FILES := HelloJni.cpp#要打包的源码
include $(BUILD_SHARED_LIBRARY)
2.创建Java文件
我们创建一个HelloJni.java文件,用于ndk交互,这个文件也特别简单,要注意的是我这里的hello()
方法用的static
,在jni里对应第二个参数为jclass
,如果不是静态方法,就会对应jobject
。
public class HelloJni {
public static native String hello();
}
3.创建C++文件
首先需要创建.h
文件,有二种创建方法,第一种就是手动创建,第二种就是利用javah.exe
这个工具创建,我们这里就利用第二种方法来创建这个.h
文件。
javah.exe
这个工具在jdk的bin
目录下,我们打开AndroidStudio的Terminal
窗口然后输入javah.exe -d app/src/main/jni -cp app/src/main/java com.xiuyukeji.ndk_config.HelloJni
回车后我们就能生成com_xiuyukeji_ndk_config_HelloJni.h文件。
这里有点需要注意,函数名对应java层的包名+类名+方法名
,如果不是自动生成,要检查下函数名是否对应,不然会报UnsatisfiedLinkError
错误。
/* DO NOT EDIT THIS FILE - it is machine generated */
#include <jni.h>
/* Header for class com_xiuyukeji_ndk_config_HelloJni */
#ifndef _Included_com_xiuyukeji_ndk_config_HelloJni
#define _Included_com_xiuyukeji_ndk_config_HelloJni
#ifdef __cplusplus
extern "C" {
#endif
/*
* Class: com_xiuyukeji_ndk_config_HelloJni
* Method: hello
* Signature: ()Ljava/lang/String;
*/
JNIEXPORT jstring JNICALL Java_com_xiuyukeji_ndk_1config_HelloJni_hello
(JNIEnv *, jclass);
#ifdef __cplusplus
}
#endif
#endif
我来解释下javah.exe
这条命令的意思,-d
代表输出目录在app/src/main/jni
,-cp
代表加载目录在app/src/main/java
,最后的com.xiuyukeji.ndk_config.HelloJni
就是文件名了。
javah.exe
这个工具可以看下这篇文章《超级简单的Android Studio jni 实现(无需命令行)》
- 如果提示找不到
javah.exe
就说明你的环境变量需要在path
里多加一句%JAVA_HOME%\bin
。
输出.h
文件后我们就可以开始写HelloJni.cpp了,代码特别简单,返回一个字符串Hello jni
,我这里加了个extern "C"
,意思是告诉编译器按照C进行编译,不加也可以,具体解释看这里《extern "c"用法解析》。
#include "com_xiuyukeji_ndk_config_HelloJni.h"
extern "C" {
JNIEXPORT jstring JNICALL Java_com_xiuyukeji_ndk_1config_HelloJni_hello(JNIEnv * env, jclass jc){
return (env)->NewStringUTF("Hello jni");
}
}
然后我们可以开始生成so库了,执行Build->Build APK命令。
最终会在lib下生成各个架构的so库。
4.调用So库
上面我们已经生成了so库,下面我们就需要在java层调用libHelloJni.so
里面的hello
函数。
- 在MainActivity里动态加载so库,一般加载so库都是利用
static {}
,这种写法叫静态代码块优先于其他代码执行。
static {
System.loadLibrary("HelloJni");
}
- 调用HelloJni.hello()语句。
public class MainActivity extends AppCompatActivity {
//... 省略其他代码
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
Toolbar toolbar = (Toolbar) findViewById(R.id.toolbar);
setSupportActionBar(toolbar);
FloatingActionButton fab = (FloatingActionButton) findViewById(R.id.fab);
fab.setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View view) {
Snackbar.make(view, HelloJni.hello(), Snackbar.LENGTH_LONG).show();
}
});
}
}
结尾
如果它有解决你的问题的话,请下点个赞,谢谢。
这是我个人的第三篇文章,写于2017年4月19日。