springboot环境下java调用c程序生成动态链接库(基于JNI,linux环境下运行)

花了两天时间,研究出来的,现在把整个过程记录分享一下。
其中包含 简单的demo调用,挺简单,但是放到实际的项目中,网上没有资料,现在把整个流程以及其中可能犯的错误总结分享一下!

第一部分:简单的java调用C程序demo(在别人的基础上修改解释)

第一步.首先,我们先写个JAVA类:
public class HelloJNI { 
static { 
System.loadLibrary("HelloWorld");  //链接库的名字
} 
public native static void setNum(int num);  //链接库的方法
public native static int get();//链接库的方法
public static void main(String[] args) { 
    HelloJNI test = new HelloJNI(); //声明对象的时候,回去执行static里面的方法,加载c程序库
    test.setNum(666); 
        System.out.println(test.get());
       }
}

解释1:System.loadLibrary(“HelloWorld”);这句话是在执行java代码之前加载动态库,大家可以查阅一下System.loadLibrary的用法,System.load其实也是可以的,其中二者区别为:
System.load 参数必须为库文件的绝对路径,可以是任意路径
System.loadLibrary 参数为库文件名,不包含库文件的扩展名。
上面代码写的是System.loadLibrary(“HelloWorld”); ,意思就是生成的动态库文件名为HelloWorld.so(这是linux环境)(如果是window环境,则为HelloWorld.dll)
这里可能有人就会问,这个HelloWorld.so文件应该放在哪里呢?
这个需要放到linux系统下的JNI环境中,也就是说必须声明一个环境变量,对应一个文件夹,然后这个HelloWorld.so文件就放在这个文件夹下面就可以找到了。
环境变量声明:

export LD_LIBRARY_PATH=/opt/nativeTest

在此之前,可以查看一下LD_LIBRARY_PATH环境变量路径
echo $LD_LIBRARY_PATH
在这里插入图片描述
发现一个问题,我明明已经声明了,可为什么还是没有呢????
我又看了一下整个linux系统的环境变了配置

vim /etc/profile 查看当前linux环境变量

在这里插入图片描述
发现环境变量里面是有这个东西的啊,后来问了运维才发现,export LD_LIBRARY_PATH=/opt/nativeTest命令只对当前环境生效,也就是当前窗口,如果你再从新开一个窗口就不行了,解决办法,执行命令

source /etc/profile 让配置文件生效

在这里插入图片描述
现在就可以了。
解释2:
public native static void setNum(int num); //链接库的方法
public native static int get();//链接库的方法
这两个方法是在这里声明,然后再c程序里面实现的方法,用native 关键字修饰即可

回到正文,

第二步:执行.java文件

javac HelloJNI.java 生成.class文件,为了后面执行所用
javah -jni HelloJNI 生成.h文件,是为了链接c程序所用
这里没什么好解释的,懂的人自然懂,不懂的人,慢慢理解
来看一眼.h文件里面是什么吧

/* DO NOT EDIT THIS FILE - it is machine generated */
#include <jni.h>
/* Header for class HelloJNI */

#ifndef _Included_HelloJNI
#define _Included_HelloJNI
#ifdef __cplusplus
extern "C" {
#endif
/*
 * Class:     HelloJNI
 * Method:    setNum
 * Signature: (I)V
 */
JNIEXPORT void JNICALL Java_HelloJNI_setNum
  (JNIEnv *, jclass, jint);

/*
 * Class:     HelloJNI
 * Method:    get
 * Signature: ()I
 */
JNIEXPORT jint JNICALL Java_HelloJNI_get
  (JNIEnv *, jclass);

#ifdef __cplusplus
}
#endif
#endif

特别需要注意的地方,.h文件里面生成的方法名要和.c里面的是一样的!!!!!
也就是.h里面的方法名为Java_HelloJNI_setNum,.c文件里面的方法名也需要是Java_HelloJNI_setNum!!
当然这个只是在同一个文件夹的情况下是这样的,如果.java文件和生成的.so文件不在同一个文件夹下面,比如java文佳在com.huali.util文件夹下面,则这个c程序的方法名应该是Java_com_huali_util_HelloJNI_setNum,不然就会报错
特别注意2:生成的h文件要引入c程序里面


java.lang.UnsatisfiedLinkError:方法名

意思就是找不到这个方法的实现。

第三步:编写.c程序
#include "HelloJNI.h"
int result=888; 
//注:JAVA的类型跟C的类型转换 可以用JNI来操作
//有点类似继承的样子  
JNIEXPORT void JNICALL Java_HelloJNI_setNum
  (JNIEnv * env, jclass jc, jint num){
    result+=num; 

  }

  JNIEXPORT jint JNICALL Java_HelloJNI_get
  (JNIEnv * env, jclass jc){
    return result;

  }

注意看看上面c程序的方法名
注意看c程序引入的h文件,就是我们用java文件生成的h文件

