使用sqlc项目快速开发MySQL应用的完整指南

丁璋英Lester

于 2025-06-02 09:16:23 发布

阅读量251

点赞数 3

CC 4.0 BY-SA版权

本文链接：https://blog.youkuaiyun.com/gitblog_00661/article/details/148377589

使用sqlc项目快速开发MySQL应用的完整指南

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

前言

在现代应用开发中，数据库操作是不可或缺的一部分。传统的手写SQL语句和ORM框架各有优缺点，而sqlc项目提供了一种全新的解决方案。本文将详细介绍如何使用sqlc工具来简化MySQL数据库开发流程。

sqlc简介

sqlc是一个将SQL查询转换为类型安全代码的工具，它能够：

根据SQL schema自动生成数据模型
将SQL查询转换为类型安全的函数
支持多种编程语言（本文以Go为例）
提供编译时类型检查

相比传统ORM，sqlc保持了SQL的灵活性，同时提供了类型安全保证，是数据库访问层的理想选择。

环境准备

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

sqlc最新版本
Go工具链（1.16+版本）
MySQL数据库服务

项目初始化

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

mkdir sqlc-mysql-demo
cd sqlc-mysql-demo
go mod init demo.sqlc.dev/app

配置sqlc

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

version: "2"
sql:
  - engine: "mysql"
    queries: "query.sql"    # SQL查询文件
    schema: "schema.sql"   # 数据库schema文件
    gen:
      go:
        package: "demo"   # 生成的Go包名
        out: "demo"        # 输出目录

定义数据库Schema

创建schema.sql文件定义authors表结构：

CREATE TABLE authors (
  id   BIGINT  NOT NULL AUTO_INCREMENT PRIMARY KEY,
  name text    NOT NULL,   -- 作者姓名
  bio  text                -- 作者简介
);

这个schema定义了一个简单的作者表，包含ID、姓名和简介字段。

编写SQL查询

在query.sql中定义CRUD操作：

-- 获取单个作者，:one表示返回单条记录
-- name: GetAuthor :one
SELECT * FROM authors
WHERE id = ? LIMIT 1;

-- 获取作者列表，:many表示返回多条记录
-- name: ListAuthors :many
SELECT * FROM authors
ORDER BY name;

-- 创建作者，:execresult返回执行结果
-- name: CreateAuthor :execresult
INSERT INTO authors (name, bio) VALUES (?, ?);

-- 删除作者，:exec不返回结果
-- name: DeleteAuthor :exec
DELETE FROM authors WHERE id = ?;

sqlc支持多种查询注释语法：

:one：返回单行结果
:many：返回多行结果
:exec：执行但不返回结果
:execresult：返回执行结果（如插入ID）

生成代码

执行生成命令：

sqlc generate

成功执行后，项目结构如下：

.
├── demo/             # 生成的代码目录
│   ├── db.go         # 数据库接口
│   ├── models.go     # 数据模型
│   └── query.sql.go  # 查询方法
├── go.mod
├── query.sql
├── schema.sql
└── sqlc.yaml

使用生成的代码

创建main.go文件演示如何使用生成的代码：

package main

import (
	"context"
	"database/sql"
	"log"
	
	_ "github.com/go-sql-driver/mysql"
	"demo.sqlc.dev/app/demo"  // 导入生成的包
)

func main() {
	ctx := context.Background()
	
	// 初始化数据库连接
	db, err := sql.Open("mysql", "user:password@tcp(127.0.0.1:3306)/dbname?parseTime=true")
	if err != nil {
		log.Fatal(err)
	}
	defer db.Close()

	// 创建查询实例
	queries := demo.New(db)
	
	// 创建作者
	author, err := queries.CreateAuthor(ctx, demo.CreateAuthorParams{
		Name: "John Doe",
		Bio:  sql.NullString{String: "Technical writer", Valid: true},
	})
	if err != nil {
		log.Fatal(err)
	}
	
	// 获取作者ID
	id, _ := author.LastInsertId()
	
	// 查询单个作者
	fetched, err := queries.GetAuthor(ctx, id)
	if err != nil {
		log.Fatal(err)
	}
	
	log.Printf("Author: %+v", fetched)
	
	// 查询作者列表
	authors, err := queries.ListAuthors(ctx)
	if err != nil {
		log.Fatal(err)
	}
	
	log.Printf("Total authors: %d", len(authors))
}

高级特性

类型安全参数

sqlc会自动为每个查询生成类型安全的参数结构体。例如对于CreateAuthor查询，它会生成：

type CreateAuthorParams struct {
	Name string
	Bio  sql.NullString
}

空值处理

sqlc正确处理了MySQL中的NULL值，使用标准库的sql.NullString等类型。

事务支持

生成的代码天然支持事务：

tx, err := db.Begin()
if err != nil {
    log.Fatal(err)
}

qtx := queries.WithTx(tx)
// 在事务中执行查询
err = qtx.DeleteAuthor(ctx, id)
if err != nil {
    tx.Rollback()
    return
}
tx.Commit()