SQLite数据库操作神器sqlc入门指南

SQLite数据库操作神器sqlc入门指南

sqlc 项目地址: https://gitcode.com/gh_mirrors/sql/sqlc

前言

在Go语言开发中，数据库操作是一个常见需求。传统的方式需要开发者手动编写大量重复的SQL语句和结构体映射代码，这不仅效率低下，而且容易出错。sqlc项目正是为解决这一问题而生，它能根据SQL schema和查询语句自动生成类型安全的Go代码，极大提升开发效率。

环境准备

开始之前，请确保已安装以下工具：

1. Go语言工具链（1.16+版本）
2. sqlc工具（最新版本）

项目初始化

首先创建一个新项目目录并初始化Go模块：

mkdir sqlc-tutorial && cd sqlc-tutorial
go mod init tutorial.sqlc.dev/app

配置sqlc

sqlc需要一个配置文件来指定生成规则。创建sqlc.yaml文件：

version: "2"
sql:
  - engine: "sqlite"  # 指定使用SQLite数据库
    queries: "query.sql"  # 查询语句文件
    schema: "schema.sql"  # 数据库schema文件
    gen:
      go:
        package: "tutorial"  # 生成的Go包名
        out: "tutorial"  # 输出目录

定义数据库结构

在schema.sql中定义数据表结构：

CREATE TABLE authors (
  id   INTEGER PRIMARY KEY,
  name text    NOT NULL,  -- 作者姓名，非空
  bio  text               -- 作者简介，可为空
);

编写SQL查询

在query.sql中定义CRUD操作：

-- 获取单个作者
-- name: GetAuthor :one
SELECT * FROM authors
WHERE id = ? LIMIT 1;

-- 获取作者列表
-- name: ListAuthors :many
SELECT * FROM authors
ORDER BY name;

-- 创建作者并返回结果
-- name: CreateAuthor :one
INSERT INTO authors (name, bio)
VALUES (?, ?)
RETURNING *;

-- 更新作者信息
-- name: UpdateAuthor :exec
UPDATE authors
SET name = ?, bio = ?
WHERE id = ?;

-- 删除作者
-- name: DeleteAuthor :exec
DELETE FROM authors
WHERE id = ?;

注意每个查询前的注释：

• :one表示返回单条记录
• :many表示返回多条记录
• :exec表示不返回记录

生成代码

执行生成命令：

sqlc generate

成功执行后，将生成以下文件结构：

tutorial/
├── db.go        # 数据库连接相关
├── models.go    # 结构体定义
└── query.sql.go # 查询方法实现

使用生成的代码

创建一个示例程序tutorial.go：

package main

import (
	"context"
	"database/sql"
	"log"
	"reflect"

	_ "github.com/mattn/go-sqlite3"
	"tutorial.sqlc.dev/app/tutorial"
)

func main() {
	ctx := context.Background()
	
	// 初始化内存数据库
	db, err := sql.Open("sqlite3", ":memory:")
	if err != nil {
		log.Fatal(err)
	}
	
	// 创建表结构
	if _, err := db.ExecContext(ctx, `CREATE TABLE...`); err != nil {
		log.Fatal(err)
	}

	queries := tutorial.New(db)
	
	// 创建作者
	author, err := queries.CreateAuthor(ctx, tutorial.CreateAuthorParams{
		Name: "Brian Kernighan",
		Bio:  sql.NullString{String: "C语言和Go语言合著者", Valid: true},
	})
	if err != nil {
		log.Fatal(err)
	}
	
	// 查询作者
	fetched, err := queries.GetAuthor(ctx, author.ID)
	if err != nil {
		log.Fatal(err)
	}
	
	// 验证数据一致性
	log.Println(reflect.DeepEqual(author, fetched))
}

最佳实践

1. 参数验证：sqlc生成的代码已经做了基础类型检查，但仍建议在业务层做额外验证
2. 事务处理：可以使用queries.WithTx()方法在事务中执行多个操作
3. 复杂查询：对于复杂查询，sqlc支持JOIN等操作，生成的代码会自动处理结果映射

总结

sqlc通过以下特性显著提升开发效率：

• 自动生成类型安全的Go代码
• 消除手写SQL和结构体映射的繁琐工作
• 生成的代码符合Go语言习惯
• 支持多种数据库引擎

通过本教程，您已经掌握了使用sqlc进行SQLite开发的基本流程。在实际项目中，您可以扩展查询复杂度，利用sqlc的强大功能来简化数据库操作。

sqlc 项目地址: https://gitcode.com/gh_mirrors/sql/sqlc