Dotsql: Golang中高效管理SQL文件的插件库

Dotsql是一个轻量级的Go库，专门用于管理SQL文件并简化数据库操作。它允许你将SQL查询与代码分离，保持代码整洁，同时提供便捷的方式来执行这些查询。

Dotsql的核心优势

1. SQL与代码分离：将SQL语句存储在单独的.sql文件中
2. 命名查询：为每个SQL语句命名，便于调用
3. 预处理支持：自动处理参数化查询
4. 轻量级：不引入复杂的ORM概念

安装Dotsql

go get github.com/gchaincl/dotsql

基本使用方法

1. 准备SQL文件

创建一个queries.sql文件：

-- name: create-users-table
CREATE TABLE IF NOT EXISTS users (
    id INTEGER PRIMARY KEY AUTOINCREMENT,
    name TEXT NOT NULL,
    email TEXT NOT NULL UNIQUE,
    created_at DATETIME DEFAULT CURRENT_TIMESTAMP
);

-- name: insert-user
INSERT INTO users (name, email) VALUES (?, ?);

-- name: find-user-by-email
SELECT id, name, email, created_at FROM users WHERE email = ?;

-- name: find-all-users
SELECT id, name, email, created_at FROM users;

2. 加载SQL文件并执行查询

package main

import (
	"database/sql"
	"fmt"
	"log"

	_ "github.com/mattn/go-sqlite3"
	"github.com/gchaincl/dotsql"
)

func main() {
	// 打开数据库连接
	db, err := sql.Open("sqlite3", "./test.db")
	if err != nil {
		log.Fatal(err)
	}
	defer db.Close()

	// 加载SQL文件
	dot, err := dotsql.LoadFromFile("queries.sql")
	if err != nil {
		log.Fatal(err)
	}

	// 执行创建表的查询
	_, err = dot.Exec(db, "create-users-table")
	if err != nil {
		log.Fatal(err)
	}

	// 插入用户数据
	res, err := dot.Exec(db, "insert-user", "John Doe", "john@example.com")
	if err != nil {
		log.Fatal(err)
	}
	lastID, _ := res.LastInsertId()
	fmt.Printf("Inserted user with ID: %d\n", lastID)

	// 查询单个用户
	row := dot.QueryRow(db, "find-user-by-email", "john@example.com")
	var user struct {
		ID        int
		Name      string
		Email     string
		CreatedAt string
	}
	err = row.Scan(&user.ID, &user.Name, &user.Email, &user.CreatedAt)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("Found user: %+v\n", user)

	// 查询所有用户
	rows, err := dot.Query(db, "find-all-users")
	if err != nil {
		log.Fatal(err)
	}
	defer rows.Close()

	fmt.Println("All users:")
	for rows.Next() {
		var u struct {
			ID        int
			Name      string
			Email     string
			CreatedAt string
		}
		err = rows.Scan(&u.ID, &u.Name, &u.Email, &u.CreatedAt)
		if err != nil {
			log.Fatal(err)
		}
		fmt.Printf("- %+v\n", u)
	}
}

高级用法

1. 从字符串加载SQL

sql := `
-- name: count-users
SELECT COUNT(*) FROM users;
`

dot, err := dotsql.LoadFromString(sql)

2. 合并多个SQL文件

dot1, err := dotsql.LoadFromFile("queries1.sql")
dot2, err := dotsql.LoadFromFile("queries2.sql")

dot := dotsql.Merge(dot1, dot2)

3. 预处理语句

// 获取预处理语句
stmt, err := dot.Prepare(db, "insert-user")
defer stmt.Close()

// 执行预处理
_, err = stmt.Exec("Jane Doe", "jane@example.com")

4. 事务支持

tx, err := db.Begin()
defer tx.Rollback()

_, err = dot.Exec(tx, "insert-user", "Alice", "alice@example.com")
_, err = dot.Exec(tx, "insert-user", "Bob", "bob@example.com")

err = tx.Commit()

最佳实践

1. 按功能模块组织SQL文件：例如users.sql、products.sql等
2. 使用有意义的查询名称：如get-user-by-id而非query1
3. 添加注释：说明查询的用途和参数
4. 版本控制SQL文件：与代码一起管理
5. 测试SQL查询：为关键查询编写测试

性能考虑

Dotsql本身非常轻量，主要开销在于：

1. 文件加载和解析（只在启动时一次）
2. 预处理语句的创建

对于高性能场景，建议：

• 在应用启动时加载所有SQL文件
• 对频繁使用的查询使用Prepare缓存预处理语句

与其他库的比较

Dotsql在需要直接控制SQL但又想保持代码整洁的场景下表现最佳。

总结

Dotsql为Go开发者提供了一种优雅的方式来管理SQL查询，特别适合：

• 需要精细控制SQL语句的项目
• 希望保持代码整洁的团队
• 需要将SQL与业务逻辑分离的架构

通过将SQL外部化，Dotsql使你的代码更易于维护，同时保留了直接使用SQL的灵活性和性能优势。