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

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
  • 请参阅(link：https://github.com/netty/netty/blob/ca0018279754557576bb2ecc17d209c2b6874609/transport/src/main/java/io/netty/bootstrap/AbstractBootstrap.java#L152 文本：AbstractBootstrap.java)和(link：https://github.com/netty/netty/issues/1780 文本：问题#1780)以及Clojure票据CLJ-1183
• (链接：https://github.com/jfager/functional-critbit 文本：jfager/functional-critbit)
  • 请参阅(link：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 反射中的一个错误：(链接：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 APIs时遇到了这个问题。
要使用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）文本：KeyFactory。

在1.7和1.8版本Clojure的运行时测试了，以下异常仍然存在；
{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 制作

Hey 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()}}方法中实现的
• 如果找到了这样的类，则使用该类而不是方法声明类在生成方法调用时的字节码
• 如果找不到这样的类，则在声明所选方法的类的公共祖先中尝试找到一个兼容的方法

请注意，这种改动可能会导致与改动前不同的方法被调用，如{{selecting-method-on-nonpublic-interface}}测试所示。我认为这是一个可接受的变化，因为它
导致调用与参数类型匹配度更好的方法
使Clojure中的方法选择行为更类似于Java中的行为

Answer 12

评论由：stuart.sierra发表

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

Answer 13

参考： 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方法签名