ScalikeJDBC 技术文档

本文档将详细介绍如何安装、使用 ScalikeJDBC 以及其 API 的使用方法。

1. 安装指南

ScalikeJDBC 是一个用于 Scala 的 JDBC 封装库，支持直观且高度灵活的功能。若要开始使用 ScalikeJDBC，请先添加相应的依赖到你的 build.sbt 文件中：

libraryDependencies ++= Seq(
  "org.scalikejdbc" %% "scalikejdbc"     % "4.3.+",
  "com.h2database"  %  "h2"              % "2.2.+",
  "ch.qos.logback"  %  "logback-classic" % "1.5.+"
)

如果你的项目使用 Play Framework，也可以查看 scalikejdbc-play-support 项目。

2. 项目使用说明

以下是一个简单的示例，展示如何使用 ScalikeJDBC 执行 SQL 查询：

import scalikejdbc._

// 初始化 JDBC 驱动和连接池
Class.forName("org.h2.Driver")
ConnectionPool.singleton("jdbc:h2:mem:hello", "user", "pass")

// 在 REPL 上使用 ad-hoc session 提供器
implicit val session: DBSession = AutoSession

// 创建表
sql"""
create table members (
  id serial not null primary key,
  name varchar(64),
  created_at timestamp not null
)
""".execute.apply()

// 插入初始数据
Seq("Alice", "Bob", "Chris") foreach { name =>
  sql"insert into members (name, created_at) values (${name}, current_timestamp)".update.apply()
}

// 查询所有数据
val entities: List[Map[String, Any]] = sql"select * from members".map(_.toMap).list.apply()

// 定义实体对象和提取器
import java.time._
case class Member(id: Long, name: Option[String], createdAt: ZonedDateTime)
object Member extends SQLSyntaxSupport[Member] {
  override val tableName = "members"
  def apply(rs: WrappedResultSet) = new Member(
    rs.long("id"), rs.stringOpt("name"), rs.zonedDateTime("created_at"))
}

// 查询所有成员
val members: List[Member] = sql"select * from members".map(rs => Member(rs)).list.apply()

// 使用 Scala REPL 的粘贴模式 (':paste') 来运行
val m = Member.syntax("m")
val name = "Alice"
val alice: Option[Member] = withSQL {
  select.from(Member as m).where.eq(m.name, name)
}.map(rs => Member(rs)).single.apply()

3. 项目 API 使用文档

ScalikeJDBC 提供了丰富的 API，以下是一些常用的方法：

• ConnectionPool.singleton: 创建一个单例连接池。
• Class.forName: 加载 JDBC 驱动。
• sql"...": 创建一个 SQL 执行语句。
• .execute(): 执行 SQL 语句。
• .map(_.toMap): 将查询结果映射到 Map。
• .list.apply(): 执行查询并返回一个列表。
• SQLSyntaxSupport: 定义如何将结果集转换为对象。

更多 API 文档和示例，请参考官方文档：ScalikeJDBC 文档。

4. 项目安装方式

ScalikeJDBC 的安装方式已在“安装指南”中说明，主要步骤是将依赖项添加到 build.sbt 文件中。

确保你的项目已经设置了 Scala 和 sbt，然后执行以下命令来添加依赖：

libraryDependencies ++= Seq(
  "org.scalikejdbc" %% "scalikejdbc"     % "4.3.+",
  "com.h2database"  %  "h2"              % "2.2.+",
  "ch.qos.logback"  %  "logback-classic" % "1.5.+"
)

完成以上步骤后，你就可以开始使用 ScalikeJDBC 来操作数据库了。

以上是关于 ScalikeJDBC 的基本安装和使用说明。希望这篇文档能帮助你更好地理解和使用 ScalikeJDBC。