JavaCPP快速入門(官方demo增強版)

歡迎訪問我的GitHub

https://github.com/zq2599/blog_demos

內容：所有原創文章分類彙總及配套原始碼，涉及Java、Docker、Kubernetes、DevOPS等；

關於JavaCPP

JavaCPP 使得Java 應用可以在高效的訪問本地C++方法，JavaCPP底層使用了JNI技術，可以廣泛的用在Java SE應用中（也包括安卓），以下兩個特性是JavaCPP的關鍵，稍後我們們會用到：
提供一些註解，將Java程式碼對映為C++程式碼
提供一個jar，用java -jar命令可以將C++程式碼轉為java應用可以訪問的動態連結庫檔案；
目前JavaCPP團隊已經用JavaCPP為多個著名C++專案生成了完整的介面，這意味著我們們的java應用可以很方便的使用這些C++庫，這裡擷取部分專案如下圖，更詳細的列表請訪問：https://github.com/bytedeco/j...

在這裡插入圖片描述

本篇概覽

今天我們們先寫C++函式，再寫Java類，該Java類用JavaCPP呼叫C++函式；
提前小結JavaCPP開發的基本步驟如下圖，稍後就按這些步驟去做：

在這裡插入圖片描述

與官方demo的差異

聰明的您應該會想到：入門demo，JavaCPP官方也有啊(https://github.com/bytedeco/j...)，難道欣宸還能比官方的好？
官方的入門demo一定是最好的，這個毋庸置疑，我這裡與官方的不同之處，是新增了下面這些官方沒提到的內容，更符合自己的開發習慣（官方沒有這些的原因，我覺得應該是更關注JavaCPP本身，而不是一些其他的細枝末節）：

如下圖，官方的C++程式碼只有一個NativeLibrary.h檔案，函式功能也在這個檔案中，最終生成了一個jni的so檔案，而實際上，應該是標頭檔案與功能程式碼分離，因此本文中的標頭檔案和C++函式的原始碼是分開的，先生成函式功能的so，再在java中生成jni的so，一共會有兩個so檔案，至於這兩個so如何配置和訪問，也是本文的重點之一：

在這裡插入圖片描述

官方demo的java原始碼如下圖，是沒有package資訊的，而實際java工程中都會有package，由此帶來的路徑問題，例如標頭檔案放哪裡？編譯和生成so檔案時的命令列怎麼處理package資訊，等等官方並沒有提到，而在本篇我們們的java類是有package的，與之相關的路徑問題也會解決：

在這裡插入圖片描述

官方demo在執行時使用的依賴庫是org.bytedeco:javacpp:1.5.5，執行時會輸出以下警告資訊，本篇會解決這個告警問題：

Warning: Could not load Loader: java.lang.UnsatisfiedLinkError: no jnijavacpp in java.library.path

環境資訊

這裡給出我的環境資訊，您可以作為參考：

作業系統：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
操作賬號：root

javacpp-1.5.5.jar檔案下載

本篇不會用到maven或者gradle，因此所需的jar檔案需要自行準備，您可以從官網、maven中央倉庫等地方下載，也可以從下面兩個地方任選一個下載：

CSDN（不用積分）：https://download.csdn.net/dow...
GitHub：https://raw.githubusercontent...

完整原始碼和相關檔案下載

本次實戰的所有原始碼以及相關檔案，我這裡都按照實戰的目錄位置打包上傳到伺服器，如果有需要，您可以從下面兩個地方任選一個下載，用以參考，

CSDN（不用積分）：https://download.csdn.net/dow...
GitHub：https://raw.githubusercontent...

接下進入實戰環節

C++開發

新建一個資料夾，我這邊是/root/javacpp/cpp，C++開發都在此資料夾下進行
C++部分總共要寫三個檔案，分別是：

C++函式的原始碼：NativeLibrary.cpp
標頭檔案：NativeLibrary.h
測試函式功能的檔案：test.cpp（該檔案僅用於測試C++函式是否正常可用，與JavcCPP無關）

接下來分別編寫，首先是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);
    };
}

測試檔案test.cpp，可見是驗證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;
}

執行以下命令，編譯NativeLibrary.cpp，得到so檔案libMyFunc.so：

g++ -std=c++11 -fPIC -shared NativeLibrary.cpp -o libMyFunc.so

執行以下命令，編譯和連結test.cpp，得到可執行檔案test：

g++ test.cpp -o test ./libMyFunc.so

執行可執行檔案試試，命令是./test：

root@docker:~/javacpp/cpp# ./test
add value 3

將libMyFunc.so檔案複製到/usr/lib/目錄下
test的執行結果符合預期，證明so檔案建立成功，記住下面兩個關鍵資訊，稍後會用到：

標頭檔案是NativeLibrary.h
so檔案是libMyFunc.so

接下來是java部分

Java開發

