Go语言database/sql包教程

本文翻译自《Go database/sql tutorial》。

在Go中使用SQL或类SQL的数据库的惯用方法是通过database/sql包。它为面向行的数据库提供了一个轻量级的接口。这个网站是关于如何使用它的最常见的方面的参考。

为什么需要这样做?这个包的文档告诉了你所有的功能,但并没有告诉你如何使用这个它。我们中的许多人发现自己希望获得一份入门手册,即讲故事,而不是列事实。欢迎你来做贡献:请在此处发送拉取请求。

概述

要在Go中访问数据库,你需要使用sql.DB。你可以使用sql.DB类型来创建语句和事务、执行查询和获取结果。

你应该知道的第一件事是sql.DB不是一个数据库连接。它也没有映射到任何特定数据库软件的“数据库”或“模式”这些概念。它是数据库的接口和数据库本身的抽象,抽象的内部可以多种多样:数据库可以是本地文件,可以通过网络连接访问,也可以存在于内存和进程中。

sql.DB在幕后为你执行一些重要任务:

  • 它通过数据库驱动程序打开和关闭与实际底层数据库的连接。
  • 它根据需要管理一个连接池,其中可能包括前面提到的各种内容。

sql.DB抽象旨在避免你担心如何管理对底层数据存储的并发访问。当你使用连接执行任务时,它会被标记为正在使用,然后在不再使用时返回到可用连接池。这样做的一个后果是,如果无法将连接释放回到连接池,可能会导致sql.DB打开大量连接,从而可能耗尽资源(连接太多、打开的文件句柄太多、缺少可用的网络端口等)。我们稍后将对此进行更多讨论。

在创建了一个sql.DB之后,你可以使用它来查询它所代表的数据库,以及创建语句和事务。

导入一个数据库驱动

要使用database/sql,你需要该包本身,和要使用的特定数据库的驱动程序。

你通常不应该直接使用特定数据库的驱动程序包,尽管一些驱动程序鼓励你这样做。(在我们看来,这通常是个坏主意。)相反,如果可能,你的代码应该只引用database/sql中定义的类型。这有助于避免让你的代码依赖于特定的驱动程序,当需要更改底层的数据库驱动程序(以及你正在访问的数据库)时,你就可以通过最少的代码来更改。你应该使用Go语言的惯用法,而不是驱动程序作者可能提供的特定的惯用法。

在本文档中,我们将使用@julienschmidt和@arnehormann开发的优秀的MySQL驱动程序作为示例。 将以下内容添加到Go源代码文件的顶部:

import (
	"database/sql"
	_ "github.com/go-sql-driver/mysql"
)

请注意,我们正在匿名加载这个驱动程序,将其包的别名设置为_,因此我们的代码看不到任何它的导出名称。在底层,该驱动程序将自己注册为对database/sql包可用,通常除了运行包的init函数之外没有其他任何事情发生。

现在你已准备好了访问数据库。

访问数据库

现在你已经加载了数据库驱动程序包,你已准备好创建一个数据库对象,一个sql.DB

要创建sql.DB,你可以使用sql.Open(),返回一个*sql.DB

func main() {
	db, err := sql.Open("mysql",
		"user:password@tcp(127.0.0.1:3306)/hello")
	if err != nil {
		log.Fatal(err)
	}
	defer db.Close()
}

在以上示例中,我们说明了几件事:

1 sql.Open函数的第一个参数是驱动程序的名称。这是驱动程序用来向database/sql注册自己的字符串,通常与包名相同以避免混淆。例如,上例中是github.com/go-sql-driver/mysql包的mysql。一些驱动程序不遵循这一约定使用对应的数据库名称,例如github.com/mattn/go-sqlite3包的sqlite3github.com/lib/pq包的postgres

2 第二个参数是特定于驱动程序的数据源名称字符串(译者注:数据库连接字符串),它告诉驱动程序如何访问底层的数据存储。在此示例中,我们连接到本地的MySQL服务器中的“hello”数据库实例。

3 你应该(几乎)总是检查和处理从所有database/sql操作返回的错误。稍后我们将讨论一些特殊情况,在这些情况下这样做没有意义。

4 如果sql.DB的生命周期不应超出调用它函数的范围,则defer db.Close()是惯用的做法。

也许与直觉相反,sql.Open()并不建立任何与数据库的连接,也不验证驱动程序连接参数。相反,它只是为以后的使用做好准备,在程序确实需要用到与底层数据存储的实际连接时,才真正建立第一个连接。如果你想立即检查数据库是否可用和可访问(例如,检查你是否可以建立网络连接并登录),请使用db.Ping()来执行此操作,并记住检查是否返回了一个错误:

