JavaCPP快速入门(官方demo增强版)

野性酷女 2022-10-19 11:29 260阅读 0赞

### 欢迎访问我的GitHub ###

> 这里分类和汇总了欣宸的全部原创(含配套源码)：[https://github.com/zq2599/blog\_demos][https_github.com_zq2599_blog_demos]

### 关于JavaCPP ###

*  JavaCPP 使得Java 应用可以在高效的访问本地C++方法，JavaCPP底层使用了JNI技术，可以广泛的用在Java SE应用中（也包括安卓），以下两个特性是JavaCPP的关键，稍后咱们会用到：

1.  提供一些注解，将Java代码映射为C++代码
2.  提供一个jar，用java -jar命令可以将C++代码转为java应用可以访问的动态链接库文件；

*  目前JavaCPP团队已经用JavaCPP为多个著名C++项目生成了完整的接口，这意味着咱们的java应用可以很方便的使用这些C++库，这里截取部分项目如下图，更详细的列表请访问：https://github.com/bytedeco/javacpp-presets

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5_size_16_color_FFFFFF_t_70_pic_center]

### 本篇概览 ###

*  今天咱们先写C++函数，再写Java类，该Java类用JavaCPP调用C++函数；
 *  提前小结JavaCPP开发的基本步骤如下图，稍后就按这些步骤去做：  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5_size_16_color_FFFFFF_t_70_pic_center 1]

### 与官方demo的差异 ###

*  聪明的您应该会想到：入门demo，JavaCPP官方也有啊(https://github.com/bytedeco/javacpp)，难道欣宸还能比官方的好？
 *  官方的入门demo一定是最好的，这个毋庸置疑，我这里与官方的不同之处，是添加了下面这些官方没提到的内容，更符合自己的开发习惯（官方没有这些的原因，我觉得应该是更关注JavaCPP本身，而不是一些其他的细枝末节）：

1.  如下图，官方的C++代码只有一个NativeLibrary.h文件，函数功能也在这个文件中，最终生成了一个jni的so文件，而实际上，应该是头文件与功能代码分离，因此本文中的头文件和C++函数的源码是分开的，先生成函数功能的so，再在java中生成jni的so，一共会有两个so文件，至于这两个so如何配置和访问，也是本文的重点之一：  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5_size_16_color_FFFFFF_t_70]
2.  官方demo的java源码如下图，是没有package信息的，而实际java工程中都会有package，由此带来的路径问题，例如头文件放哪里？编译和生成so文件时的命令行怎么处理package信息，等等官方并没有提到，而在本篇咱们的java类是有package的，与之相关的路径问题也会解决：  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5_size_16_color_FFFFFF_t_70 1]
3.  官方demo在运行时使用的依赖库是org.bytedeco:javacpp:1.5.5，运行时会输出以下警告信息，本篇会解决这个告警问题：

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

### 环境信息 ###

*  这里给出我的环境信息，您可以作为参考：

1.  操作系统：Ubuntu 16.04.5 LTS (server版，64位)
2.  g++：(Ubuntu 5.4.0-6ubuntu1~16.04.10) 5.4.0 20160609
3.  JDK：1.8.0\_291
4.  JavaCPP：1.5.5
5.  操作账号：root

### javacpp-1.5.5.jar文件下载 ###

*  本篇不会用到maven或者gradle，因此所需的jar文件需要自行准备，您可以从官网、maven中央仓库等地方下载，也可以从下面两个地方任选一个下载：

1.  CSDN（不用积分）：https://download.csdn.net/download/boling\_cavalry/20189395
2.  GitHub：https://raw.githubusercontent.com/zq2599/blog\_download\_files/master/files/javacpp-1.5.5.jar

### 完整源码和相关文件下载 ###

*  本次实战的所有源码以及相关文件，我这里都按照实战的目录位置打包上传到服务器，如果有需要，您可以从下面两个地方任选一个下载，用以参考，

1.  CSDN（不用积分）：https://download.csdn.net/download/boling\_cavalry/20189692
2.  GitHub：https://raw.githubusercontent.com/zq2599/blog\_download\_files/master/files/javacpp-project.tar

*  接下进入实战环节

