解决macOS上CMake无法正确检测Temurin JDK 8 JNI的问题

1. 问题背景与现象分析

在macos系统上进行java native interface (jni) 开发时，c/c++项目通常会使用cmake来管理构建过程并查找jni相关的头文件和库。然而，当使用homebrew安装的adoptium temurin jdk 8时，即使您已正确设置了java_home环境变量，cmake的find_package(jni ...)命令仍然可能无法成功定位jni组件，并抛出以下错误：

CMake Error at /usr/local/Cellar/cmake/3.24.2/share/cmake/Modules/FindPackageHandleStandardArgs.cmake:230 (message):
  Could NOT find JNI (missing: JAVA_INCLUDED_PATH JAVA_INCLUDED_PATH2 AWT)

这个错误表明CMake的FindJNI模块未能找到JNI所需的几个关键路径：JAVA_INCLUDED_PATH（通常指向jni.h所在的目录）、JAVA_INCLUDED_PATH2（通常指向jni_md.h所在的特定平台目录，如darwin）以及AWT相关的包含路径。尽管jni.h文件可能确实存在于JDK的include目录下，并且您手动测试find_path命令可以找到它，但FindJNI模块的内部逻辑可能在特定环境下未能正确解析或设置这些变量。

2. 前提条件：JDK与CMake的安装

在解决问题之前，请确保您的系统已正确安装Temurin JDK 8和CMake：

1. 安装Temurin JDK 8：

   brew tap homebrew/cask-versions
   brew install --cask temurin8

   登录后复制

2. 设置JAVA_HOME环境变量： 在终端中执行以下命令，并将其添加到您的shell配置文件（如~/.bash_profile, ~/.zshrc等）中，以便永久生效：

   export JAVA_HOME=$(/usr/libexec/java_home -v 1.8)
   echo $JAVA_HOME
   # 预期输出：/Library/Java/JavaVirtualMachines/temurin-8.jdk/Contents/Home

   登录后复制

3. 安装CMake：

   brew install cmake

   登录后复制

3. 解决方案：显式传递JNI路径给CMake

解决此问题的最有效方法是绕过FindJNI模块的自动检测机制，直接通过CMake命令行参数显式地指定JNI相关的路径。这可以确保CMake能够准确找到所需的头文件和库。

您需要在调用cmake命令时，添加以下-D参数来定义JNI相关的变量：

cmake \
  -DJAVA_HOME=$(/usr/libexec/java_home -v 1.8) \
  -DJAVA_INCLUDE_PATH=$(/usr/libexec/java_home -v 1.8)/include \
  -DJAVA_INCLUDE_PATH2=$(/usr/libexec/java_home -v 1.8)/include/darwin \
  -DJAVA_AWT_INCLUDE_PATH=$(/usr/libexec/java_home -v 1.8)/include \
  <您的项目源目录>

参数解释：

Clipfly

一站式AI视频生成和编辑平台，提供多种AI视频处理、AI图像处理工具。

98

查看详情

• -DJAVA_HOME: 指定Java开发工具包的根目录。
• -DJAVA_INCLUDE_PATH: 指向包含jni.h等通用JNI头文件的目录。对于Temurin JDK 8，通常是${JAVA_HOME}/include。
• -DJAVA_INCLUDE_PATH2: 指向包含特定平台（如macOS）JNI头文件（如jni_md.h）的目录。在macOS上，这通常是${JAVA_HOME}/include/darwin。
• -DJAVA_AWT_INCLUDE_PATH: 指向AWT（Abstract Window Toolkit）相关的头文件目录。虽然在某些非GUI项目中可能不直接需要，但FindJNI模块通常会检查此路径。对于Temurin JDK 8，它也位于${JAVA_HOME}/include。

示例 CMakeLists.txt 文件：

一个典型的C++项目CMakeLists.txt文件，需要查找JNI时，会包含类似如下内容：

cmake_minimum_required(VERSION 3.10)
project(MyJNIProject CXX)

# 查找JNI包，要求版本1.7及以上
find_package(JNI 1.7 REQUIRED)

# 如果成功找到JNI，则打印相关路径
if (JNI_FOUND)
    message(STATUS "JNI found.")
    message(STATUS "JAVA_INCLUDE_PATH: ${JAVA_INCLUDE_PATH}")
    message(STATUS "JAVA_INCLUDE_PATH2: ${JAVA_INCLUDE_PATH2}")
    message(STATUS "JAVA_AWT_INCLUDE_PATH: ${JAVA_AWT_INCLUDE_PATH}")
    message(STATUS "JAVA_JVM_LIBRARY: ${JAVA_JVM_LIBRARY}")
else()
    message(FATAL_ERROR "JNI not found.")
endif()

# 示例：添加一个依赖JNI的库
add_library(mylibrary SHARED mylibrary.cpp)
target_include_directories(mylibrary PUBLIC ${JAVA_INCLUDE_PATH} ${JAVA_INCLUDE_PATH2} ${JAVA_AWT_INCLUDE_PATH})
target_link_libraries(mylibrary PUBLIC ${JAVA_JVM_LIBRARY})

完整的构建命令示例：

假设您的CMakeLists.txt位于当前目录，您可以在项目根目录下创建一个build目录并执行以下命令：

mkdir build
cd build
cmake \
  -DJAVA_HOME=$(/usr/libexec/java_home -v 1.8) \
  -DJAVA_INCLUDE_PATH=$(/usr/libexec/java_home -v 1.8)/include \
  -DJAVA_INCLUDE_PATH2=$(/usr/libexec/java_home -v 1.8)/include/darwin \
  -DJAVA_AWT_INCLUDE_PATH=$(/usr/libexec/java_home -v 1.8)/include \
  ..
make

4. 注意事项与最佳实践

• 路径的动态获取： 使用$(/usr/libexec/java_home -v 1.8)命令来动态获取JDK 8的安装路径，而不是硬编码。这可以确保即使JDK的安装位置发生变化，您的CMake命令依然有效。
• 版本兼容性： find_package(JNI 1.7 REQUIRED)表示需要JNI 1.7或更高版本。Temurin JDK 8满足此要求。
• 验证路径： 在执行CMake命令前，您可以通过ls命令手动验证上述include和include/darwin目录下是否存在jni.h和jni_md.h等文件，以确保路径的正确性。

  ls $(/usr/libexec/java_home -v 1.8)/include/jni.h
  ls $(/usr/libexec/java_home -v 1.8)/include/darwin/jni_md.h

  登录后复制
• 通用性： 这种显式传递路径的方法不仅适用于Temurin JDK，当您遇到CMake在macOS上无法正确检测其他JDK版本或类型（如Oracle JDK, OpenJDK）的JNI问题时，也可以尝试类似的方法。

5. 总结

在macOS上使用Adoptium Temurin JDK 8进行JNI开发时，CMake的FindJNI模块可能会因为内部检测机制的限制而无法正确识别JNI路径。通过在CMake命令行中显式地设置JAVA_HOME、JAVA_INCLUDE_PATH、JAVA_INCLUDE_PATH2和JAVA_AWT_INCLUDE_PATH等变量，可以有效解决这一问题。这种方法提供了一个稳定可靠的解决方案，确保您的JNI项目能够顺利配置和编译，从而避免因环境配置问题而阻碍开发进度。

以上就是解决macOS上CMake无法正确检测Temurin JDK 8 JNI的问题的详细内容，更多请关注php中文网其它相关文章！