golang 生成对应的数据表struct定义操作


Posted in Golang onApril 28, 2021

在开发过程中,常常需要将数据库表对应到golang的一个struct,特别是使用一些ORM工具,sqlx库等,我是个懒人,即使数据表的字段不多,我也懒得去一个个对应的敲入代码,更别提数据表字段比较多的情况了,码农的时间,不能浪费在这啊,对吧?所以我在想,是不是有办法可以自动生成。

我在工作时,用得最多的是mysql了,因此

本文针对mysql的数据表来自动生成golang 的struct定义

mysql有个自带的数据库information_schema,里面的信息量比较多,朋友们可以去百度下,我这里用到了表COLUMNS,它的字段包含数据库名、表名、字段名、字段类型等,利用这个表的数据,把对应的表的字段信息读取出来,然后再根据golang的语法规则,生成文件就可以了。

大致思路确定了,开始动手。

我采用sqlx进行数据库的访问,首先定义一个struct来表示COLUMNS的数据,这里我只需要几个字段,因此,没有把表COLUMNS的所有字段都对应到struct:

type FieldInfo struct {
 ColName    string `db:"COLUMN_NAME"`
 DataType   string `db:"DATA_TYPE"`
 ColComment string `db:"COLUMN_COMMENT"`
 IsNullable string `db:"IS_NULLABLE"`
}

需要指定生成的struct对应的是哪个库、哪个表,最终的golang文件保存地址

这里利用命令行参数来输入:

var dbname= flag.String("db", "", "the database name")
var tblname = flag.String("tbl", "", "the table name to export")
var savepath = flag.String("path", "./", "the path to save file")

另外,我们项目习惯使用下划线“_”来分割单词,比如info_user,表示user表,而生成的struct名称为InfoUser,字段名也是类似规则

因此定义了如下函数来处理这种情况:

func fmtFieldDefine(src string) string {
 temp := strings.Split(src, "_") // 有下划线的,需要拆分
 var str string
 for i := 0; i < len(temp); i++ {
  b := []rune(temp[i])
  for j := 0; j < len(b); j++ {
   if j == 0 {
    // 首字母大写转换
    b[j] -= 32
    str += string(b[j])
   } else {
    str += string(b[j])
   }
  }
 } 
 return str
}

即把下划线去掉,且将单词的首字母改为大写。

有些字段,在设计数据库时,是可空的,information_schema->COLUMNS中有个字段IS_NULLABLE专门表示,而golang的sql有几个类型对应:sql.NullString、sql.NullBool、sql.NullFloat64、sql.NullInt64,基本上是可以满足使用要求的了。

有人可能会有疑问,假如字段类型为date、timestamp等,该对应哪种呢?通常第三方的类库会转为string类型,那么就对应sql.NullString好了。不过我这里没有进行这方面的处理。

前期工作做好了,开始编码:

