Poi Scala 技术文档

本文档旨在帮助用户了解和使用 Poi Scala 项目，该项目的核心功能是使用 Apache POI 库在 Scala 中程序化地创建 Excel 表格。

1. 安装指南

SBT

在 SBT 项目中，您可以通过以下依赖添加 Poi Scala：

libraryDependencies += "info.folone" %% "poi-scala" % "${poi-scala.version}"

Maven

在 Maven 项目中，请在 pom.xml 文件中添加以下依赖：

<dependency>
    <groupId>info.folone</groupId>
    <artifactId>poi-scala_${scala.version}</artifactId>
    <version>${poi-scala.version}</version>
</dependency>

确保将 ${poi-scala.version} 替换为实际的版本号。

2. 项目的使用说明

Poi Scala 允许用户创建和操作 Excel 工作簿、工作表、行和单元格。以下是一些基本用法示例：

• 创建一个工作簿，添加两个工作表，然后保存到文件：

  val sheetOne = Workbook {
    Set(Sheet("name") {
      Set(Row(1) {
        Set(NumericCell(1, 13.0/5), FormulaCell(2, "ABS(A1)"))
      },
      Row(2) {
        Set(StringCell(1, "data"), StringCell(2, "data2"))
      })
    },
    Sheet("name2") {
      Set(Row(2) {
        Set(BooleanCell(1, true), NumericCell(2, 2.4))
      })
    })
  }
  
  val path = "/tmp/workbook.xls"
  sheetOne.safeToFile(path).fold(ex => throw ex, identity).unsafePerformIO()
  

• 加载现有工作簿，添加新的工作表，并保存：

  val sheetOneReloaded = load(path)
  val sheetTwo = Workbook {
    Set(Sheet("name") {
      Set(Row(1) {
        Set(StringCell(1, "newdata"), StringCell(2, "data2"), StringCell(3, "data3"))
      },
      Row(2) {
        Set(StringCell(1, "data"), StringCell(2, "data2"))
      },
      Row(3) {
        Set(StringCell(1, "data"), StringCell(2, "data2"))
      })
    })
  }
  
  val mergeSheets = sheetOneReloaded |+| sheetTwo
  mergeSheets.safeToFile(path).fold(ex => throw ex, identity).unsafePerformIO()
  

3. 项目API使用文档

Poi Scala 提供了以下 API 来创建和操作 Excel 文件：

• Workbook：表示一个 Excel 工作簿。
• Sheet：表示一个工作表。
• Row：表示一行。
• Cell：表示单元格，具体类型如下：
  • NumericCell：数字单元格。
  • StringCell：字符串单元格。
  • BooleanCell：布尔单元格。
  • FormulaCell：公式单元格。

更多 API 细节，请参考项目源代码和相关文档。

4. 项目安装方式

请参考“安装指南”部分，使用 SBT 或 Maven 将 Poi Scala 添加到您的项目中。确保正确配置版本号以匹配您的 Scala 版本。