err = db.Ping()
if err != nil {
	// 错误处理
}

尽管在完成数据库时Close()是惯用方法,但sql.DB对象被设计为长寿命的。不要经常Open()Close()数据库。相反,为你需要访问的每个不同的数据存储(数据库)创建一个sql.DB对象,并保留它,直到程序完成对该数据存储的访问。根据需要传递,或者以某种方式在全局范围内提供,保持打开状态。不要从一个短暂的函数中Open()Close()。相反,将sql.DB作为参数传递到那个短暂的函数中。

如果你不将sql.DB视为一个长时间存活的对象,你可能会遇到一些问题,例如连接的重用和共享不足、可用网络资源不足,或者由于许多TCP连接仍处于TIME_WAIT状态而出现偶发故障。这些问题表明你没有按照设计使用database/sql

现在是时候使用sql.DB对象了。

获取结果集

有几个惯用操作可以从数据存储中检索结果:

1 执行返回多行数据的查询。

2 准备一个要重复使用的SQL预处理语句,多次执行,然后销毁它。

3 以一次性的方式执行SQL语句,而无需为重复使用做准备。

4 执行一个返回单行数据的查询。对于这种特殊情况,有一种获取数据的快捷的方式。

Go的database/sql包里的函数名称非常重要。如果函数名中包含Query,那么它被设计为向数据库询问问题,并返回一组行数据或空。不返回行数据的语句不应该使用Query函数;他们应该使用Exec函数。

从数据库中获取数据

让我们看一个如何查询数据库并处理返回结果的示例。我们将在users表中查询id1的用户,并打印出该用户的idname。我们将把结果分配给变量,一次一行,用rows.Scan()函数。

var (
	id int
	name string
)
rows, err := db.Query("select id, name from users where id = ?", 1)
if err != nil {
	log.Fatal(err)
}
defer rows.Close()
for rows.Next() {
	err := rows.Scan(&id, &name)
	if err != nil {
		log.Fatal(err)
	}
	log.Println(id, name)
}
err = rows.Err()
if err != nil {
	log.Fatal(err)
}

以下是上面代码中发生的情况:

1 我们使用db.Query()将查询发送到数据库。我们像往常一样检查错误。

2 我们推迟执行rows.Close()。这非常重要。

3 我们用rows.Next()对行进行迭代。

4 我们使用rows.Scan()将每一行中的列值读取到对于的变量里。

5 在完成对行的迭代之后,我们检查这一过程中是否有错误发生。

这几乎是Go语言中唯一的方式。例如,你不能将一行数据读取到一个map里。这是因为所有东西都是强类型的。你需要创建正确类型的变量,并将指针传递给rows.Scan(),如上所示。

其中有几个部分很容易出错,并可能会产生不良后果:

  • 你应该始终在for rows.Next()循环的末尾检查是否有错误发生。如果在循环过程中出现错误,你需要了解它。不要只假设循环会正常迭代完毕所有行。
  • 其次,只要有一个打开的结果集(由rows表示),底层连接就很忙,不能用于任何其他查询。这意味着它在连接池中不可用。如果你使用rows.Next()遍历所有行,最终你将读取完最后一行,rows.Next()将遇到内部EOF错误并为你调用rows.Close()。但是,如果出于某种原因退出了那个循环——提前返回,等等——那么这些rows就不会关闭,底层数据库连接仍然是打开的。(不过,如果rows.Next()由于错误而返回false,它将会自动关闭)。记得defer rows.Close(),否则很容易耗尽资源。
  • 如果rows已经关闭,那么rows.Close()已是一个无害的空操作(no-op),所以你可以多次调用它。然而,请注意,我们首先检查是否有错误发生,如果没有错误发生才调用rows.Close(),以避免运行时panic
  • 你应该始终defer rows.Close(),即使你也在循环结束时显式调用rows.Close(),这也不是一个坏主意。
  • 不要在循环体中deferdefer语句要等到函数退出后才能执行,所以长时间运行的函数不应该使用它。如果这样做,你会慢慢耗尽内存。如果在循环中重复查询和使用结果集,那么在处理完每个结果后,应该显式调用rows.Close(),而不要使用defer

Scan()是怎么工作的

当你迭代行并将其中的列值扫描到目标变量中时,Go会在后台为你执行数据类型转换工作。它基于目标变量的类型。意识到这一点可以清理代码并避免重复工作。

