如何通过Java反射提前预判对类实例的反射访问是否合法

问题场景 #

我们有一款工具类，能遍历任意对象内容，将对象字段或getter方法返回值递归扁平化至指定层级并存入映射表。这个工具在日志记录、复杂结构问题排查中作用很大——当对象的toString()方法无法提供有效或足够信息时，它能弥补这一不足。

但在Java 9及以上版本中，如果待访问实例来自未授权的其他模块，会触发如下警告：

WARNING: An illegal reflective access operation has occurred

核心疑问：Java反射工具中是否存在简便方法，可提前获知反射访问是否被允许，从而预先避免此类触发警告/错误的调用？

可行解决方案 #

1. 利用AccessibleObject.trySetAccessible()（最简便） #

Java 9专门引入了trySetAccessible()方法，它不会抛出异常，而是返回布尔值表示是否成功设置反射对象的访问权限。直接针对要访问的字段、方法或构造器进行检查，成功后再执行访问操作，能有效避免触发非法访问警告。

示例代码：

// 针对字段的检查
Field targetField = targetClass.getDeclaredField("fieldName");
if (targetField.trySetAccessible()) {
    Object fieldValue = targetField.get(targetObject);
    // 处理字段值
} else {
    // 访问被拒绝，跳过该字段的处理
}

// 针对方法的检查
Method targetMethod = targetClass.getDeclaredMethod("getterMethod");
if (targetMethod.trySetAccessible()) {
    Object methodResult = targetMethod.invoke(targetObject);
    // 处理方法返回值
} else {
    // 访问被拒绝，跳过该方法的处理
}

2. 通过Module API检查模块权限 #

Java 9的模块系统中，可以通过Module类的方法提前判断当前模块是否有权限访问目标类所在的模块及包：

• Module.canRead(Module other)：检查当前模块是否能读取目标类所在的模块
• Module.isExported(String packageName, Module callerModule)：检查目标类的包是否导出给当前模块
• Module.isOpen(String packageName, Module callerModule)：检查目标类的包是否对当前模块开放（允许反射访问）

示例代码：

Class<?> targetClass = targetObject.getClass();
Module currentModule = MyReflectionTool.class.getModule();
Module targetModule = targetClass.getModule();
String targetPackage = targetClass.getPackageName();

// 先检查是否能读取目标模块
if (!currentModule.canRead(targetModule)) {
    // 无法读取目标模块，直接跳过
    return;
}

// 检查目标包是否导出给当前模块，或对当前模块开放
boolean isPackageAccessible = targetModule.isExported(targetPackage, currentModule) 
                            || targetModule.isOpen(targetPackage, currentModule);
if (isPackageAccessible) {
    // 可以尝试反射访问
} else {
    // 无访问权限，跳过
}

注意：如果目标模块通过JVM参数--add-opens对当前模块开放了指定包，isOpen()会返回true。

3. 捕获非法访问异常（兜底方案） #

如果无法提前检查，可以在反射调用时捕获IllegalReflectiveAccessException和IllegalAccessException，在异常发生时跳过该对象的处理。需要注意的是，默认情况下JVM只会输出警告而非抛出异常，可通过添加JVM参数--illegal-access=deny将警告转为IllegalReflectiveAccessException，方便捕获处理。

示例代码：

try {
    Field targetField = targetClass.getDeclaredField("fieldName");
    targetField.setAccessible(true);
    Object fieldValue = targetField.get(targetObject);
    // 处理字段值
} catch (IllegalReflectiveAccessException | IllegalAccessException e) {
    // 访问被拒绝，跳过处理
}

总结 #

优先推荐使用trySetAccessible()方法，它无需处理复杂的模块权限逻辑，直接针对具体的反射对象进行检查，代码简洁且能准确判断访问权限，是最简便的预检查方案。

内容的提问来源于stack exchange，提问作者Artur Linhart