### C++开发 ###

*  新建一个文件夹，我这边是/root/javacpp/cpp，C++开发都在此文件夹下进行
 *  C++部分总共要写三个文件，分别是：

1.  C++函数的源码：NativeLibrary.cpp
2.  头文件：NativeLibrary.h
3.  测试函数功能的文件：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文件创建成功，记住下面两个关键信息，稍后会用到：

1.  头文件是NativeLibrary.h
2.  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有以下几处需要注意：

1.  Namespace注解的值是命名空间，要与前面C++代码保持一致
2.  静态类名为MyFunc，这个要和C++中声明的类保持一致
3.  Platform注解的include属性是NativeLibrary.h，作用是指定头文件
4.  Platform注解的link属性的值是MyFunc，和so文件名libMyFunc.so相比，少了前面的lib前缀，以及so后缀，这是容易出错的地方，要千万小心，需要按照这个规则来设置link属性的值
5.  对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应用的输出，如下所示，其中有一段告警信息：

*  上述告警信息不会影响功能，如果想消除掉，就不能只用org.bytedeco:javacpp:1.5.5这一个库，而是org.bytedeco:javacpp-platform:1.5.5，**以及它的依赖库**
 *  由于本篇没有用到maven或者gradle，因此很难将org.bytedeco:javacpp-platform:1.5.5及其依赖库集齐，我这里已经将所有jar文件打包上传，您可以选择下面任意一种方式下载：

1.  CSDN（不用积分）：https://download.csdn.net/download/boling\_cavalry/20188764
2.  GitHub：https://raw.githubusercontent.com/zq2599/blog\_download\_files/master/files/javacpp-platform155.tar

*  下载下来后解压，是个名为lib的文件夹，将此文件夹放在/root/javacpp/java/目录下
 *  lib文件夹下的jar只是在运行时用到，编译时用不上，因此现在可以再次运行java应用了，命令如下：

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

*  在看控制台输出如下图，这次没有告警了：  
    ![在这里插入图片描述][20210711104047937.png]
 *  本次实战最终所有文件与目录信息如下，供您参考：

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++的函数，有以下几处需要重点关注：

1.  在Java代码中，要有与C++中同名的静态类
2.  注意Java代码中Namespace注解和C++中的namespace一致
3.  C++的头文件要和Java类放在同一个目录下
4.  使用so库的时候，库名为libMyFunc.so，Platform注解的link参数的值就是库名去掉lib前缀和.so后缀
5.  C++函数的so文件可以放在/usr/lib目录，也可以移至linux-x86\_64目录

*  至此，JavaCPP快速入门就完成了，如果您正在学习JavaCPP技术，希望本篇能给您一些参考；

### 你不孤单，欣宸原创一路相伴 ###

1.  [Java系列][Java]
2.  [Spring系列][Spring]
3.  [Docker系列][Docker]
4.  [kubernetes系列][kubernetes]
5.  [数据库+中间件系列][Link 1]
6.  [DevOps系列][DevOps]

[https_github.com_zq2599_blog_demos]: https://github.com/zq2599/blog_demos
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5_size_16_color_FFFFFF_t_70_pic_center]: /images/20221005/a0805f577bb24234a93193db244bf7b9.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5_size_16_color_FFFFFF_t_70_pic_center 1]: /images/20221005/c5687380347c4a9aa768a27770c67a7f.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5_size_16_color_FFFFFF_t_70]: /images/20221005/05b52bed981f4839914f0a2383683228.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5_size_16_color_FFFFFF_t_70 1]: /images/20221005/4d010e701c5f43d6a435d0e01ab24da8.png
[20210711104047937.png]: /images/20221005/239f08aad26247078e16134d3266fcd9.png
[Java]: https://xinchen.blog.csdn.net/article/details/105068742
[Spring]: https://xinchen.blog.csdn.net/article/details/105086498
[Docker]: https://xinchen.blog.csdn.net/article/details/105086732
[kubernetes]: https://xinchen.blog.csdn.net/article/details/105086794
[Link 1]: https://xinchen.blog.csdn.net/article/details/105086850
[DevOps]: https://xinchen.blog.csdn.net/article/details/105086920