例如,假设你从包含字符串列值的表中选择一些行,例如包含VARCHAR(45)的列或类似的行。然而,你碰巧知道,这个字符串列总是包含数字。如果将指针传递给字符串,Go将把字节复制到字符串中。现在,你可以使用strconv.ParseInt()或类似的方法将值转换为数字。你必须检查SQL操作中是否有错误发生,以及解析整数时是否有错误发生。这既混乱又乏味。

或者,你可以直接向Scan()传递一个指向整数的指针。Go将检测到这一点,并为你调用strconv.ParseInt()。如果转换中出现错误,调用Scan()会返回错误。你的代码现在更整洁、更小了。这是我们建议使用database/sql包的方式。

准备语句(预处理语句)

通常,你应该始终准备要多次使用的查询语句。准备查询语句的结果是一个准备好的语句(译者注:准备语句,预处理语句),它可以为语句的参数提供占位符(也称为绑定值)。由于所有常见的原因(例如,避免SQL注入攻击),这比连接SQL语句加参数值字符串的做法要好得多。

在MySQL中,参数占位符是?,在PostgreSQL中是$N,其中N是一个数字。SQLite接受其中任何一种。在Oracle中,占位符以冒号开头并命名,如:param1。我们将使用?因为我们使用MySQL作为示例。

stmt, err := db.Prepare("select id, name from users where id = ?")
if err != nil {
	log.Fatal(err)
}
defer stmt.Close()
rows, err := stmt.Query(1)
if err != nil {
	log.Fatal(err)
}
defer rows.Close()
for rows.Next() {
	// ...
}
if err = rows.Err(); err != nil {
	log.Fatal(err)
}

在底层,db.Query()实际上准备、执行和关闭一个准备好的语句。这会对数据库进行三次往返访问。如果你不小心,你的应用程序进行的数据库交互次数可能会增加三倍!某些驱动程序可以在特定情况下避免这种情况,但并非所有驱动程序都这样做。有关详细信息,请参阅准备好的语句

查询单行

如果查询最多返回一行,则可以使用以下快捷的方式绕过一些冗长的样板代码:

var name string
err = db.QueryRow("select name from users where id = ?", 1).Scan(&name)
if err != nil {
	log.Fatal(err)
}
fmt.Println(name)

查询中的错误会延迟到调用Scan(),然后返回。准备好的语句也可以调用QueryRow()

stmt, err := db.Prepare("select name from users where id = ?")
if err != nil {
	log.Fatal(err)
}
defer stmt.Close()
var name string
err = stmt.QueryRow(1).Scan(&name)
if err != nil {
	log.Fatal(err)
}
fmt.Println(name)

修改数据和使用事务

现在我们已经准备好了解如何修改数据和处理事务。如果你习惯于使用“语句(statement)”对象来获取行和更新数据的编程语言,那么Go语言的做法与它们有点区别,这种区别看起来是人为的,但有一个重要的原因。

修改数据的语句

使用Exec(),最好与准备语句(预处理语句)一起使用,以完成INSERTUPDATEDELETE或其他不返回行数据的语句。以下示例显示如何插入行并检查有关操作的元数据:

stmt, err := db.Prepare("INSERT INTO users(name) VALUES(?)")
if err != nil {
	log.Fatal(err)
}
res, err := stmt.Exec("Dolly")
if err != nil {
	log.Fatal(err)
}
lastId, err := res.LastInsertId()
if err != nil {
	log.Fatal(err)
}
rowCnt, err := res.RowsAffected()
if err != nil {
	log.Fatal(err)
}
log.Printf("ID = %d, affected = %d\n", lastId, rowCnt)

执行Exec()会返回一个sql.Result,它可以访问语句的元数据:最后插入行的ID和受影响的行数。

如果你不在乎执行结果怎么办?如果你只想执行一条语句并检查是否有任何错误发生,但忽略执行的结果怎么办?下面两行代码会做同样的事情吗?

_, err := db.Exec("DELETE FROM users")  // 可行
_, err := db.Query("DELETE FROM users") // 不可行

答案是不一样。它们不做同样的事情,你不应该像这样使用Query()Query()将返回一个sql.Rows,它保留数据库连接直到sql.Rows关闭。由于可能有未读数据(例如多行数据的情况),因此无法重用连接。在上面的示例中,连接将永远不会被再次释放。垃圾收集器最终会为你关闭底层的net.Conn,但这可能需要很长时间之后。此外,database/sql包一直在连接池中跟踪这条连接,希望你在某个时候释放它,以便可以再次使用该连接。因此,这种反模式可能会耗尽资源(例如,太多连接)。

