Go实现简单的数据库表转结构体详解

2023-01-10 15:00

短信预约 -IT技能 免费直播动态提醒

前言

码上源码

package main
import (
	"database/sql"
	"fmt"
	_ "github.com/go-sql-driver/mysql"
	"strings"
)

type SchemaMeta struct {
	Field   string
	Type    string
	Null    string
	Key     string
	Default interface{}
	Extra   string
}
func main() {
	dbString := "{YOUR_MYSQL_CONNECTION}"
	db, _ := sql.Open("mysql", dbString)
	tables := getTables(db)
	for _, table := range tables {
		metas := getTableInfo(table, db)
		result := changeMetas(table, metas)
		fmt.Println(result)
	}
}
func getTables(db *sql.DB) []string {
	var tables []string
	res, _ := db.Query("SHOW TABLES")
	for res.Next() {
		var table string
		res.Scan(&table)
		tables = append(tables, table)
	}
	return tables
}
func getTableInfo(tableName string, db *sql.DB) (metas []SchemaMeta) {
	list, _ := db.Query(fmt.Sprintf("show columns from %s", tableName))
	for list.Next() {
		var data SchemaMeta
		err := list.Scan(&data.Field, &data.Type, &data.Null, &data.Key, &data.Default, &data.Extra)
		if err != nil {
			fmt.Println(err.Error())
		}
		metas = append(metas, data)
	}
	return metas
}
func changeMetas(tableName string, metas []SchemaMeta) string {
	var modelStr string
	for _, val := range metas {
		dataType := "interface{}"
		if val.Type[:3] == "int" {
			dataType = "int"
		} else if val.Type[:7] == "varchar" {
			dataType = "string"
		} else if val.Type[:7] == "tinyint" {
			dataType = "bool"
		} else if val.Type == "datetime" {
			dataType = "time.Time"
		}
		field := val.Field
		field = strings.ToUpper(field[:1]) + field[1:]
		modelStr += fmt.Sprintf("%s %s\n", field, dataType)
	}
	tableName = strings.ToUpper(tableName[:1]) + tableName[1:]
	return fmt.Sprintf("type %s struct {\n %s }", tableName, modelStr)
}

设计好了数据库表之后最烦的就是又要在代码中建一层实体层然后一个个创建对应表的结构体。关键那么多项目每次都是需要创建一份，所以就使用 go 实现一个简单的将数据库的表转化为结构体。

基本的设计思路也是很简单：

连接数据库
获取数据库中所有的表
获取表的所有的元数据
将元数据转换为字符串，该字符串就是一个 struct的内容并输出结果

设计过程

经常使用 MySQL 的时候，可以通过 SQL 语句查询相关的信息，比如查看数据库的状态、数据库的数据表、数据库服务的状态等等语句。

show databases 查看所有的数据库
show tables [from dbName] 查看数据库的所有表数据
show columns from tableName [from dbName] 查看数据库表的所有元信息
show status 查看数据服务的状态

所以就可以使用以上的 SQL 语句进行相操作，比如获取所有的表，获取相关表的元数据

func getTableInfo(tableName string, db *sql.DB) (metas []SchemaMeta) {
    list, _ := db.Query(fmt.Sprintf("show columns from %s", tableName))
    for list.Next() {
        var data SchemaMeta
        err := list.Scan(&data.Field, &data.Type, &data.Null, &data.Key, &data.Default, &data.Extra)
        if err != nil {
            fmt.Println(err.Error())
        }
        metas = append(metas, data)
    }
    return metas
}

表的元数据获取完之后就可以进行封装成一个字符串。最主要的功能有两个：

db 数据类型转 go 数据类型
首字母大小写，

数据类型的转换简单处理的话可以使用枚举的方式将 db 数据类型和 go 的数据类型建立一个map 进行一一对应，当然也可以使用模糊匹配的方式。我这里直接使用截取字符串值去匹配。

因要设置为对象类型，必须设置为公有的，所以结构体名称和字段名称都必须是大写。直接使用截取第一位然后进行大写转换再重新拼接出去。比如 field = strings.ToUpper(field[:1]) + field[1:]。这部分的数据大小写还需要根据自己的需求进行调整，比如有写字段是这样：“user_code”那么转换成字段应该是“UserCode”。

转换完之后就可以输出，一个简单的工具就完成了。