如何将 Scala 案例类和集合桥接到 Java

Question

我们在尝试使用 Java 中的 Scala 代码时遇到了问题。我们正在寻找一种方法来自动桥接各种 Scala 和 java 集合，而无需在我们的 Java 代码中显式转换。当地方很少时这样做是合理的，但如果它被广泛传播并不断添加新的 scala 类就变得不切实际了。

例如，在我们的 Scala 代码中，我们有一些这样的类（其中很多）：

case class Product(id: String, group: String, attributes : Map[String,String])

def fooWithProducts(products : Seq[Product]) = ...

// create a product
val p1 = Product("id1","group1", Map("attribute1" -> "value1","attribute2" -> "value2")

val p2 = Product("id2","group1", Map("attribute1" -> "value1","attribute2" -> "value2")

fooWithProducts(Seq(p1,p2))

当我们想用 Java 编写类似的代码时，它变得非常繁琐，我们需要在各处添加很多辅助样板：

// JAVA
// create a product
HashMap<String, String> attributes = new HashMap<String, String>();
attributes.put("my-attribute","my-value");

// create a scala collection
scala.collection.immutable.Map<String, String> scalaAttributes = Conversions.toScalaImmutableMap(attributes);

// create a product
Product p = Product("id","group",scalaAttributes)

// create a scala sequence of product
ArrayList<Product> dataFeedsProducts = new ArrayList<Product>();
        dataFeedsProducts.add(Product);
Seq<Product> seq = JavaConversions.asScalaBuffer(dataFeedsProducts).seq();

fooWithProducts(seq)

// SCALA helpers

public class Conversions {
    //https://stackoverflow.com/questions/11903167/convert-java-util-hashmap-to-scala-collection-immutable-map-in-java/11903737#11903737
    @SuppressWarnings("unchecked")
    /**
     * Transforms a java map to a scala immutable map
     */
    public static <K, V> scala.collection.immutable.Map<K, V> toScalaImmutableMap(java.util.Map<K, V> javaMap) {
        final java.util.List<scala.Tuple2<K, V>> list = new java.util.ArrayList(javaMap.size());
        for (final java.util.Map.Entry<K, V> entry : javaMap.entrySet()) {
            list.add(scala.Tuple2.apply(entry.getKey(), entry.getValue()));
        }
        final scala.collection.Seq<Tuple2<K, V>> seq = scala.collection.JavaConverters.asScalaBufferConverter(list).asScala().toSeq();
        return (scala.collection.immutable.Map<K, V>) scala.collection.immutable.Map$.MODULE$.apply(seq);
    }

    /**
     * transforms a scala map to the java counterpart
     */
    public static <K,V> java.util.Map<K,V> mapAsJavaMap(scala.collection.immutable.Map<K,V> m) {
        if (m == null) {
            return null;
        }
        return JavaConversions.mapAsJavaMap(m);
    }

    public static<A> Seq<A> asScalaSeq(java.util.List<A> l) {
        return JavaConversions.asScalaBuffer(l).toSeq();
    }
}

我们想知道是否有办法对 Scala 代码进行注释或为这些 Scala 惯用语自动生成等效的 Java 对应接口。

Answer 1

大多数用 Scala 编写但应该同时用于 Scala 和 Java 的框架都有一个独立的 Java API。例如，Akka、Play 和 Spark 就是这种情况。

这样做是因为有太多的 Scala 构造不能自然地映射到 Java 中可用的任何东西。虽然从 Java 实例化 Scala 类并非完全不可能，但直接这样做会导致 Java 代码非常不习惯和繁琐。因此，设计者无需将 Java 数据结构转换为 Scala 数据结构的负担转嫁给 API 的用户，而是简单地创建一个单独的 Java API，并一劳永逸地解决所有转换和工厂方法的问题。

也就是说，而不是

• 在 Scala 中编写库并仅提供 Scala API
• 用 Java 编写 C_1 类，使用 Scala API，用转换污染代码 (painful-1)
• ...
• 用 Java 编写 C_n 类，使用 Scala API，用转换污染代码 (painful-n)

您执行以下操作：

• 用Scala写一个库，先提供Scala API
• 将foobar.api.java 包添加到您的库中，实现一个单独的 Java API，仍然使用 Scala （pain-singleton）
• 使用 Java API 在 Java 中编写 C_1 类 (nice-and-pleasant-1)
• ...
• 使用 Java API 在 Java 中编写 C_n 类 (nice-and-pleasant-n)

这应该会大大减少您对 scala 库的用户（在您的情况下：对您自己）造成的总体痛苦。

对于您提供的小代码 sn-p，具体而言，这意味着：

1. 提供工厂方法以便Products可以方便地从Java中实例化：

   // api.java 中的某处 定义产品（ id：字符串， grp：字符串， attrToVal：java.util.HashMap[字符串，字符串] ): Product = /* 使用JavaConversions，调用构造函数*/

2. 提供可以从 Java 调用的fooWithProducts 版本 没有任何转换：

   // 在 api.java 中 def fooWithProducts(ps: java.util.List[Product]): Foo = // 这里将 java List 转换为 scala Seq, // 调用原来的fooWithProducts

对应该出现在 API 中的每个类和方法执行此操作。要使其正常工作，API 必须具有最小的表面积，并且与库的内部相比，必须集中且相对简单。