Apache POI框架是非常常用的操作Office文档库，最近用Kotlin重构了一段使用POI操作Excel的方法，让代码的构建上简化了很多。
先来观察一下之前使用Java中POI操作Excel要经历什么：
public static void writeToOutputStream(ExcelData data, OutputStream outputStream) throws IOException {
// 创建一个工作簿
XSSFWorkbook xs = new XSSFWorkbook();
// 设置一个样式
DataFormat fmt = xs.createDataFormat();
CellStyle textStyle = xs.createCellStyle();
textStyle.setDataFormat(fmt.getFormat("@"));
// 操作Excel
for (ExcelSheet sheet : data.sheets) {
Sheet xsheet = xs.createSheet(sheet.sheetName);
int rowNum = 0;
// 填写每行的内容
for (ExcelRow row : sheet.rows) {
Row xrow = xsheet.createRow(rowNum);
int cellNum = 0;
xsheet.setDefaultColumnStyle(cellNum, textStyle);
for (ExcelColumn column : row.columns) {
Cell cell = xrow.createCell(cellNum);
if (column != null && column.value instanceof Number) {
cell.setCellValue(((Number) column.value).doubleValue());
} else if (column != null) {
cell.setCellValue(column.value.toString());
} else {
cell.setCellValue("null");
}
cellNum += 1;
}
rowNum += 1;
}
}
xs.write(outputStream);
}
代码看起来就不是特别直观，以致于我需要额外抽象出一系列ExcelData这种Value Object来存放数据传入这个方法(writeToOutputStream())以降低调用方的使用困惑。
而在使用Kotlin来重构这部分代码的时候，可以充分地利用Kotlin扩展方法的特性扩展POI这个库，那么可以先来了解下Kotlin的扩展方法。在业务中我们经常要遇到各种Utils类，这些Utils的本质是对原有类的扩展，比如下面这个StringUtils：
String str = "hello";
boolean flag = StringUtils.isNotEmpty(str);
光是在我们项目中就找到了三种StringUtils实现，如果我们可以扩展原有的类库，而不是写Utils，语言上表现力会好很多。在Kotlin中允许定义这种扩展函数来扩充原来的已经存在类库，而不是通过Utils的方式来补充：
fun String.isNotEmpty() = this != null && this.length > 0
val str = "hello"
var flag = str.isNotEmpty()
这样的写法更加符合面向对象(不过由于Jvm本身的限制，kotlin的这种写法，最终会被JVM编译成Utils的的类，在Java中还是会变成Utils被使用。)。
再回到POI的例子，对于调用方来说，什么样的方式创建Excel才是直观的呢？
Excel
既然Excel是一张表格，那么我们的代码是不是也可以弄得跟表格一样和Excel形成映射。所以我希望函数的最终使用效果可以是这样：
Excel.create {
val sheet = it.createSheet()
// sheet[row,column] = value
sheet[0, 0] = "标题1"
sheet[0, 1] = "标题2"
sheet[0, 2] = "标题3"
sheet[0, 3] = "标题4"
}
在Kotlin中用扩展方法非常少的代码就足够完成这套扩展了：
// operator关键字允许我们对操作符号(类似 + , - 等等)进行重载
// a.get(i) 在对用的操作符号是 a[i]
// 操作符号重载的方法列表具体参见：https://kotlinlang.org/docs/reference/operator-overloading.html
operator fun Sheet.get(n: Int): Row = this.getRow(n) ?: this.createRow(n)
// 就像前面String一样，在**方法名称**前面加上一个类名，将这个方法添加到Row这个类中。
// 在POI中，Sheet，Row，Workbook等等原本都是没有set和get方法的
// 这几个方法都是试图去获取Excel中某一行或者某一个工作簿，如果没有不存在就创建它们
operator fun Row.get(n: Int): Cell =
this.getCell(n) ?: this.createCell(n, Cell.CELL_TYPE_BLANK)
operator fun Sheet.get(x: Int, y: Int): Cell = this[x][y]
operator fun Workbook.get(n: Int): Sheet =
try {
this.getSheetAt(n)
} catch (e: Exception) {
this.createSheet()
}
// 在Kotlin中`?.method()`这种调用方式可以避免空指针异常，如果对象是null，方法不会被调用。
operator fun Sheet.set(x: Int, y: Int, value: Any?) {
value?.let {
// 所有的字段都设置成文本字段
val textStyle = this.workbook.createCellStyle()
textStyle.dataFormat = this.workbook.createDataFormat().getFormat("@")
this.setDefaultColumnStyle(x, textStyle)
val cell = this[x, y]
when (value) {
// 判断value的数据类型，然后用转换之后填入
is String -> cell.setCellValue(value)
is Int -> cell.setCellValue(value.toString())
is Double -> cell.setCellValue(value.toString())
else -> throw IllegalArgumentException("数据类型不支持")
}
}
}
// object 关键字可以将Excel这个类定义成一个单例对象，和Scala一样。
object Excel {
// 这个方法接收一个 入参是`Workbook`类，返回值是空的**函数对象**
fun create(opFun: (Workbook) -> Unit): ByteArray =
XSSFWorkbook().use {
it
.apply(opFun) // 利用apply方法把自己传入`opFun()`方法里
.let { workbook ->
ByteArrayOutputStream()
.use {
workbook.write(it)
// 返回一个byte[]对象，即Excel文件
return it.toByteArray()
}
}
}
}
所以再看调用方的那一段代码, 他就能直接获取到一个可以写到本地的Excel文件流：
val excelFileData = Excel
.create {
val sheet = it.createSheet()
// sheet[row,column] = value
sheet[0, 0] = "标题1"
sheet[0, 1] = "标题2"
sheet[0, 2] = "标题3"
sheet[0, 3] = "标题4"
}
Files.write(Paths.get("/path/to/demo.xlsx"), excelFileData)
和之前Java的版本比起来，这样写法显得清楚很多了，而且一般项目中需要制作Excel的业务，数据势必是以List或者Map为主, 完全可以通过遍历对象的方式来简化这种Excel操作，看看Java中使用这段效果的代码：
Excel.INSTANCE.create(workbook -> {
final Sheet sheet = workbook.createSheet();
// ExcelIntegrationKt.set(sheet,row,column,value);
ExcelIntegrationKt.set(sheet, 0, 0, "标题1");
ExcelIntegrationKt.set(sheet, 0, 1, "标题2");
ExcelIntegrationKt.set(sheet, 0, 2, "标题3");
ExcelIntegrationKt.set(sheet, 0, 3, "标题4");
return Unit.INSTANCE;
});
好像看起来也不是很差嘛，哈哈哈。通过这个例子，我不是为了说这个Excel的操作有多好用，而是希望写写这种扩展方法的好处。当然扩展方法也不是Kotlin独创的，很多语言都支持这种方式，在Ruby中这种写法被称为Monkey Patch(猴子打补丁)，但在Jvm上的语言出现这种特性还是能很直接地给我们带来福利的，这种扩展方法，可以让我们对一些第三方库进行简单扩展的时候，不用像之前在Java中大费周章来折腾源码了。: )
网友评论