Java/Scala互操作实践 1:基础操作

本文将以Spring Boot为例,介绍下实际工作中的Java/Scala互操作。在提高个人效率、满足自我追求的情况下更多的照顾到团队不同人的实际。同时也是想说明,在同一个工程里混用Java和Scala语言是可能的。

本文源代码在:http://git.oschina.net/hualongdata/spring-starter

Java Bean

Java Bean有个特点,就是对于可修改属性都会有对应的gettersetter方法(final属性将只有getter方法)。由Java定义的对象在Scala中可以直接使用,并无二样。而在Scala中定义Java Bean却有些不同。

其实在Scala中可以像Java一样来定义Java Bean:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
// Scala中默认为public访问权限,包括属性和方法
class Person {
// 下划线在这里是一个占位符,它代码相应属性对应类型的默认值
private var id: Int = _
private var name: String = _;
def getId: Int = id;
def setId(id: Int) {
this.id = id
}
def getName: String = name;
def setName(name: String) {
this.name = name;
}
}

这样写的话,除了语法上与Java有些差别,其实定义的方式是一样的。但其实Scala提供了注解来自动生成gettersetter函数:

1
2
3
4
5
6
7
8
9
import scala.beans.BeanProperty
class Person {
@BeanProperty
var id: Int = _
@BeanProperty
var name: String = _
@BeanProperty
val createdAt: LocalDateTime = _
}

除了使用传统的class,在Scala中还可以使用case class来定义POJO:

1
2
3
4
5
6
7
8
case class SignRequest(@BeanProperty
account: String = null,
@BeanProperty
password: String = null,
@BeanProperty
captcha: String = null,
@BeanProperty
var smsCode: String = null)

case class的主构造函数声明的参数将同时做为SignRequest的履性,且是val的(类似Java的public final)。在这里,accountpasswordcaptcha将只生成getter函数。而smsCode将生成gettersetter函数,因为它使用var来修饰。

这里有一个Java里没有的特性:参数默认值,像C++、Python、ES6+ 一样,Scala的参数是可以设置默认值的。因为Java Bean规范要求类必需有参数为空的默认构造函数,而当case class的主构造函数所有参数都设置默认值后,在实例化这个类时将相当于拥有一个空的默认构造函数。

在Java中调用case class可见:com/hualongdata/springstarter/data/repository/UserRepositoryImpl.java

基于注解的依赖注入

在Spring开发中,依赖注入是很常用的一个特性。基于属性的注解注入在Java和Scala中都是一样的。但基于构造函数的依赖注入在Scala中有些特别,代码如下:

1
2
3
4
5
class SignController @Autowired()(userService: UserService,
webUtils: WebUtils,
hlTokenComponent: HlTokenComponent) {
......
}

在Scala中,单注解作用于构造函数上时需要类似方法调用的形式:@Autowired()。又因为Scala中,主构造函数必需定义在类名之后的小括号内,所以注解需要紧跟在类名之号,主构造函数左括号之前。

在Scala中使用主构造函数的注入组件是一个更好的实践,它同时拥有注入的组件为private final访问权限。相同效果的Java代码需要更多:

1
2
3
4
5
6
7
8
9
10
11
public SignController {
private final UserService userService;
private final WebUtils webUtils;
private final HlTokenComponent hlTokenComponent;
public SignController(UserService userService, WebUtils webUtils, HlTokenComponent hlTokenComponent) {
this.userService = userService;
this.webUtils = webUtils;
this.hlTokenComponent = hlTokenComponent;
}
}

可以看到,Scala的版本代码量更少,同时看起来更简洁。

注解参数

数组参数