使用事务

在Go中,事务本质上是一个保留到数据库连接的对象。它允许执行到目前为止我们见过的所有操作,并且保证它们将在同一条连接上执行。

通过调用db.begin()开始事务,并对生成的Tx变量使用Commit()Rollback()方法结束事务。在底层,Tx从连接池中获取一条连接,并将其保留为仅用于该事务。sql.DB的方法Tx也拥有对应的方法,例如Query()等等。

在事务中创建的准备语句专门绑定到该事务。有关详细信息,请参阅准备好的语句

你不应该在代码中混合使用事务相关的函数(例如Begin()Commit())和SQL语句(例如BeginCommit)。可能会出现以下不好的结果:

  • Tx对象保持打开的状态,保留连接池中的一条连接而不返回。
  • 数据库的状态可能与用来表示它的Go变量的状态不同步。
  • 你可能会认为你在事务内部的一个连接上执行查询,而实际上Go已经无形地为你创建了几个连接,而有些语句不属于事务的一部分。

在事务内部工作时,应注意不要调用db变量。应该使用db.Begin()创建的Tx变量进行所有调用。db不在事务中,只有Tx对象在事务中。如果你调用db.Exec()或类似的函数,这些调用将发生在该事务范围之外的其他连接上,不在该事务中执行。

如果你需要执行修改连接状态的多个语句,即使你本身不想使用事务,也需要Tx。例如:

  • 创建仅对一个连接可见的临时表。
  • 设置数据库变量,例如MySQL的SET @var := somevalue语法。
  • 更改数据库的连接选项,例如字符集或超时时间。

如果你需要做这些事情中的任何一件,你需要将你的活动绑定到一个连接上,而在Go中做到这一点的唯一方法就是使用Tx

使用准备好的语句

准备好的语句具有Go中所有常见的好处:安全、高效、方便。但它们的实现方式与你习惯的可能有点不同,尤其是在如何与database/sql包的一些内部交互方面。

准备好的语句和数据库连接

在数据库级别,准备好的语句被绑定到单个数据库连接。典型的流程是,客户端向服务器发送一个带有参数占位符的SQL语句进行准备,服务器生成该语句的一个ID进行响应,然后客户端通过发送其ID和参数来执行该语句。

然而,在Go中,数据库连接不会直接暴露给database/sql包的用户。你不是在一条数据库连接上准备SQL语句。你可以在一个DBTx的实例上准备它。database/sql包有一些方便的行为,比如自动重试。由于这些原因,存在于驱动程序级别的准备好的语句和数据库连接之间的潜在关联,对代码来说是透明的。

以下是它的工作原理:

1 准备语句时,它是在连接池中的某条连接上准备的。

2 Stmt实例会记住使用了哪条连接。

3 当你执行Stmt时,它会尝试使用该连接。如果该连接因为关闭或忙于做其他事情而不可用,它将从连接池中获取另一条连接,并在这条连接上重新准备语句

由于语句在原始连接繁忙时,会根据需要重新准备,因此当数据库在高并发使用时,可能会使许多连接繁忙,从而创建大量准备好的语句。这可能会导致明显的语句泄漏,语句的准备和重新准备的频率比你想象的要高,甚至会遇到服务器端对语句数量的限制。

避免准备好的语句

Go在底层为你创建准备好的语句。例如,一个简单的db.Query(sql, param1, param2)的工作原理是准备SQL语句,然后用参数执行它,最后关闭该语句。

然而,某些时候准备好的语句并不是你想要的,可能有如下几个原因:

1 某些数据库不支持准备好的语句。例如,当使用MySQL驱动程序时,你可以连接到MemSQL和Sphinx,因为它们支持MySQL连接协议。但它们不支持包含准备好的语句的“二进制”协议,因此它们可能会以令人困惑的方式执行失败。

2 某些SQL语句的复用程度不足以使用准备好的语句,而且安全问题可以用其他方式处理,因此无需额外性能开销。这方面的一个例子可以在VividCortex的博客上看到。

如果你不想使用准备好的语句,你需要使用fmt.Sprint()或类似的方法来组装SQL,并将其作为唯一的参数传递给db.Query()db.QueryRow()。你的驱动程序需要支持执行纯文本查询,这是通过ExecerQueryer接口在Go 1.1中实现的,文档在此

在事务中使用准备好的语句

