无法从包私有基类中解析公共泛型方法

Question

Clojure编译器无法解析从包私有基类继承的公共泛型方法。

复现说明

• 在包P1中
  • 定义一个包含泛型类型参数的包私有类A
  • 在A中定义一个使用泛型类型（在其参数或返回值中）的公共方法M
    **** 定义一个扩展A的公共类B
• 在包P2中
  • 构建B的一个实例
    **** 调用B.M()

这在Java中是有效的。在Clojure中，调用B.M会先产生一个反射警告，然后错误信息 "java.lang.IllegalArgumentException: Can't call public method of non-public class."。无论类型提示如何都无法阻止警告或错误。

附件clj-1243-demo1.tar.gz包含示例代码和脚本，用于展示该问题。

使用包私有类中的公共方法的Java项目示例

• (链接：https://netty.java.net.cn/ 文本：Netty) 4
  • 查看链接：https://github.com/netty/netty/blob/ca0018279754557576bb2ecc17d209c2b6874609/transport/src/main/java/io/netty/bootstrap/AbstractBootstrap.java#L152 文本：AbstractBootstrap.java 和 https://github.com/netty/netty/issues/1780 文本：问题 #1780 以及Clojure票据CLJ-1183
• (链接：https://github.com/jfager/functional-critbit 文本：jfager/functional-critbit)
  • 查看链接：https://github.com/jfager/functional-critbit/blob/abb927d7e93ad21eaf75da339c27220f2cfdc222/src/main/java/io/prelink/critbit/AbstractCritBitTree.java#L305 文本：AbstractCritBitTree.java
    **** 示例：{{(.get (io.prelink.critbit.CritBitTree. (org.ardverk.collection.DefaultKeyAnalyzer.)) nil)}}

Answer 1

评论者：stuart.sierra

从Java中反射调用该方法也是不可能的。

这可能是Java反射中的一个bug：(链接：http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=4283544 文本：JDK-4283544)

但为什么它只发生在泛型方法上呢？

Comments

错误。这是一个合法的方法调用，因此使用Java反射调用它是完全可以接受的。你甚至不需要setAccessible。请参见我的示例：https://ask.clojure.org/index.php/4255/cannot-resolve-public-generic-method-package-private-class?show=12483#a12483

Answer 2

评论者：stuart.sierra

Rich Hickey表示，桥接方法的存在在JDK版本之间是不确定和不一致的。

一个可能的解决方案是使用ASM来检查第三方Java类的字节码，而不是使用反射API。这样，Clojure编译器就会拥有与Java编译器相同的信息。

Answer 3

评论者：jafingerhut

CLJ-1183已被关闭，因为它与此问题重复。在此提及它，以防任何处理此工单的人想要跟踪链接并阅读那里的讨论或测试用例。

Answer 4

评论者：noamb

我目前使用的临时解决方案是定义一个新的Java类，添加一个静态方法来执行我所需的功能，然后从Clojure中调用它。

Answer 5

评论者：noamb

此外，我在1.6和1.7(alpha5)中也看到了这个问题，但问题中只提到了1.5及以前版本。

Answer 6

评论由adamtait发表：

刚刚在尝试使用谷歌的云API时遇到了这个问题。
要使用谷歌的云数据存储，您需要访问保护泛型子类(BaseKey)上的(method: https://github.com/GoogleCloudPlatform/gcloud-java/blob/v0.1.6/gcloud-java-datastore/src/main/java/com/google/gcloud/datastore/BaseKey.java#L96 文本: .kind)方法，该子类通过(method: https://github.com/GoogleCloudPlatform/gcloud-java/blob/v0.1.6/gcloud-java-datastore/src/main/java/com/google/gcloud/datastore/KeyFactory.java#L25 文本: KeyFactory)扩展而来。

已在Clojure 1.7和1.8运行时测试，以下异常持续存在；
{quote}
IllegalArgumentException：无法调用非公开类的公共方法：public com.google.gcloud.datastore.BaseKey$Builder com.google.gcloud.datastore.BaseKey$Builder.kind(java.lang.String) clojure.lang.Reflector.invokeMatchingMethod (Reflector.java:88)
{quote}

Answer 7

评论由kstrempel发表：

我也遇到了与谷歌云API相同的问题。

在1.8和1.9.0-alpha7上都测试过。问题依旧。

Answer 8

评论由kstrempel发表：

我也遇到了与谷歌云API相同的问题。

在1.8和1.9.0-alpha7上都测试过。问题依旧。

Answer 9

评论由mruza发表：

我也遇到了相同的问题。(链接: ^invocation_target_selection.patch 文本: 随附的补丁)为我解决了问题。
项目中的所有测试仍然通过，但这是非常需要专家审阅的。

Answer 10

评论由alexmiller发表：

嗨，Michal，

感谢你查看它。

1. 请在此处查看有关如何以正确格式创建补丁的说明： http://dev.clojure.org/display/community/Developing Patches
2. 如果您能提供一些有关更改的解释以协助审阅那就十分有益。否则审阅者必须从头开始重新设计您的思想过程。
3. 在进行筛选之前，此更改也需要进行一些测试（当然，写起来并不特别有趣，但我认为在这里是必要的）

Answer 11

评论由mruza发表：

我已经添加了测试并根据说明更新了补丁。

以下是一些背后的理由。以下是 src/jvm/clojure/lang/Compiler.java 文件的摘录

1462: if(target.hasJavaClass() && target.getJavaClass() != null) 1463: { 1464: List methods = Reflector.getMethods(target.getJavaClass(), args.count(), methodName, false); 1465: if(methods.isEmpty()) 1466: { 1467: method = null; 1468: if(RT.booleanCast(RT.WARN_ON_REFLECTION.deref())) 1469: { 1470: RT.errPrintWriter() 1471: .format("Reflection warning, %s:%d:%d - call to method %s on %s can't be resolved (no such method).\n", 1472: SOURCE_PATH.deref(), line, column, methodName, target.getJavaClass().getName()); 1473: } 1474: } 1475: else 1476: { 1477: int methodidx = 0; 1478: if(methods.size() > 1) 1479: { 1480: ArrayList<Class[]> params = new ArrayList(); 1481: ArrayList<Class> rets = new ArrayList(); 1482: for(int i = 0; i < methods.size(); i++) 1483: { 1484: java.lang.reflect.Method m = (java.lang.reflect.Method) methods.get(i); 1485: params.add(m.getParameterTypes()); 1486: rets.add(m.getReturnType()); 1487: } 1488: methodidx = getMatchingParams(methodName, params, args, rets); 1489: } 1490: java.lang.reflect.Method m = 1491: (java.lang.reflect.Method) (methodidx >= 0 ? methods.get(methodidx) : null); 1492: if(m != null && !Modifier.isPublic(m.getDeclaringClass().getModifiers())) 1493: { 1494: //public method of non-public class, try to find a public descendant 1495: if((type=Reflector.getDeepestPublicDescendant(m.getDeclaringClass(), target.getJavaClass())) == null) 1496: //if descendant not found, try to find an ancestor 1497: m = Reflector.getAsMethodOfPublicBase(m.getDeclaringClass(), m); 1498: } 1499: method = m; 1500: if(method == null && RT.booleanCast(RT.WARN_ON_REFLECTION.deref())) 1501: { 1502: RT.errPrintWriter() 1503: .format("Reflection warning, %s:%d:%d - call to method %s on %s can't be resolved (argument types: %s).\n", 1504: SOURCE_PATH.deref(), line, column, methodName, target.getJavaClass().getName(), getTypeStringForArgs(args)); 1505: } 1506: } 1507: }

• 第1462行的条件确保了目标类型/类的已知性
• 第1464行调用的{{clojure.lang.Reflector.getMethods()}}方法返回为目标类型定义的给定名称的所有公共方法列表
• 然后在第1477-1491行选择最佳调用的方法
• 如果选中方法的声明类不是公共的，则尝试找到既是目标类型的超类又是选中方法声明类的子类的公共类——这是在{{clojure.lang.Reflector.getDeepestPublicDescendant()}}方法中实现的
• 如果找到了这样的类，则将其用于而不是方法声明类来生成方法调用的字节码
• 如果没有找到这样的类，则尝试在声明选中方法的类的公共祖先中找到一个兼容的方法

请注意，更改可能会导致在{{选择非公共接口的方法}}测试中调用不同的方法，我认为这是一个可以接受的更改，因为它
带来了更好的匹配（与参数类型相关）的方法被调用
使 clojure 中的方法选择表现得与 java 更相似

Answer 12

评论者：stuart.sierra

CLJ-126 描述了在 Java 5 上存在的一个类似问题。

Answer 13

参考：[https://clojure.atlassian.net/browse/CLJ-1243](https://clojure.atlassian.net/browse/CLJ-1243)（由 stuart.sierra 报告）

Answer 14

以下是一个在 Java 中正常工作但在 Clojure 中失败的代码示例。示例类来自 [org.opensearch.client/opensearch-java "2.1.0"] 库。

以下 Java 代码无问题运行

package example;

import org.opensearch.client.opensearch.core.bulk.IndexOperation;

import java.io.IOException;
import java.util.Map;

public class Example {
    public static void main(String[] args) throws IOException {
        new IndexOperation.Builder<Map<?, ?>>()
                .index("test-index")
                .id("test-id")
                .document(Map.of("test-document", 123))
                .build();
    }
}

但 Clojure 版本无法使用 Java 互操作编写。解决方法是手动使用反射来调用这些方法

(ns example
  (:import (org.opensearch.client.opensearch.core.bulk IndexOperation$Builder)))

(defn bug []
  (-> (IndexOperation$Builder.)
      (.index "test-index")
      (.id "test-id")
      (.document {"test-document" 123})
      (.build)))

(defn workaround []
  (let [bulk-builder-index (-> (Class/forName "org.opensearch.client.opensearch.core.bulk.BulkOperationBase$AbstractBuilder")
                               (.getDeclaredMethod "index" (into-array Class [String])))
        bulk-builder-id (-> (Class/forName "org.opensearch.client.opensearch.core.bulk.BulkOperationBase$AbstractBuilder")
                            (.getDeclaredMethod "id" (into-array Class [String])))]
    (-> (IndexOperation$Builder.)
        ^IndexOperation$Builder ((fn [builder index]
                                   (.invoke bulk-builder-index builder (into-array Object [index])))
                                 "test-index")
        ^IndexOperation$Builder ((fn [builder id]
                                   (.invoke bulk-builder-id builder (into-array Object [id])))
                                 "test-id")
        (.document {"test-document" 123})
        (.build))))

(comment
  (bug)
  (workaround))

当这个命名空间与 Clojure 1.11.1 一同加载时，给出以下反射警告

Reflection warning, .../example.clj:6:7 - call to method index on org.opensearch.client.opensearch.core.bulk.IndexOperation$Builder can't be resolved (argument types: java.lang.String).
Reflection warning, .../example.clj:7:7 - call to method id can't be resolved (target class is unknown).
Reflection warning, .../example.clj:8:7 - call to method document can't be resolved (target class is unknown).
Reflection warning, .../example.clj:9:7 - reference to field build can't be resolved.

当执行故障函数时，它会抛出异常

Execution error (IllegalArgumentException) at example/bug (example.clj:6).
Can't call public method of non-public class: public final org.opensearch.client.opensearch.core.bulk.BulkOperationBase$AbstractBuilder org.opensearch.client.opensearch.core.bulk.BulkOperationBase$AbstractBuilder.index(java.lang.String)

IndexOperation$Builder 是一个公共类，它扩展了受保护的抽象类 WriteOperation$AbstractBuilder，后者扩展了受保护的抽象类 BulkOperationBase$AbstractBuilder。方法的 index 和 id 返回类型是类级别的类型参数，但方法参数不是泛型。

以下是库代码中相关的地方

• IndexOperation$Builder 类型签名
• WriteOperation$AbstractBuilder 类型签名
• BulkOperationBase$AbstractBuilder 类型签名
• BulkOperationBase$AbstractBuilder 方法签名