关于云计算:JavaCPP快速入门官方demo增强版

https://github.com/zq2599/blog_demos

内容：所有原创文章分类汇总及配套源码，波及 Java、Docker、Kubernetes、DevOPS 等；

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，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

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

CSDN（不必积分）：https://download.csdn.net/dow…
GitHub：https://raw.githubusercontent…

本次实战的所有源码以及相干文件，我这里都依照实战的目录地位打包上传到服务器，如果有须要，您能够从上面两个中央任选一个下载，用以参考，

CSDN（不必积分）：https://download.csdn.net/dow…
GitHub：https://raw.githubusercontent…

接下进入实战环节

新建一个文件夹，我这边是 /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 文件，不创立 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 系列
Spring 系列
Docker 系列
kubernetes 系列
数据库 + 中间件系列
DevOps 系列

微信搜寻「程序员欣宸」，我是欣宸，期待与您一起畅游 Java 世界 …
https://github.com/zq2599/blog_demos

关于云计算:JavaCPP快速入门官方demo增强版

欢送拜访我的 GitHub

对于 JavaCPP

本篇概览

与官网 demo 的差别

环境信息

javacpp-1.5.5.jar 文件下载

残缺源码和相干文件下载

C++ 开发

Java 开发

编译和运行

一点小问题

关键点小结

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

欢送关注公众号：程序员欣宸