Java調用Golang產生的動態庫（dll,so）

## 0x01. 環境準備## A. GCC在控制台中輸入```bashgcc -v```如果提示命令未找到，那麼說明你的電腦中還沒有gcc，去安裝一個吧，gcc官方網站：https://gcc.gnu.org/如果從來沒有安裝過gcc的朋友可以直接安裝win-build，可以幫你快速的安裝官方網站：http://mingw-w64.org/doku.php/download/win-builds## 0x02. 編寫go程式我們這裡只是編寫一個簡單的計算加法的程式，接受兩個整數，然後計算他們的和，並返回。在這裡，我們將檔案命名為libhello.go```gopackage mainimport "C"//export Sumfunc Sum(a int, b int) int {return a + b}func main() {}```注意，即使是要編譯成動態庫，也要有main函數，上面的`import "C"`一定要有而且一定要有注釋```go//export Sum```經測試，如果沒有這個匯出的DLL庫中找不到對應的函數## 0x03. 編譯go程式首先，將控制台的所在目錄切換到go程式的所在目錄，即libhello.go所在目錄#### A. Windows動態庫執行如下命令產生DLL動態連結程式庫：```bashgo build -buildmode=c-shared -o libhello.dll .\libhello.go```如果控制台沒有報錯，那麼會在當前路徑下產生libhello.dll檔案#### B. Linux/Unix/macOS動態庫執行如下命令產生SO動態庫：```bashgo build -buildmode=c-shared -o libhello.so .\libhello.go```## 0x04. 在java中調用#### A. JNA的引用Java調用Native的動態庫有兩種方式，JNI和JNA，JNA是Oracle最新推出的與Native互動的方式，具體介紹我就不多說了，引用百度百科的串連：https://baike.baidu.com/item/JNA/8637274?fr=aladdin，有需要的朋友可以去看看。在這裡，我們使用JNA的方式，JNI的方式基本廢棄，除非有特殊需要，在這裡不多說，有需要可以聯絡我討論。建立Java工程，我使用的是Maven做包管理，所以直接引用JNA的依賴：```xml<dependency> <groupId>net.java.dev.jna</groupId> <artifactId>jna</artifactId> <version>4.5.2</version></dependency>```如果你沒有使用包管理工具，可以直接下載Jar檔案引入，下載地址也貼一下吧，也是4.5.2版本的：http://central.maven.org/maven2/net/java/dev/jna/jna/4.5.2/jna-4.5.2.jar#### B. 建立介面我們需要建立一個interface來映射DLL中的函數，之後我們可以通過interface的執行個體來訪問DLL中的函數。```javascriptpackage cn.lemonit.robot.runner.executor;import com.sun.jna.Library;import com.sun.jna.Native;public interface LibHello extends Library { LibHello INSTANCE = (LibHello) Native.loadLibrary("E:/workspace/libhello", LibHello.class); int Sum(int a, int b);}```注意，Sum是函數名，一定要與Go中事先寫好的函數名保持一致Native.loadLibrary()的第一個參數是一個字串，要載入的動態庫的名稱或全路徑，後面不需要加.dll或者.so的尾碼。第二個參數為interface的類名稱。#### C. 調用我們建立一個App類，作為main方法的入口類，在main方法中不需要多餘的操作，只需要調用即可，在這裡我們調用Sum方法，同時傳如222 ， 333，可以看到控制台輸出：555```javascriptpackage cn.lemonit.robot.runner.executor;public class App { public static void main(String[] args) { System.out.println(LibHello.INSTANCE.Sum(222, 333)); }}```大功告成，我終於玩通了Java調用Go程式！！！！？？？不對勁，有點太過於幸災樂禍了，往下繼續>>>## 0x05. 參數中包含字串#### A. 我真的大功告成了嗎？我們的程式總不能只傳數值型的參數吧，我們把GO程式改一下，換成一個一字串作為參數的函數，接受一個字串參數，然後從控制台輸出：hello: xxx，如下：```gopackage mainimport "fmt"//export Hellofunc Hello(msg string) {fmt.Print("hello: " + msg)}func main() {}```按照上面0x02.B步驟中的寫法，我們將java的LibHello介面改成這個樣子：```javascriptpackage cn.lemonit.robot.runner.executor;import com.sun.jna.Library;import com.sun.jna.Native;public interface LibHello extends Library { LibHello INSTANCE = (LibHello) Native.loadLibrary("E:/workspace/libhello", LibHello.class); void Hello(String msg);}```接下來，我們調用這個介面，將0x02.C中的啟動入口類App代碼改成這樣：```javascriptpackage cn.lemonit.robot.runner.executor;public class App { public static void main(String[] args) { LibHello.INSTANCE.Hello("LemonIT.CN"); }}```運行起來，咦？報錯了？？？```javascriptfatal error: string concatenation too longgoroutine 17 [running, locked to thread]:runtime.throw(0x644c1d4f, 0x1d) xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx （runtime報錯，沒有意義，不貼了）```這是怎麼回事，我傳的是一個很標準的String啊，怎麼會報錯呢？在一陣無頭緒中，發現剛才在調用`go build -buildmode=c-shared -o libhello.dll .\libhello.go`命令的時候在檔案夾中除了libhello.dll被產生之外，還產生了一個libhello.h檔案！！！這不是C的標頭檔嗎？出於好奇，開啟看看有什麼高大上的東西，這一開啟還真是嚇到我了：```c/* Created by "go tool cgo" - DO NOT EDIT. *//* package command-line-arguments */#line 1 "cgo-builtin-prolog"#include <stddef.h> /* for ptrdiff_t below */#ifndef GO_CGO_EXPORT_PROLOGUE_H#define GO_CGO_EXPORT_PROLOGUE_Htypedef struct { const char *p; ptrdiff_t n; } _GoString_;#endif/* Start of preamble from import "C" comments. *//* End of preamble from import "C" comments. *//* Start of boilerplate cgo prologue. */#line 1 "cgo-gcc-export-header-prolog"#ifndef GO_CGO_PROLOGUE_H#define GO_CGO_PROLOGUE_Htypedef signed char GoInt8;typedef unsigned char GoUint8;typedef short GoInt16;typedef unsigned short GoUint16;typedef int GoInt32;typedef unsigned int GoUint32;typedef long long GoInt64;typedef unsigned long long GoUint64;typedef GoInt64 GoInt;typedef GoUint64 GoUint;typedef __SIZE_TYPE__ GoUintptr;typedef float GoFloat32;typedef double GoFloat64;typedef float _Complex GoComplex64;typedef double _Complex GoComplex128;/* static assertion to make sure the file is being used on architecture at least with matching size of GoInt.*/typedef char _check_for_64_bit_pointer_matching_GoInt[sizeof(void*)==64/8 ? 1:-1];typedef _GoString_ GoString;typedef void *GoMap;typedef void *GoChan;typedef struct { void *t; void *v; } GoInterface;typedef struct { void *data; GoInt len; GoInt cap; } GoSlice;#endif/* End of boilerplate cgo prologue. */#ifdef __cplusplusextern "C" {#endifextern void Hello(GoString p0);#ifdef __cplusplus}#endif```這麼大一篇子，往下翻翻翻，找到了我們的Hello函數的定義：```cextern void Hello(GoString p0);```發現問題了，人家參數要的事GoString，而我們傳的是Java的String，肯定類型不一致啊。那GoString是個什麼東西呢，我該給他傳什嗎？往上翻，找到了這麼兩行代碼：```gotypedef struct { const char *p; ptrdiff_t n; } _GoString_;// .....typedef _GoString_ GoString;```嗯嗯嗯，看來這個GoString不過就是個C裡面的結構體罷了，結構體裡面一個char *一個ptrdiff_t，看來我們用java調用程式的時候，構造個這麼樣的結構體給他傳進來應該就行了，好了，有思路了，開始折騰。#### B. 建立GoString！我們首先用JNA構建一個C的結構體類型，那麼問題來了，JNA中char *可以直接用java的String來代替，那麼ptrdiff_t這個玩意……有點無語，這是啥啊？經過一頓操作百度和Google，終於知道了，這個類型實際上是兩個記憶體位址之間的距離的值，資料類型實際上就是C中的`long int`，在這裡他表示的是字串char *的長度，也就是字串的長度唄~，知道這個就好辦了，我們在Java中直接用long類型來代替它。我們建立一個GoString類來對應C中的GoString結構體，也就是Go程式中的string，這塊得說一下，有些人可能沒有用過JNA，在JNA中若想定義一個結構體，需要建立一個類繼承自`com.sun.jna.Structure`，熟悉C的人應該知道（不知道也沒關係），向C中傳值通常有兩種，一種是傳引用（就是傳指標類型），一種是傳真實值，在JNA裡面做的話我們通常在這個結構體類中建立兩個靜態內部類，這兩個內部類繼承自這個結構體類，並實現Structure.ByValue和Structure.ByReference介面，其中ByValue就是傳真實值時候用的，ByReference就是傳引用的時候用的，綜上所述，我們的GoString類就應該長成這個樣子：```javascriptpackage cn.lemonit.robot.runner.executor;import com.sun.jna.Structure;import java.util.ArrayList;import java.util.List;public class GoString extends Structure { public String str; public long length; public GoString() { } public GoString(String str) { this.str = str; this.length = str.length(); } @Override protected List<String> getFieldOrder() { List<String> fields = new ArrayList<>(); fields.add("str"); fields.add("length"); return fields; } public static class ByValue extends GoString implements Structure.ByValue { public ByValue() { } public ByValue(String str) { super(str); } } public static class ByReference extends GoString implements Structure.ByReference { public ByReference() { } public ByReference(String str) { super(str); } }}```可以發現，我們重寫了一個getFieldOrder方法，在裡面建立一個list，然後把兩個屬性名稱作為字串放到裡面，然後當做傳回值返回了。這個操作實際是為了告訴JNA，我這兩個變數和C結構體中的變數是怎麼個對應關係的，我們再來回顧一下剛才libhello.h中定義的GoString結構體（其實是省著你再往上翻看，費勁，直接粘出來方便你看）：```ctypedef struct { const char *p; ptrdiff_t n; } _GoString_;```我們的字串叫str，而char *的名稱是p，我們的字串長度叫length，而結構體中叫n，JNA又不是人工智慧架構，肯定猜不出來你想把str對應到p，length想對應到n，所以我們在這裡通過list的形式把欄位名在list中排一個順序，告訴JNA，我的str想對應結構體的第一個屬性，length想對應結構體的第二個屬性。（你可以試試，讓fields.add的順序調換一下，肯定會出問題）。#### C. 有了GoString！我又可以幸災樂禍了！？？？好了，GoString有了，萬事俱備，只欠東風了！用一把，我們把剛才0x05.A中的LibHello類改成這樣：```javascriptpackage cn.lemonit.robot.runner.executor;import com.sun.jna.Library;import com.sun.jna.Native;public interface LibHello extends Library { LibHello INSTANCE = (LibHello) Native.loadLibrary("E:/workspace/libhello", LibHello.class); void Hello(GoString.ByValue msg);}```App入口類代碼改成這樣：```javascriptpackage cn.lemonit.robot.runner.executor;public class App { public static void main(String[] args) { LibHello.INSTANCE.Hello(new GoString.ByValue("LemonIT.CN")); }}```運行！控制台成功輸出：```javascripthello: LemonIT.CN```哈哈哈！成功了，有點小激動！把代碼發給朋友們看！！！有一個朋友問我，你這Hello函數的結果能不能不在Go中的控制台列印，而是在Java中列印到控制台？額……我猶豫了一下，應該能吧……開幹！## 0x06. 傳回值中包含字串#### A. 做一個小實驗~我們把0x05中的Go函數Hello改一下，讓結果通過傳回值返回，而不是直接在控制台列印，變成這樣滴：```gopackage mainimport "C"//export Hellofunc Hello(msg string) string{return "hello:" + msg}func main() {}```既然傳回值也是string，那JNA這邊也得小改一波，把0x05.C中的LibHello類改成這樣：```javascriptpackage cn.lemonit.robot.runner.executor;import com.sun.jna.Library;import com.sun.jna.Native;public interface LibHello extends Library { LibHello INSTANCE = (LibHello) Native.loadLibrary("E:/workspace/libhello", LibHello.class); GoString.ByValue Hello(GoString.ByValue msg);}```運行入口類App也對應修改一下：```javascriptpackage cn.lemonit.robot.runner.executor;public class App { public static void main(String[] args) { System.out.println(LibHello.INSTANCE.Hello(new GoString.ByValue("LemonIT.CN")).str); }}```大功告成，運行一下！```javascriptpanic: runtime error: cgo result has Go pointergoroutine 17 [running, locked to thread]:main._cgoexpwrap_b02601c1465e_Hello.func1(0xc04203deb8)_cgo_gotypes.go:59 +0x6cmain._cgoexpwrap_b02601c1465e_Hello(0xbe3ce0, 0xa, 0xc042008050, 0x10)_cgo_gotypes.go:61 +0xa1```嗯？這啥？我的LemonIT.CN呢？在控制台中並沒有找到啊！有點讓人發狂，怎麼一步一個坎~不過想想比爾蓋茨，我還是決定做一名脾氣好的程式員，慢慢研究吧。#### B. 事情總有解決辦法！（車到山前必有路，有路必有豐田車）雖然沒有LemonIT.CN，但是看控制台中的error，cgo result has Go pointer，還是找到了一絲線索。又開始一頓操作百度和Google。原來，Go有自己的GC（記憶體回收，不解釋），通俗點說就是我Go語言的指標你們其他語言別想用！額，那咋整！急的我連大學時候的課堂筆記都翻出來了。無意中看到了當時寫的藉助JNA與C通訊，C中將char *返回給Java，然後Java使用String即可接收。嗯，嗯？這條咋忘了呢？哈哈哈，豈不是我把Go中的string轉成C的char *返回就可以了？好了，讓我們試上那麼一試，把剛才的Go中的Hello函數再次修改一波：```gopackage mainimport "C"//export Hellofunc Hello(msg string) *C.char{return C.CString("hello : " + msg) }func main() {}```同樣滴，我們的JNA這邊也得改一改，把LibHello類修改成這樣：```javascriptpackage cn.lemonit.robot.runner.executor;import com.sun.jna.Library;import com.sun.jna.Native;public interface LibHello extends Library { LibHello INSTANCE = (LibHello) Native.loadLibrary("E:/workspace/libhello", LibHello.class); String Hello(GoString.ByValue msg);}```LibHello既然改了，那麼入口類App也得對應修改：```javascriptpackage cn.lemonit.robot.runner.executor;public class App { public static void main(String[] args) { System.out.println(LibHello.INSTANCE.Hello(new GoString.ByValue("LemonIT.CN"))); }}```好了好了好了，運行：```javascripthello : LemonIT.CN```終於輸出出來了！## 0x07. 總結這個Go和Java的互動剛剛走了這一小小步就一步一個坎，看來真不能隨便的幸災樂禍啊！！還得謙虛，路才能越走越遠。雖然費了這麼大勁就解決了這麼點小事，但是Go語言的優勢是很大的，還是很值得我來折騰的，相信能讀到這裡的朋友也是對Go語言非常的喜愛，大家一起加油吧，歡迎各位大佬來指正批評~155 次點擊  ∙  1 贊