#include "HelloJNI.h"
第四步:生成.so文件

执行命令

gcc -fPIC -I $JAVA_HOME/include -I $JAVA_HOME/include/linux -shared -o libHelloNative.so HelloNative.c

JAVAHOMElinuxjavaJAVA_HOME为linux下配置的环境变量,也就是java的安装的路径,如果没有配置JAVA_HOME环境变量的话,也可以直接写绝对路径
查看jdk的路径命令:好吧,我也不知道是怎么查看了!!百度一下
然后替换$JAVA_HOME,变成:

gcc -fPIC -I /usr/lib/jvm/java-8-openjdk-amd64/include -I /usr/lib/jvm/java-8-openjdk-amd64/include/linux -shared -o libHelloNative.so HelloNative.c

然后发现几个文件都在一个文件夹下

在这里插入图片描述

运行先前生成的.class文件就可以看到结果了

 java HelloJNI 

在这里插入图片描述
需要注意点:
需要将文件所在文件夹设置为动态库的环境变量
export LD_LIBRARY_PATH=/opt/nativeTest
不然就会出现一下错误

Exception in thread "main" java.lang.UnsatisfiedLinkError: no HelloWorld in java.library.path

在这里插入图片描述
意思就是找不到这个库在哪里!

第二部分:融合到项目中,并且优化操作

上面的demo很简单,但是如果放置到项目中,有两个弊端

第一:这个生成的.so文件还要放在特定的文件中,那用springboot每次打包,还要去关心这个东西,如果能直接将这个so文件放在项目中,一起打包,不用配置环境变量,那样就好了
第二:这个so的动态库,每次调用的时候都要去加载,那样就太浪费性能了吧,能不能在项目启动的时候就去加载,后面就不用加载了

首先简单说一下放入项目中的流程,首先生成so文件,流程基本上跟上面差不多。
第一步:写一个java文件,里面声明c程序里面实现的方法

package com.huali.business.util;

/**
 * @author wxy
 * @date 2019年5月15日 下午5:56:53
 */
public class V2xalgo{   
    public static native String mde(String param);

    public static String calculation(String param) {
        String result = mde(param);
	    return result;
    }
}

我的方法名字是mde,包是com.huali.business.util;,所以c程序里面的方法名必须是Java_com_huali_business_util_V2xalgo_mde
解释一下:java是固定的,_代表点,com_huali_business_util对应包名,V2xalgo代表类的名字,mde是方法名,如果java文件在其他的包里面,命名就要发生相应的变化,具体参考连接:
https://blog.csdn.net/ouyang_peng/article/details/52997698
第二步:生成.h文件,并且需要引入c程序中

#include "v2xalgo.h"

然后利用

gcc -fPIC -I $JAVA_HOME/include -I $JAVA_HOME/include/linux -shared -o libHelloNative.so HelloNative.c

生成so文件,将其放入resource下面的native文件夹下面
第三步:加载项目中的so动态链接库

package com.huali.business.util;

import java.io.*;
import java.net.JarURLConnection;
import java.net.URL;
import java.util.Enumeration;
import java.util.jar.JarEntry;
import java.util.jar.JarFile;

/**
 * @author Sky$
 * @Description: TODO
 * @date 2018/2/8$ 17:55$
 */
public class NativeLoader {


    /**
     * 加载项目下的native文件,DLL或SO
     *
     * @param dirPath 需要扫描的文件路径,项目下的相对路径
     * @throws IOException
     * @throws ClassNotFoundException
     */
    public synchronized static void loader(String dirPath) throws IOException, ClassNotFoundException {
        Enumeration<URL> dir = Thread.currentThread().getContextClassLoader().getResources(dirPath);
        // 获取操作系统类型
        String systemType = System.getProperty("os.name");
        //String systemArch = System.getProperty("os.arch");
        // 获取动态链接库后缀名
        String ext = (systemType.toLowerCase().indexOf("win") != -1) ? ".dll" : ".so";
        while (dir.hasMoreElements()) {
            URL url = dir.nextElement();
            String protocol = url.getProtocol();
            if ("jar".equals(protocol)) {
                JarURLConnection jarURLConnection = (JarURLConnection) url.openConnection();
                JarFile jarFile = jarURLConnection.getJarFile();
                // 遍历Jar包
                Enumeration<JarEntry> entries = jarFile.entries();
                while (entries.hasMoreElements()) {
                    JarEntry jarEntry = entries.nextElement();
                    String entityName = jarEntry.getName();
                    if (jarEntry.isDirectory() || !entityName.startsWith(dirPath)) {
                        continue;
                    }
                    if (entityName.endsWith(ext)) {
                        loadJarNative(jarEntry);
                    }
                }
            } else if ("file".equals(protocol)) {
                File file = new File(url.getPath());
                loadFileNative(file, ext);
            }

        }
    }

