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

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 反射调用它是完全没问题的。你甚至不需要设置可访问性。请参见我的答案示例：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 方法，而KeyFactory类是通过链接： 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

Hey Michal,

感谢查看。

1. 请在此处按照如何以正确格式创建补丁的说明操作： http://dev.clojure.org/display/community/Developing Patches
2. 如果您能提供一些更改的说明以帮助审查，将非常 helpful。否则，审核人员必须从头开始重新设计您的思考过程。
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()}} 方法返回了针对目标类型定义的给定名称的所有 public 方法列表
• 然后在第1477-1491行选择了要调用的最佳方法
• 如果所选方法的声明类不是 public，则尝试找到一个既是目标类型的超类又是所选方法声明类的子类的 public 类 - 这是在 {{clojure.lang.Reflector.getDeepestPublicDescendant()}} 方法中实现的
• 如果找到了这样的类，则在使用方法调用生成字节码时使用该类而不是方法的声明类
• 如果没有找到这样的类，则尝试在声明所选方法的类的 public 祖先中找到一个兼容的方法

请注意，该更改可能导致调用与更改之前不同的方法，如 {{selecting-method-on-nonpublic-interface}} 测试所展示的那样。在我看来，这是一个可以接受的更改，因为
它产生了更好的匹配（相对于参数类型）的方法来调用
让 clojure 中的方法选择行为更像 java

Answer 12

评论者：stuart.sierra

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

Answer 13

参考：https://clojure.atlassian.net/browse/CLJ-1243（由 stanut.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 方法签名