技术: JNI

JNI技术, 一种本来是用来写java虚拟机的技术, 后来被NDK玩坏了

“Java Native Interface” , 最初是在Android NDK编程的时候接触的.

近期正好总结跨语言编程实践, 那么正好也就写一写, 就当写了一个中文的简要参考手册.

(参考资料中的第一本书推荐一下)

引子

跨语言的调用怎么弄? 这个话题, 太大了, 我倒是可以给你推荐一个框架, 脸书的Thrift; 这里只考虑 Java 和 C 的互相调用的话(调用方向不一样,方式也有稍稍不同, 复杂度也不一样), 就引出了JNI技术(JNI本身是native接口, 但在编程框架中更像一种协议), 专门针对Java和C交互.

我想最初设计这个框架的人一定考虑了至少3个问题:

  • 跨语言对象的对接问题
  • 数据类型规格问题
  • 调用效率问题

JNI允许运行在Java虚拟机的Java代码与用其他语言(如C, C++和汇编)编写的库交互, 通过JNI, 可以在native code中完成至少下面的事情:

  • 创建、检查或者更新java对象
  • 调用java方法
  • 捕捉和抛出异常
  • 加载class和获取class信息
  • 运行时类型检查

理论太啰嗦了, 不说了. 下面详细介绍这些技术, 以及常见的开发流程.

正文

开发流程

Java主调C代码.

也就是说实现部分是在C, Java部分就是起到简单的调用.

根据Java代码, 使用相应的编译器Javap生成本地访问头文件, 然后C代码中引用该头文件, 返回操作结果. Java代码中虚拟机运行时加载相应的本地代码(可能需要LoadLibrary), 从而完成java代码调用C代码.

流程归纳起来就是:
编译,加载,链接本地方法.

  • 编译:
    java VM是多线程的 ,所以native libraries应该用多线程编译器来进行编译和链接。例如使用Sun Studio compiler编译器的时候,要为c++代码添加-mt标记;使用 GNU gcc compiler的时候,需添加-D_REENTRANT 或-D_POSIX_C_SOURCE
  • 加载
    native库通过System.loadLibrary方法进行加载。如:

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    package pkg;  

    class Cls {

    native double f(int i, String s);

    static {
    System.loadLibrary(“pkg_Cls”);
    }
    }

    系统会对library名会进行转换,在不同平台上有不同的转换方式,例如,Solaris系统转换pkg_Cls为libpkg_Cls.so,而Win32系统转换pkg_Cls为pkg_Cls.dll

  • 链接
    如果系统不支持动态链接,那么所有本地方法需要预链接到虚拟机,这种情况下,VM已经完成System.loadLibrary了。程序员也可以调用JNI函数RegisterNatives()来注册该类关联的本地方法

C主调Java代码

这个相对来说, 应该算作被动调用(需求比较少), C语言回调Java方法.

根据Java代码生成相应的C代码的步骤是一样的, javap -jni 包名.类名, 然后在本地代码中引入生成的头文件, 然后根据该头文件的函数, 给出函数实现.

但是在函数实现中, 就开始利用虚拟机的特性, 开始反射的写法了, 比如你的反射可能是这么写的:

1
2
3
Class<?> instance = Class.forName("com.example.Test");
Method declearMethod = instance.getDeclaredMethod("intMethod", new Class[]{});
declearMethod.invoke(instance.newInstance(), new Object[]{});

那么在本地代码写法也类似, 先要拿到Class类型, 之后找到方法(ID), 然后再进行调用处理, 核心代码可能是:

1
2
3
4
//在某本地函数体内 
jclass jclazz = (*env)->FindClass(env, "com/example/Test");
jmethodID methodId = (*env)->GetMethodID(env, jclazz, "intMethod", "()V"/*方法签名符号,约定参数和返回值*/);
(*env)->CallVoidMethod(env, jobject, methodId); //jobject是本地函数默认的参数

(如果是返回值的可能要用其他的JNI方法)

(方法签名可以看下面的规则, 得知其符号规则; 或者使用javap工具通过字节码拿到方法签名javap -s)

但是值得注意的是C回调Java代码, 是发生在Java代码调用C代码的时候, 发现自己被回调了; 毕竟运行都是在虚拟机的主导下(也就是说没有虚拟机环境是不行的).

C回调的方法一定要和jobject是同一个类型的(jobject实例所在的类), 如果你在该类的这个本地方法里, 调用其他Java类的方法, 还要增加处理:需要创建相关类的对象(就是拿到局部引用,AllObject或者NewObject方法)或者获取类的信息(静态方法调用GetStaticMethodID(), CallStaicVoidMethod()等), 例如

1
2
3
//先FindClass 返回一个jclass对象clazz, 并且拿到methodID
jobject obj = (*env)->AllocObject(env, clazz);
(*env)->CallVoidMethod(env, obj, methodId);

但是回调的场景, 最好还是放在同一个类吧, 不要跨类方法调用.

本地方法规范

Java方法, 如果转换(编译)到本地代码, 对应哪个方式其实是有讲究的, 例如:

1
2
3
4
5
6
7
8
package pkg;  

class Cls {
//对应本地方法名: Java_pkg_Cls_f__ILjava_lang_String_2,
//参数列表:JNIEnv *env,jobject obj,jint i,jstring s
native double f(int i, String s);

p}

下面就仔细讲解一下对应的映射或者编译规则.

命名符号解析

一个本地方法名有以下几个组成部分:

  • 前缀Java_
  • 完整类名(类名中的.用_代替)
  • 下划线_
  • 方法名(方法名中的特殊字符需要转义)
  • 参数签名(非必须,有重载方法的时候才需要),如果有重载的本地方法,需要再添加两个下划线_,然后再添加方法签名(由java字段描述符描述,用代替描述符中的包名分割/符,签名中的特殊字符需要转义)