Tx实例中创建的准备好的语句专门绑定到Tx实例本身,因此前文关于重新准备的注意事项不再适用。当你对Tx实例进行操作时,你的操作会直接使用Tx实例底层连接的唯一一条连接。

这也意味着在Tx实例中创建的准备好的语句不能与它分开使用。同样,在DB中创建的准备好的语句也没法在事务中使用,因为它们被绑定到不同的数据库连接。

要在Tx中使用在事务外部准备的语句,可以使用Tx.Stmt(),它将从事务外部的准备好的语句创建一个新的绑定到本事务的准备好的语句。它通过获取一个已准备好的现有语句,设置与事务的连接,并在每次执行时重新准备所有语句来实现这一点。这种行为及其实现是不可取的,甚至在database/sql包源代码中有一个TODO来改进它;我们建议不要使用这种方法。

在事务中使用准备好的语句时必须谨慎。考虑以下示例:

tx, err := db.Begin()
if err != nil {
	log.Fatal(err)
}
defer tx.Rollback()
stmt, err := tx.Prepare("INSERT INTO foo VALUES (?)")
if err != nil {
	log.Fatal(err)
}
defer stmt.Close() // 危险!
for i := 0; i < 10; i++ {
	_, err = stmt.Exec(i)
	if err != nil {
		log.Fatal(err)
	}
}
err = tx.Commit()
if err != nil {
	log.Fatal(err)
}
// stmt.Close()在此处return

在Go 1.4关闭一个*sql.Tx之前,它会把与其关联的连接释放回连接池中,但对准备好的语句的延迟Close调用是在这之后执行的,可能会导致对基础连接的并发访问,从而导致连接状态不一致。如果使用Go 1.4或更低版本,则应确保在提交或回滚事务之前始终关闭该准备好的语句。在Go 1.4中修复了此问题,见CR 131650043

参数占位符语法

准备语句中占位符参数的语法是特定于数据库的。例如,比较MySQL、PostgreSQL和Oracle:

MySQL               PostgreSQL            Oracle
=====               ==========            ======
WHERE col = ?       WHERE col = $1        WHERE col = :col
VALUES(?, ?, ?)     VALUES($1, $2, $3)    VALUES(:val1, :val2, :val3)

错误处理

几乎所有使用database/sql包里的类型的操作都会返回一个错误变量作为最后一个值。你应该经常检查这些错误,永远不要忽视它们。

在一些地方,错误行为代表了一种特殊情况,或者你可能需要了解其他信息。

迭代结果集的错误处理

考虑以下代码:

for rows.Next() {
	// ...
}
if err = rows.Err(); err != nil {
	// 在此处处理错误
}

来自rows.Err()的错误可能是rows.Next()循环中,各种可能发生的错误的其中一种。除了正常完成循环之外,循环可能会出于某种原因退出,因此你始终需要检查循环是否正常终止。异常终止会自动调用rows.Close(),尽管多次调用它是无害的。

关闭结果集的错误处理

如前所述,如果提早退出循环,则应始终显式关闭sql.Rows。如果循环正常退出或出现错误,它会自动关闭,但你可能会错误地这样做:

for rows.Next() {
	// ...
	break; // 此时rows没有关闭。
}
// 关闭rows并检查是否有错误发生。多次调用rows.Close()是可以的,即使rows已经关闭了。
if err = rows.Close(); err != nil {
	// 如果此处真的有错误发生,我们又该怎么做呢?
	log.Println(err)
}

常规规则是最好在所有数据库操作中捕获并检查是否有错误发生,rows.Close()返回错误是常规规则的唯一例外。如果rows.Close()返回错误,则不清楚你应该怎么做。记录错误消息到日志或引发panic可能是唯一明智的做法,如果这不明智,那么也许你应该忽略该错误。

QueryRow()的错误处理

考虑以下返回单行数据的代码:

var name string
err = db.QueryRow("select name from users where id = ?", 1).Scan(&name)
if err != nil {
	log.Fatal(err)
}
fmt.Println(name)

如果没有id1的用户怎么办?这样结果中就不会有行,.Scan()也不会将值扫描到name中。然后会发生什么?

Go定义了一个特殊的错误常量,称为sql.ErrNoRows,当结果集为空时,它会从QueryRow()返回。在大多数情况下,这需要作为特殊情况处理。应用程序代码通常不会将空结果集视为一个错误,如果你不检查错误是否等于此特殊常量,则会导致意想不到的应用程序代码错误。

查询中的错误会延迟到调用Scan(),然后返回。上面的代码最好这样写:

