无法解析来自包私有的基类的公共泛型方法

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

在尝试使用Google Cloud API时遇到了这个问题。
要使用Google Cloud Datastore，您需要访问受保护的泛型子类（BaseKey）上的方法（链接：https://github.com/GoogleCloudPlatform/gcloud-java/blob/v0.1.6/gcloud-java-datastore/src/main/java/com/google/gcloud/datastore/BaseKey.java#L96）。此方法为.kind，并被（链接：https://github.com/GoogleCloudPlatform/gcloud-java/blob/v0.1.6/gcloud-java-datastore/src/main/java/com/google/gcloud/datastore/KeyFactory.java#L25）。text: 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

我在使用Google Cloud API时遇到了同样的问题。

在1.8和1.9.0-alpha7版本上测试过，问题依旧。

Answer 8

评论者：kstrempel

我在使用Google Cloud 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: } 1477: }

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

请注意，这个改动可能会导致调用不同的方法，如{{selecting-method-on-nonpublic-interface}}测试所示。在我看来，这是一个可以接受的变化，因为它
导致（关于参数类型）更好的方法匹配
使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 interop 编写。解决方案是手动使用反射调用那些方法

(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 方法签名