Golang 将数据库转换为gorm结构和RESTful api

https://github.com/smallnest/gen

介绍

gen工具从给定的数据库生成golang结构,以便在.go文件中使用。它支持gorm标签并实现一些可用的方法。它还可以为这些结构生成RESTful api。

通过从数据库中读取有关列结构的详细信息,gen生成具有所需列名,数据类型和注释的go兼容结构类型。

生成的数据类型包括对可空列sql.NullX类型或guregu null.X类型 以及预期的基本内置go类型的支持。

gen基于Seth Shelnutt的db2struct的工作而受到启发,而Db2Struct的基础/灵感来自ChimeraCoder的gojson包gojson的工作。

获取

go get github.com/smallnest/gen

使用

$ gen --connstr "root@tcp(127.0.0.1:3306)/employees?&parseTime=True" --database employees --json --gorm --guregu --rest

支持的数据库

目前支持

  • MariaDB的
  • MySQL的
  • PostgreSQL的
  • Microsoft SQL Server
  • SQLite的

计划支持

  • 神谕

MariaDB的/ MySQL的

通过查询INFORMATION_SCHEMA.Columns表,然后格式化类型,列名和元数据来创建结构,以创建可用的兼容结构类型。

支持的数据类型

目前仅支持有限数量的数据类型。初步支持包括:

  • tinyint(sql.NullInt64或null.Int)
  • int(sql.NullInt64或null.Int)
  • smallint(sql.NullInt64或null.Int)
  • mediumint(sql.NullInt64或null.Int)
  • bigint(sql.NullInt64或null.Int)
  • decimal(sql.NullFloat64或null.Float)
  • float(sql.NullFloat64或null.Float)
  • double(sql.NullFloat64或null.Float)
  • datetime(null.Time)
  • 时间(null.Time)
  • date(null.Time)
  • 时间戳(null.Time)
  • var(sql.String或null.String)
  • 枚举(sql.String或null.String)
  • varchar(sql.String或null.String)
  • longtext(sql.String或null.String)
  • mediumtext(sql.String或null.String)
  • text(sql.String或null.String)
  • tinytext(sql.String或null.String)
  • 二进制
  • BLOB
  • LONGBLOB
  • MEDIUMBLOB
  • VARBINARY

问题

  • Postgres和SQLite驱动程序支持sql.ColumnType.Nullable()(#3)
  • 无法区分表的主键。仅将第一个字段设置为主键。所以你需要在某些情况下改变它。

gorm

package model

import (
    "time"

    "github.com/guregu/null"
    "github.com/jinzhu/gorm"
)

type Title struct {
    ToDate   null.Time `gorm:"column:to_date" json:"to_date"`
    EmpNo    int       `gorm:"column:emp_no" json:"emp_no"`
    Title    string    `gorm:"column:title" json:"title"`
    FromDate time.Time `gorm:"column:from_date" json:"from_date"`
}

// TableName sets the insert table name for this struct type
func (t *Title) TableName() string {
    return "titles"
}

func (t *Title) CreateTitle(db *gorm.DB) error {
    return db.Create(t).Error
}

RESTful api

package api

import (
    "net/http"

    "github.com/julienschmidt/httprouter"
    "model"
)

func configTitlesRouter(router *httprouter.Router) {
    router.GET("/titles", GetAllTitles)
    router.POST("/titles", PostTitle)
    router.GET("/titles/:id", GetTitle)
    router.PUT("/titles/:id", PutTitle)
    router.DELETE("/titles/:id", DeleteTitle)
}

func GetAllTitles(w http.ResponseWriter, r *http.Request, ps httprouter.Params) {
    titles := []model.Title{}
    DB.Find(&titles)
    writeJSON(w, &titles)
}

func GetTitle(w http.ResponseWriter, r *http.Request, ps httprouter.Params) {
    id := ps.ByName("id")
    title := &model.Title{}
    if DB.First(title, id).Error != nil {
        http.NotFound(w, r)
        return
    }
    writeJSON(w, title)
}

func PostTitle(w http.ResponseWriter, r *http.Request, ps httprouter.Params) {
    title := &model.Title{}

    if err := readJSON(r, title); err != nil {
        http.Error(w, err.Error(), http.StatusInternalServerError)
        return
    }
    if err := DB.Save(title).Error; err != nil {
        http.Error(w, err.Error(), http.StatusInternalServerError)
        return
    }
    writeJSON(w, title)
}

func PutTitle(w http.ResponseWriter, r *http.Request, ps httprouter.Params) {
    id := ps.ByName("id")

    title := &model.Title{}
    if DB.First(title, id).Error != nil {
        http.NotFound(w, r)
        return
    }

    updated := &model.Title{}
    if err := readJSON(r, updated); err != nil {
        http.Error(w, err.Error(), http.StatusInternalServerError)
        return
    }

    // TODO: copy necessary fields from updated to title

    if err := DB.Save(title).Error; err != nil {
        http.Error(w, err.Error(), http.StatusInternalServerError)
        return
    }
    writeJSON(w, title)
}

func DeleteTitle(w http.ResponseWriter, r *http.Request, ps httprouter.Params) {
    id := ps.ByName("id")
    title := &model.Title{}

    if DB.First(title, id).Error != nil {
        http.NotFound(w, r)
        return
    }
    if err := DB.Delete(title).Error; err != nil {
        http.Error(w, err.Error(), http.StatusInternalServerError)
        return
    }
    w.WriteHeader(http.StatusOK)
}

你可能感兴趣的:(Golang 将数据库转换为gorm结构和RESTful api)