Golang无需修改代码即可使用预编译SQL语句插件库prep的使用

Prep是一个能够自动发现Go包中所有SQL语句并为数据库连接添加预编译语句支持的库。它允许你几乎不需要修改现有代码就能享受到预编译SQL语句带来的性能优势。

组成部分

Prep包含两部分：

1. 一个命令行工具，用于查找代码中的所有SQL语句
2. 一个包，使用找到的SQL语句为你的代码添加预编译SQL语句支持

使用方法

生成应用程序中使用的SQL语句列表

假设有以下示例代码：

func main() {
	db, err := sql.Open("mysql", "user:pass@tcp(localhost:3306)/mysql")
	if err != nil {
		panic(err)
	}
	const query = `SELECT CONCAT("Hello ", ?, "!")`
	var s string
	if err := db.QueryRow(query, "World").Scan(&s); err != nil {
		panic(err)
	}
	fmt.Println(s)
}

运行以下命令生成SQL语句列表：

$ prep -f github.com/hexdigest/prepdemo
$ cat prepared_statements.go

生成的prepared_statements.go文件内容如下：

//go:generate prep -f github.com/hexdigest/prepdemo

package main

var prepStatements = []string{
	"SELECT CONCAT(\"Hello \", ?, \"!\")",
}

使用预编译语句

修改主程序以使用预编译语句：

func main() {
	sqlDB, err := sql.Open("mysql", "root:root@tcp(localhost:3306)/mysql")
	if err != nil {
		panic(err)
	}

	db, err := prep.NewConnection(sqlDB, prepStatements)
	if err != nil {
		panic(err)
	}

	const query = `SELECT CONCAT("Hello ", ?, "!")`
	var s string
	if err := db.QueryRow(query, "World").Scan(&s); err != nil {
		panic(err)
	}
	fmt.Println(s)
}

关键行是：

db, err := prep.NewConnection(sqlDB, prepStatements)

这行代码会为你的数据库连接添加预编译语句支持。生成的代码已经包含了//go:generate指令，所以更新语句列表只需运行：

$ go generate

性能基准测试

以下是一些基准测试结果：

$ go test -bench=.
BenchmarkPostgresWithoutPreparedStatements-4   	   20000	     59941 ns/op	    1183 B/op	      32 allocs/op
BenchmarkPostgresWithPreparedStatements-4      	   50000	     41560 ns/op	    1021 B/op	      26 allocs/op
BenchmarkMySQLWithoutPreparedStatements-4      	   50000	     26454 ns/op	     827 B/op	      23 allocs/op
BenchmarkMySQLWithPreparedStatements-4         	  200000	      9509 ns/op	     634 B/op	      19 allocs/op
PASS
ok  	github.com/hexdigest/prep	7.884s

从结果可以看出，使用预编译语句后性能有显著提升。