requires static表示编译期必需、运行时可选的模块依赖,用于隔离调试模块:编译时保障类型检查,运行时不加载、不报错,结合DEBUG = false可实现编译期裁剪与构建阶段物理隔离。

requires static 是 Java 9 引入的模块系统(JPMS)中用于声明模块依赖关系的关键字,它表示该依赖仅在编译期和链接期需要,运行时无需存在。这个特性非常适合引入调试辅助模块——比如日志增强、内存快照、HTTP 请求追踪等开发期工具,既能在 IDE 或本地运行时生效,又不会污染生产环境。
明确区分调试模块与主模块的依赖边界
将所有调试辅助功能(如 devtools-debugger、mock-data-generator)打包为独立模块(如 com.example.debug),其 module-info.java 不导出任何包给其他模块,也不 require 非调试模块。主业务模块(如 com.example.app)通过 requires static com.example.debug; 声明弱依赖:
- 编译时:JDK 能解析其中的类型(如
@DebugOnly注解、DevModeUtils工具类),支持条件编译 - 运行时:若未将
com.example.debug放入模块路径,JVM 完全忽略该 requires,不报错、不加载、不反射扫描 - 打包生产 JAR 时,只要不包含该模块 JAR,就不会有任何残留痕迹
用编译期常量 + 静态检查控制调试代码存活
避免运行时判断 if (isDevMode()) 留下无用字节码。改用 static final boolean DEBUG = false;(由构建工具注入),配合 requires static 中的辅助类做编译期裁剪:
- 在开发构建中,Maven 使用
compilerArgs注入-DDEBUG=true,并通过javac的--add-modules显式启用调试模块 - 在生产构建中,不传
--add-modules,且设DEBUG = false;此时所有含if (DEBUG) { ... }的块被 javac 彻底优化掉(JLS §14.21) - 调试模块内可提供
DebugSupport.isAvailable()方法,返回true仅当模块已加载——主模块调用它前先用requires static约束了编译可行性
构建阶段精准隔离:Maven + jlink 双保险
借助构建工具实现物理隔离,比纯代码逻辑更可靠:
- Maven profile
dev下:添加com.example.debug为compile依赖,并配置maven-compiler-plugin启用--add-modules - Maven profile
prod下:排除该依赖,且jdk.jlink插件生成运行镜像时,不 include 调试模块,确保最终jlink输出不含任何调试类 - IDE(如 IntelliJ)可识别
requires static,自动在 dev 模式下补全调试工具类,在 prod 模式下灰显或报错(需开启 “Use --add-modules” 设置)
典型调试场景示例:HTTP 请求拦截器
假设你有一个 com.example.debug.http 模块,提供 TraceInterceptor,主模块想在开发时注册它,但生产必须零感知:
- 主模块
module-info.java写:requires static com.example.debug.http; - 启动类中写:
if (TraceInterceptor.isAvailable()) { httpClient.addInterceptor(new TraceInterceptor()); } -
TraceInterceptor.isAvailable()内部用Class.forName("com.example.debug.http.TraceInterceptor")检查——仅当模块存在时才成功,否则 catch ClassNotFoundException 并返回 false - 生产构建后,该类根本不在 classpath/module-path 上,
isAvailable()必然返回 false,且整个 if 块因DEBUG = false被编译器移除











