Slick 技术文档

1. 安装指南

1.1 使用 Maven 安装

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

<dependency>
    <groupId>com.typesafe.slick</groupId>
    <artifactId>slick_2.13</artifactId>
    <version>3.4.1</version>
</dependency>

1.2 使用 SBT 安装

在项目的 build.sbt 文件中添加以下依赖项：

libraryDependencies += "com.typesafe.slick" %% "slick" % "3.4.1"

1.3 数据库驱动

根据你使用的数据库，添加相应的 JDBC 驱动依赖。例如，如果你使用 PostgreSQL，添加以下依赖：

<dependency>
    <groupId>org.postgresql</groupId>
    <artifactId>postgresql</artifactId>
    <version>42.5.0</version>
</dependency>

2. 项目的使用说明

2.1 基本概念

Slick 是一个用于 Scala 的高级数据库访问库，提供了强类型、高度可组合的 API。它允许你以类似于 Scala 集合的方式使用数据库，同时提供了对数据库访问的完全控制。

2.2 示例代码

以下是一个简单的示例，展示了如何使用 Slick 定义一个 Coffee 对象，并在数据库中创建一个表来存储该对象的实例：

import slick.jdbc.PostgresProfile.api._

// 定义 Scala 对象
final case class Coffee(name: String, price: Double)

// 定义 Slick 如何将数据库表映射到 Scala 对象
class Coffees(tag: Tag) extends Table[Coffee](tag, "COFFEES") {
  def name  = column[String]("NAME")
  def price = column[Double]("PRICE")
  def * = (name, price).mapTo[Coffee]
}

// 创建 TableQuery 对象以访问 Slick 的查询 API
val coffees = TableQuery[Coffees]

// 插入数据
coffees += Coffee("Latte", 2.50)

// 查询数据
coffees.map(_.name)

// 复杂查询
coffees.filter(_.price < 10.0).sortBy(_.name)

3. 项目 API 使用文档

3.1 查询 API

Slick 的查询 API 灵感来自于 Scala 的集合 API。你可以使用 map、filter、sortBy 等方法来构建查询。

// 查询所有咖啡的名称
coffees.map(_.name)

// 查询价格小于 10 的咖啡
coffees.filter(_.price < 10.0)

// 按名称排序
coffees.sortBy(_.name)

3.2 异步 API

Slick 提供了基于 Future 的异步 API，允许你以非阻塞的方式执行数据库操作。

import scala.concurrent.Future
import scala.concurrent.ExecutionContext.Implicits.global

// 异步插入数据
val insertFuture: Future[Int] = db.run(coffees += Coffee("Espresso", 3.00))

// 异步查询数据
val queryFuture: Future[Seq[Coffee]] = db.run(coffees.result)

3.3 流式 API

Slick 还提供了符合 Reactive Streams 接口的流式 API，便于与 Akka Streams、FS2 或 ZIO 等流处理库集成。

import akka.stream.scaladsl.Sink
import slick.jdbc.GetResult

// 流式查询
val source = sql"select NAME, PRICE from COFFEES".as[(String, Double)].withPinnedSession
source.runWith(Sink.seq)

4. 项目安装方式

4.1 通过 Maven 安装

在 pom.xml 中添加 Slick 依赖：

<dependency>
    <groupId>com.typesafe.slick</groupId>
    <artifactId>slick_2.13</artifactId>
    <version>3.4.1</version>
</dependency>

4.2 通过 SBT 安装

在 build.sbt 中添加 Slick 依赖：

libraryDependencies += "com.typesafe.slick" %% "slick" % "3.4.1"

4.3 数据库驱动安装

根据你使用的数据库，添加相应的 JDBC 驱动依赖。例如，对于 PostgreSQL：

<dependency>
    <groupId>org.postgresql</groupId>
    <artifactId>postgresql</artifactId>
    <version>42.5.0</version>
</dependency>

通过以上步骤，你可以成功安装并开始使用 Slick 进行数据库操作。