歡迎光臨
每天分享高質量文章

golang orm 框架之 gorm

最近在想給這個小站增加點贊和評論功能,第三方系統又有各種限制,就想自己弄個後端,實現類似的功能,對於個人來說,資料量不是很大,單機的 mysql 足夠存下所有資料,mysql 作為底層儲存是個不錯的選擇

之前在公司是直接用的 github.com/go-sql-driver/mysql 訪問資料庫都是直接用寫 sql,取出結果然後自己拼成物件,使用上面不是很方便,可讀性也不好。想起之前研究 php laravel 框架的時候,直接把資料庫層屏蔽了,用戶看到的只有物件,使用非常方便,java 裡面這種操作方式基本上已經成了標準做法,就去 github 上找了一下 golang 裡面有沒有類似的東西,果然已經有非常成熟的框架了,github.com/jinzhu/gorm 已經有 7k+ 的 star 了

ORM(Object Relation Mapping),物件關係映射,實際上就是對資料庫的操作進行封裝,對上層開發人員屏蔽資料操作的細節,開發人員看到的就是一個個物件,大大簡化了開發工作,提高了生產效率

好了,下麵我以這個點贊評論系統為例,介紹一下 gorm 的簡單用法,以下使用的完整代碼:https://github.com/hatlonely/microservices/blob/master/internal/comment_like/comment_like.go

gorm 用法介紹

庫安裝

go get -u github.com/jinzhu/gorm

資料庫連接

import (  
   "github.com/jinzhu/gorm"    _ "github.com/jinzhu/gorm/dialects/mysql"

   
var db *gorm.DB

func init() {  
   var err error    db, err = gorm.Open("mysql", ":/?charset=utf8&parseTime;=True&loc;=Local")  
       if err != nil {  
           panic(err)    } }

連接比較簡單,直接呼叫 gorm.Open 傳入資料庫地址即可

github.com/jinzhu/gorm/dialects/mysql 是 golang 的 mysql 驅動,實際上就是 github.com/go-sql-driver/mysql 作者這裡為了好記,重新弄了個名字

這裡我用的 mysql,實際上支持基本上所有主流的關係資料庫,連接方式上略有不同

db.DB().SetMaxIdleConns(10)
db.DB().SetMaxOpenConns(100)

還可以使用 db.DB() 物件設置連接池信息

表定義

先來定義一個點贊表,這裡面一條記錄表示某個用戶在某個時刻對某篇文章點了一個贊,用 ip + ua 來標識用戶,title 標識文章標題

type Like struct {
    ID        int    `gorm:"primary_key"`
    Ip        string `gorm:"type:varchar(20);not null;index:ip_idx"`
    Ua        string `gorm:"type:varchar(256);not null;"`
    Title     string `gorm:"type:varchar(128);not null;index:title_idx"`
    Hash      uint64 `gorm:"unique_index:hash_idx;"`
    CreatedAt time.Time
}

gorm 用 tag 的方式來標識 mysql 裡面的約束

創建索引只需要直接指定列即可,這裡創建了兩個索引,ip_idx 和 title_idx;如果需要多列組合索引,直接讓索引的名字相同即可;如果需要創建唯一索引,指定為 unique_index 即可

支持時間型別,直接使用 time.Time 即可

創建表

if !db.HasTable(&Like;{}) {  
   if err := db.Set("gorm:table_options", "ENGINE=InnoDB DEFAULT CHARSET=utf8").CreateTable(&Like;{}).Error; err != nil {    
       panic(err)    } }

直接通過 db.CreateTable 就可以創建表了,非常方便,還可以通過 db.Set 設置一些額外的表屬性

插入

like := &Like;{
    Ip:        ip,
    Ua:        ua,
    Title:     title,
    Hash:      murmur3.Sum64([]byte(strings.Join([]string{ip, ua, title}, "-"))) >> 1,
    CreatedAt: time.Now(),
}

if err := db.Create(like).Error; err != nil {
    return err }

先構造已給物件,直接呼叫 db.Create() 就可以插入一條記錄了

刪除

if err := db.Where(&Like;{Hash: hash}).Delete(Like{}).Error; err != nil {    returnerr
}

先用 db.Where() 構造查詢條件,再呼叫 db.Delete() 就可以刪除

查詢

var count interr := db.Model(&Like;{}).Where(&Like;{Ip: ip, Ua: ua, Title: title}).Count(&count;).Errorif err != nil { 
    return false, err }

先用 db.Model() 選擇一個表,再用 db.Where() 構造查詢條件,後面可以使用 db.Count() 計算數量,如果要獲取物件,可以使用 db.Find(&Likes;) 或者只需要查一條記錄 db.First(&Like;)

修改

db.Model(&user;).Update("name", "hello")
db.Model(&user;).Updates(User{Name: "hello", Age: 18})
db.Model(&user;).Updates(User{Name: "", Age: 0, Actived: false}) // nothing update

我這個系統裡面沒有更新需求,這幾個例子來自於官網,第一個是更新單條記錄;第二個是更新整條記錄,註意只有非空欄位才會更新;第三個例子是不會更新的,在系統設計的時候要儘量避免這些空值有特殊的含義,如果一定要更新,可以使用第一種方式,設置單個值

錯誤處理

其實你已經看到了,這裡基本上所有的函式都是鏈式的,全部都傳回 db 物件,任何時候呼叫 db.Error就能獲取到錯誤信息,非常方便

事務

func CreateAnimals(db *gorm.DB) err {
    tx := db.Begin()    
   if err := tx.Create(&Animal;{Name: "Giraffe"}).Error; err != nil {        tx.Rollback()    
       return err    }    
   if err := tx.Create(&Animal;{Name: "Lion"}).Error; err != nil {        tx.Rollback()    
       return err    }    tx.Commit()  
   return nil
}

事務的處理也很簡單,用 db.Begin() 宣告開啟事務,結束的時候呼叫 tx.Commit(),異常的時候呼叫 tx.Rollback()

其他

還可以使用如下方式設置日誌輸出級別以及改變日誌輸出地方

db.LogMode(true)
db.SetLogger(gorm.Logger{revel.TRACE})
db.SetLogger(log.New(os.Stdout, "\r\n", 0))

也支持普通的 sql,但是建議儘量不要使用

參考鏈接

  • gorm 官方文件: http://gorm.io/

  • gorm github: https://github.com/jinzhu/gorm

轉載請註明出處 原文鏈接:http://hatlonely.github.io/2018/02/08/golang-orm-%E6%A1%86%E6%9E%B6%E4%B9%8B-gorm/

赞(0)

分享創造快樂