func main() {
 flag.Parse()
 fmt.Println("table name -->", *tblname) 
 dns := fmt.Sprintf("%s:%s@tcp(%s)/%s?charset=utf8", dbuser, dbpwd, dbhost, "information_schema") 
 db := sqlx.MustConnect("mysql", dns)
 
 var fs []FieldInfo
 err := db.Select(&fs, "SELECT COLUMN_NAME, DATA_TYPE, COLUMN_COMMENT, IS_NULLABLE FROM COLUMNS WHERE TABLE_NAME=? and table_schema=?", *tblname, *dbname)
 if err != nil {
  fmt.Println(err)
  panic(err)
 }
 
 if len(fs) > 0 {
  var buffer bytes.Buffer
  buffer.WriteString("package models\n")
  buffer.WriteString("type " + fmtFieldDefine(*tblname) + " struct {\n")
  for _, v := range fs {
   buffer.WriteString("" + fmtFieldDefine(v.ColName) + " ")
   switch v.DataType {
   case "int", "tinyint", "smallint":
    if v.IsNullable == "YES" {
     buffer.WriteString("sql.NullInt64 ")
    } else {
     buffer.WriteString("int ")
    }
   case "bigint":
    if v.IsNullable == "YES" {
     buffer.WriteString("sql.NullInt64 ")
    } else {
     buffer.WriteString("int64 ")
    }
   case "char", "varchar", "longtext", "text", "tinytext":
    if v.IsNullable == "YES" {
     buffer.WriteString("sql.NullString ")
    } else {
     buffer.WriteString("string ")
    }
   case "date", "datetime", "timestamp":
    buffer.WriteString("time.Time ")
   case "double", "float":
    if v.IsNullable == "YES" {
     buffer.WriteString("sql.NullFloat64 ")
    } else {
     buffer.WriteString("float64 ")
    }
   default:
    // 其他类型当成string处理
    if v.IsNullable == "YES" {
     buffer.WriteString("sql.NullString ")
    } else {
     buffer.WriteString("string ")
    }
   }
 
   buffer.WriteString(fmt.Sprintf("`db:\"%s\" json:\"%s\"`\n", v.ColName, v.ColName))
 
  }
  buffer.WriteString(`}`) 
  fmt.Println(buffer.String()) 
  filename := *savepath + "\\" + *tblname + ".go"
  f, _ := os.Create(filename)
  f.Write([]byte(buffer.String()))
  f.Close()
 
  cmd := exec.Command("goimports", "-w", filename)
  cmd.Run()
 } else {
  fmt.Println("查询不到数据")
 }
}

我把每个字段的tag,包括db和json的都加了了,在代码最后,使用goimport工具添加需要import的package,它连format的工作都做了,实在不错。

以下是我生成的一个用户购物概要表的struct定义:

package models 
import (
 "database/sql"
 "time"
)
 
type InfoUserShoppingSummary struct {
 Id            int            `db:"id" json:"id"`
 TransactionId sql.NullString `db:"transaction_id" json:"transaction_id"`
 OutTradeNo    sql.NullString `db:"out_trade_no" json:"out_trade_no"`
 WuId          int            `db:"wu_id" json:"wu_id"`
 WdId          int            `db:"wd_id" json:"wd_id"`
 TotalFee      float64        `db:"total_fee" json:"total_fee"`
 PayStaus      sql.NullInt64  `db:"pay_staus" json:"pay_staus"`
 CreateTime    time.Time      `db:"create_time" json:"create_time"`
 UpdateTime    time.Time      `db:"update_time" json:"update_time"`
 Address       sql.NullString `db:"address" json:"address"`
}

补充:Golang之方法(自定义类型,struct)

方法的使用,请看本天师的代码

//Golang的方法定义
//Golang中的方法是作用在特定类型的变量上,因此自定义类型,都可以有方法,不仅仅是struct
//定义:func (recevier type) methodName(参数列表)(返回值列表){}
//方法和函数的区别
/*
1,函数调用:function(variable,参数列表)
2, 方法,variable.function(参数列表)
方法的控制,通过大小写空格控制
 */
package main
//Golang的方法定义
//Golang中的方法是作用在特定类型的变量上,因此自定义类型,都可以有方法,不仅仅是struct
//定义:func (recevier type) methodName(参数列表)(返回值列表){}
import "fmt"
type integer int
func (p integer) print() {
    fmt.Println("p is:", p)
}
//这里传递的是副本,想改变p的值,需要传递指针
func (p *integer) set(b integer) {
    *p = b
}
type Student struct {
    Name  string
    Age   int
    Score int
    sex   int
}
//这里需要接受指针 *Student(接收者),否则修改不了值
func (p *Student) init(name string, age int, score int) {
    p.Name = name
    p.Age = age
    p.Score = score
    fmt.Println(p)
}
func (p Student) get() Student {
    return p
}
func main() {
    var stu Student
    //修改地址的写法(&stu).init
    //但是go可以自动知道,接受者是指针,这里stu就传递地址
    stu.init("stu", 18, 99)
    stu1 := stu.get()
    fmt.Println(stu1)
    //type integer方法
    var a integer
    a = 100
    a.print()
    a.set(1000)
    a.print()
}

以上为个人经验,希望能给大家一个参考,也希望大家多多支持三水点靠木。如有错误或未考虑完全的地方,望不吝赐教。