    private static void loadFileNative(File file, String ext) {
        if (null == file) {
            return;
        }
        if (file.isDirectory()) {
            File[] files = file.listFiles();
            if (null != files) {
                for (File f : files) {
                    loadFileNative(f, ext);
                }
            }
        }
        if (file.canRead() && file.getName().endsWith(ext)) {
            try {
                System.load(file.getPath());
                System.out.println("加载native文件 :" + file + "成功!!");
            } catch (UnsatisfiedLinkError e) {
                System.out.println("加载native文件 :" + file + "失败!!请确认操作系统是X86还是X64!!!");
            }
        }
    }

    /**
     * @throws IOException
     * @throws ClassNotFoundException
     * @Title: scanJ
     * @Description 扫描Jar包下所有class
     */
    /**
     * 创建动态链接库缓存文件,然后加载资源文件
     *
     * @param jarEntry
     * @throws IOException
     * @throws ClassNotFoundException
     */
    private static void loadJarNative(JarEntry jarEntry) throws IOException, ClassNotFoundException {

        File path = new File(".");
        //将所有动态链接库dll/so文件都放在一个临时文件夹下,然后进行加载
        //这是应为项目为可执行jar文件的时候不能很方便的扫描里面文件
        //此目录放置在与项目同目录下的natives文件夹下
        String rootOutputPath = path.getAbsoluteFile().getParent() + File.separator;
        String entityName = jarEntry.getName();
        String fileName = entityName.substring(entityName.lastIndexOf("/") + 1);
        System.out.println(entityName);
        System.out.println(fileName);
        File tempFile = new File(rootOutputPath + File.separator + entityName);
        // 如果缓存文件路径不存在,则创建路径
        if (!tempFile.getParentFile().exists()) {
            tempFile.getParentFile().mkdirs();
        }
        // 如果缓存文件存在,则删除
        if (tempFile.exists()) {
            tempFile.delete();
        }
        InputStream in = null;
        BufferedInputStream reader = null;
        FileOutputStream writer = null;
        try {
            //读取文件形成输入流
            in = NativeLoader.class.getResourceAsStream(entityName);
            if (in == null) {
                in = NativeLoader.class.getResourceAsStream("/" + entityName);
                if (null == in) {
                    return;
                }
            }
            NativeLoader.class.getResource(fileName);
            reader = new BufferedInputStream(in);
            writer = new FileOutputStream(tempFile);
            byte[] buffer = new byte[1024];

            while (reader.read(buffer) > 0) {
                writer.write(buffer);
                buffer = new byte[1024];
            }

        } catch (IOException e) {
            e.printStackTrace();
        }
        try {
            if (in != null) {
                in.close();
            }
            if (writer != null) {
                writer.close();
            }
        } catch (IOException e) {
            e.printStackTrace();
        }
        try {
            System.load(tempFile.getPath());
            System.out.println("加载native文件 :" + tempFile + "成功!!");
        } catch (UnsatisfiedLinkError e) {
            System.out.println("加载native文件 :" + tempFile + "失败!!请确认操作系统是X86还是X64!!!");
        }

    }

}

这是我在网上找的一个加载本地动态链接库的一个方法,直接调用NativeLoader.loader( “native” );即可,这样就可以实现在项目中直接调用so文件,而不需要去linux环境中配置环境变量并且在环境变量中放入库文件了!!
**第四步:**在项目其中文件中加载动态库

 //根据操作系统判断,如果是linux系统则加载c++方法库
      String systemType = System.getProperty("os.name");
      String ext = (systemType.toLowerCase().indexOf("win") != -1) ? ".dll" : ".so";
        if(ext.equals(".so")) {
        	try {
				NativeLoader.loader( "native" );
			} catch (Exception e) {
				System.out.println("加载so库失败");
			}
        	// System.loadLibrary( "v2xalgo" );
        }

NativeLoader.loader( “native” );native就是resource下面的文件夹的名称

这样就可以解决一次加载,后面就不用重复加载的问题了(这个启动文件,springboot+springcloud中必须有的启动文件)
这样就解决了上面说的两个问题
**第五部:**直接调用

String result = V2xalgo.calculation(param); 

传入参数,即可调用
注意点1: V2xalgo所在的包名要和c程序里面的方法名对应
注意点2:生成的so文件名必须是必须是lib+类名,,好像大小写没影响。

另外如果对性能没有要求的话,可以试用jna调用,具体大家可以研究一下,提供一篇文章供大家参考二者的区别
http://www.cnblogs.com/lanxuezaipiao/p/3635556.html
下图是项目结构截图
在这里插入图片描述
注意一下我的V2xalgo.java所在的位置,c程序里面实现方法的文件名为Java_com_huali_business_util_V2xalgo_mde

差不多就这样吧,花了两个多小时写的,挺累的。

展开阅读全文

没有更多推荐了,返回首页

©️2019 CSDN 皮肤主题: 深蓝海洋 设计师: CSDN官方博客
应支付0元
点击重新获取
扫码支付

支付成功即可阅读