Go 语言通过 Gokb 驱动连接 Kingbase 数据库实战

如果使用的是 go1.17 及更高版本，go get 不支持在非 GOMODULE 下添加依赖，可以使用 go install 替换 go get 命令。

下载的依赖在 $GOPATH/pkg/mod 目录下，比如 $GOPATH/pkg/mod/github.com/shopspring/[email protected]，

将两个依赖包不保留版本号拷贝到 $GOPATH/src 目录下，比如拷贝为 $GOPATH/src/github.com/shopspring/decimal 即可。

2.3 导入 Gokb(此代码在示例文件中已包含)

在用例文件中通过 _ 方式导入 Gokb 驱动即可通过 go 的官方包 database/sql 操作数据库

import (
	"database/sql"	// 提供数据库连接操作等 api
	_ "kingbase.com/gokb"	// 通过_方式导入会调用驱动包的初始化函数，完成注册驱动
)

2.4 编译示例并执行

修改示例文件中的连接串，使用命令编译名为 test.go 的用例文件，得到可执行文件 test 通过./test 执行即可

go build test.go

或可通过以下命令直接执行，此命令包含编译并执行，但是不会生成可执行文件

go run test.go

三、使用 GOMODULE 管理 Gokb

使用 GOMODULE 管理 Gokb(GOPATH 或 GOMODULE 根据需要选择一种即可)

3.1 查看或配置 GOMODULE

在 go 1.11 引入 GO MODULE 管理包，使用以下命令查看 GO111MODULE，默认为空，表示当项目下存在 go.mod 文件时通过 GOMODULE 管理否则通过 GOPATH 管理

go env

不同 go 版本可能存在差异，可通过命令以下命令强制指定使用 GOMODULE 管理

GO111MODULE=on 或 go env -w GO111MODULE=on

在工程目录下使用以下命令初始化一个名为 test 的项目

go mod init test

得到一个 go.mod 文件，初始内容为

module test
go 1.18

3.2 配置 Gokb

使用 GOMODULE 管理依赖包时可以在联网环境下自动拉取或删除项目所需的依赖包，Gokb 尚未发布到开源网站，所以需要手动配置位置

解压 go 驱动源码，将 kingbase.com/gokb 源码放置在需要的任意位置即可

修改 go.mod，添加以下内容：

module test
go 1.18
require kingbase.com/gokb v1.0.0
replace kingbase.com/gokb => kingbase.com/gokb 所在的绝对路径或相对路径

执行以下命令自动拉取项目所需要的其它依赖：

go mod tidy

该命令也会同时拉取 Gokb 所需的依赖包并指定所需的版本，不需要再手动进行管理

3.3 编译用例并执行

修改示例文件中的连接串，使用命令编译名为 test.go 的用例文件，得到可执行文件 test，通过 ./test 执行即可。

go build test.go

或可通过以下命令直接执行，此命令包含编译并执行，但是不会生成可执行文件

go run test.go

四、文件示例模版

package main

import (
	"database/sql"	// 提供数据库连接操作等 api
	"fmt"	// 提供格式化输出的 api
	_ "kingbase.com/gokb"	// 通过_方式导入会调用驱动包的初始化函数，完成注册驱动
)

// 修改此处连接信息为已开启服务的 KES 的信息
const (
	host     = "127.0.0.1"
	port     = 54321
	user     = "system"
	password = "123456"
	dbname   = "test"
)

// 操作的表结构
type GoTable struct {
	Num  int    `db:"num"`
	Text string `db:"text"`
	Blob []byte `db:"blob"`
	Clob string `db:"clob"`
}

// 建立连接
func testConn(connInfo string) (*sql.DB, error) {
	db, err := sql.Open("kingbase", connInfo)
	if err != nil {
		return db, err
	}
	err = db.Ping()
	if err != nil {
		return db, err
	}
	return db, err
}

// 事务操作
func testTran(db *sql.DB, sql string) (err error) {
	txn, err := db.Begin()
	defer txn.Commit()
	if err != nil {
		return err
	}
	_, err = txn.Exec(sql)
	if err != nil {
		return err
	}
	return nil
}

func testInsert(db *sql.DB, sql string) (err error) {
	err = testTran(db, sql)
	return err
}

// 通过预备语句执行
func testPrepare(db *sql.DB, sql string) (err error) {
	stmt, err := db.Prepare(sql)
	defer stmt.Close()
	if err != nil {
		return err
	}
	_, err = stmt.Exec(int64(100), "VARCHAR 中文示例文字", []byte{10, 20, 30, 40, 50}, "CLOB 中文示例文字")
	if err != nil {
		return err
	}
	return nil
}

// 查询操作
func testSelect(db *sql.DB, query string) (data []*GoTable, err error) {
	rows, err := db.Query(query)
	defer rows.Close()
	if err != nil {
		return nil, err
	}
	for rows.Next() {
		var row GoTable
		err = rows.Scan(&row.Num, &row.Text, &row.Blob, &row.Clob)
		if err != nil {
			return nil, err
		}
		data = append(data, &row)
	}
	return data, nil
}

func main() {
	connInfo := fmt.Sprintf("host=%s port=%d user=%s password=%s dbname=%s sslmode=disable", host, port, user, password, dbname)
	db, err := testConn(connInfo)
	if err != nil {
		panic(err)
	}
	fmt.Println("Connection test success!")
	defer db.Close()

	err = testTran(db, "CREATE temp TABLE temp_golang_test (num INTEGER, text VARCHAR, blob BLOB, clob CLOB)")
	if err != nil {
		panic(err)
	}
	fmt.Println("Transaction test success!")

	err = testInsert(db, "insert into temp_golang_test(num,text,blob,clob) values(123456,'ABC!@#123','abcdef123456','123456!@#$%^');")
	if err != nil {
		panic(err)
	}
	fmt.Println("Insert data test success!")

	err = testPrepare(db, "insert into temp_golang_test values($1,$2,$3,$4)")
	if err != nil {
		panic(err)
	}
	fmt.Println("Prepare and execute test success!")

	data, err := testSelect(db, "select * from temp_golang_test;")
	if err != nil {
		panic(err)
	}
	fmt.Println(data[0], "\n", data[1])
	fmt.Println("Select test success!")
}

五、总结

本文通过 Go+Gokb+Kingbase 的集成方案，覆盖了从环境搭建到 SQL 操作的全流程。重点强调了连接验证、参数化查询、事务管理三大核心，并针对常见编译、连接、类型问题提供了解决方案。