Golang 相关文章推荐
golang中实现给gif、png、jpeg图片添加文字水印
Apr 26 Golang
Golang全局变量加锁的问题解决
May 08 Golang
go 实现简易端口扫描的示例
May 22 Golang
Go语言实现Snowflake雪花算法
Jun 08 Golang
Go timer如何调度
Jun 09 Golang
浅谈Go语言多态的实现与interface使用
Jun 16 Golang
Go 语言中 20 个占位符的整理
Oct 16 Golang
Golang使用Panic与Recover进行错误捕获
Mar 22 Golang
Golang 链表的学习和使用
Apr 19 Golang
Golang 入门 之url 包
May 04 Golang
Go调用Rust方法及外部函数接口前置
Jun 14 Golang
Golang gRPC HTTP协议转换示例
Jun 16 Golang
golang 如何通过反射创建新对象
Apr 28 #Golang
golang 实现两个结构体复制字段
Apr 28 #Golang
go结构体嵌套的切片数组操作
Apr 28 #Golang
golang json数组拼接的实例
Apr 28 #Golang
golang 实现对Map进行键值自定义排序
Apr 28 #Golang
go语言中json数据的读取和写出操作
Apr 28 #Golang
golang 实现菜单树的生成方式
Apr 28 #Golang
You might like
php+mysqli实现将数据库中一张表信息打印到表格里的方法
2015/01/28 PHP
CI框架中数据库操作函数$this-&gt;db-&gt;where()相关用法总结
2016/05/17 PHP
JS中style属性
2006/10/11 Javascript
IE6、IE7中setAttribute不支持class/for/rowspan/colspan等属性
2011/08/28 Javascript
Javascript图像处理—虚拟边缘介绍及使用方法
2012/12/27 Javascript
可选择和输入的下拉列表框示例
2013/11/05 Javascript
使用CSS3的scale实现网页整体缩放
2014/03/18 Javascript
JavaScript实现图片DIV竖向滑动的方法
2015/04/25 Javascript
Extjs 点击复选框在表格中增加相关信息行
2016/07/12 Javascript
关于微信中a链接无法跳转问题
2016/08/02 Javascript
Vue.js组件tree实现省市多级联动
2016/12/02 Javascript
JS调用Android、Ios原生控件
2017/01/06 Javascript
对比分析Django的Q查询及AngularJS的Datatables分页插件
2017/02/07 Javascript
vue模板语法-插值详解
2017/03/06 Javascript
详解微信小程序框架wepy踩坑记录(与vue对比)
2019/03/12 Javascript
在Layui 的表格模板中,实现layer父页面和子页面传值交互的方法
2019/09/10 Javascript
解决vue的touchStart事件及click事件冲突问题
2020/07/21 Javascript
Python爬取读者并制作成PDF
2015/03/10 Python
Numpy中的mask的使用
2018/07/21 Python
学习和使用python的13个理由
2019/07/30 Python
python带参数打包exe及调用方式
2019/12/21 Python
python中的 zip函数详解及用法举例
2020/02/16 Python
Python3 搭建Qt5 环境的方法示例
2020/07/16 Python
Python将QQ聊天记录生成词云的示例代码
2021/02/10 Python
VSCode中autopep8无法运行问题解决方案(提示Error: Command failed,usage)
2021/03/02 Python
详解css3 mask遮罩实现一些特效
2018/10/24 HTML / CSS
举例详解CSS3中的Transition
2015/07/15 HTML / CSS
video下autoplay属性无效的解决方法(添加muted属性)
2020/05/19 HTML / CSS
怎样自定义一个异常类
2016/09/27 面试题
建筑施工实习自我鉴定
2013/09/19 职场文书
个人课题方案
2014/05/08 职场文书
秋收起义观后感
2015/06/11 职场文书
导游词之阳朔遇龙河
2019/12/16 职场文书
Python中else的三种使用场景
2021/06/16 Python
使用Redis实现分布式锁的方法
2022/06/16 Redis
MySQL远程无法连接的一些常见原因总结
2022/09/23 MySQL