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

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反射中存在的问题：（链接：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 文本：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: } 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](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方法签名