var name string
err = db.QueryRow("select name from users where id = ?", 1).Scan(&name)
if err != nil {
	if err == sql.ErrNoRows {
		// 一行数据都没有,也没有其他错误发生
	} else {
		log.Fatal(err)
	}
}
fmt.Println(name)

有人可能会问,为什么空的结果集被认为是一个错误。空结果集并非错误。原因是QueryRow()方法需要使用这种特殊情况,以便让调用者区分QueryRow()是否真的找到了一行;如果没有它,Scan()就什么也不做,而你可能根本没有意识到你的变量没有从数据库中获得任何值。

只有在使用QueryRow()时才会遇到此错误。如果你在其他地方遇到这个错误,那就是你做错了什么。

鉴别特定的数据库错误

编写如下代码可能很诱人:

rows, err := db.Query("SELECT someval FROM sometable")
// err包含如下字符串:
// ERROR 1045 (28000): Access denied for user 'foo'@'::1' (using password: NO)
if strings.Contains(err.Error(), "Access denied") {
	// 处理"Access denied"错误
}

不过,这并不是最好的做法。例如,数据库服务器发送的错误消息所使用的语言不同时,我们会收到不同的字符串。比较错误号码来确定具体的错误是什么要好得多。

然而,实现这一点的机制因驱动程序而异,因为这不是database/sql本身的一部分。在本教程重点介绍的MySQL驱动程序中,你可以编写以下代码:

if driverErr, ok := err.(*mysql.MySQLError); ok { //现在可以直接获取错误号码
	if driverErr.Number == 1045 {
		// 处理拒绝权限错误
	}
}

同样,这里的MySQLError类型是由这个特定的驱动程序提供的,不同的驱动程序的.Number字段可能不同。然而,该数字的值取自MySQL的错误消息,因此是特定于数据库的,而不是特定于驱动程序的。

以上代码仍然很难看。像1045这样的神奇的数字是一种代码臭味。一些驱动程序(虽然不是MySQL驱动程序,但原因与这里的主题无关)提供了错误标识符列表。Postgres数据库的pq驱动程序在error.go中就是这样做的。还有一个由VividCortex维护的MySQL错误号码外部包。使用这样的列表,上面的代码可以更好地这样写:

if driverErr, ok := err.(*mysql.MySQLError); ok {
	if driverErr.Number == mysqlerr.ER_ACCESS_DENIED_ERROR {
		// 处理拒绝权限错误
	}
}

处理连接错误

如果你与数据库的连接被断开、终止或出现错误,该怎么办?

发生这种情况时,你不需要实现任何逻辑来重试失败的语句。作为database/sql中连接池的一部分,处理失败的连接是Go内建的。如果执行查询或其他语句,而底层连接出现故障,Go将重新打开一个新连接(或只是从连接池中获取另一个),然后重试,最多10次。

然而,可能会有一些意想不到的后果。当发生错误情况时,可能会重试某些类型的错误。这也可能是特定于驱动程序的。MySQL驱动程序的一个例子是,使用KILL取消不需要的语句(如长时间运行的查询),会导致该语句被重试多达10次。

处理空列值

可为null的列很烦人,会导致很多难看的代码。如果可以的话,应该避免它们。如果没有,那么你需要使用database/sql包中的特殊类型来处理它们,或者定义自己的类型。

database/sql包定义了可为null的布尔值、字符串、整数和浮点值的类型。以下是如何使用它们的一个示例:

for rows.Next() {
	var s sql.NullString
	err := rows.Scan(&s)
	// 检查err
	if s.Valid {
	   // 使用s.String
	} else {
	   // 是NULL值
	}
}

可为null的类型的限制,以及避免可为null列的原因:

1 没有sql.NullUint64或其他sql.NullYourFavoriteType类型。你需要为此定义自己的。

2 使用可为null的类型是一种奇技淫巧,而且不能经得起未来的考验。如果你认为某个东西不会为空,但你错了,你的程序就会崩溃,可能很少会在发布之前发现错误。

3 Go的一个好处是为每个变量都有一个有用的默认零值。但这不是可为null的类型的工作方式。

如果需要定义自己的类型来处理NULL,可以复制sql.NullString的设计来实现这一点。

如果你无法避免在数据库中使用NULL值,那么大多数数据库系统都支持另一种方法,即使用COALESCE()函数。你可以在不引入无数sql.Null*类型的情况下编写类似于以下的代码:

rows, err := db.Query(`
	SELECT
		name,
		COALESCE(other_field, '') as otherField
	WHERE id = ?
`, 42)

for rows.Next() {
	err := rows.Scan(&name, &otherField)
	// ..
	// 如果`other_field`列的值为NULL, 最终存入`otherField`变量的值就是空字符串。这种方式也以同样的逻辑处理其他数据类型。
}

处理未知列数

函数Scan()要求你传递正确数量的目标变量。如果你不知道查询将返回什么,该怎么办?

如果你不知道查询将返回多少列,可以使用columns()返回一个列名的列表。你可以检查此列表的长度以查看有多少列,还可以将一个具有正确列数的切片传递到Scan()中。例如,MySQL的一些分支执行SHOW PROCESSLIST命令返回不同的列,因此你必须为此做好准备,否则会导致错误。这里有一种方法:

cols, err := rows.Columns()
if err != nil {
	// 处理这个错误
} else {
	dest := []interface{}{ // 标准MySQL的列
		new(uint64), // id
		new(string), // host
		new(string), // user
		new(string), // db
		new(string), // command
		new(uint32), // time
		new(string), // state
		new(string), // info
	}
	if len(cols) == 11 {
		// 如果返回了11列,那么使用的数据库可能是Percona server for MySQL
	} else if len(cols) > 8 {
		// 如果返回的列数大于8,处理这种情况
	}
	err = rows.Scan(dest...)
	// 处理dest里的值
}

如果你不知道列数或它们的类型,那么应该使用sql.RawBytes

cols, err := rows.Columns() // 记得无论如何都要检查err,此处省略,因为与主题无关
vals := make([]interface{}, len(cols))
for i, _ := range cols {
	vals[i] = new(sql.RawBytes)
}
for rows.Next() {
	err = rows.Scan(vals...)
	// Now you can check each element of vals for nil-ness, and you can use type introspection and type assertions to fetch the column into a typed variable.现在,你可以检查vals的每个元素是否为nil,并且可以使用类型内省(type introspection)和类型断言(type assertions)将列获取到特定类型的变量中。
}

连接池

database/sql包中有一个基本的连接池。没有太多的能力来控制或检查它,但以下是一些你可能会觉得有用的事情:

  • 连接池意味着在一个数据库上执行两个连续的语句可能会打开两个连接并分别执行。对于程序员来说,对他们的代码为什么表现不佳感到困惑是很常见的。例如,LOCK TABLES后面跟着INSERT可能会阻塞,因为INSERT位于不包含LOCK TABLES锁表的连接上。
  • 当连接池中没有可用的连接时,database/sql包会在需要时创建新的连接。
  • 默认情况下,对连接的数量没有限制。如果你试图同时做很多事情,你可以创建任意数量的连接。这可能会导致数据库返回诸如“连接过多”之类的错误。
  • 在Go 1.1或更新的版本中,可以使用db.SetMaxIdleConns(N)来限制连接池中的空闲连接数。不过,这并没有限制连接池的大小(size)。
  • 在Go 1.2.1或更新的版本中,可以使用db.SetMaxOpenConn(N)来限制到数据库的打开连接的总数。不幸的是,一个死锁Bug修复)使db.SetMaxOpenConn(N)无法在Go 1.2中安全使用。
  • 连接的回收速度相当快。使用db.SetMaxIdleConns(N)设置更多空闲连接的数目可以减少这种流失,并有助于保持连接以供重用。
  • 长时间保持空闲的连接可能会导致问题(例如Microsoft Azure上的MySQL的问题)。如果由于连接空闲时间过长而导致连接超时,请尝试db.SetMaxIdleConns(0)
  • 你还可以通过设置db.SetConnMaxLifetime(duration)来指定连接可以重复使用的最长时间,因为重复使用寿命过长的连接可能会导致网络问题。这会延迟关闭未使用的连接,即可能会延迟关闭过期的连接。

惊讶、反模式和限制

尽管一旦你习惯了database/sql包,数据库编程就很简单,但你可能会对它所支持的其他一些巧妙用法感到惊讶。这在Go的核心库中很常见。

资源耗尽

正如本网站中所提到的,如果你没有按预期使用database/sql,你肯定会给自己带来麻烦,通常是消耗一些资源或阻止它们被有效地重用:

  • 过于频繁地打开和关闭数据库可能会导致资源耗尽。
  • 未能读取完毕所有行数据或rows.Close()执行失败,将占据连接池中的一条连接。
  • 对不返回行数据的语句使用Query()将占据连接池中的一条连接。
  • 没有意识到准备好的语句是如何工作的,可能会导致大量额外的数据库活动。