簡單起見，我們們手寫java檔案，不建立maven工程
新建一個資料夾，我這邊是/root/javacpp/java，java開發都在此資料夾下進行
將檔案javacpp-1.5.5.jar複製到/root/javacpp/java/目錄下
出於個人習慣，喜歡將java類放在packgage下，因此建好package目錄，我這裡是com/bolingcavalry/javacppdemo，在我這裡的絕對路徑就是/root/javacpp/java/com/bolingcavalry/javacppdemo
將檔案NativeLibrary.h複製到com/bolingcavalry/javacppdemo目錄下
在com/bolingcavalry/javacppdemo目錄下新建Test.java，有幾處要注意的地方稍後會提到：

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++程式碼保持一致
靜態類名為MyFunc，這個要和C++中宣告的類保持一致
Platform註解的include屬性是NativeLibrary.h，作用是指定標頭檔案
Platform註解的link屬性的值是MyFunc，和so檔名libMyFunc.so相比，少了前面的lib字首，以及so字尾，這是容易出錯的地方，要千萬小心，需要按照這個規則來設定link屬性的值
對so中的add方法，通過native關鍵字做宣告，然後就可以使用了
現在開發工作已經完成，接下來開始編譯和執行

編譯和執行

首先是編譯java檔案，進入目錄/root/javacpp/java，執行以下命令，即可生成class檔案：

javac -cp javacpp-1.5.5.jar com/bolingcavalry/javacppdemo/Test.java

接下來要用javacpp-1.5.5.jar完成c++檔案的建立和編譯，生成linux下的so檔案：

java \
-jar javacpp-1.5.5.jar \
com/bolingcavalry/javacppdemo/Test.java

控制檯輸出以下資訊，表名so檔案已經生成，並且清理掉了中間過程產生的臨時檔案：

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

此時的com/bolingcavalry/javacppdemo目錄下新增了一個名為linux-x86_64的資料夾，裡面的libjniTest.so是javacpp-1.5.5.jar生成的
您可以將/usr/lib/目錄下的libMyFunc.so檔案移動到linux-x86_64目錄下（不移動也可以，只是個人覺得業務so檔案放在/usr/lib/這種公共目錄下不太合適）
將java應用執行起來：

java -cp javacpp-1.5.5.jar:. com.bolingcavalry.javacppdemo.Test

控制檯輸出的資訊如下所示，333表示呼叫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的資料夾和檔案的資訊詳細列出來，您可以參考：

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

一點小問題

我們們回顧一下java應用的輸出，如下所示，其中有一段告警資訊：

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

上述告警資訊不會影響功能，如果想消除掉，就不能只用org.bytedeco:javacpp:1.5.5這一個庫，而是org.bytedeco:javacpp-platform:1.5.5，以及它的依賴庫
由於本篇沒有用到maven或者gradle，因此很難將org.bytedeco:javacpp-platform:1.5.5及其依賴庫集齊，我這裡已經將所有jar檔案打包上傳，您可以選擇下面任意一種方式下載：

CSDN（不用積分）：https://download.csdn.net/dow...
GitHub：https://raw.githubusercontent...

下載下來後解壓，是個名為lib的資料夾，將此資料夾放在/root/javacpp/java/目錄下
lib資料夾下的jar只是在執行時用到，編譯時用不上，因此現在可以再次執行java應用了，命令如下：

java -cp lib/*:. com.bolingcavalry.javacppdemo.Test

在看控制檯輸出如下圖，這次沒有告警了：

在這裡插入圖片描述

本次實戰最終所有檔案與目錄資訊如下，供您參考：

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入門體驗已經完成，接下來做個小結，將關鍵點列出來

關鍵點小結

今天的實戰，我們們藉助JavaCPP，在java應用中使用c++的函式，有以下幾處需要重點關注：

在Java程式碼中，要有與C++中同名的靜態類
注意Java程式碼中Namespace註解和C++中的namespace一致
C++的標頭檔案要和Java類放在同一個目錄下
使用so庫的時候，庫名為libMyFunc.so，Platform註解的link引數的值就是庫名去掉lib字首和.so字尾
C++函式的so檔案可以放在/usr/lib目錄，也可以移至linux-x86_64目錄

至此，JavaCPP快速入門就完成了，如果您正在學習JavaCPP技術，希望本篇能給您一些參考；

你不孤單，欣宸原創一路相伴

歡迎關注公眾號：程式設計師欣宸

微信搜尋「程式設計師欣宸」，我是欣宸，期待與您一同暢遊Java世界...
https://github.com/zq2599/blog_demos

JavaCPP快速入門(官方demo增強版)

歡迎訪問我的GitHub

關於JavaCPP

本篇概覽

與官方demo的差異

環境資訊

javacpp-1.5.5.jar檔案下載

完整原始碼和相關檔案下載

C++開發

Java開發

編譯和執行

一點小問題

關鍵點小結

你不孤單，欣宸原創一路相伴

歡迎關注公眾號：程式設計師欣宸

相關文章