1. Hello World NDK
在开始实战练习前,你需要先大致了解运行一个 Hello World 的项目大概需要做什么,有哪些配置以及配置的具体意思。 Android Studio(2.2以上版本)提供两种方式编译原生库:CMake( 默认方式) 和 ndk-build。对于初学者可以先了解 CMake 的方式,另外,对于本文可以暂时不用了解 so 库如何编译和使用。
一个 Hello World 的 NDK 项目很简单,按照流程新建一个 native 库工程就可以,由于太简单,而且网上也有很多教程,这里就没必要浪费时间再用图文介绍了。详细操作方法,可以参考这篇文章,AS2.2使用CMake方式进行JNI/NDK开发-于连林- CSDN博客
列出项目中涉及 NDK 的内容或配置几点需要注意的地方:
.externalNativeBuild 文件是 CMake 编译好的文件,显示支持的各种硬件平台的信息,如 ARM、x86等;
cpp 文件是放置 native 文件的地方,名字可以修改成其他的(只要里面函数名字对应Java native 方法就好);
CMakeLists.txt,AS自动生成的 CMake 脚本配置文件
build.gradle 文件,注意两个 externalNativeBuild {}
的配置
local.properties 文件会多了 ndk 路径的配置
MainActivity 调用 so 库
另外,还需要回顾上篇 JNI 基础篇-静态注册也提到 JNI 的函数命名规则:JNIEXPORT 返回值 JNICALL Java_全路径类名_方法名_参数签名(JNIEnv* , jclass, 其它参数);
其中第二个参数,当 java native 方法是 static 时,为 jclass,当为非静态方法时,为 jobject,为了简单起见,下面的例子 JNI 函数都标记extern "C"
,函数名就不需要写参数签名了
2. JNI 函数访问 Java 对象的变量
注:以下练习中 Java native 方法都是非静态的
步骤:
1)通过
env->GetObjectClass(jobject)
获取Java 对象的 class 类,返回一个 jclass;2)调用
env->GetFieldID(jclazz, fieldName, signature)
得到该实例域(变量)的 id,即 jfieldID;如果变量是静态 static 的,则调用的方法为GetStaticFieldID
3)最后通过调用
env->Get{type}Field(jobject, fieldId)
得到该变量的值。其中{type} 是变量的类型;如果变量是静态 static 的,则调用的方法是GetStatic{type}Field(jclass, fieldId)
,注意 static 的话, 是使用 jclass 作为参数;
2.1 访问某个变量,并通过某个方法对其处理后返回
native方法定义和调用
C++层:
输出结果:
由于 jclass 也是继承 jobject,所以使用 GetIntField 时不要混淆两个参数
2.2 访问一个 static 变量,并对其修改
native方法定义和调用
C++代码:
输出结果:
需要注意的是,获取 java 静态变量,都是调用 JNI 相应静态的函数,不能调用非静态的,同时留意传入的参数是 jclass,而不是 jobject
2.3 访问一个 private 变量,并对其修改
native方法定义和调用
C++:
输出结果:
3. JNI 函数调用 Java 对象的方法
步骤:(和访问 Java 对象的变量有点类型)
1)通过
env->GetObjectClass(jobject)
获取Java 对象的 class 类,返回一个 jclass;2)通过
env->GetMethodID(jclass, methodName, sign)
获取到 Java 对象的方法 Id,即 jmethodID,当获取的方法是 static 的时,使用GetStaticMethodID
;3)通过 JNI 函数
env->Call{type}Method(jobject, jmethod, param...)
实现调用 Java的方法;若调用的是 static 方法,则使用CallStatic{type}Method(jclass, jmethod, param...)
,使用的是 jclass
3.1 调用 Java 公有方法
native方法定义和调用
C++
结果:
调用 java private 方法也是类似, Java 的访问域修饰符对 C++无效
3.2 调用 Java 静态方法
native方法定义和调用
C++
输出结果:MainActivity: 调用静态方法:getHeight() = 170
注意调用的静态方法要一致。
3.3 调用 Java 父类方法
native方法定义和调用
C++
注意两点不同的地方,
获取的是父类的方法,所以不能通过GetObjectClass获取,需要通过反射 FindClass 获取;
调用父类的方法是 CallNonvirtual{type}Method 函数。Nonvirtual是非虚拟函数
4. Java 方法传递参数给 JNI 函数
native 方法既可以传递基本类型参数给 JNI(可以不经过转换直接使用),也可以传递复杂的类型(需要转换为 C/C++ 的数据结构才能使用),如数组,String 或自定义的类等。
基础类型,这里就不举例子了,详细可以看 GitHub 上的源码: AndroidTrainingDemo/JNISample
要用到的 JNI 函数:
获取数组长度:
GetArrayLength(j{type}Array)
,type 为基础类型;数组转换为对应类型的指针:
Get{type}ArrayElements(jarr, 0)
获取构造函数的 jmethodID 时,仍然是用
env->GetMethodID(jclass, methodName, sign)
获取,方法 name 是<init>;通过构造函数 new 一个 jobject,
env->NewObject(jclass, constructorMethodID, param...)
,无参构造函数 param 则为空
4.1 数组参数的传递
计算整型数组参数的和
native方法定义和调用
C++
输出结果:MainActivity: intArrayMethod: 39
4.2 自定义对象参数的传递
Person 定义,native方法定义和调用
C++:
输出结果MainActivity: objectMethod: Person :{ name: cfanr, age: 21}
注意:传递对象时,获取的 jclass 是获取该参数对象的 jobject 获取,而不是第二个参数(定义该 native 方法的对象)取;
4.3 自定义对象的集合参数的传递
native方法定义和调用
C++
输出结果:
复杂的集合参数也是需要通过获取集合的 class 和对应的方法来调用实现的
5. JNI 函数的字符串处理
访问字符串函数
其中 isCopy 是取值为JNI_TRUE和JNI_FALSE(或者1,0),值为JNI_TRUE,表示返回JVM内部源字符串的一份拷贝,并为新产生的字符串分配内存空间。如果值为JNI_FALSE,表示返回JVM内部源字符串的指针,意味着可以通过指针修改源字符串的内容,不推荐这么做,因为这样做就打破了Java字符串不能修改的规定;Java默认使用Unicode编码,而C/C++默认使用UTF编码,所以在本地代码中操作字符串的时候,必须使用合适的JNI函数把jstring转换成C风格的字符串
- UTF-8字符:const char* GetStringUTFChars(jstring string, jboolean* isCopy)
- Unicode字符:const jchar* GetStringChars(jstring string, jboolean* isCopy)
释放字符串内存
UTF-8字符:
void ReleaseStringUTFChars(jstring string, const char* utf)
Unicode 字符:
void ReleaseStringChars(jstring string, const jchar* chars)
创建 String 对象,UTF-8: NewStringUTF,Unicode: NewString
取char*的长度,UTF-8: GetStringUTFLength,Unicode: GetStringLength
GetStringRegion和GetStringUTFRegion:分别表示获取Unicode和UTF-8编码字符串指定范围内的内容。这对函数会把源字符串复制到一个预先分配的缓冲区内。GetStringUTFRegion与 GetStringUTFChars 比较相似,不同的是,GetStringUTFRegion 内部不分配内存,不会抛出内存溢出异常。
代码示例就不写了,其他详细可参考:
JNI开发之旅(9)JNI函数字符串处理 - 猫的阁楼 - CSDN博客
JNI/NDK开发指南(四)——字符串处理 - 技术改变生活- CSDN博客
6. 动态注册 JNI
学了上面的练习,发现静态注册的方式还是挺麻烦的,生成的 JNI 函数名太长,文件、类名、变量或方法重构时,需要重新修改头文件或 C/C++ 内容代码(而且还是各个函数都要修改,没有一个统一的地方),动态注册 JNI 的方法就可以解决这个问题。
由上篇回顾下,Android NDK开发:JNI基础篇 | cfanr
动态注册 JNI 的原理:直接告诉 native 方法其在JNI 中对应函数的指针。通过使用 JNINativeMethod 结构来保存 Java native 方法和 JNI 函数关联关系,步骤:
先编写 Java 的 native 方法;
编写 JNI 函数的实现(函数名可以随便命名);
利用结构体 JNINativeMethod 保存Java native方法和 JNI函数的对应关系;
利用
registerNatives(JNIEnv* env)
注册类的所有本地方法;在 JNI_OnLoad 方法中调用注册方法;
在Java中通过System.loadLibrary加载完JNI动态库之后,会自动调用JNI_OnLoad函数,完成动态注册;
代码实例:
native 方法和调用:
C++动态注册 JNI 代码:
输出结果:
上面代码涉及到 JNI 调用 Android 的 Log,只需要引入#include "android/log.h"
头文件和对函数别名命名即可。其他具体说明见上面代码。
实际开发中可以采取动态和静态注册结合的方式,写一个Java 的 native 方法完成调用动态注册的代码,大概代码如下:
C++
7. 小结
虽然都是按照网上的例子做的练习记录,但还是遇到不少小问题的,不过只要仔细查找,也比较容易发现问题的所在,以前觉得 JNI 挺难懂的,但这次练习下来,觉得 JNI 也只不过是一套语法规则而已,按照规则去实现代码也不算特别难,当然这只是 JNI 的一小部分内容,JNI 还有很多内容,如反射、异常处理、多线程、NIO 等。虽然这次练习比较简单,但建议还是自己亲自敲一遍代码,在练习中发现问题,并解决,以后遇到同类型的问题也比较容易解决。
注意一些报错的问题:
如果没加 extern “C” 或者 没将 C/C++ 文件配置到 CMake 文件上,可能会报
java.lang.UnsatisfiedLinkError: Native method not found: xxx
错误一般报
java.lang.NoSuchMethodError: no method with xxx
错误,可能是因为 class 和方法不对应,env->GetObjectClass( jobject jobj)
这里用错了对象报
java.lang.NoClassDefFoundError
,可能是类名写错找不到类;
本文完整代码可以到 GitHub 查看源码: AndroidTrainingDemo/JNISample
评论