uint64

这是一个令人惊讶的错误。如果设置了高位(high bit),则不能将大的无符号整数作为参数传递给语句:

_, err := db.Exec("INSERT INTO users(id) VALUES", math.MaxUint64) // Error

这将引发一个错误。如果使用uint64值,请小心,因为它们可能一开始很小,工作时没有错误,但随着时间的推移而增大,并开始抛出错误。

连接状态不匹配

有些事情可能会改变连接状态,这可能会导致问题,原因有两个:

  • 某些连接状态,例如是否处于事务中,应该通过Go类型来处理。
  • 你可能会假设你的查询在某一个连接上运行,而事实并非如此。

例如,用USE语句设置当前数据库是许多人通常要做的事情。但在Go中,这么做只会影响当前运行它的这条数据库连接。除非在事务中(译者注:或者使用专用连接),否则你认为在该连接上执行的其他语句,实际上可能会在从连接池中获得的其他连接上运行,所以可能无法应用这些语句的更改。

此外,在你更改连接后,它将返回到池中,并可能污染其他代码的状态。这也是为什么永远不应该直接将BEGINCOMMIT语句作为SQL命令发出的原因之一。

数据库的特定语法

database/sql包的API提供了面向行的数据库的抽象,但特定的数据库和驱动程序可能在行为和/或语法上有所不同,例如准备好的语句的占位符语法

多个结果集

Go驱动程序无论如何都不支持来自单个查询返回的多个结果集,而且似乎没有任何计划这样做,尽管有一个支持批量复制等批量操作的功能请求

这意味着,返回多个结果集的存储过程将无法正常工作。

调用存储过程

调用存储过程的语法是特定于驱动程序的,但在MySQL驱动程序中,目前无法做到这一点。你似乎可以通过执行以下操作来调用一个返回单个结果集的简单存储过程:

err := db.QueryRow("CALL mydb.myprocedure").Scan(&result) // Error

实际上它不能按预期执行,反而会报错:”Error 1312: PROCEDURE mydb.myprocedure can’t return a result set in the given context.”。这是因为MySQL希望连接被设置为多语句模式(multi-statement mode),即使只是返回单个结果,而驱动程序目前不会这样做(尽管请参阅此议题)。

支持多语句

database/sql包目前没有明确支持多语句,这意味着它的行为依赖于后端实现:

_, err := db.Exec("DELETE FROM tbl1; DELETE FROM tbl2") // 出错或不能返回预期结果

database/sql包目前没有明确支持多语句,这意味着它的行为依赖于后端实现:

_, err := db.Exec("DELETE FROM tbl1; DELETE FROM tbl2") // 出错或不能返回预期结果

服务器可以按照自己的意愿对此进行解释,包括返回一个错误、只执行第一条语句或同时执行这两条语句。

类似地,没有办法在事务中批处理SQL语句。事务中的每条语句都必须串行执行,并且必须扫描或关闭结果中的资源,例如RowRows,以便底层连接可以供下一条语句使用。这与非事务的普通行为不同。在普通行为下,完全可以执行查询,在Rows上循环遍历,并在循环中对数据库进行另一次查询(这将在一条新连接上发生):

rows, err := db.Query("select * from tbl1") // 使用数据库连接1
for rows.Next() {
	err = rows.Scan(&myvariable)
	// 因为连接1已经在使用,以下代码将不会使用连接1
	db.Query("select * from tbl2 where id = ?", myvariable)
}

但是事务只绑定到一个数据库连接,所以上述代码在事务中是不可能的:

tx, err := db.Begin()
rows, err := tx.Query("select * from tbl1") // 使用绑定到tx的数据库连接
for rows.Next() {
	err = rows.Scan(&myvariable)
	tx.Query("select * from tbl2 where id = ?", myvariable) // ERROR,tx的连接正在忙!
}

不过,Go并不能阻止你去尝试。如果你试图在第一个语句释放其资源并在其自身清理之前执行另一个语句,就可能会导致连接损坏。这也意味着事务中的每条语句与数据库服务器之间的网络通讯,是一组单独的网络往返。

其他相关文章和资源

以下是我们发现有帮助的一些外部信息资源:

我们希望这个网站会有所帮助。如果你有任何改进建议,请到https://github.com/VividCortex/go-database-sql-tutorial发送拉取请求(pull request)或开启一个议题。

发表回复

您的电子邮箱地址不会被公开。 必填项已用 * 标注