詳解JNI到底是什么
一、前言
首先回顧一下jni
的主要功能,從jdk1.1開始jni
標準就成為了java平臺的一部分,它提供的一系列的API允許java和其他語言進行交互,實現(xiàn)了在java代碼中調(diào)用其他語言的函數(shù)。通過jni
的調(diào)用,能夠?qū)崿F(xiàn)這些功能:
通常情況下我們一般使用jni
用來調(diào)用c或c++中的代碼,在上一篇文章中我們用了下面的流程來描述了native
方法的調(diào)用過程:
Java Code -> JNI -> C/C++ Code
但是準確的來說這一過程并不嚴謹,因為最終被執(zhí)行的不是原始的c/c++代碼,而是被編譯連接后的動態(tài)鏈接庫。因此我們將這個過程從單純的代碼調(diào)用層面上進行升級,將jni
的調(diào)用過程提高到了jvm和操作系統(tǒng)的層面,來加點細節(jié)進行一下完善:
看到這里,可能有的小伙伴就要提出疑問了,不是說java語言是跨平臺的嗎,這種與操作系統(tǒng)本地編譯的動態(tài)鏈接庫進行的交互,會不會使java失去跨平臺的可移植性?
針對這一問題,大家可以回想一下以前安裝jdk的經(jīng)歷,在官網(wǎng)的下載列表中提供了各個操作系統(tǒng)的不同版本jdk,例如windows
、linux
、mac os
版本等等,在這些jdk中,針對不同系統(tǒng)有著不同的jvm實現(xiàn)。而java語言的跨平臺性恰好是和它底層的jvm密不可分的,正是依靠不同的操作系統(tǒng)下不同版本jvm的“翻譯”工作,才能使編譯后的字節(jié)碼在不同的平臺下暢通無阻的運行。
在不同操作系統(tǒng)下,c/c++或其他代碼生成的動態(tài)鏈接庫也會有差異,例如在window平臺下會編譯為dll
文件,在linux平臺下會編譯為so
文件,在mac os下會編譯為jnilib
文件。而不同平臺下的jvm,會“約定俗成”的去加載某個固定類型的動態(tài)鏈接庫文件,使得依賴于操作系統(tǒng)的功能可以被正常的調(diào)用,這一過程可以參考下面的圖來進行理解:
在對jni
的整體調(diào)用流程有了一定的了解后,對于它如何調(diào)用其他語言中的函數(shù)這一過程,你是否也會好奇它是怎樣實現(xiàn)的,下面我們就通過手寫一個java程序調(diào)用c++代碼的例子,來理解它的調(diào)用過程。
二、準備java代碼
首先定義一個包含了native
方法的類如下,之后我們要使用這個類中的native
方法通過jni
調(diào)用c++編寫成的動態(tài)鏈接庫中的方法:
public class JniTest { static{ System.loadLibrary("MyNativeDll"); } public static native void callCppMethod(); public static void main(String[] args) { System.out.println("DLL path:"+System.getProperty("java.library.path")); callCppMethod(); } }
在代碼中主要完成了以下工作:
- 在靜態(tài)代碼塊中,調(diào)用
loadLibrary
方法加載本地的動態(tài)鏈接庫,參數(shù)為不包含擴展名的動態(tài)鏈接庫庫文件名。在window平臺下會加載dll
文件,在linux平臺下會加載so
文件,在mac os下會加載jnilib
文件 - 聲明了一個
native
方法,native
關(guān)鍵字負責通知jvm這里調(diào)用方法的是本地方法,該方法在外部被定義 - 在
main
方法中,打印加載dll
文件的路徑,并調(diào)用本地方法
三、生成頭文件
在使用c/c++來實現(xiàn)本地方法時,需要先創(chuàng)建.h
頭文件。簡單的來說,c/c++程序通常由頭文件(.h
)和定義文件(.c
或.cpp
)組成,頭文件包含了功能函數(shù)、數(shù)據(jù)接口的聲明,而定義文件用于書寫程序的實現(xiàn)。
在jdk8中可以直接使用javac -h
指令生成c/c++語言中的頭文件。如果你使用的是較早版本的jdk,需要在執(zhí)行javac
編譯完成class
文件后,再執(zhí)行javah -jni
生成c/c++風格的頭文件(在jdk10的新特性中已經(jīng)刪除了javah
這一指令)。我們使用的jdk8簡化了這一步驟,使其可以一步完成,在命令行窗口下執(zhí)行命令:
javac -h ./jni JniTest.java
指令中使用 -h
參數(shù)指定放置生成的頭文件的位置,最后的參數(shù)是java源文件的名稱。在這個過程中完成了兩件工作,首先生成class
文件,其次在參數(shù)指定的目錄下生成頭文件。生成的頭文件com_cn_jni_JniTest.h
內(nèi)容如下:
/* DO NOT EDIT THIS FILE - it is machine generated */ #include <jni.h> /* Header for class com_cn_jni_JniTest */ #ifndef _Included_com_cn_jni_JniTest #define _Included_com_cn_jni_JniTest #ifdef __cplusplus extern "C" { #endif /* * Class: com_cn_jni_JniTest * Method: callCppMethod * Signature: ()V */ JNIEXPORT void JNICALL Java_com_cn_jni_JniTest_callCppMethod (JNIEnv *, jclass); #ifdef __cplusplus } #endif #endif
生成的頭文件和大家熟悉的 java接口有些相似,只有函數(shù)的聲明而沒有具體實現(xiàn)。簡單的解釋一下頭文件中的代碼:
extern "C"
告訴編譯器,這部分代碼使用C語言規(guī)則來進行編譯JNIEXPORT
和JNICALL
是jni
中定義的兩個宏,使用JNIEXPORT
支持在外部程序代碼中調(diào)用該動態(tài)庫中的方法,使用JNICALL
定義函數(shù)調(diào)用時參數(shù)的入棧出棧約定- 函數(shù)名稱由包名+類名+方法名組成,在該方法中有兩個參數(shù),通過第一個參數(shù)
JNIEnv *
的對象可以調(diào)用jni.h
中封裝好的大量函數(shù) ,第二個參數(shù)代表著native
方法的調(diào)用者,當java代碼中定義的native
方法是靜態(tài)方法時這里的參數(shù)是jclass
,非靜態(tài)方法的參數(shù)是jobject
接下來我們創(chuàng)建一個cpp
文件,引用頭文件并實現(xiàn)其中的函數(shù),也就是native
方法將要實際執(zhí)行的邏輯:
#include "com_cn_jni_JniTest.h" #include <stdio.h> JNIEXPORT void JNICALL Java_com_cn_jni_JniTest_callCppMethod (JNIEnv *, jclass) { printf("Print From Cpp: \n"); printf("I am a cpp method ! \n"); }
在方法的實現(xiàn)中加入簡單的printf
打印語句,在完成方法的實現(xiàn)后,我們需要將上面的cpp
文件編譯為動態(tài)鏈接庫,提供給java中的native
方法調(diào)用,因此下面需要在window環(huán)境下安裝gcc
環(huán)境。
四、gcc環(huán)境安裝
在window環(huán)境下,如果你不希望為了生成一個dll
就去下載體積龐大的的Visual Studio
的話,MinGW
是一個不錯的選擇,簡單的說它就是一個windows版本下的gcc
。那么估計有的同學(xué)又要問了,gcc
是什么?簡單的來說就是linux系統(tǒng)下C/C++
的編譯器,通過它可以將源代碼編譯成可執(zhí)行程序。首先從下面的網(wǎng)址下載mingw-get-setup
的安裝程序:
http://sourceforge.net/projects/mingw/ #32位
https://sourceforge.net/projects/mingw-w64/ #64位
需要注意,一定要按照系統(tǒng)位數(shù)安裝對應(yīng)的版本,否則后面生成的dll
在運行時就可能會因位數(shù)不匹配而報錯,我在實驗的過程中第一次就錯誤安裝了32位的MinGw
,導(dǎo)致了在程序運行過程中報了下面錯誤:
Exception in thread "main" java.lang.UnsatisfiedLinkError:
F:\Workspace20\unsafe-test\src\main\java\com\cn\jni\jni\MyNativeDll.dll:
Can't load IA 32-bit .dll on a AMD 64-bit platform
安裝完成后,將MinGW\bin
目錄加入系統(tǒng)環(huán)境變量PATH
,輸入下面的指令測試gcc
是否可以使用:
gcc -v
如果能夠正常輸出gcc
的版本信息,說明gcc
安裝成功:
在測試的過程中發(fā)現(xiàn),如果安裝的是64位的mingw
,那么在安裝完成后gcc
就已經(jīng)直接可以可用。但是如果安裝的是32位的mingw
,需要使用下面的命令單獨安裝gcc
:
mingw-get install gcc
gcc
安裝完成后,如果還想安裝gdb
或make
等其他指令進行調(diào)試或編譯,同樣可以使用強大的mingw-get
命令進行獨立安裝。
五、生成動態(tài)鏈接庫
在gcc
環(huán)境準備好的條件下,接下來使用下面的命令生成dll
動態(tài)鏈接庫:
gcc -m64 -Wl,--add-stdcall-alias -I"D:\Program Files\Java\jdk1.8.0_261\include"
-I"D:\Program Files\Java\jdk1.8.0_261\include\win32"
-shared -o MyNativeDll.dll JniTestImpl.cpp
簡單的解釋一下各個參數(shù)的含義:
-m64
:將cpp代碼編譯為64位的應(yīng)用程序-Wl,--add-stdcall-alias
:-Wl
表示將后面的參數(shù)傳遞給連接程序,參數(shù)--add-stdcall-alias
表示帶有標準調(diào)用后綴@NN
的符號會被剝掉后綴后導(dǎo)出-I
:指定頭文件的路徑,在生成的頭文件代碼中引入的jni.h
就在這個目錄下-shared
:指定生成動態(tài)鏈接庫,如果不使用這個標志那么外部程序?qū)o法連接-o
:指定目標的名稱,這里將生成的動態(tài)鏈接庫命名為MyNativeDll.dll
JniTestImpl.cpp
:被編譯的源程序文件名
在指令的執(zhí)行過程中,都做了什么事呢,可以參考下面這張圖:
在執(zhí)行過程中,以.cpp
源代碼和.h
頭文件作為源文件,先進行了預(yù)處理、編譯、匯編的操作,圖中省略了這一階段產(chǎn)生的一些中間文件,編譯完成后生成的.o
二進制文件相對重要,依賴這個文件,最終生成動態(tài)鏈接庫。
在執(zhí)行了上面的指令后,就會在當前目錄下生成一個MyNativeDll.dll
文件,再運行之前準備好的java代碼:
程序報錯,這是因為在默認的載入庫文件的目錄下沒有找到我們的dll
文件。有兩種方式可以解決:
- 直接將
dll
文件拷貝到默認的加載目錄下,具體的路徑可以通過System.getProperty("java.library.path")
獲取,該方法可能會獲得多個目錄,放在任意一個目錄下即可 - 是在
VM Option
中修改啟動參數(shù),指定dll
的存放目錄:
-Djava.library.path=F:\Workspace20\unsafe-test\src\main\java\com\cn\jni\jni
再次執(zhí)行,輸出結(jié)果:
DLL path:F:\Workspace20\unsafe-test\src\main\java\com\cn\jni\jni
Print From Cpp:
I am a cpp method !
可以看到程序加載dll
的路徑已經(jīng)切換成了它的存放路徑,并且通過jni
調(diào)用成功,輸出了在c++中的代碼邏輯??梢杂孟旅娴膱D來總結(jié)上面實現(xiàn)jni
調(diào)用的過程:
在對jni
的調(diào)用有了一個整體的了解后,如果大家對代理模式比較熟悉的話,也可以從代理模式的角度來理解jni
,將jni
調(diào)用過程中的各個角色帶入到代理模式中:
- 代理角色:包含
native
方法的jni
類 - 實現(xiàn)角色:c/c++或其他語言實現(xiàn)的動態(tài)鏈接庫
- 客戶端:調(diào)用
native
方法的java類程序 - 接口(抽象角色):在
jni
中接口這一角色的存在感相對薄弱,因為jni
是跨語言的,所以說無法嚴格的定義一個接口并讓它同時應(yīng)用于java和其他語言。但是通過生成的.h
頭文件,在一定程度上實現(xiàn)了從接口規(guī)范上統(tǒng)一了java中native
方法和其他語言中的函數(shù)
以代理模式的概述圖來進行描述:
上圖在標準代理模式的基礎(chǔ)上做了一些修改以便于理解,因為這里的接口只做規(guī)范約束作用,所以讓客戶端的調(diào)用過程跳過了接口,直接指向了代理角色,再由代理角色調(diào)用實現(xiàn)角色完成功能的調(diào)用??偟膩碚f,jni
起到了一個代理或中介的作用,與常見代理不同的是這里只做方法的調(diào)用,而不實現(xiàn)邏輯上的增強。通過這一模式,向java程序員隱藏了底層c/c++代碼的實現(xiàn)細節(jié),讓我們專注于業(yè)務(wù)代碼的編寫即可。
六、總結(jié)
在前面對native
方法有了一定了解的基礎(chǔ)上,本文介紹了jni
的相關(guān)知識。通過本文的學(xué)習(xí),有助于我們:
- 理解java的為何能夠做到跨平臺,以及依賴操作系統(tǒng)的底層操作是如何實現(xiàn)的
- 了解
native
方法的調(diào)用過程,在必要時可以自己實現(xiàn)jni
類接口調(diào)用 - 學(xué)到一點C++知識
當然了,使用jni
也會帶來一些缺點:
- 當在某個操作系統(tǒng)下使用了
jni
標準,將本地代碼編譯生成了動態(tài)鏈接庫后,如果要將這個程序移植到其他操作系統(tǒng),需要在新的平臺重新編譯代碼生成動態(tài)鏈接庫 - 對其他語言的不正確使用可能會造成程序出現(xiàn)錯誤,例如之前提到的使用c語言進行內(nèi)存操作時未及時回收內(nèi)存可能引起的內(nèi)存泄漏
- 對其他語言的依賴過高,會提高了java和其他語言的耦合性,也提高了對項目代碼的維護成本
以上就是詳解JNI到底是什么的詳細內(nèi)容,更多關(guān)于JNI的資料請關(guān)注腳本之家其它相關(guān)文章!
相關(guān)文章
java實現(xiàn)動態(tài)編譯并動態(tài)加載
這篇文章主要介紹了java實現(xiàn)動態(tài)編譯并動態(tài)加載,需要的朋友可以參考下2021-04-04辨析Java中的String與StringBuffer及StringBuilder字符串類
這里將為大家來辨析Java中的String與StringBuffer及StringBuilder字符串類型,通常來說StringBuilder的性能更加,需要的朋友可以參考下2016-05-05分析JVM源碼之Thread.interrupt系統(tǒng)級別線程打斷
在java編程中,我們經(jīng)常會調(diào)用Thread.sleep()方法使得線程停止運行一段時間,而Thread類中也提供了interrupt方法供我們?nèi)ブ鲃哟驍嘁粋€線程。那么線程掛起和打斷的本質(zhì)究竟是什么,本文就此問題作一個探究2021-06-06