教程：访问关系数据库
本教程介绍了使用 Go 和其标准库中的 database/sql 软件包访问关系数据库的基础知识。
如果您对 Go 及其工具有基本了解，则可以充分利用本教程。如果您是第一次接触 Go，请参阅 教程：开始使用 Go 以快速入门。
您将使用的 database/sql 软件包包含用于连接到数据库、执行事务、取消正在进行的操作等的类型和函数。有关使用该软件包的更多详细信息，请参阅 访问数据库。
在本教程中，您将创建一个数据库，然后编写代码来访问该数据库。您的示例项目将是关于老式爵士乐唱片的数据存储库。
在本教程中，您将完成以下部分
- 为您的代码创建一个文件夹。
- 设置数据库。
- 导入数据库驱动程序。
- 获取数据库句柄并连接。
- 查询多行。
- 查询单行。
- 添加数据。
注意：有关其他教程，请参阅 教程。
先决条件
- MySQL 关系数据库管理系统 (DBMS) 的安装。
- Go 的安装。有关安装说明，请参阅 安装 Go。
- 用于编辑代码的工具。您拥有的任何文本编辑器都可以正常工作。
- 命令终端。Go 在 Linux 和 Mac 上的任何终端以及 Windows 中的 PowerShell 或 cmd 中都能很好地工作。
为您的代码创建一个文件夹
首先，为要编写的代码创建一个文件夹。
-
打开命令提示符并更改到您的主目录。
在 Linux 或 Mac 上
$ cd在 Windows 上
C:\> cd %HOMEPATH%在教程的其余部分中，我们将显示 $ 作为提示符。我们使用的命令在 Windows 上也能正常工作。
-
在命令提示符下，为您的代码创建一个名为 data-access 的目录。
$ mkdir data-access $ cd data-access -
创建一个模块，您可以在其中管理本教程期间添加的依赖项。
运行
go mod init命令，并为其提供新的代码的模块路径。$ go mod init example/data-access go: creating new go.mod: module example/data-access此命令创建一个 go.mod 文件，您添加的依赖项将列在其中以进行跟踪。有关更多信息，请务必参阅 管理依赖项。
注意：在实际开发中，您需要指定更符合您自己需求的模块路径。有关更多信息，请参阅 管理依赖项。
接下来，您将创建一个数据库。
设置数据库
在此步骤中，您将创建要使用的数据库。您将使用 DBMS 本身的 CLI 来创建数据库和表，以及添加数据。
您将创建一个包含有关黑胶唱片上复古爵士乐录音的数据的数据库。
此处的代码使用 MySQL CLI，但大多数 DBMS 都具有具有类似功能的自己的 CLI。
-
打开新的命令提示符。
-
在命令行中，登录到您的 DBMS，如下面的 MySQL 示例所示。
$ mysql -u root -p Enter password: mysql> -
在
mysql命令提示符下，创建一个数据库。mysql> create database recordings; -
更改到刚创建的数据库，以便您可以添加表。
mysql> use recordings; Database changed -
在文本编辑器中，在 data-access 文件夹中，创建一个名为 create-tables.sql 的文件，以保存用于添加表的 SQL 脚本。
-
将以下 SQL 代码粘贴到文件中，然后保存文件。
DROP TABLE IF EXISTS album; CREATE TABLE album ( id INT AUTO_INCREMENT NOT NULL, title VARCHAR(128) NOT NULL, artist VARCHAR(255) NOT NULL, price DECIMAL(5,2) NOT NULL, PRIMARY KEY (`id`) ); INSERT INTO album (title, artist, price) VALUES ('Blue Train', 'John Coltrane', 56.99), ('Giant Steps', 'John Coltrane', 63.99), ('Jeru', 'Gerry Mulligan', 17.99), ('Sarah Vaughan', 'Sarah Vaughan', 34.98);在此 SQL 代码中，您
-
删除（drop）名为
album的表。首先执行此命令可让您在以后想要重新开始使用该表时更轻松地重新运行脚本。 -
创建一个具有四列的
album表：title、artist和price。每行的id值由 DBMS 自动创建。 -
添加四行值。
-
-
从
mysql命令提示符运行刚刚创建的脚本。您将以以下形式使用
source命令mysql> source /path/to/create-tables.sql -
在 DBMS 命令提示符下，使用
SELECT语句验证您是否已成功创建包含数据的表。mysql> select * from album; +----+---------------+----------------+-------+ | id | title | artist | price | +----+---------------+----------------+-------+ | 1 | Blue Train | John Coltrane | 56.99 | | 2 | Giant Steps | John Coltrane | 63.99 | | 3 | Jeru | Gerry Mulligan | 17.99 | | 4 | Sarah Vaughan | Sarah Vaughan | 34.98 | +----+---------------+----------------+-------+ 4 rows in set (0.00 sec)
接下来，您将编写一些 Go 代码进行连接，以便您可以查询。
查找并导入数据库驱动程序
既然您已经拥有包含一些数据的数据库，请开始您的 Go 代码。
找到并导入一个数据库驱动程序，该驱动程序会将您通过 database/sql 包中的函数发出的请求转换为数据库理解的请求。
-
在浏览器中，访问 SQLDrivers wiki 页面以识别您可以使用的驱动程序。
使用页面上的列表来识别您将使用的驱动程序。在本教程中访问 MySQL 时，您将使用 Go-MySQL-Driver。
-
记下驱动程序的包名称——此处为
github.com/go-sql-driver/mysql。 -
使用文本编辑器，创建一个文件来编写您的 Go 代码，并将该文件保存为 main.go，位于您之前创建的 data-access 目录中。
-
在 main.go 中，粘贴以下代码以导入驱动程序包。
package main import "github.com/go-sql-driver/mysql"在此代码中，您
-
将您的代码添加到
main包中，以便您可以独立执行它。 -
导入 MySQL 驱动程序
github.com/go-sql-driver/mysql。
-
导入驱动程序后，您将开始编写代码以访问数据库。
获取数据库句柄并连接
现在编写一些 Go 代码，该代码通过数据库句柄为您提供数据库访问权限。
您将使用指向 sql.DB 结构的指针，该结构表示对特定数据库的访问。
编写代码
-
在 main.go 中，粘贴以下 Go 代码以创建数据库句柄，位于您刚刚添加的
import代码下方。var db *sql.DB func main() { // Capture connection properties. cfg := mysql.Config{ User: os.Getenv("DBUSER"), Passwd: os.Getenv("DBPASS"), Net: "tcp", Addr: "127.0.0.1:3306", DBName: "recordings", } // Get a database handle. var err error db, err = sql.Open("mysql", cfg.FormatDSN()) if err != nil { log.Fatal(err) } pingErr := db.Ping() if pingErr != nil { log.Fatal(pingErr) } fmt.Println("Connected!") }在此代码中，您
-
声明一个
*sql.DB类型的db变量。这是你的数据库句柄。将
db设置为全局变量可以简化此示例。在实际应用中，你应避免使用全局变量，例如通过将变量传递给需要它的函数或将其包装在结构中。 -
使用 MySQL 驱动程序的
Config- 以及该类型的FormatDSN- 收集连接属性并将它们格式化为连接字符串中的 DSN。Config结构使得代码比连接字符串更易于阅读。 -
调用
sql.Open初始化db变量，传递FormatDSN的返回值。 -
检查
sql.Open的错误。如果例如你的数据库连接规范格式不正确，它可能会失败。为了简化代码，你正在调用
log.Fatal以结束执行并将错误打印到控制台。在实际代码中，你将希望以更优雅的方式处理错误。 -
调用
DB.Ping以确认连接到数据库是否有效。在运行时，sql.Open可能不会立即连接，具体取决于驱动程序。你在此处使用Ping以确认database/sql包在需要时可以连接。 -
检查
Ping的错误，以防连接失败。 -
如果
Ping成功连接，则打印一条消息。
-
-
在 main.go 文件的顶部附近，就在包声明的下方，导入你将需要用来支持你刚刚编写的代码的包。
该文件顶部现在应如下所示
package main import ( "database/sql" "fmt" "log" "os" "github.com/go-sql-driver/mysql" ) -
保存 main.go。
运行代码
-
开始将 MySQL 驱动程序模块作为依赖项进行跟踪。
使用
go get将 github.com/go-sql-driver/mysql 模块作为你自己的模块的依赖项进行添加。使用点参数表示“获取当前目录中代码的依赖项”。有关依赖项跟踪的更多信息，请参阅 添加依赖项。$ go get . go get: added github.com/go-sql-driver/mysql v1.6.0Go 下载了此依赖项，因为你在前一步中将其添加到
import声明中。有关依赖项跟踪的更多信息，请参阅 添加依赖项。 -
从命令提示符中，设置
DBUSER和DBPASS环境变量，以便 Go 程序使用。在 Linux 或 Mac 上
$ export DBUSER=username $ export DBPASS=password在 Windows 上
C:\Users\you\data-access> set DBUSER=username C:\Users\you\data-access> set DBPASS=password -
从包含 main.go 的目录中的命令行中，通过键入带有点参数的
go run来运行代码，表示“运行当前目录中的包”。$ go run . Connected!
你可以连接！接下来，你将查询一些数据。
查询多行
在本节中，你将使用 Go 执行旨在返回多行的 SQL 查询。
对于可能返回多行的 SQL 语句，请使用 database/sql 包中的 Query 方法，然后循环遍历它返回的行。（稍后，您将在 查询单行 部分中了解如何查询单行。）
编写代码
-
在
func main正上方，粘贴Album结构的以下定义。您将使用它来保存从查询返回的行数据。type Album struct { ID int64 Title string Artist string Price float32 } -
在
func main下方，粘贴以下albumsByArtist函数以查询数据库。// albumsByArtist queries for albums that have the specified artist name. func albumsByArtist(name string) ([]Album, error) { // An albums slice to hold data from returned rows. var albums []Album rows, err := db.Query("SELECT * FROM album WHERE artist = ?", name) if err != nil { return nil, fmt.Errorf("albumsByArtist %q: %v", name, err) } defer rows.Close() // Loop through rows, using Scan to assign column data to struct fields. for rows.Next() { var alb Album if err := rows.Scan(&alb.ID, &alb.Title, &alb.Artist, &alb.Price); err != nil { return nil, fmt.Errorf("albumsByArtist %q: %v", name, err) } albums = append(albums, alb) } if err := rows.Err(); err != nil { return nil, fmt.Errorf("albumsByArtist %q: %v", name, err) } return albums, nil }在此代码中，您
-
声明一个您定义的
Album类型的albums片段。这将保存来自返回行的的数据。结构字段名称和类型对应于数据库列名称和类型。 -
使用
DB.Query执行SELECT语句以查询具有指定艺术家名称的专辑。Query的第一个参数是 SQL 语句。在参数之后，您可以传递零个或多个任何类型的参数。这些参数为您提供指定 SQL 语句中参数值的地方。通过将 SQL 语句与参数值分开（而不是使用fmt.Sprintf等对其进行连接），您可以使database/sql包能够将值与 SQL 文本分开发送，从而消除任何 SQL 注入风险。 -
延迟关闭
rows，以便在函数退出时释放它所持有的任何资源。 -
循环遍历返回的行，使用
Rows.Scan将每行的列值分配给Album结构字段。Scan采用指向 Go 值的指针列表，其中将写入列值。在此处，您传递指向alb变量中字段的指针，使用&运算符创建。Scan通过指针写入以更新结构字段。 -
在循环内部，检查从列值扫描到结构字段的错误。
-
在循环内部，将新的
alb追加到albums片段。 -
在循环之后，使用
rows.Err检查来自整个查询的错误。请注意，如果查询本身失败，则在此处检查错误是找出结果不完整情况的唯一方法。
-
-
更新您的
main函数以调用albumsByArtist。在
func main的末尾，添加以下代码。albums, err := albumsByArtist("John Coltrane") if err != nil { log.Fatal(err) } fmt.Printf("Albums found: %v\n", albums)在新代码中，您现在
-
调用您添加的
albumsByArtist函数，将其返回值分配给新的albums变量。 -
打印结果。
-
运行代码
在包含 main.go 的目录中的命令行中，运行代码。
$ go run .
Connected!
Albums found: [{1 Blue Train John Coltrane 56.99} {2 Giant Steps John Coltrane 63.99}]
接下来，您将查询单行。
查询单行
在本部分中，您将使用 Go 查询数据库中的单行。
对于您已知将最多返回单行的 SQL 语句，您可以使用 QueryRow，它比使用 Query 循环更简单。
编写代码
-
在
albumsByArtist下方，粘贴以下albumByID函数。// albumByID queries for the album with the specified ID. func albumByID(id int64) (Album, error) { // An album to hold data from the returned row. var alb Album row := db.QueryRow("SELECT * FROM album WHERE id = ?", id) if err := row.Scan(&alb.ID, &alb.Title, &alb.Artist, &alb.Price); err != nil { if err == sql.ErrNoRows { return alb, fmt.Errorf("albumsById %d: no such album", id) } return alb, fmt.Errorf("albumsById %d: %v", id, err) } return alb, nil }在此代码中，您
-
使用
DB.QueryRow执行SELECT语句以查询具有指定 ID 的专辑。它返回一个
sql.Row。为了简化调用代码（您的代码！），QueryRow不会返回错误。相反，它会安排从Rows.Scan返回任何查询错误（例如sql.ErrNoRows）。 -
使用
Row.Scan将列值复制到结构字段中。 -
检查来自
Scan的错误。特殊错误
sql.ErrNoRows表示查询未返回任何行。通常，值得用更具体的文本替换该错误，例如此处为“无此专辑”。
-
-
更新
main以调用albumByID。在
func main的末尾，添加以下代码。// Hard-code ID 2 here to test the query. alb, err := albumByID(2) if err != nil { log.Fatal(err) } fmt.Printf("Album found: %v\n", alb)在新代码中，您现在
-
调用您添加的
albumByID函数。 -
打印返回的专辑 ID。
-
运行代码
在包含 main.go 的目录中的命令行中，运行代码。
$ go run .
Connected!
Albums found: [{1 Blue Train John Coltrane 56.99} {2 Giant Steps John Coltrane 63.99}]
Album found: {2 Giant Steps John Coltrane 63.99}
接下来，您将向数据库添加专辑。
添加数据
在本部分中，您将使用 Go 执行 SQL INSERT 语句，以向数据库添加新行。
您已了解如何将 Query 和 QueryRow 与返回数据的 SQL 语句一起使用。要执行不返回数据的 SQL 语句，请使用 Exec。
编写代码
-
在
albumByID下方，粘贴以下addAlbum函数以在数据库中插入新专辑，然后保存 main.go。// addAlbum adds the specified album to the database, // returning the album ID of the new entry func addAlbum(alb Album) (int64, error) { result, err := db.Exec("INSERT INTO album (title, artist, price) VALUES (?, ?, ?)", alb.Title, alb.Artist, alb.Price) if err != nil { return 0, fmt.Errorf("addAlbum: %v", err) } id, err := result.LastInsertId() if err != nil { return 0, fmt.Errorf("addAlbum: %v", err) } return id, nil }在此代码中，您
-
使用
DB.Exec执行INSERT语句。与
Query类似，Exec采用 SQL 语句，后跟 SQL 语句的参数值。 -
检查尝试
INSERT的错误。 -
使用
Result.LastInsertId检索已插入数据库行的 ID。 -
检查尝试检索 ID 的错误。
-
-
更新
main以调用新的addAlbum函数。在
func main的末尾，添加以下代码。albID, err := addAlbum(Album{ Title: "The Modern Sound of Betty Carter", Artist: "Betty Carter", Price: 49.99, }) if err != nil { log.Fatal(err) } fmt.Printf("ID of added album: %v\n", albID)在新代码中，您现在
- 使用新专辑调用
addAlbum，将您要添加的专辑的 ID 分配给albID变量。
- 使用新专辑调用
运行代码
在包含 main.go 的目录中的命令行中，运行代码。
$ go run .
Connected!
Albums found: [{1 Blue Train John Coltrane 56.99} {2 Giant Steps John Coltrane 63.99}]
Album found: {2 Giant Steps John Coltrane 63.99}
ID of added album: 5
结论
恭喜！您刚刚使用 Go 对关系数据库执行了简单的操作。
建议的后续主题
-
查看数据访问指南，其中包括更多有关此处仅涉及主题的信息。
-
如果您是 Go 新手，您会发现 Effective Go 和 How to write Go code 中描述的有用最佳实践。
-
Go 导览是一份逐步介绍 Go 基础知识的优秀指南。
已完成代码
本部分包含使用本教程构建的应用程序的代码。
package main
import (
"database/sql"
"fmt"
"log"
"os"
"github.com/go-sql-driver/mysql"
)
var db *sql.DB
type Album struct {
ID int64
Title string
Artist string
Price float32
}
func main() {
// Capture connection properties.
cfg := mysql.Config{
User: os.Getenv("DBUSER"),
Passwd: os.Getenv("DBPASS"),
Net: "tcp",
Addr: "127.0.0.1:3306",
DBName: "recordings",
}
// Get a database handle.
var err error
db, err = sql.Open("mysql", cfg.FormatDSN())
if err != nil {
log.Fatal(err)
}
pingErr := db.Ping()
if pingErr != nil {
log.Fatal(pingErr)
}
fmt.Println("Connected!")
albums, err := albumsByArtist("John Coltrane")
if err != nil {
log.Fatal(err)
}
fmt.Printf("Albums found: %v\n", albums)
// Hard-code ID 2 here to test the query.
alb, err := albumByID(2)
if err != nil {
log.Fatal(err)
}
fmt.Printf("Album found: %v\n", alb)
albID, err := addAlbum(Album{
Title: "The Modern Sound of Betty Carter",
Artist: "Betty Carter",
Price: 49.99,
})
if err != nil {
log.Fatal(err)
}
fmt.Printf("ID of added album: %v\n", albID)
}
// albumsByArtist queries for albums that have the specified artist name.
func albumsByArtist(name string) ([]Album, error) {
// An albums slice to hold data from returned rows.
var albums []Album
rows, err := db.Query("SELECT * FROM album WHERE artist = ?", name)
if err != nil {
return nil, fmt.Errorf("albumsByArtist %q: %v", name, err)
}
defer rows.Close()
// Loop through rows, using Scan to assign column data to struct fields.
for rows.Next() {
var alb Album
if err := rows.Scan(&alb.ID, &alb.Title, &alb.Artist, &alb.Price); err != nil {
return nil, fmt.Errorf("albumsByArtist %q: %v", name, err)
}
albums = append(albums, alb)
}
if err := rows.Err(); err != nil {
return nil, fmt.Errorf("albumsByArtist %q: %v", name, err)
}
return albums, nil
}
// albumByID queries for the album with the specified ID.
func albumByID(id int64) (Album, error) {
// An album to hold data from the returned row.
var alb Album
row := db.QueryRow("SELECT * FROM album WHERE id = ?", id)
if err := row.Scan(&alb.ID, &alb.Title, &alb.Artist, &alb.Price); err != nil {
if err == sql.ErrNoRows {
return alb, fmt.Errorf("albumsById %d: no such album", id)
}
return alb, fmt.Errorf("albumsById %d: %v", id, err)
}
return alb, nil
}
// addAlbum adds the specified album to the database,
// returning the album ID of the new entry
func addAlbum(alb Album) (int64, error) {
result, err := db.Exec("INSERT INTO album (title, artist, price) VALUES (?, ?, ?)", alb.Title, alb.Artist, alb.Price)
if err != nil {
return 0, fmt.Errorf("addAlbum: %v", err)
}
id, err := result.LastInsertId()
if err != nil {
return 0, fmt.Errorf("addAlbum: %v", err)
}
return id, nil
}