关于转义:

  • _0XXXX 一个Unicode字符XXXX。注意小写是用来表示非ascii Unicode字符, 如:_0abcd与_0ABCD不相同
  • 1 字符
  • _2 参数签名中的字符;
  • _3 参数签名中的字符[

类型符号解析

注意这些规则, 对应的是用在函数或者参数名字上(java和c数据类型对应有另外一套规则)
命名中的类型(Java类型对应本地符号)规则, 如下:

1
2
3
4
5
6
7
8
9
Boolean		Z
Byte B
Char C
Short S
Int I
Long J (特殊)
Float F
Double D
Void V

特殊的有数组和对象:

1
2
3
4
5
6
数组:
"[类型" 表示, 如:int[]-> [I, int[][]-> [[I, Thread[]-> [Ljava/lang/Thread;

objects:
以"L"开头, 以";"结尾, 用"/" 隔开的包及类名. 比如: Ljava/lang/String;
如果是嵌套类, 则用$来表示嵌套, 例 Landroid/os/FileUtils$FileStatus;

参数解析

一个Java方法, 编译到native code会自然多出两个参数, 一个代表JNI接口指针类型(Java虚拟机环境), 另外一个是对象实例的引用(通俗来说就是this指针, 当然进程方法可以不用).

例如:
Java代码:

1
2
3
4
5
6
7
package pkg;  

class Cls {

native double f(int i, String s);

}

编译到C代码就是:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
/*c和c++在使用JNI接口的时候有点不一致, 
请仔细观察通过env调用接口的调用方式 */

//C版本
jdouble Java_pkg_Cls_f__ILjava_lang_String_2 (
JNIEnv *env, /* interface pointer */
jobject obj, /* "this" pointer */
jint i, /* argument #1 */
jstring s) /* argument #2 */
{
/* Obtain a C-copy of the Java string */
const char *str = (*env)->GetStringUTFChars(env, s, 0);

/* process the string */
...

/* Now we are done with str */
(*env)->ReleaseStringUTFChars(env, s, str);

return ...
}

//C++版本
extern "C" /* specify the C calling convention */
jdouble Java_pkg_Cls_f__ILjava_lang_String_2 (

JNIEnv *env, /* interface pointer */
jobject obj, /* "this" pointer */
jint i, /* argument #1 */
jstring s) /* argument #2 */
{

const char *str = env->GetStringUTFChars(s, 0);
...

env->ReleaseStringUTFChars(s, str);

return ...
}

对象类型解析

本地代码中的参数, 才不管你Java类的具体类型, 统一jobject类型;
当然也可以对应更细致(也不那么细致):
jobject

java对象引用:

  • 基本类型(如整型,字符等)在Java和native之间是采用值传递
  • Java对象采用的是引用(地址)传递(Java语言本身封装了指针)

全局引用&弱全局引用, 局部引用:

  • 局部引用在方法调用的时候有效,在方法调用结束之后会自动释放
  • 全局引用会一直可用,直到显式地对其进行释放
  • 弱全局引用跟全局引用的区别是弱全局引用持有的java对象可以被VM进行回收,所以才使用弱全局引用前,我们需要对其进行检测,看它对应的对象是否被回收了

JNIENV方法:

  • 返回的Java对象都是局部引用
  • 可以接受全局引用和全局引用

native方法: (C方法)

  • 可以返回局部或者全局引用
  • 接收的一般是局部引用(Java对象)

并且JNI允许程序从局部引用创建一个全局引用.

native代码中的局部的对象, 该怎么释放?

  • 在方法调用结束之后,我们依赖VM去帮我们释放所有局部引用
  • 以下几种情况下,我们应该显式地释放局部引用:
    • 方法中创建了一个比较大的java对象的,并持有其局部引用,使用完之后,如果接下来都不再需要使用了,如果仍然不对它进行释放的话,在方法结束之前,这个对象都不会进行释放,这样会对资源造成浪费
    • JNI会将创建的局部引用都存储在一个局部引用表中,如果这个表超过了最大容量限制,就会造成局部引用表溢出,使程序崩溃。比如在一个循环中创建局部引用,最好在每一轮循环中释放局部引用,否则随着循环次数增加,很可能就内存溢出了

局部引用仅仅在其创建的线程内有效(也就是占用的是本地代码的栈空间), native代码不能跨线程传递局部引用.

类型别名解析

上面的jint, 其实是JNI定义的别名(具体对应什么可以自己定义), 对应的可能是标准C中的long, 其实你也可以使用c语言标准中的int类型.

详细的信息可以参考下面:

1
2
3
4
5
6
7
8
9
10
Java 类型   JNI类型别名		 描述
boolean jboolean unsigned char, 8 bits
byte jbyte signed char, 8 bits
char jchar unsigned short, 16 bits
short jshort signed short, 16 bits
int jint signed long, 32 bits
long jlong __int64, signed long long, 64 bits
float jfloat float, 32 bits
double jdouble double 64 bits
void void N/A

别名
当然你也可以选择使用或者不用:(默认使用)

1
2
#define JNI_FALSE  0 
#define JNI_TRUE 1

注意到char使用的双字节编码, 而不是单字节编码,所以Java虚拟机的UTF-8字符串不可能有嵌入的空值; 并且不支持标准的四字节编码,用 two-times-three-byte 格式代替

调用Java方法

JNI允许native代码访问对象的成员以及调用它的方法,通过两个步骤即可实现访问,比如,我们需要调用cls中的f方法:

1
2
jmethodID mid = env->GetMethodID(cls, “f”, “(ILjava/lang/String;)D”);//mid可以重复使用
jdouble result = env->CallDoubleMethod(obj, mid, 10, str);

但是需要注意的是,字段ID或方法ID并不能防止VM卸载该类. 当类被卸载后, 方法ID和字段ID将变成不可用的. 因此,我们需要确保:

  • 持有class的引用,让它不被卸载,或者
  • 重新获取方法id或者字段id

关于jmethodID:
在C中, 字段和方法的 ID 是一个指向结构体的指针:

1
2
3
4
5
struct _jfieldID;                       /* opaque structure */
typedef struct _jfieldID* jfieldID; /* field IDs */

struct _jmethodID; /* opaque structure */
typedef struct _jmethodID* jmethodID; /* method IDs */

方法签名

1
2
//方法签名为:(ILjava/lang/String;[I)J 
long f (int n, String s, int[] arr);

异常处理

JNI不对空指针或非法参数类型等错误进行检测, 因为:

  • 检查所有可能的错误会降低方法执行的性能
  • 在很多时候,没有足够的运行时信息去进行检测
    程序员不得传递一个非法指针或者错误的类型给JNI函数, 否则可能会导致系统异常货虚拟机崩溃.

JNI允许本地方法抛出处理任何异常,也可以处理Java中抛出的异常,剩下没有处理的异常会继续给VM处理.

Java部分处理:

大多数情况下,JNI提供的方法通过返回错误码或者抛出java异常来处理错误,因此,程序中可以:

  • 检查JNI函数返回值
  • 调用 ExceptionOccurred() 方法,获取方法中抛出的异常

有两种情况下,程序需要优先检测java异常而不是先检测返回码:

  • 通过JNI调用Java方法的时候,需要ExceptionOccurred()检测是否在Java方法中抛出了异常
  • 一些访问数组的方法,它不返回错误码,但是会抛出 ArrayIndexOutOfBoundsException 或者 ArrayStoreException异常

本地部分处理

有两种方法可以在本地方法中处理异常:

  • 检测到异常的时候立即返回,异常将会在调用该本地代码的地方抛出
  • 在本地方法中调用ExceptionClear()清除异常,处理接下来的逻辑

异常抛出的时,本地方法需清除异常后,才能继续调用其他JNI接口方法.

有异常发生后,只有以下方法才能被安全调用:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
ExceptionOccurred()
ExceptionDescribe()
ExceptionClear()
ExceptionCheck()
ReleaseStringChars()
ReleaseStringUTFChars()
ReleaseStringCritical()
Release<Type>ArrayElements()
ReleasePrimitiveArrayCritical()
DeleteLocalRef()
DeleteGlobalRef()
DeleteWeakGlobalRef()
MonitorExit()
PushLocalFrame()
PopLocalFrame()

JNI接口详解

花时间阅读那个 jni.h, 以及参考文档.

JNI函数必须接受一个非空对象,你必须保证传入的参数不为空,JNI函数不需要再对它进行空指针判断.

返回码说明

1
2
3
4
5
6
7
#define JNI_OK          (0)         /* no error */
#define JNI_ERR (-1) /* generic error */
#define JNI_EDETACHED (-2) /* thread detached from the VM */
#define JNI_EVERSION (-3) /* JNI version error */

#define JNI_COMMIT 1 /* copy content, do not free buffer */
#define JNI_ABORT 2 /* free buffer w/o copying back */

接口代码说明

该部分比较多(1000多行), 有一定的注释

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
/**
* 返回本地方法接口的版本
*
* @param env JNI接口指针
*
* @return 高16位返回主版本号,低16位返回次版本号,
如在JDK/JRE 1.6中,返回0x00010006
也有可能返回 JNI_EDETACHED 和 JNI_EVERSION 错误码
*/
jint (*GetVersion)(JNIEnv *);


/**
* 从二进制的.class的数据缓冲区中加载类
*
* @param env JNI接口指针
* @param name UTF8编码的需要加载的类的名字
* @param loader 类加载器
* @param buf 包含.class字节码的数组
* @param bufLen 长度
*
* @return class对象或NULL
*
* @throws ClassFormatError 不是有效的class数据
* @throws ClassCircularityError 类或接口是自身的父类或自身继承了该接口
* @throws OutOfMemoryError 内存不足
* @throws SecurityException 如果该类是属于java包的
*/
jclass (*DefineClass)(JNIEnv *, const char *, jobject, const jbyte *, jsize);


/**
* 用于加载本地定义的类
*
* @param env JNI接口指针
* @param name 完整的包名("/"代替".") 或 数组类型字段描述("["开头,紧跟签名描述),
如"java/lang/String" for java.lang.String,
"[Ljava/lang/Object;" for java.lang.Object[]
*
* @return class对象或NULL
*
* @throws ClassFormatError 不是有效的class数据
* @throws ClassCircularityError 类或接口是自身的父类或自身继承了该接口
* @throws OutOfMemoryError 内存不足
* @throws NoClassDefFoundError 找不到name对应的class类
*/
jclass (*FindClass)(JNIEnv *, const char *);


/**
* 从java.lang.reflect.Method 或 java.lang.reflect.Constructor 获取method ID
*
* @param env JNI接口指针
* @param method java.lang.reflect.Method 或 java.lang.reflect.Constructor对象
*
* @return 方法ID
*/
jmethodID (*FromReflectedMethod)(JNIEnv *, jobject);


/**
* 从java.lang.reflect.Field获取field ID
*
* @param env JNI接口指针
* @param field java.lang.reflect.Field对象
*
* @return field ID
*/
jfieldID (*FromReflectedField)(JNIEnv *, jobject);


/**
* 从method ID获取 java.lang.reflect.Method 或 java.lang.reflect.Constructor 对象
*
* @param env JNI接口指针
* @param cls 该方法的类对象
* @param methodID 方法ID
* @param isStatic 是否静态方法
*
* @return java.lang.reflect.Method 或 java.lang.reflect.Constructor 对象
*
* @throws OutOfMemoryError 内存不足
*/
jobject (*ToReflectedMethod)(JNIEnv *, jclass, jmethodID, jboolean);


/**
* 如果clazz不是class对象或接口,则返回该class的超类
*
* @param env JNI接口指针
* @param clazz class对象
*
* @return 返回输入类的父类 或 NULL
*/
jclass (*GetSuperclass)(JNIEnv *, jclass);


/**
* class1是否可以安全地转换为class2,以下三种情况会返回TRUE
* 1. 当class1和class2是同一个java class的引用
* 2. class1是class2的子类
* 3. class2是class1的某个接口
*
* @param env JNI接口指针
* @param clazz1 class1
* @param clazz2 class2
*
* @return JNI_TRUE or JNI_FALSE
*/
jboolean (*IsAssignableFrom)(JNIEnv *, jclass, jclass);


/**
* 根据 field ID 获取 java.lang.reflect.Field 对象
*
* @param env JNI接口指针
* @param cls 该方法的类对象
* @param fieldID 字段ID
* @param isStatic 是否静态变量
*
* @return java.lang.reflect.Field 对象
*
* @throws OutOfMemoryError 内存不足
*/
jobject (*ToReflectedField)(JNIEnv *, jclass, jfieldID, jboolean);


/**
* 抛出异常
*
* @param env JNI接口指针
* @param obj java.lang.Throwable 对象
*
* @return 0:成功, 负数:失败
*
* @throws Throwable
*/
jint (*Throw)(JNIEnv *, jthrowable);


/**
* 根据clazz和message构造一个异常对象,并将它抛出
*
* @param env JNI接口指针
* @param clazz java.lang.Throwable的子类
* @param message 错误信息
*
* @return 0:成功, 负数:失败
*
* @throws Throwable
*/
jint (*ThrowNew)(JNIEnv *, jclass, const char *);


/**
* 判断是否有异常抛出,在调用ExceptionClear()或java代码处理了exception之前,都可以用这个方法判断是否有异常
*
* @param env JNI接口指针
*
* @return 异常对象 or NULL
*/
jthrowable (*ExceptionOccurred)(JNIEnv *);


/**
* 打印异常信息
*
* @param env JNI接口指针
*/
void (*ExceptionDescribe)(JNIEnv *);


/**
* 清除所有已抛出的异常
*
* @param env JNI接口指针
*/
void (*ExceptionClear)(JNIEnv *);


/**
* 抛出致命错误并且不希望虚拟机进行恢复。无返回值
*
* @param env JNI接口指针
* @param msg 错误信息
*/
void (*FatalError)(JNIEnv *, const char *);


/**
* 创建一个新的本地引用帧
*
* @param env JNI接口指针
* @param capacity 容量
*
* @return 0:成功,负数:失败
*
* @throws OutOfMemoryError
*/
jint (*PushLocalFrame)(JNIEnv *, jint);


/**
* 弹出当前本地引用帧,释放所有本地引用
*
* @param env JNI接口指针
* @param result
*
* @return
*/
jobject (*PopLocalFrame)(JNIEnv *, jobject);


/**
* 为传入的obj创建全局引用,obj可以是全局引用也可以是局部引用。全局引用需要调用DeleteGlobalRef来释放
*
* @param env JNI接口指针
* @param obj 全局或局部引用
*
* @return 全局引用 or NULL(内存不足)
*/
jobject (*NewGlobalRef)(JNIEnv *, jobject);


/**
* 释放全局引用
*
* @param env JNI接口指针
* @param globalRef 全局引用
*/
void (*DeleteGlobalRef)(JNIEnv *, jobject);


/**
* 释放局部引用
*
* @param env JNI接口指针
* @param localRef 局部引用
*/
void (*DeleteLocalRef)(JNIEnv *, jobject);


/**
* 判断两个引用是否同一java对象的引用
*
* @param env JNI接口指针
* @param ref1 引用1
* @param ref2 引用2
*
* @return JNI_TRUE:两个引用指向同一个java对象
*/
jboolean (*IsSameObject)(JNIEnv *, jobject, jobject);


/**
* 为传入的ref创建局部引用,ref可以是全局引用也可以是局部引用
*
* @param env JNI接口指针
* @param ref 全局或局部引用
*
* @return 局部引用 or NULL
*/
jobject (*NewLocalRef)(JNIEnv *, jobject);


/**
* 确保当前线程可以创建capacity个局部引用。在进入本地方法时,VM确保可以可以创建最少16个局部引用
*
* @param env JNI接口指针
* @param capacity 局部引用个数
*
* @return 0:成功,负数:失败
*
* @throws OutOfMemoryError 内存不足
*/
jint (*EnsureLocalCapacity)(JNIEnv *, jint);


/**
* 创建一个新的java对象(不会调用对象的构造方法)
*
* @param env JNI接口指针
* @param clazz 非数组class对象
*
* @return java对象
*
* @throws InstantiationException clazz是一个接口或抽象类
* @throws OutOfMemoryError 内存不足
*/
jobject (*AllocObject)(JNIEnv *, jclass);


/**
* 构造一个新的java对象,method ID指用以生成该类的构造方法,method ID必须是通过GetMethodID()获得
*
* @param env JNI接口指针
* @param clazz 非数组class对象
* @param ... 传递给构造方法的参数
*
* @return java对象 or NULL(对象构造失败)
*
* @throws InstantiationException clazz是一个接口或抽象类
* @throws OutOfMemoryError 内存不足
*/
jobject (*NewObject)(JNIEnv *, jclass, jmethodID, ...);


/**
* 构造一个新的java对象,method ID指用以生成该类的构造方法,method ID必须是通过GetMethodID()获得
*
* @param env JNI接口指针
* @param clazz 非数组class对象
* @param args va_list结构,里面有传递给构造方法的参数
*
* @return java对象 or NULL(对象构造失败)
*
* @throws InstantiationException clazz是一个接口或抽象类
* @throws OutOfMemoryError 内存不足
*/
jobject (*NewObjectV)(JNIEnv *, jclass, jmethodID, va_list);


/**
* 构造一个新的java对象,method ID指用以生成该类的构造方法,method ID必须是通过GetMethodID()获得
*
* @param env JNI接口指针
* @param clazz 非数组class对象
* @param args 参数数组,里面是传递给构造方法的参数
*
* @return java对象 or NULL(对象构造失败)
*
* @throws InstantiationException clazz是一个接口或抽象类
* @throws OutOfMemoryError 内存不足
*/
jobject (*NewObjectA)(JNIEnv *, jclass, jmethodID, jvalue *);


/**
* 返回对象对应的class对象
*
* @param env JNI接口指针
* @param obj 非空java对象
*
* @return class对象
*/
jclass (*GetObjectClass)(JNIEnv *, jobject);


/**
* 判断obj是否clazz的实例对象
*
* @param env JNI接口指针
* @param obj java对象
* @param clazz class对象
*
* @return
*/
jboolean (*IsInstanceOf)(JNIEnv *, jobject, jclass);


/**
* 返回非静态方法的method ID
*
* @param env JNI接口指针
* @param clazz class对象
* @param name 方法名
* @param sig 方法签名
*
* @return 方法ID or NULL
*
* @throws NoSuchMethodError 找不到对应的方法
* @throws ExceptionInInitializerError class初始化失败
* @throws OutOfMemoryError 内存不足
*/
jmethodID (*GetMethodID)(JNIEnv *, jclass, const char *, const char *);


/**
* Call<type>Method(JNIEnv *env, jobject obj, jmethodID methodID, ...);调用参数放到可变参数中
* Call<type>MethodA(JNIEnv *env, jobject obj, jmethodID methodID, const jvalue *args);调用参数放入jvalue数组
* Call<type>MethodV(JNIEnv *env, jobject obj, jmethodID methodID, va_list args);调用参数放入va_list结构中
*
* 以上三组调用接口都是根据 method ID调用java实例方法(非静态方法)的接口,其中method ID是通过GetMethodID()获取的
* 当这些方法用于调用java对象的私有方法或构造函数时,method ID必须从obj的真实类获取,而不应从其某个父类获取
* <type>是方法的返回类型,三类接口间唯一的区别是methodID参数之后调用参数的不同
*
*
* @param env JNI接口指针
* @param obj java对象
* @param methodID 方法ID
* @param args 调用参数
*
* @return java方法返回结果
*
* @throws java方法中可能抛出的异常
*/
jobject (*CallObjectMethod)(JNIEnv *, jobject, jmethodID, ...);
jobject (*CallObjectMethodV)(JNIEnv *, jobject, jmethodID, va_list);
jobject (*CallObjectMethodA)(JNIEnv *, jobject, jmethodID, jvalue *);
jboolean (*CallBooleanMethod)(JNIEnv *, jobject, jmethodID, ...);
jboolean (*CallBooleanMethodV)(JNIEnv *, jobject, jmethodID, va_list);
jboolean (*CallBooleanMethodA)(JNIEnv *, jobject, jmethodID, jvalue *);
jbyte (*CallByteMethod)(JNIEnv *, jobject, jmethodID, ...);
jbyte (*CallByteMethodV)(JNIEnv *, jobject, jmethodID, va_list);
jbyte (*CallByteMethodA)(JNIEnv *, jobject, jmethodID, jvalue *);
jchar (*CallCharMethod)(JNIEnv *, jobject, jmethodID, ...);
jchar (*CallCharMethodV)(JNIEnv *, jobject, jmethodID, va_list);
jchar (*CallCharMethodA)(JNIEnv *, jobject, jmethodID, jvalue *);
jshort (*CallShortMethod)(JNIEnv *, jobject, jmethodID, ...);
jshort (*CallShortMethodV)(JNIEnv *, jobject, jmethodID, va_list);
jshort (*CallShortMethodA)(JNIEnv *, jobject, jmethodID, jvalue *);
jint (*CallIntMethod)(JNIEnv *, jobject, jmethodID, ...);
jint (*CallIntMethodV)(JNIEnv *, jobject, jmethodID, va_list);
jint (*CallIntMethodA)(JNIEnv *, jobject, jmethodID, jvalue *);
jlong (*CallLongMethod)(JNIEnv *, jobject, jmethodID, ...);
jlong (*CallLongMethodV)(JNIEnv *, jobject, jmethodID, va_list);
jlong (*CallLongMethodA)(JNIEnv *, jobject, jmethodID, jvalue *);
jfloat (*CallFloatMethod)(JNIEnv *, jobject, jmethodID, ...);
jfloat (*CallFloatMethodV)(JNIEnv *, jobject, jmethodID, va_list);
jfloat (*CallFloatMethodA)(JNIEnv *, jobject, jmethodID, jvalue *);
jdouble (*CallDoubleMethod)(JNIEnv *, jobject, jmethodID, ...);
jdouble (*CallDoubleMethodV)(JNIEnv *, jobject, jmethodID, va_list);
jdouble (*CallDoubleMethodA)(JNIEnv *, jobject, jmethodID, jvalue *);
void (*CallVoidMethod)(JNIEnv *, jobject, jmethodID, ...);
void (*CallVoidMethodV)(JNIEnv *, jobject, jmethodID, va_list);
void (*CallVoidMethodA)(JNIEnv *, jobject, jmethodID, jvalue *);


/**
* CallNonvirtual<type>Method(JNIEnv *env, jobject obj, jclass clazz, jmethodID methodID, ...);调用参数放到可变参数中
* CallNonvirtual<type>MethodA(JNIEnv *env, jobject obj, jclass clazz, jmethodID methodID, const jvalue *args);调用参数放入jvalue数组
* CallNonvirtual<type>MethodV(JNIEnv *env, jobject obj, jclass clazz, jmethodID methodID, va_list args);调用参数放入va_list结构中
*
* 以上三组调用接口都是根据 method ID 和 class 调用java实例方法(非静态方法)的接口,其中method ID是基于clazz通过GetMethodID()获取的
* <type>是方法的返回类型,三类接口间唯一的区别是methodID参数之后调用参数的不同
* 注意,和Call<type>Method不同,如果子类重写了父类的方法,Call<type>Method调用的是子类的方法,如果想调用父类的方法,
* 则需要用CallNonvirtual<type>Method,这个方法可以传入父类的class和父类的method id,从而达到调用父类方法的效果
*
*
* @param env JNI接口指针
* @param clazz class对象
* @param obj java对象
* @param methodID 方法ID
* @param args 调用参数
*
* @return java方法返回结果
*
* @throws java方法中可能抛出的异常
*/
jobject (*CallNonvirtualObjectMethod)(JNIEnv *, jobject, jclass, jmethodID, ...);
jobject (*CallNonvirtualObjectMethodV)(JNIEnv *, jobject, jclass, jmethodID, va_list);
jobject (*CallNonvirtualObjectMethodA)(JNIEnv *, jobject, jclass, jmethodID, jvalue *);
jboolean (*CallNonvirtualBooleanMethod)(JNIEnv *, jobject, jclass, jmethodID, ...);
jboolean (*CallNonvirtualBooleanMethodV)(JNIEnv *, jobject, jclass, jmethodID, va_list);
jboolean (*CallNonvirtualBooleanMethodA)(JNIEnv *, jobject, jclass, jmethodID, jvalue *);
jbyte (*CallNonvirtualByteMethod)(JNIEnv *, jobject, jclass, jmethodID, ...);
jbyte (*CallNonvirtualByteMethodV)(JNIEnv *, jobject, jclass, jmethodID, va_list);
jbyte (*CallNonvirtualByteMethodA)(JNIEnv *, jobject, jclass, jmethodID, jvalue *);
jchar (*CallNonvirtualCharMethod)(JNIEnv *, jobject, jclass, jmethodID, ...);
jchar (*CallNonvirtualCharMethodV)(JNIEnv *, jobject, jclass, jmethodID, va_list);
jchar (*CallNonvirtualCharMethodA)(JNIEnv *, jobject, jclass, jmethodID, jvalue *);
jshort (*CallNonvirtualShortMethod)(JNIEnv *, jobject, jclass, jmethodID, ...);
jshort (*CallNonvirtualShortMethodV)(JNIEnv *, jobject, jclass, jmethodID, va_list);
jshort (*CallNonvirtualShortMethodA)(JNIEnv *, jobject, jclass, jmethodID, jvalue *);
jint (*CallNonvirtualIntMethod)(JNIEnv *, jobject, jclass, jmethodID, ...);
jint (*CallNonvirtualIntMethodV)(JNIEnv *, jobject, jclass, jmethodID, va_list);
jint (*CallNonvirtualIntMethodA)(JNIEnv *, jobject, jclass, jmethodID, jvalue *);
jlong (*CallNonvirtualLongMethod)(JNIEnv *, jobject, jclass, jmethodID, ...);
jlong (*CallNonvirtualLongMethodV)(JNIEnv *, jobject, jclass, jmethodID, va_list);
jlong (*CallNonvirtualLongMethodA)(JNIEnv *, jobject, jclass, jmethodID, jvalue *);
jfloat (*CallNonvirtualFloatMethod)(JNIEnv *, jobject, jclass, jmethodID, ...);
jfloat (*CallNonvirtualFloatMethodV)(JNIEnv *, jobject, jclass, jmethodID, va_list);
jfloat (*CallNonvirtualFloatMethodA)(JNIEnv *, jobject, jclass, jmethodID, jvalue *);
jdouble (*CallNonvirtualDoubleMethod)(JNIEnv *, jobject, jclass, jmethodID, ...);
jdouble (*CallNonvirtualDoubleMethodV)(JNIEnv *, jobject, jclass, jmethodID, va_list);
jdouble (*CallNonvirtualDoubleMethodA)(JNIEnv *, jobject, jclass, jmethodID, jvalue *);
void (*CallNonvirtualVoidMethod)(JNIEnv *, jobject, jclass, jmethodID, ...);
void (*CallNonvirtualVoidMethodV)(JNIEnv *, jobject, jclass, jmethodID, va_list);
void (*CallNonvirtualVoidMethodA)(JNIEnv *, jobject, jclass, jmethodID, jvalue *);


/**
* 根据class对象获取非静态成员变量的field ID
*
* @param env JNI接口指针
* @param clazz class对象
* @param name 变量名
* @param sig 变量签名
*
* @return field ID or NULL
*
* @throws NoSuchFieldError 找不到对应的变量ID
* @throws ExceptionInInitializerError class初始化失败
* @throws OutOfMemoryError 内存不足
*/
jfieldID (*GetFieldID)(JNIEnv *, jclass, const char *, const char *);


/**
* 根据field id取出对象中相应的变量值,field Id通过GetFieldID()获取
*
* @param env JNI接口指针
* @param obj java对象
* @param fieldID 有效的field id
*
* @return 相应的变量值
*/
jobject (*GetObjectField)(JNIEnv *, jobject, jfieldID);
jboolean (*GetBooleanField)(JNIEnv *, jobject, jfieldID);
jbyte (*GetByteField)(JNIEnv *, jobject, jfieldID);
jchar (*GetCharField)(JNIEnv *, jobject, jfieldID);
jshort (*GetShortField)(JNIEnv *, jobject, jfieldID);
jint (*GetIntField)(JNIEnv *, jobject, jfieldID);
jlong (*GetLongField)(JNIEnv *, jobject, jfieldID);
jfloat (*GetFloatField)(JNIEnv *, jobject, jfieldID);
jdouble (*GetDoubleField)(JNIEnv *, jobject, jfieldID);


/**
* 根据field id为相应的变量设置新的值,field Id通过GetFieldID()获取
*
* @param env JNI接口指针
* @param obj java对象
* @param fieldID 有效的field id
* @param value 要设置的值
*/
void (*SetObjectField)(JNIEnv *, jobject, jfieldID, jobject);
void (*SetBooleanField)(JNIEnv *, jobject, jfieldID, jboolean);
void (*SetByteField)(JNIEnv *, jobject, jfieldID, jbyte);
void (*SetCharField)(JNIEnv *, jobject, jfieldID, jchar);
void (*SetShortField)(JNIEnv *, jobject, jfieldID, jshort);
void (*SetIntField)(JNIEnv *, jobject, jfieldID, jint);
void (*SetLongField)(JNIEnv *, jobject, jfieldID, jlong);
void (*SetFloatField)(JNIEnv *, jobject, jfieldID, jfloat);
void (*SetDoubleField)(JNIEnv *, jobject, jfieldID, jdouble);


/**
* 返回静态方法的method ID
*
* @param env JNI接口指针
* @param clazz class对象
* @param name 方法名
* @param sig 方法签名
*
* @return 方法ID or NULL
*
* @throws NoSuchMethodError 找不到对应的方法
* @throws ExceptionInInitializerError class初始化失败
* @throws OutOfMemoryError 内存不足
*/
jmethodID (*GetStaticMethodID)(JNIEnv *, jclass, const char *, const char *);


/**
* CallStatic<type>Method(JNIEnv *env, jclass clazz, jmethodID methodID, ...);调用参数放到可变参数中
* CallStatic<type>MethodA(JNIEnv *env, jclass clazz, jmethodID methodID, const jvalue *args);调用参数放入jvalue数组
* CallStatic<type>MethodV(JNIEnv *env, jclass clazz, jmethodID methodID, va_list args);调用参数放入va_list结构中
*
* 以上三组调用接口都是根据 method ID调用java静态方法的接口,其中method ID是通过GetStaticMethodID()获取的
* method ID必须从clazz的真实类获取,而不应从其某个父类获取
* <type>是方法的返回类型,三类接口间唯一的区别是methodID参数之后调用参数的不同
*
*
* @param env JNI接口指针
* @param clazz class对象
* @param methodID 方法ID
* @param args 调用参数
*
* @return java方法返回结果
*
* @throws java方法中可能抛出的异常
*/
jobject (*CallStaticObjectMethod)(JNIEnv *, jclass, jmethodID, ...);
jobject (*CallStaticObjectMethodV)(JNIEnv *, jclass, jmethodID, va_list);
jobject (*CallStaticObjectMethodA)(JNIEnv *, jclass, jmethodID, jvalue *);
jboolean (*CallStaticBooleanMethod)(JNIEnv *, jclass, jmethodID, ...);
jboolean (*CallStaticBooleanMethodV)(JNIEnv *, jclass, jmethodID, va_list);
jboolean (*CallStaticBooleanMethodA)(JNIEnv *, jclass, jmethodID, jvalue *);
jbyte (*CallStaticByteMethod)(JNIEnv *, jclass, jmethodID, ...);
jbyte (*CallStaticByteMethodV)(JNIEnv *, jclass, jmethodID, va_list);
jbyte (*CallStaticByteMethodA)(JNIEnv *, jclass, jmethodID, jvalue *);
jchar (*CallStaticCharMethod)(JNIEnv *, jclass, jmethodID, ...);
jchar (*CallStaticCharMethodV)(JNIEnv *, jclass, jmethodID, va_list);
jchar (*CallStaticCharMethodA)(JNIEnv *, jclass, jmethodID, jvalue *);
jshort (*CallStaticShortMethod)(JNIEnv *, jclass, jmethodID, ...);
jshort (*CallStaticShortMethodV)(JNIEnv *, jclass, jmethodID, va_list);
jshort (*CallStaticShortMethodA)(JNIEnv *, jclass, jmethodID, jvalue *);
jint (*CallStaticIntMethod)(JNIEnv *, jclass, jmethodID, ...);
jint (*CallStaticIntMethodV)(JNIEnv *, jclass, jmethodID, va_list);
jint (*CallStaticIntMethodA)(JNIEnv *, jclass, jmethodID, jvalue *);
jlong (*CallStaticLongMethod)(JNIEnv *, jclass, jmethodID, ...);
jlong (*CallStaticLongMethodV)(JNIEnv *, jclass, jmethodID, va_list);
jlong (*CallStaticLongMethodA)(JNIEnv *, jclass, jmethodID, jvalue *);
jfloat (*CallStaticFloatMethod)(JNIEnv *, jclass, jmethodID, ...);
jfloat (*CallStaticFloatMethodV)(JNIEnv *, jclass, jmethodID, va_list);
jfloat (*CallStaticFloatMethodA)(JNIEnv *, jclass, jmethodID, jvalue *);
jdouble (*CallStaticDoubleMethod)(JNIEnv *, jclass, jmethodID, ...);
jdouble (*CallStaticDoubleMethodV)(JNIEnv *, jclass, jmethodID, va_list);
jdouble (*CallStaticDoubleMethodA)(JNIEnv *, jclass, jmethodID, jvalue *);
void (*CallStaticVoidMethod)(JNIEnv *, jclass, jmethodID, ...);
void (*CallStaticVoidMethodV)(JNIEnv *, jclass, jmethodID, va_list);
void (*CallStaticVoidMethodA)(JNIEnv *, jclass, jmethodID, jvalue *);


/**
* 根据class对象获取静态成员变量的field ID
*
* @param env JNI接口指针
* @param clazz class对象
* @param name 变量名
* @param sig 变量签名
*
* @return field ID or NULL
*
* @throws NoSuchFieldError 找不到对应的变量ID
* @throws ExceptionInInitializerError class初始化失败
* @throws OutOfMemoryError 内存不足
*/
jfieldID (*GetStaticFieldID)(JNIEnv *, jclass, const char *, const char *);


/**
* 根据field id取出对象中相应的变量值,field Id通过GetStaticFieldID()获取
*
* @param env JNI接口指针
* @param clazz class对象
* @param fieldID 有效的field id
*
* @return 相应的静态变量值
*/
jobject (*GetStaticObjectField)(JNIEnv *, jclass, jfieldID);
jboolean (*GetStaticBooleanField)(JNIEnv *, jclass, jfieldID);
jbyte (*GetStaticByteField)(JNIEnv *, jclass, jfieldID);
jchar (*GetStaticCharField)(JNIEnv *, jclass, jfieldID);
jshort (*GetStaticShortField)(JNIEnv *, jclass, jfieldID);
jint (*GetStaticIntField)(JNIEnv *, jclass, jfieldID);
jlong (*GetStaticLongField)(JNIEnv *, jclass, jfieldID);
jfloat (*GetStaticFloatField)(JNIEnv *, jclass, jfieldID);
jdouble (*GetStaticDoubleField)(JNIEnv *, jclass, jfieldID);


/**
* 根据field id为相应的静态变量设置新的值,field Id通过GetStaticFieldID()获取
*
* @param env JNI接口指针
* @param clazz class对象
* @param fieldID 有效的field id
* @param value 要设置的值
*/
void (*SetStaticObjectField)(JNIEnv *, jclass, jfieldID, jobject);
void (*SetStaticBooleanField)(JNIEnv *, jclass, jfieldID, jboolean);
void (*SetStaticByteField)(JNIEnv *, jclass, jfieldID, jbyte);
void (*SetStaticCharField)(JNIEnv *, jclass, jfieldID, jchar);
void (*SetStaticShortField)(JNIEnv *, jclass, jfieldID, jshort);
void (*SetStaticIntField)(JNIEnv *, jclass, jfieldID, jint);
void (*SetStaticLongField)(JNIEnv *, jclass, jfieldID, jlong);
void (*SetStaticFloatField)(JNIEnv *, jclass, jfieldID, jfloat);
void (*SetStaticDoubleField)(JNIEnv *, jclass, jfieldID, jdouble);


/**
* 创建一个新的java.lang.String对象
*
* @param env JNI接口指针
* @param unicodeChars 指向Unicode字符串的指针
* @param len Unicode字符串的长度
*
* @return String对象 or NULL
*
* @throws OutOfMemoryError 内存不足
*/
jstring (*NewString)(JNIEnv *, const jchar *, jsize);


/**
* 返回java.lang.String的长度(Unicode字符数)
*
* @param env JNI接口指针
* @param string String对象
*
* @return 长度
*/
jsize (*GetStringLength)(JNIEnv *, jstring);


/**
* 返回指向Unicode字符数组的指针
* 该指针在调用ReleaseStringchars()前一直有效
* 如果isCopy非空,则在复制完成后将*isCopy设为JNI_TRUE。否则设为JNI_FALSE
*
* @param env JNI接口指针
* @param string String对象
* @param isCopy 指向boolean的指针
*
* @return 指向字符串的指针 or NULL
*/
const jchar *(*GetStringChars)(JNIEnv *, jstring, jboolean *);


/**
* 通知VM无需再访问chars
* chars是一个指针,通过GetStringChars()
*
* @param env JNI接口指针
* @param string String对象
* @param chars 指向字符串的指针
*/
void (*ReleaseStringChars)(JNIEnv *, jstring, const jchar *);


/**
* 根据UTF-8编码的字符数组创建一个新的java.lang.String对象
*
* @param env JNI接口指针
* @param bytes 指向UTF-8字符串的指针
*
* @return String对象 or NULL
*
* @throws OutOfMemoryError 内存不足
*/
jstring (*NewStringUTF)(JNIEnv *, const char *);


/**
* 返回字符串以UTF-8为编码的字节数
*
* @param env JNI接口指针
* @param string String对象
*
* @return 字符串的UTF-8字节数
*/
jsize (*GetStringUTFLength)(JNIEnv *, jstring);


/**
* 返回指向UTF-8编码字符数组的指针
* 该指针在调用ReleaseStringUTFChars()前一直有效
* 如果isCopy非空,则在复制完成后将*isCopy设为JNI_TRUE。否则设为JNI_FALSE
*
* @param env JNI接口指针
* @param string String对象
* @param isCopy 指向boolean的指针
*
* @return 指向字符串的指针 or NULL
*/
const char *(*GetStringUTFChars)(JNIEnv *, jstring, jboolean *);


/**
* 通知VM无需再访问utf
* utf是一个指针,通过GetStringUTFChars()
*
* @param env JNI接口指针
* @param string String对象
* @param utf 指向字符串的指针
*/
void (*ReleaseStringUTFChars)(JNIEnv *, jstring, const char *);


/**
* 获取数组元素个数
*
* @param env JNI接口指针
* @param array java数组对象
*
* @return 数组长度
*/
jsize (*GetArrayLength)(JNIEnv *, jarray);


/**
* 创建新的elementClass类型数组,所有元素初始值均设为initialElement
*
* @param env JNI接口指针
* @param length 数组大小
* @param elementClass 数组类型
* @param initialElement 初始值
*
* @return 数组对象 or NULL
*/
jobjectArray (*NewObjectArray)(JNIEnv *, jsize, jclass, jobject);


/**
* 获取对象数组中指定index的值
*
* @param env JNI接口指针
* @param array java数组
* @param index 索引
*
* @return 索引对象的对象
*
* @throws ArrayIndexOutOfBoundsException
*/
jobject (*GetObjectArrayElement)(JNIEnv *, jobjectArray, jsize);


/**
* 设置对象数组中指定index的值
*
* @param env JNI接口指针
* @param array java数组
* @param index 索引
* @param value 新的值
*
* @throws ArrayIndexOutOfBoundsException
*/
void (*SetObjectArrayElement)(JNIEnv *, jobjectArray, jsize, jobject);


/**
* ArrayType New<PrimitiveType>Array(JNIEnv *env, jsize length);
* 创建基本类型数组对象
*
* @param env JNI接口指针
* @param length 数组大小
*
* @return 数组对象 or NULL
*/
jbooleanArray (*NewBooleanArray)(JNIEnv *, jsize);
jbyteArray (*NewByteArray)(JNIEnv *, jsize);
jcharArray (*NewCharArray)(JNIEnv *, jsize);
jshortArray (*NewShortArray)(JNIEnv *, jsize);
jintArray (*NewIntArray)(JNIEnv *, jsize);
jlongArray (*NewLongArray)(JNIEnv *, jsize);
jfloatArray (*NewFloatArray)(JNIEnv *, jsize);
jdoubleArray (*NewDoubleArray)(JNIEnv *, jsize);


/**
* NativeType *Get<PrimitiveType>ArrayElements(JNIEnv *env, ArrayType array, jboolean *isCopy);
* 返回基本类型数组中的数据,通过返回的指针可以访问这些数据,若虚拟机支持pinning,则指针指向原始数组,否则指向原始数组的拷贝
* 返回的指针在Release<PrimitiveType>ArrayElements()调用前一直有效
* 数组用使用结束后,调用Release<PrimitiveType>ArrayElements,并在调用参数中决定是否把修改提交给java
*
* @param env JNI接口指针
* @param array java数组
* @param isCopy 指向boolean的指针,若不为NULL,则执行了复制设为JNI_TRUE,否则设为JNI_FALSE
*
* @return 指向数组元素的指针 or NULL
*/
jboolean *(*GetBooleanArrayElements)(JNIEnv *, jbooleanArray, jboolean *);
jbyte *(*GetByteArrayElements)(JNIEnv *, jbyteArray, jboolean *);
jchar *(*GetCharArrayElements)(JNIEnv *, jcharArray, jboolean *);
jshort *(*GetShortArrayElements)(JNIEnv *, jshortArray, jboolean *);
jint *(*GetIntArrayElements)(JNIEnv *, jintArray, jboolean *);
jlong *(*GetLongArrayElements)(JNIEnv *, jlongArray, jboolean *);
jfloat *(*GetFloatArrayElements)(JNIEnv *, jfloatArray, jboolean *);
jdouble *(*GetDoubleArrayElements)(JNIEnv *, jdoubleArray, jboolean *);


/**
* Release<PrimitiveType>ArrayElements
* 通知VM不再需要访问这些数组,根据mode参数的不同,将决定是否把数组的修改复制到源数组
*
* @param env JNI接口指针
* @param array java数组对象
* @param elems 指向数组元素的指针
* @param mode 释放模式,0:把数据复制回源数组并释放elems缓冲区,JNI_COMMIT:把数据复制回源数组但不释放elems缓冲区,JNI_ABORT:不把数据复制回源数组,释放elems缓冲区
*/
void (*ReleaseBooleanArrayElements)(JNIEnv *, jbooleanArray, jboolean *, jint);
void (*ReleaseByteArrayElements)(JNIEnv *, jbyteArray, jbyte *, jint);
void (*ReleaseCharArrayElements)(JNIEnv *, jcharArray, jchar *, jint);
void (*ReleaseShortArrayElements)(JNIEnv *, jshortArray, jshort *, jint);
void (*ReleaseIntArrayElements)(JNIEnv *, jintArray, jint *, jint);
void (*ReleaseLongArrayElements)(JNIEnv *, jlongArray, jlong *, jint);
void (*ReleaseFloatArrayElements)(JNIEnv *, jfloatArray, jfloat *, jint);
void (*ReleaseDoubleArrayElements)(JNIEnv *, jdoubleArray, jdouble *, jint);


/**
* void Get<PrimitiveType>ArrayRegion(JNIEnv *env, ArrayType array, jsize start, jsize len, NativeType *buf);
* 把基本类型数组拷贝到buf中
*
* @param env JNI接口指针
* @param array java数组
* @param start 开始index
* @param len 拷贝长度
* @param buf 目标地址
*
* @throws ArrayIndexOutOfBoundsException
*/
void (*GetBooleanArrayRegion)(JNIEnv *, jbooleanArray, jsize, jsize, jboolean *);
void (*GetByteArrayRegion)(JNIEnv *, jbyteArray, jsize, jsize, jbyte *);
void (*GetCharArrayRegion)(JNIEnv *, jcharArray, jsize, jsize, jchar *);
void (*GetShortArrayRegion)(JNIEnv *, jshortArray, jsize, jsize, jshort *);
void (*GetIntArrayRegion)(JNIEnv *, jintArray, jsize, jsize, jint *);
void (*GetLongArrayRegion)(JNIEnv *, jlongArray, jsize, jsize, jlong *);
void (*GetFloatArrayRegion)(JNIEnv *, jfloatArray, jsize, jsize, jfloat *);
void (*GetDoubleArrayRegion)(JNIEnv *, jdoubleArray, jsize, jsize, jdouble *);


/**
* void Set<PrimitiveType>ArrayRegion(JNIEnv *env, ArrayType array, jsize start, jsize len, const NativeType *buf);
* 把buf中的内容拷贝回数组中
*
* @param env JNI接口指针
* @param array java数组
* @param start 开始index
* @param len 拷贝长度
* @param buf 源数据
*
* @throws ArrayIndexOutOfBoundsException
*/
void (*SetBooleanArrayRegion)(JNIEnv *, jbooleanArray, jsize, jsize, const jboolean *);
void (*SetByteArrayRegion)(JNIEnv *, jbyteArray, jsize, jsize, const jbyte *);
void (*SetCharArrayRegion)(JNIEnv *, jcharArray, jsize, jsize, const jchar *);
void (*SetShortArrayRegion)(JNIEnv *, jshortArray, jsize, jsize, const jshort *);
void (*SetIntArrayRegion)(JNIEnv *, jintArray, jsize, jsize, const jint *);
void (*SetLongArrayRegion)(JNIEnv *, jlongArray, jsize, jsize, const jlong *);
void (*SetFloatArrayRegion)(JNIEnv *, jfloatArray, jsize, jsize, const jfloat *);
void (*SetDoubleArrayRegion)(JNIEnv *, jdoubleArray, jsize, jsize, const jdouble *);


/**
* 为clazz类注册本地方法
*
* @param env JNI接口指针
* @param clazz class对象
* @param methods clazz类中的本地方法,指向方法数组
* @param nMethods 本地方法个数
*
* @return 0:成功, 负数:失败
*
* @throws NoSuchMethodError
*/
jint (*RegisterNatives)(JNIEnv *, jclass, const JNINativeMethod *, jint);


/**
* 取消clazz类本地方法的注册
*
* @param env JNI接口指针
* @param clazz class对象
*
* @return 0:成功, 负数:失败
*/
jint (*UnregisterNatives)(JNIEnv *, jclass);


/**
* 进入与obj所引用的Java对象相关联的监控,obj 必须为非空
*
* @param env JNI接口指针
* @param obj java对象 或 class对象
*
* @return 0:成功, 负数:失败
*/
jint (*MonitorEnter)(JNIEnv *, jobject);


/**
* 退出与obj所引用的Java对象相关联的监控,obj 必须为非空
* 当前线程必须是与obj所引用的Java对象相关联的监控程序的所有者
* 监控程序次数的计数器减 1。如果计数器的值变为 0,则释放当前线程的监控程序
*
* @param env JNI接口指针
* @param obj java对象 或 class对象
*
* @return 0:成功, 负数:失败
*/
jint (*MonitorExit)(JNIEnv *, jobject);


/**
* 获取当前线程关联的Java VM接口
*
* @param env JNI接口指针
* @param vm java VM接口指针
*
* @return 0:成功, 负数:失败
*/
jint (*GetJavaVM)(JNIEnv *, JavaVM **);


/**
* 从start index开始,拷贝len个Unicode字符到buf
*
* @param env JNI接口指针
* @param str string对象
* @param start 开始index
* @param len 拷贝长度
* @param buf 目标地址
*
* @throws StringIndexOutOfBoundsException
*/
void (*GetStringRegion)(JNIEnv *, jstring, jsize, jsize, jchar *);


/**
* 从start index开始,取出len个Unicode字符转换为UTF-8编码后拷贝到buf
*
* @param env JNI接口指针
* @param str string对象
* @param start 开始index
* @param len 拷贝长度
* @param buf 目标地址
*
* @throws StringIndexOutOfBoundsException
*/
void (*GetStringUTFRegion)(JNIEnv *, jstring, jsize, jsize, char *);


/**
* 与Get/Release<primitivetype>ArrayElements方法非常相似,在这个方法中VM尽量返回指向原始数组的指针
*
* @since JDK/JRE 1.2
*
* @param env JNI接口指针
* @param array java数组
* @param isCopy 指向boolean的指针,若不为NULL,则执行了复制设为JNI_TRUE,否则设为JNI_FALSE
*
* @return 指向数组元素的指针 or NULL
*/
void *(*GetPrimitiveArrayCritical)(JNIEnv *, jarray, jboolean *);
void (*ReleasePrimitiveArrayCritical)(JNIEnv *, jarray, void *, jint);


/**
* 与Get/ReleaseStringChars方法非常相似,在这个方法中VM尽量返回指向原始字符串的指针
*
* @since JDK/JRE 1.2
*
* @param env JNI接口指针
* @param string String对象
* @param isCopy 指向boolean的指针
*
* @return 指向字符串的指针 or NULL
*/
const jchar *(*GetStringCritical)(JNIEnv *, jstring, jboolean *);
void (*ReleaseStringCritical)(JNIEnv *, jstring, const jchar *);


/**
* 为传入的obj创建弱全局引用
* 弱全局引用不会阻止VM释放所引用的对象,程序中可以通过使用IsSameObject比较弱全局引用和NULL来确认所引用的对象是否被释放
*
* @param env JNI接口指针
* @param obj 全局或局部引用
*
* @return 弱全局引用 or NULL
*/
jweak (*NewWeakGlobalRef)(JNIEnv *, jobject);


/**
* 删除弱全局引用
*
* @param env JNI接口指针
* @param obj 弱全局引用
*/
void (*DeleteWeakGlobalRef)(JNIEnv *, jweak);


/**
* 判断是否有未处理异常
*
* @param env JNI接口指针
*
* @return JNI_TRUE表示有未处理异常,否则为JNI_FALSE
*/
jboolean (*ExceptionCheck)(JNIEnv *);


/**
* 创建并返回java.nio.ByteBuffer对象,该对象引用以address为开始地址,大小为capacity的内存块
*
* @since JDK/JRE 1.4
*
* @param env JNI接口指针
* @param address 开始地址
* @param capacity 内存大小
*
* @return Jjava.nio.ByteBuffer or NULL
*
* @throws OutOfMemoryError
*/
jobject (*NewDirectByteBuffer)(JNIEnv *, void *, jlong);


/**
* 根据java.nio.ByteBuffer对象,获取相应的内存数据并返回开始地址
*
* @since JDK/JRE 1.4
*
* @param env JNI接口指针
* @param buf java.nio.ByteBuffer对象
*
* @return 数据的开始地址 or NULL
*/
void *(*GetDirectBufferAddress)(JNIEnv *, jobject);


/**
* 根据java.nio.ByteBuffer对象,获取相应的内存数据的大小
*
* @since JDK/JRE 1.4
*
* @param env JNI接口指针
* @param buf java.nio.ByteBuffer对象
*
* @return 数据大小 or -1
*/
jlong (*GetDirectBufferCapacity)(JNIEnv *, jobject);


/**
* 获取java对象的引用类型,可能的返回值有:
* JNIInvalidRefType
* JNILocalRefType:局部引用
* JNIGlobalRefType:全局引用
* JNIWeakGlobalRefType :全局弱若引用
*
* @since JDK/JRE 1.6
*
* @param env JNI接口指针
* @param obj java对象的引用
*
* @return 引用类型
*/
jobjectRefType (*GetObjectRefType)(JNIEnv *, jobject);

简单案例

一般用的最多的就是Java调用C的实现, 下面给出了一个非常简单的例子:

1
2
3
4
5
6
7
8
9
10
11
JNIEXPORT jintArray JNICALL Java_com_example_Test_intMethod
(JNIENV *env, jobject jobject, jintArray jarray) {
//遍历数组元素, 每个元素+5; 最后返回原数组
int length = (*env)->GetArrayLength(env, jarray);
int *array = (*env)->GetINtArrayElements(env,jarray,0);

for(int i=0; i < length; ++i) {
*(array+i) += 5;
}
return jarray;
}

尾巴

jni本身还是比较简单的, 因为机制比较成熟了. 基本的规则, 本文已经讲了非常多了, 关键还是要熟悉 jni.h 这个文件里的相关API.

先这样, 以后用到了再来详细搞.

参考资料

  1. 《the JNI Programmer’s Guide and Specification》 主要参考资料, 把这本好好读读就可以了
  2. http://docs.oracle.com/javase/7/docs/technotes/guides/jni/ 主要参考资料
  3. JNI编程指南 网上找的比较偏理论的讲解,80多页
  4. http://blog.csdn.net/shensky711/article/details/52806794 作者写的太乱了
文章目录
  1. 1. 引子
  2. 2. 正文
    1. 2.1. 开发流程
      1. 2.1.1. Java主调C代码.
      2. 2.1.2. C主调Java代码
    2. 2.2. 本地方法规范
      1. 2.2.1. 命名符号解析
      2. 2.2.2. 类型符号解析
      3. 2.2.3. 参数解析
      4. 2.2.4. 对象类型解析
      5. 2.2.5. 类型别名解析
      6. 2.2.6. 调用Java方法
      7. 2.2.7. 方法签名
    3. 2.3. 异常处理
      1. 2.3.1. Java部分处理:
      2. 2.3.2. 本地部分处理
    4. 2.4. JNI接口详解
      1. 2.4.1. 返回码说明
      2. 2.4.2. 接口代码说明
      3. 2.4.3. 简单案例
  3. 3. 尾巴
  4. 4. 参考资料
|