1
2
3
4
@RestController
@RequestMapping(Array("/sign"))
class SignController @Autowired()(userService: UserService,
......

在Scala中,对于注解的数组参数当只设置一个元素时是不能像Java一样贱一个字符串的,必需显示的定义一个数组。

参数值必需为常量

在Scala中,当为注解的某个参数贱值时必需使用常量,像:@RequestMapping(Array(Constants.API_BASE + "/sign"))这样的形式都是非法的。只能像这样贱值:@RequestMapping(Array("/aip/sign"))

变长参数

在Scala中变长参数通过星号(*)来定义,代码如下:

1
def log(format: String, value: String*)

但是这样定义出来的变参在Java中是不能访问的,因为Scala默认实现中value的类型为: Seq[Any],而Java中的变参类型实际上是一个数组(String[])。要解决这个问题非常简单,在函数定义前加上scala.annotation.varargs注解就可以强制Scala使用Java的实现来实现变长参数。

集合库

Scala有自己的一套集合库实现:scala.collection,分为不可变集合scala.collection.immutable和可变集合scala.collection.mutable。两者都实现了很多高阶函数,可以简化日常编程,同时Scala中推荐使用不可变集合。

Java集合到Scala集合

Scala提供了scala.collection.JavaConverters来转换Java集合到Scala集合:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
import scala.collection.JavaConverters._
/**
* 根据sheet名获取sheet所有单元格
*
* @param workbook Excel [[Workbook]]对象
* @param sheetName sheet 名
* @return 返回所有有效单元格可迭代二维列表
*/
def getSheetCells(workbook: Workbook, sheetName: String): Iterable[Iterable[RichCell]] = {
workbook.getSheet(sheetName)
.asScala
.map(row => row.asScala.map(cell => new RichCell(cell)))
}

workbook.getSheet方法返回的Sheet类型是实现了java.lang.Iterable接口的可迭代类型。为了使用Scala集合上提供的map高阶函数,我们需要把Java集合转换成Scala集合。可以通过在Java集合上调用.asScala函数来将其转换成Scala集合,这里运用了Scala里的隐式转换特性来实现。

Scala集合到Java集合

接下来我们看另外一个函数:

1
2
3
4
@varargs
def getSheets(workbook: Workbook, sheetNames: String*): java.util.List[Sheet] = {
sheets(workbook, sheetNames: _ *).asJava
}

这个函数实现的功能是根据传入的一个或多个Sheet名字从Excel里获取Sheet列表。sheets函数返回的是一个Scala集合:Seq[Sheet],通过getSheets代理函数将其转换成Java集合,通过在Seq[Sheet]上调用.asJava方法来实现自动转换。同样的,这里也运用了Scala的隐式转换特性。

Java代码中做集合转换

之前的例子都是在Scala代码中实现的,通过隐式转换这一特性我们发现做Java/Scala集合的相互转换是非常方便的。但在Java代码中做两者的转换就不那么直观了,因为Java没有隐式转换这一特性,我们需要显示的调用代码来先生成包装类,再调用.asScala.asJava方法来转换集合类型:

1
2
3
4
5
6
7
8
9
10
import scala.collection.JavaConverters$;
import scala.collection.mutable.Buffer;
public static void demo() {
List<String> list = Arrays.asList("dd", "dd");
// Java List 到 Scala Buffer
Buffer<String> scalaBuffer = JavaConverters$.MODULE$.asScalaBufferConverter(list).asScala();
// Scala Buffer 到 Java List
List<String> javaList = JavaConverters$.MODULE$.bufferAsJavaListConverter(scalaBuffer).asJava();
}

为Java和Scala同时提供API

当在项目中混用Java和Scala语言时,有个问题不得不重视。提供的API是用Java还是Scala来实现?实现的API是优先考虑兼容Java还是Scala?

对于API的实现,用Java或Scala均可。若使用Java实现,在Scala中调用是基本无压力的。而使用Scala实现时,为了兼容Java你可能不得不作一些折中。一个常用的方式是:使用Scala或Java来实现API,而再用Java或Scala来实现一个封装层(代理)作兼容。比如:Spark、Akka……,它们使用Scala来实现API,但提供了包装的Java API层。

一个好的实践是把Scala API放到scalaapi包路径(或者反之把Java API放到javaapi包路径)。

若我们只提供一个API,那就要尽量同时支持Java和Scala方便的调用。比如使用@varargs注解来修饰变长参数。

对于参数需要集合类型,或返回值为集合类型的函数。我们除了使用上一节提供的JavaConverters来做自动/手动转换以外,也可以通过装饰器形式来提供Java或Scala专有的API。这里,我推荐Scala API函数名直接使用代表操作的名词/动词实现,而Java API在之前加上:getsetcreate等前缀进行修饰。

1
2
3
4
5
6
7
8
def sheets(workbook: Workbook, sheetNames: String*): Seq[Sheet] = {
sheetNames.map(sheetName => workbook.getSheet(sheetName))
}
@varargs
def getSheets(workbook: Workbook, sheetNames: String*): java.util.List[Sheet] = {
sheets(workbook, sheetNames: _ *).asJava
}

这里sheetsgetSheets实现相同的功能,区别是第一个是Scala API,第二个是Java API。

结语

本文较详细的介绍了Java/Scala的互操作性,以上示例都来自作者及团队的实际工作。

这篇文章简单介绍了一些基础的Java/Scala互操作方法,接下来的文章将介绍些高级的互操作:FutureOptional/Optionlamdba函数、类与接口等。