macOS环境下CMake与Temurin JDK 8 JNI集成指南

本文旨在解决在macOS系统上使用Temurin JDK 8时，CMake在构建过程中无法正确检测到JNI库的常见问题。即使JAVA_HOME环境变量已正确配置，CMake的FindJNI模块仍可能报错。本教程将详细介绍通过在CMake调用中显式设置JNI相关的包含路径和变量来克服此障碍，确保项目能够顺利编译并链接JNI接口，为开发者提供一个稳定可靠的解决方案。

问题背景：CMake JNI检测失败的挑战

在macos系统上进行java native interface (jni) 开发时，使用cmake作为构建系统是一种常见实践。然而，当结合adoptium的eclipse temurin jdk 8版本时，开发者可能会遇到cmake无法正确检测到jni库的问题，即使java开发环境已通过homebrew正确安装，并且java_home环境变量也已指向正确的jdk路径。典型的错误信息如下：

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)

尽管jni.h等关键头文件确实存在于JDK的include目录下，且FindJNI.cmake模块中的JAVA_AWT_INCLUDE_DIRECTORIES变量值也正确，但CMake的内部find_path函数在某些情况下可能无法成功设置JAVA_INCLUDE_PATH，从而导致上述错误。这表明问题并非出在文件缺失，而是CMake的JNI查找机制在特定环境下的兼容性或路径解析问题。

解决方案：显式指定JNI相关路径

解决此问题的最直接且有效的方法是，在调用CMake时，通过命令行参数显式地将所有必需的JNI相关路径传递给它。这会覆盖CMake内部FindJNI模块可能存在的路径解析问题，强制CMake使用我们提供的正确路径。

以下是需要显式设置的CMake变量及其对应的路径：

• JAVA_HOME: Java安装的根目录。
• JAVA_INCLUDE_PATH: 包含jni.h等通用JNI头文件的路径。
• JAVA_INCLUDE_PATH2: 包含平台特定JNI头文件（如jni_md.h或jawt_md.h）的路径。在macOS上，这通常是JDK_HOME/include/darwin。
• JAVA_AWT_INCLUDE_PATH: 包含AWT相关JNI头文件的路径，通常与JAVA_INCLUDE_PATH相同。

为了确保路径的动态性和准确性，建议使用/usr/libexec/java_home -v 1.8命令来获取Java 8的安装路径。

完整的CMake调用示例：

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        .. # 其他CMake参数，例如你的源码目录

变量解释：

• -DJAVA_HOME=$(/usr/libexec/java_home -v 1.8): 设置Java开发工具包的根目录。java_home命令确保即使JDK安装路径发生变化，也能动态获取正确的路径。
• -DJAVA_INCLUDE_PATH=$(/usr/libexec/java_home -v 1.8)/include: 指向JNI核心头文件（如jni.h）所在的目录。
• -DJAVA_INCLUDE_PATH2=$(/usr/libexec/java_home -v 1.8)/include/darwin: 指向macOS平台特定的JNI头文件（如jni_md.h）所在的目录。这是解决JAVA_INCLUDED_PATH2缺失的关键。
• -DJAVA_AWT_INCLUDE_PATH=$(/usr/libexec/java_home -v 1.8)/include: 指向AWT（Abstract Window Toolkit）相关的JNI头文件目录，通常与JAVA_INCLUDE_PATH相同。

注意事项与最佳实践

1. JDK版本匹配： 确保java_home -v 1.8确实指向你希望使用的Temurin JDK 8版本。如果安装了多个JDK版本，此命令将返回与指定版本最匹配的路径。
2. 路径验证： 在执行CMake命令前，可以手动验证这些路径是否存在且包含所需的头文件。例如，ls $(/usr/libexec/java_home -v 1.8)/include/jni.h。
3. CMakeLists.txt中的find_package： 你的CMakeLists.txt文件中对JNI的find_package调用应保持不变，例如find_package(JNI 1.7 REQUIRED)。通过命令行参数显式设置变量会优先于FindJNI.cmake模块的内部查找逻辑。
4. 跨平台兼容性： 这种显式设置变量的方法在macOS上非常有效。对于Linux或Windows等其他操作系统，JAVA_INCLUDE_PATH2的路径可能会有所不同（例如，Linux通常是/include/linux，Windows则可能不需要此变量或路径不同）。因此，此解决方案主要针对macOS环境。
5. 自动化构建脚本： 如果你的项目使用自动化构建脚本（如Shell脚本或CI/CD流水线），请确保将上述CMake命令集成到脚本中，以保证每次构建都能正确配置JNI路径。

总结

通过在CMake命令行中显式指定JAVA_HOME、JAVA_INCLUDE_PATH、JAVA_INCLUDE_PATH2和JAVA_AWT_INCLUDE_PATH，可以有效解决在macOS上使用Temurin JDK 8时CMake无法正确检测JNI的问题。这种方法绕过了FindJNI.cmake模块在特定环境下的路径解析限制，提供了一个稳定可靠的解决方案，确保基于JNI的C/C++项目能够顺利编译和链接。开发者应根据实际JDK版本和操作系统环境调整路径，并将其融入到自动化构建流程中，以提高开发效率和构建的稳定性。