歡迎訪問我的GitHub
https://github.com/zq2599/blog_demos
內(nèi)容:所有原創(chuàng)文章分類匯總及配套源碼,涉及Java、Docker、Kubernetes、DevOPS等;
關(guān)于JavaCPP
- JavaCPP 使得Java 應(yīng)用可以在高效的訪問本地C++方法,JavaCPP底層使用了JNI技術(shù),可以廣泛的用在Java SE應(yīng)用中(也包括安卓),以下兩個(gè)特性是JavaCPP的關(guān)鍵,稍后咱們會(huì)用到:
- 提供一些注解,將Java代碼映射為C++代碼
- 提供一個(gè)jar,用java -jar命令可以將C++代碼轉(zhuǎn)為java應(yīng)用可以訪問的動(dòng)態(tài)鏈接庫(kù)文件;
- 目前JavaCPP團(tuán)隊(duì)已經(jīng)用JavaCPP為多個(gè)著名C++項(xiàng)目生成了完整的接口,這意味著咱們的java應(yīng)用可以很方便的使用這些C++庫(kù),這里截取部分項(xiàng)目如下圖,更詳細(xì)的列表請(qǐng)?jiān)L問:https://github.com/bytedeco/javacpp-presets
本篇概覽
-
今天咱們先寫C++函數(shù),再寫Java類,該Java類用JavaCPP調(diào)用C++函數(shù);
-
提前小結(jié)JavaCPP開發(fā)的基本步驟如下圖,稍后就按這些步驟去做:
與官方demo的差異
-
聰明的您應(yīng)該會(huì)想到:入門demo,JavaCPP官方也有啊(https://github.com/bytedeco/javacpp),難道欣宸還能比官方的好?
-
官方的入門demo一定是最好的,這個(gè)毋庸置疑,我這里與官方的不同之處,是添加了下面這些官方?jīng)]提到的內(nèi)容,更符合自己的開發(fā)習(xí)慣(官方?jīng)]有這些的原因,我覺得應(yīng)該是更關(guān)注JavaCPP本身,而不是一些其他的細(xì)枝末節(jié)):
- 如下圖,官方的C++代碼只有一個(gè)NativeLibrary.h文件,函數(shù)功能也在這個(gè)文件中,最終生成了一個(gè)jni的so文件,而實(shí)際上,應(yīng)該是頭文件與功能代碼分離,因此本文中的頭文件和C++函數(shù)的源碼是分開的,先生成函數(shù)功能的so,再在java中生成jni的so,一共會(huì)有兩個(gè)so文件,至于這兩個(gè)so如何配置和訪問,也是本文的重點(diǎn)之一:
- 官方demo的java源碼如下圖,是沒有package信息的,而實(shí)際java工程中都會(huì)有package,由此帶來的路徑問題,例如頭文件放哪里?編譯和生成so文件時(shí)的命令行怎么處理package信息,等等官方并沒有提到,而在本篇咱們的java類是有package的,與之相關(guān)的路徑問題也會(huì)解決:
- 官方demo在運(yùn)行時(shí)使用的依賴庫(kù)是org.bytedeco:javacpp:1.5.5,運(yùn)行時(shí)會(huì)輸出以下警告信息,本篇會(huì)解決這個(gè)告警問題:
Warning: Could not load Loader: java.lang.UnsatisfiedLinkError: no jnijavacpp in java.library.path
環(huán)境信息
- 這里給出我的環(huán)境信息,您可以作為參考:
- 操作系統(tǒng):Ubuntu 16.04.5 LTS (server版,64位)
- g++:(Ubuntu 5.4.0-6ubuntu1~16.04.10) 5.4.0 20160609
- JDK:1.8.0_291
- JavaCPP:1.5.5
- 操作賬號(hào):root
javacpp-1.5.5.jar文件下載
- 本篇不會(huì)用到maven或者gradle,因此所需的jar文件需要自行準(zhǔn)備,您可以從官網(wǎng)、maven中央倉(cāng)庫(kù)等地方下載,也可以從下面兩個(gè)地方任選一個(gè)下載:
- CSDN(不用積分):https://download.csdn.net/download/boling_cavalry/20189395
- GitHub:https://raw.githubusercontent.com/zq2599/blog_download_files/master/files/javacpp-1.5.5.jar
完整源碼和相關(guān)文件下載
- 本次實(shí)戰(zhàn)的所有源碼以及相關(guān)文件,我這里都按照實(shí)戰(zhàn)的目錄位置打包上傳到服務(wù)器,如果有需要,您可以從下面兩個(gè)地方任選一個(gè)下載,用以參考,
-
CSDN(不用積分):https://download.csdn.net/download/boling_cavalry/20189692
-
GitHub:https://raw.githubusercontent.com/zq2599/blog_download_files/master/files/javacpp-project.tar
- 接下進(jìn)入實(shí)戰(zhàn)環(huán)節(jié)
C++開發(fā)
- 新建一個(gè)文件夾,我這邊是/root/javacpp/cpp,C++開發(fā)都在此文件夾下進(jìn)行
- C++部分總共要寫三個(gè)文件,分別是:
- C++函數(shù)的源碼:NativeLibrary.cpp
- 頭文件:NativeLibrary.h
- 測(cè)試函數(shù)功能的文件:test.cpp(該文件僅用于測(cè)試C++函數(shù)是否正??捎?,與JavcCPP無關(guān))
- 接下來分別編寫,首先是NativeLibrary.cpp,如下,僅有加法的方法:
#include "NativeLibrary.h"
namespace NativeLibrary {
int MyFunc::add(int a, int b) {
return a + b;
}
}
- 頭文件:
#include<iostream>
namespace NativeLibrary {
class MyFunc{
public:
MyFunc(){};
~MyFunc(){};
int add(int a, int b);
};
}
- 測(cè)試文件test.cpp,可見是驗(yàn)證MyFunc類的方法是否正常:
#include<iostream>
#include"NativeLibrary.h"
using namespace NativeLibrary;
int main(){
MyFunc myFunc;
int value = myFunc.add(1, 2);
std::cout << "add value " << value << std::endl;
return 0;
}
- 執(zhí)行以下命令,編譯NativeLibrary.cpp,得到so文件libMyFunc.so:
g++ -std=c++11 -fPIC -shared NativeLibrary.cpp -o libMyFunc.so
- 執(zhí)行以下命令,編譯和鏈接test.cpp,得到可執(zhí)行文件test:
g++ test.cpp -o test ./libMyFunc.so
- 運(yùn)行可執(zhí)行文件試試,命令是./test:
root@docker:~/javacpp/cpp# ./test
add value 3
- 將libMyFunc.so文件復(fù)制到/usr/lib/目錄下
- test的執(zhí)行結(jié)果符合預(yù)期,證明so文件創(chuàng)建成功,記住下面兩個(gè)關(guān)鍵信息,稍后會(huì)用到:
- 頭文件是NativeLibrary.h
- so文件是libMyFunc.so
- 接下來是java部分
Java開發(fā)
- 簡(jiǎn)單起見,咱們手寫java文件,不創(chuàng)建maven工程
- 新建一個(gè)文件夾,我這邊是/root/javacpp/java,java開發(fā)都在此文件夾下進(jìn)行
- 將文件javacpp-1.5.5.jar復(fù)制到/root/javacpp/java/目錄下
- 出于個(gè)人習(xí)慣,喜歡將java類放在packgage下,因此建好package目錄,我這里是com/bolingcavalry/javacppdemo,在我這里的絕對(duì)路徑就是/root/javacpp/java/com/bolingcavalry/javacppdemo
- 將文件NativeLibrary.h復(fù)制到com/bolingcavalry/javacppdemo目錄下
- 在com/bolingcavalry/javacppdemo目錄下新建Test.java,有幾處要注意的地方稍后會(huì)提到:
package com.bolingcavalry.javacppdemo;
import org.bytedeco.javacpp.*;
import org.bytedeco.javacpp.annotation.*;
@Platform(include="NativeLibrary.h",link="MyFunc")
@Namespace("NativeLibrary")
public class Test {
public static class MyFunc extends Pointer {
static { Loader.load(); }
public MyFunc() { allocate(); }
private native void allocate();
// to call add functions
public native int add(int a, int b);
}
public static void main(String[] args) {
MyFunc myFunc = new MyFunc();
System.out.println(myFunc .add(111,222));
}
}
- Test.java有以下幾處需要注意:
- Namespace注解的值是命名空間,要與前面C++代碼保持一致
- 靜態(tài)類名為MyFunc,這個(gè)要和C++中聲明的類保持一致
- Platform注解的include屬性是NativeLibrary.h,作用是指定頭文件
- Platform注解的link屬性的值是MyFunc,和so文件名libMyFunc.so相比,少了前面的lib前綴,以及so后綴,這是容易出錯(cuò)的地方,要千萬小心,需要按照這個(gè)規(guī)則來設(shè)置link屬性的值
- 對(duì)so中的add方法,通過native關(guān)鍵字做聲明,然后就可以使用了
- 現(xiàn)在開發(fā)工作已經(jīng)完成,接下來開始編譯和運(yùn)行
編譯和運(yùn)行
- 首先是編譯java文件,進(jìn)入目錄/root/javacpp/java,執(zhí)行以下命令,即可生成class文件:
javac -cp javacpp-1.5.5.jar com/bolingcavalry/javacppdemo/Test.java
- 接下來要用javacpp-1.5.5.jar完成c++文件的創(chuàng)建和編譯,生成linux下的so文件:
java
-jar javacpp-1.5.5.jar
com/bolingcavalry/javacppdemo/Test.java
- 控制臺(tái)輸出以下信息,表名so文件已經(jīng)生成,并且清理掉了中間過程產(chǎn)生的臨時(shí)文件:
root@docker:~/javacpp/java# java
> -jar javacpp-1.5.5.jar
> com/bolingcavalry/javacppdemo/Test.java
Info: javac -cp javacpp-1.5.5.jar:/root/javacpp/java com/bolingcavalry/javacppdemo/Test.java
Info: Generating /root/javacpp/java/jnijavacpp.cpp
Info: Generating /root/javacpp/java/com/bolingcavalry/javacppdemo/jniTest.cpp
Info: Compiling /root/javacpp/java/com/bolingcavalry/javacppdemo/linux-x86_64/libjniTest.so
Info: g++ -I/usr/lib/jvm/jdk1.8.0_291/include -I/usr/lib/jvm/jdk1.8.0_291/include/linux /root/javacpp/java/com/bolingcavalry/javacppdemo/jniTest.cpp /root/javacpp/java/jnijavacpp.cpp -march=x86-64 -m64 -O3 -s -Wl,-rpath,$ORIGIN/ -Wl,-z,noexecstack -Wl,-Bsymbolic -Wall -fPIC -pthread -shared -o libjniTest.so -lMyFunc
Info: Deleting /root/javacpp/java/com/bolingcavalry/javacppdemo/jniTest.cpp
Info: Deleting /root/javacpp/java/jnijavacpp.cpp
-
此時(shí)的com/bolingcavalry/javacppdemo目錄下新增了一個(gè)名為linux-x86_64的文件夾,里面的libjniTest.so是javacpp-1.5.5.jar生成的
-
您可以將/usr/lib/目錄下的libMyFunc.so文件移動(dòng)到linux-x86_64目錄下(不移動(dòng)也可以,只是個(gè)人覺得業(yè)務(wù)so文件放在/usr/lib/這種公共目錄下不太合適)
-
將java應(yīng)用運(yùn)行起來:
java -cp javacpp-1.5.5.jar:. com.bolingcavalry.javacppdemo.Test
- 控制臺(tái)輸出的信息如下所示,333表示調(diào)用so中的方法成功了:
root@docker:~/javacpp/java# java -cp javacpp-1.5.5.jar:. com.bolingcavalry.javacppdemo.Test
Warning: Could not load Loader: java.lang.UnsatisfiedLinkError: no jnijavacpp in java.library.path
333
- 最后,將我這里c++和java的文件夾和文件的信息詳細(xì)列出來,您可以參考:
root@docker:~# tree /root/javacpp
/root/javacpp
├── cpp
│ ├── libMyFunc.so
│ ├── NativeLibrary.cpp
│ ├── NativeLibrary.h
│ ├── test
│ └── test.cpp
└── java
├── com
│ └── bolingcavalry
│ └── javacppdemo
│ ├── linux-x86_64
│ │ ├── libjniTest.so
│ │ └── libMyFunc.so
│ ├── NativeLibrary.h
│ ├── Test.class
│ ├── Test.java
│ └── Test$MyFunc.class
└── javacpp-1.5.5.jar
6 directories, 12 files
一點(diǎn)小問題
- 咱們回顧一下java應(yīng)用的輸出,如下所示,其中有一段告警信息:
root@docker:~/javacpp/java# java -cp javacpp-1.5.5.jar:. com.bolingcavalry.javacppdemo.Test
Warning: Could not load Loader: java.lang.UnsatisfiedLinkError: no jnijavacpp in java.library.path
333
-
上述告警信息不會(huì)影響功能,如果想消除掉,就不能只用org.bytedeco:javacpp:1.5.5這一個(gè)庫(kù),而是org.bytedeco:javacpp-platform:1.5.5,以及它的依賴庫(kù)
-
由于本篇沒有用到maven或者gradle,因此很難將org.bytedeco:javacpp-platform:1.5.5及其依賴庫(kù)集齊,我這里已經(jīng)將所有jar文件打包上傳,您可以選擇下面任意一種方式下載:
- CSDN(不用積分):https://download.csdn.net/download/boling_cavalry/20188764
- GitHub:https://raw.githubusercontent.com/zq2599/blog_download_files/master/files/javacpp-platform155.tar
-
下載下來后解壓,是個(gè)名為lib的文件夾,將此文件夾放在/root/javacpp/java/目錄下
-
lib文件夾下的jar只是在運(yùn)行時(shí)用到,編譯時(shí)用不上,因此現(xiàn)在可以再次運(yùn)行java應(yīng)用了,命令如下:
java -cp lib/*:. com.bolingcavalry.javacppdemo.Test
- 在看控制臺(tái)輸出如下圖,這次沒有告警了:
- 本次實(shí)戰(zhàn)最終所有文件與目錄信息如下,供您參考:
root@docker:~/javacpp# tree /root/javacpp
/root/javacpp
├── cpp
│ ├── libMyFunc.so
│ ├── NativeLibrary.cpp
│ ├── NativeLibrary.h
│ ├── test
│ └── test.cpp
└── java
├── com
│ └── bolingcavalry
│ └── javacppdemo
│ ├── linux-x86_64
│ │ ├── libjniTest.so
│ │ └── libMyFunc.so
│ ├── NativeLibrary.h
│ ├── Test.class
│ ├── Test.java
│ └── Test$MyFunc.class
├── javacpp-1.5.5.jar
└── lib
├── javacpp-1.5.5-android-arm64.jar
├── javacpp-1.5.5-android-arm.jar
├── javacpp-1.5.5-android-x86_64.jar
├── javacpp-1.5.5-android-x86.jar
├── javacpp-1.5.5-ios-arm64.jar
├── javacpp-1.5.5-ios-x86_64.jar
├── javacpp-1.5.5.jar
├── javacpp-1.5.5-linux-arm64.jar
├── javacpp-1.5.5-linux-armhf.jar
├── javacpp-1.5.5-linux-ppc64le.jar
├── javacpp-1.5.5-linux-x86_64.jar
├── javacpp-1.5.5-linux-x86.jar
├── javacpp-1.5.5-macosx-arm64.jar
├── javacpp-1.5.5-macosx-x86_64.jar
├── javacpp-1.5.5-windows-x86_64.jar
├── javacpp-1.5.5-windows-x86.jar
└── javacpp-platform-1.5.5.jar
7 directories, 29 files
- 至此,JavaCPP入門體驗(yàn)已經(jīng)完成,接下來做個(gè)小結(jié),將關(guān)鍵點(diǎn)列出來
關(guān)鍵點(diǎn)小結(jié)
- 今天的實(shí)戰(zhàn),咱們借助JavaCPP,在java應(yīng)用中使用c++的函數(shù),有以下幾處需要重點(diǎn)關(guān)注:
- 在Java代碼中,要有與C++中同名的靜態(tài)類
- 注意Java代碼中Namespace注解和C++中的namespace一致
- C++的頭文件要和Java類放在同一個(gè)目錄下
- 使用so庫(kù)的時(shí)候,庫(kù)名為libMyFunc.so,Platform注解的link參數(shù)的值就是庫(kù)名去掉lib前綴和.so后綴
- C++函數(shù)的so文件可以放在/usr/lib目錄,也可以移至linux-x86_64目錄
- 至此,JavaCPP快速入門就完成了,如果您正在學(xué)習(xí)JavaCPP技術(shù),希望本篇能給您一些參考;
你不孤單,欣宸原創(chuàng)一路相伴
歡迎關(guān)注公眾號(hào):程序員欣宸
微信搜索「程序員欣宸」,我是欣宸,期待與您一同暢游Java世界...
https://github.com/zq2599/blog_demos
本文摘自 :https://www.cnblogs.com/