使用xo从数据库Schema生成Go代码

xo是一个强大的工具，可以从数据库schema自动生成类型安全的Go代码。它支持多种数据库(PostgreSQL, MySQL, SQLite, Oracle, Microsoft SQL Server)并能生成模型、查询、存储过程等代码。

安装xo

# 安装xo
go get -u github.com/xo/xo

# 安装数据库驱动(根据需要选择)
go get -u github.com/lib/pq      # PostgreSQL
go get -u github.com/go-sql-driver/mysql # MySQL
go get -u github.com/mattn/go-sqlite3    # SQLite

基本使用

1. 从数据库生成模型

# PostgreSQL示例
xo pgsql://user:pass@host/dbname -o models

# MySQL示例
xo mysql://user:pass@host/dbname -o models

# SQLite示例
xo file:path/to/db.sqlite3 -o models

2. 常用选项

# 指定包名
xo pgsql://user:pass@host/dbname -o models --package mymodels

# 忽略特定表
xo pgsql://user:pass@host/dbname -o models --ignore users,logs

# 只包含特定表
xo pgsql://user:pass@host/dbname -o models --include users,posts

# 添加自定义模板
xo pgsql://user:pass@host/dbname -o models --template-path /path/to/templates

生成代码示例

假设有一个简单的users表：

CREATE TABLE users (
    id SERIAL PRIMARY KEY,
    name VARCHAR(100) NOT NULL,
    email VARCHAR(100) UNIQUE NOT NULL,
    created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP
);

运行xo后会生成以下文件：

models/user.go

// Code generated by xo. DO NOT EDIT.

package models

import (
    "context"
    "time"
)

// User represents a row from 'public.users'.
type User struct {
    ID        int       `json:"id"`         // id
    Name      string    `json:"name"`       // name
    Email     string    `json:"email"`      // email
    CreatedAt time.Time `json:"created_at"` // created_at
    // xo fields
    _exists, _deleted bool
}

// Exists returns true when the User exists in the database.
func (u *User) Exists() bool {
    return u._exists
}

// Deleted returns true when the User has been marked for deletion from
// the database.
func (u *User) Deleted() bool {
    return u._deleted
}

// Insert inserts the User to the database.
func (u *User) Insert(ctx context.Context, db DB) error {
    // ...
}

// Update updates a User in the database.
func (u *User) Update(ctx context.Context, db DB) error {
    // ...
}

// Save saves the User to the database.
func (u *User) Save(ctx context.Context, db DB) error {
    if u.Exists() {
        return u.Update(ctx, db)
    }
    return u.Insert(ctx, db)
}

// Delete deletes the User from the database.
func (u *User) Delete(ctx context.Context, db DB) error {
    // ...
}

// UserByEmail retrieves a row from 'public.users' as a User.
func UserByEmail(ctx context.Context, db DB, email string) (*User, error) {
    // ...
}

models/xo_db.go

// Code generated by xo. DO NOT EDIT.

package models

import (
    "context"
    "database/sql"
    "fmt"
    "time"
)

// DB is the common interface for database operations.
type DB interface {
    ExecContext(context.Context, string, ...interface{}) (sql.Result, error)
    PrepareContext(context.Context, string) (*sql.Stmt, error)
    QueryContext(context.Context, string, ...interface{}) (*sql.Rows, error)
    QueryRowContext(context.Context, string, ...interface{}) *sql.Row
}

自定义模板

xo允许使用自定义模板来生成代码。默认模板在xo/templates目录下。

要使用自定义模板：

1. 创建模板目录结构
2. 修改需要的模板文件
3. 使用--template-path选项指定模板路径

xo pgsql://user:pass@host/dbname -o models --template-path /path/to/templates

在项目中使用生成的代码

package main

import (
    "context"
    "database/sql"
    "fmt"
    "log"
    
    "your_project/models"
    
    _ "github.com/lib/pq"
)

func main() {
    db, err := sql.Open("postgres", "postgres://user:pass@localhost/dbname?sslmode=disable")
    if err != nil {
        log.Fatal(err)
    }
    defer db.Close()
    
    // 创建新用户
    user := &models.User{
        Name:  "John Doe",
        Email: "john@example.com",
    }
    if err := user.Save(context.Background(), db); err != nil {
        log.Fatal(err)
    }
    
    // 查询用户
    fetchedUser, err := models.UserByEmail(context.Background(), db, "john@example.com")
    if err != nil {
        log.Fatal(err)
    }
    
    fmt.Printf("User: %+v\n", fetchedUser)
}

高级功能

1. 自定义类型：使用--custom-type选项映射数据库类型到Go类型
2. 复合主键：支持复合主键表的生成
3. 外键关系：自动生成关联查询方法
4. 存储过程：支持生成存储过程的调用代码
5. 枚举类型：支持数据库枚举类型的生成

xo是一个强大的工具，可以显著减少数据库相关的样板代码编写工作，同时保持类型安全。