关于云计算: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,用<font color=”blue”>java -jar</font>命令能够将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自身,而不是一些其余的细枝末节):
  1. 如下图,官网的C++代码只有一个<font color=”blue”>NativeLibrary.h</font>文件,函数性能也在这个文件中,最终生成了一个jni的so文件,而实际上,应该是头文件与性能代码拆散,因而本文中的头文件和C++函数的源码是离开的,学生成函数性能的so,再在java中生成jni的so,一共会有两个so文件,至于这两个so如何配置和拜访,也是本文的重点之一:

  1. 官网demo的java源码如下图,是没有package信息的,而理论java工程中都会有package,由此带来的门路问题,例如头文件放哪里?编译和生成so文件时的命令行怎么解决package信息,等等官网并没有提到,而在本篇咱们的java类是有package的,与之相干的门路问题也会解决:

  1. 官网demo在运行时应用的依赖库是<font color=”blue”>org.bytedeco:javacpp:1.5.5</font>,运行时会输入以下正告信息,本篇会解决这个告警问题:
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/dow…
  2. GitHub:https://raw.githubusercontent…

残缺源码和相干文件下载

  • 本次实战的所有源码以及相干文件,我这里都依照实战的目录地位打包上传到服务器,如果有须要,您能够从上面两个中央任选一个下载,用以参考,
  1. CSDN(不必积分):https://download.csdn.net/dow…
  2. GitHub:https://raw.githubusercontent…
  • 接下进入实战环节

C++开发

  • 新建一个文件夹,我这边是<font color=”blue”>/root/javacpp/cpp</font>,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文件<font color=”blue”>libMyFunc.so</font>:
g++ -std=c++11 -fPIC -shared NativeLibrary.cpp -o libMyFunc.so
  • 执行以下命令,编译和链接test.cpp,失去可执行文件<font color=”blue”>test</font>:
g++ test.cpp -o test ./libMyFunc.so
  • 运行可执行文件试试,命令是<font color=”blue”>./test</font>:
root@docker:~/javacpp/cpp# ./test
add value 3
  • 将<font color=”red”>libMyFunc.so</font>文件复制到<font color=”blue”>/usr/lib/</font>目录下
  • test的执行后果合乎预期,证实so文件创建胜利,记住上面两个要害信息,稍后会用到:
  1. 头文件是<font color=”blue”>NativeLibrary.h</font>
  2. so文件是<font color=”blue”>libMyFunc.so</font>
  • 接下来是java局部

Java开发

  • 简略起见,咱们手写java文件,不创立maven工程
  • 新建一个文件夹,我这边是<font color=”blue”>/root/javacpp/java</font>,java开发都在此文件夹下进行
  • 将文件<font color=”red”>javacpp-1.5.5.jar</font>复制到<font color=”blue”>/root/javacpp/java/</font>目录下
  • 出于集体习惯,喜爱将java类放在packgage下,因而建好package目录,我这里是<font color=”blue”>com/bolingcavalry/javacppdemo</font>,在我这里的绝对路径就是<font color=”blue”>/root/javacpp/java/com/bolingcavalry/javacppdemo</font>
  • 将文件<font color=”red”>NativeLibrary.h</font>复制到<font color=”blue”>com/bolingcavalry/javacppdemo</font>目录下
  • 在<font color=”blue”>com/bolingcavalry/javacppdemo</font>目录下新建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++代码保持一致
  • 动态类名为<font color=”red”>MyFunc</font>,这个要和C++中申明的类保持一致
  • Platform注解的include属性是NativeLibrary.h,作用是指定头文件
  • Platform注解的link属性的值是<font color=”red”>MyFunc</font>,和so文件名libMyFunc.so相比,少了后面的lib前缀,以及so后缀,这是容易出错的中央,要千万小心,须要依照这个规定来设置link属性的值
  • 对so中的add办法,通过native关键字做申明,而后就能够应用了
  • 当初开发工作曾经实现,接下来开始编译和运行

编译和运行

  • 首先是编译java文件,进入目录<font color=”blue”>/root/javacpp/java</font>,执行以下命令,即可生成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
  • 此时的<font color=”blue”>com/bolingcavalry/javacppdemo</font>目录下新增了一个名为<font color=”red”>linux-x86_64</font>的文件夹,外面的<font color=”red”>libjniTest.so</font>是javacpp-1.5.5.jar生成的
  • 您能够将<font color=”blue”>/usr/lib/</font>目录下的<font color=”red”>libMyFunc.so</font>文件挪动到<font color=”blue”>linux-x86_64</font>目录下(不挪动也能够,只是集体感觉业务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
  • 上述告警信息不会影响性能,如果想打消掉,就不能只用<font color=”blue”>org.bytedeco:javacpp:1.5.5</font>这一个库,而是<font color=”blue”>org.bytedeco:javacpp-platform:1.5.5</font>,<font color=”red”>以及它的依赖库</font>
  • 因为本篇没有用到maven或者gradle,因而很难将<font color=”blue”>org.bytedeco:javacpp-platform:1.5.5</font>及其依赖库集齐,我这里曾经将所有jar文件打包上传,您能够抉择上面任意一种形式下载:
  1. CSDN(不必积分):https://download.csdn.net/dow…
  2. GitHub:https://raw.githubusercontent…
  • 下载下来后解压,是个名为<font color=”blue”>lib</font>的文件夹,将此文件夹放在<font color=”blue”>/root/javacpp/java/</font>目录下
  • 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++的函数,有以下几处须要重点关注:
  1. 在Java代码中,要有与C++中同名的动态类
  2. 留神Java代码中Namespace注解和C++中的namespace统一
  3. C++的头文件要和Java类放在同一个目录下
  4. 应用so库的时候,库名为<font color=”blue”>libMyFunc.so</font>,Platform注解的link参数的值就是库名去掉<font color=”red”>lib</font>前缀和<font color=”red”>.so</font>后缀
  5. C++函数的so文件能够放在/usr/lib目录,也能够移至linux-x86_64目录
  • 至此,JavaCPP疾速入门就实现了,如果您正在学习JavaCPP技术,心愿本篇能给您一些参考;

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

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

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

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

评论

发表回复

您的邮箱地址不会被公开。 必填项已用 * 标注

这个站点使用 Akismet 来减少垃圾评论。了解你的评论数据如何被处理