在SpringBoot項目中如何確保ffmpeg和opencv的so依賴在打包后正確加載?
在開發過程中,經常會遇到將FFmpeg和OpenCV集成到SpringBoot項目中的情況,尤其是當項目需要處理視頻和圖像時。然而,開發環境和生產環境之間的差異常常導致庫文件加載問題。本文將詳細探討如何在SpringBoot項目中正確加載FFmpeg和OpenCV的so依賴,并確保打包后的應用也能正常運行。
問題背景
在使用Java 21和SpringBoot 3開發的項目中,我們依賴于FFmpeg 7.1-1.5.11和OpenCV 4.10.0-1.5.11這兩個庫。項目的pom.xml配置如下:
<properties> <bytedeco.version>1.5.11</bytedeco.version> <opencv-platform.version>4.10.0-1.5.11</opencv-platform.version> <ffmpeg-platform.version>7.1-1.5.11</ffmpeg-platform.version> <javacpp.platform.linux-x86_64>linux-x86_64</javacpp.platform.linux-x86_64> <javacpp.platform.windows-x86_64>windows-x86_64</javacpp.platform.windows-x86_64> <javacpp.platform>${javacpp.platform.linux-x86_64}</javacpp.platform> </properties> <dependencies> <dependency> <groupId>org.bytedeco</groupId> <artifactId>javacpp</artifactId> <version>${bytedeco.version}</version> </dependency> <dependency> <groupId>org.bytedeco</groupId> <artifactId>javacv</artifactId> <version>${bytedeco.version}</version> </dependency> <dependency> <groupId>org.bytedeco</groupId> <artifactId>opencv</artifactId> <version>${opencv-platform.version}</version> <classifier>${javacpp.platform}</classifier> </dependency> <dependency> <groupId>org.bytedeco</groupId> <artifactId>ffmpeg</artifactId> <version>${ffmpeg-platform.version}</version> <classifier>${javacpp.platform}</classifier> </dependency> </dependencies>
當項目打包成jar后,FFmpeg和OpenCV的so依賴應該被包含在jar包中的BOOT-INF/lib目錄下。然而,在運行時,這些依賴并沒有被正確加載,導致如下錯誤:
Caused by: java.lang.ExceptionInInitializerError: Exception java.lang.UnsatisfiedLinkError: no jniavutil in java.library.path: /usr/java/packages/lib:/usr/lib64:/lib64:/lib:/usr/lib [in thread "http-nio-8100-exec-1"]
在開發環境中,ide會自動將依賴添加到classpath中,因此可以正常加載。但在生產環境中,jar包的運行方式不同,導致這些依賴無法被找到。
解決方案
為了解決這個問題,我們需要在SpringBoot應用中編程方式配置JavaCPP,以便在應用啟動時正確加載這些本地庫。
-
在應用啟動時配置JavaCPP
我們可以創建一個配置類,在應用啟動時執行必要的配置:
package com.demo.config; import org.bytedeco.javacpp.Loader; import org.springframework.context.annotation.Configuration; import javax.annotation.PostConstruct; @Configuration public class JavaCppConfig { @PostConstruct public void init() { // 設置JavaCPP提取本地庫的目錄 System.setProperty("org.bytedeco.javacpp.extract", "true"); System.setProperty("org.bytedeco.javacpp.extractDir", "/tmp/javacpp-native-libs"); // 預加載需要的庫,這會觸發JavaCPP從jar中提取庫文件 try { // 預加載FFmpeg相關庫 Loader.load(org.bytedeco.ffmpeg.global.avutil.class); Loader.load(org.bytedeco.ffmpeg.global.avcodec.class); Loader.load(org.bytedeco.ffmpeg.global.avformat.class); Loader.load(org.bytedeco.ffmpeg.global.swscale.class); // 預加載OpenCV庫 Loader.load(org.bytedeco.opencv.global.opencv_core.class); Loader.load(org.bytedeco.opencv.global.opencv_imgproc.class); System.out.println("Native libraries loaded successfully"); } catch (Exception e) { System.err.println("Failed to load native libraries: " e.getMessage()); e.printStackTrace(); } } }
-
自定義docker鏡像構建
如果項目需要構建成Docker鏡像,我們可以創建一個自定義的Dockerfile來預先提取這些本地庫并配置好路徑:
FROM openjdk:21-slim # 安裝程序運行所需的庫 RUN apt-get update && apt-get install -y libgomp1 && rm -rf /var/lib/apt/lists/* # 創建目錄用于提取本地庫 RUN mkdir -p /opt/javacpp-native-libs ENV JAVACPP_EXTRACT_DIR=/opt/javacpp-native-libs # 設置工作目錄 WORKDIR /app # 復制應用jar包 COPY target/*.jar app.jar # 預先提取所有本地庫到指定目錄 RUN mkdir -p /tmp/extract && cd /tmp/extract && java -Dorg.bytedeco.javacpp.extract=true -Dorg.bytedeco.javacpp.extractDir=/opt/javacpp-native-libs -jar /app/app.jar --extract-native-libraries && rm -rf /tmp/extract # 設置系統屬性,指向提取的本地庫位置 ENV JAVA_OPTS="-Dorg.bytedeco.javacpp.extractDir=/opt/javacpp-native-libs -Dorg.bytedeco.javacpp.extract=false" # 啟動應用 ENTRYPOINT ["sh", "-c", "java $JAVA_OPTS -jar app.jar"]
通過上述方法,我們可以在應用啟動時正確加載FFmpeg和OpenCV的so依賴,并且確保在Docker容器中也能正常運行,而無需修改基礎鏡像或將so文件添加到外部目錄。
注意事項
- JavaCPP需要能夠寫入臨時目錄來提取本地庫。
- 在Docker環境中,可能需要添加-Dorg.bytedeco.javacpp.maxphysicalbytes=0來防止內存限制問題。
- 如果項目需要在多個平臺(如Windows和Linux)上運行,需注意配置正確的平臺屬性。
通過在啟動應用時添加以下系統屬性,也可以嘗試解決問題:
java -Djava.library.path=path/to/extracted/libs -Djavacpp.platform=linux-x86_64 -jar your-app.jar