golang orm 框架之 gorm

最近在想給這個(gè)小站增加點(diǎn)贊和評(píng)論功能,第三方系統(tǒng)又有各種限制龟梦,就想自己弄個(gè)后端,實(shí)現(xiàn)類似的功能窃躲,對(duì)于個(gè)人來說计贰,數(shù)據(jù)量不是很大,單機(jī)的 mysql 足夠存下所有數(shù)據(jù)蒂窒,mysql 作為底層存儲(chǔ)是個(gè)不錯(cuò)的選擇

之前在公司是直接用的 github.com/go-sql-driver/mysql 訪問數(shù)據(jù)庫都是直接用寫 sql躁倒,取出結(jié)果然后自己拼成對(duì)象,使用上面不是很方便洒琢,可讀性也不好秧秉。想起之前研究 php laravel 框架的時(shí)候,直接把數(shù)據(jù)庫層屏蔽了衰抑,用戶看到的只有對(duì)象象迎,使用非常方便,java 里面這種操作方式基本上已經(jīng)成了標(biāo)準(zhǔn)做法呛踊,就去 github 上找了一下 golang 里面有沒有類似的東西砾淌,果然已經(jīng)有非常成熟的框架了,github.com/jinzhu/gorm 已經(jīng)有 7k+ 的 star 了

ORM(Object Relation Mapping)谭网,對(duì)象關(guān)系映射汪厨,實(shí)際上就是對(duì)數(shù)據(jù)庫的操作進(jìn)行封裝,對(duì)上層開發(fā)人員屏蔽數(shù)據(jù)操作的細(xì)節(jié)蜻底,開發(fā)人員看到的就是一個(gè)個(gè)對(duì)象骄崩,大大簡(jiǎn)化了開發(fā)工作,提高了生產(chǎn)效率

好了薄辅,下面我以這個(gè)點(diǎn)贊評(píng)論系統(tǒng)為例要拂,介紹一下 gorm 的簡(jiǎn)單用法,以下使用的完整代碼:https://github.com/hatlonely/microservices/blob/master/internal/comment_like/comment_like.go

gorm 用法介紹

庫安裝

go get -u github.com/jinzhu/gorm

數(shù)據(jù)庫連接

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", "<user>:<password>/<database>?charset=utf8&parseTime=True&loc=Local")
    if err != nil {
        panic(err)
    }
}

連接比較簡(jiǎn)單站楚,直接調(diào)用 gorm.Open 傳入數(shù)據(jù)庫地址即可

github.com/jinzhu/gorm/dialects/mysql 是 golang 的 mysql 驅(qū)動(dòng)脱惰,實(shí)際上就是 github.com/go-sql-driver/mysql 作者這里為了好記,重新弄了個(gè)名字

這里我用的 mysql窿春,實(shí)際上支持基本上所有主流的關(guān)系數(shù)據(jù)庫拉一,連接方式上略有不同

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

還可以使用 db.DB() 對(duì)象設(shè)置連接池信息

表定義

先來定義一個(gè)點(diǎn)贊表采盒,這里面一條記錄表示某個(gè)用戶在某個(gè)時(shí)刻對(duì)某篇文章點(diǎn)了一個(gè)贊,用 ip + ua 來標(biāo)識(shí)用戶蔚润,title 標(biāo)識(shí)文章標(biāo)題

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 的方式來標(biāo)識(shí) mysql 里面的約束

創(chuàng)建索引只需要直接指定列即可磅氨,這里創(chuàng)建了兩個(gè)索引,ip_idxtitle_idx嫡纠;如果需要多列組合索引烦租,直接讓索引的名字相同即可;如果需要?jiǎng)?chuàng)建唯一索引除盏,指定為 unique_index 即可

支持時(shí)間類型叉橱,直接使用 time.Time 即可

創(chuàng)建表

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 就可以創(chuàng)建表了,非常方便者蠕,還可以通過 db.Set 設(shè)置一些額外的表屬性

插入

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
}

先構(gòu)造已給對(duì)象窃祝,直接調(diào)用 db.Create() 就可以插入一條記錄了

刪除

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

先用 db.Where() 構(gòu)造查詢條件,再調(diào)用 db.Delete() 就可以刪除

查詢

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

先用 db.Model() 選擇一個(gè)表踱侣,再用 db.Where() 構(gòu)造查詢條件粪小,后面可以使用 db.Count() 計(jì)算數(shù)量,如果要獲取對(duì)象泻仙,可以使用 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

我這個(gè)系統(tǒng)里面沒有更新需求糕再,這幾個(gè)例子來自于官網(wǎng),第一個(gè)是更新單條記錄玉转;第二個(gè)是更新整條記錄突想,注意只有非空字段才會(huì)更新;第三個(gè)例子是不會(huì)更新的究抓,在系統(tǒng)設(shè)計(jì)的時(shí)候要盡量避免這些空值有特殊的含義猾担,如果一定要更新,可以使用第一種方式刺下,設(shè)置單個(gè)值

錯(cuò)誤處理

其實(shí)你已經(jīng)看到了绑嘹,這里基本上所有的函數(shù)都是鏈?zhǔn)降模慷挤祷?db 對(duì)象橘茉,任何時(shí)候調(diào)用 db.Error 就能獲取到錯(cuò)誤信息工腋,非常方便

事務(wù)

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
}

事務(wù)的處理也很簡(jiǎn)單,用 db.Begin() 聲明開啟事務(wù)畅卓,結(jié)束的時(shí)候調(diào)用 tx.Commit()擅腰,異常的時(shí)候調(diào)用 tx.Rollback()

其他

還可以使用如下方式設(shè)置日志輸出級(jí)別以及改變?nèi)罩据敵龅胤?/p>

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

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

參考鏈接

轉(zhuǎn)載請(qǐng)注明出處
本文鏈接:http://hatlonely.github.io/2018/02/08/golang-orm-%E6%A1%86%E6%9E%B6%E4%B9%8B-gorm/

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末翁潘,一起剝皮案震驚了整個(gè)濱河市趁冈,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖渗勘,帶你破解...
    沈念sama閱讀 218,284評(píng)論 6 506
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件沐绒,死亡現(xiàn)場(chǎng)離奇詭異,居然都是意外死亡旺坠,警方通過查閱死者的電腦和手機(jī)乔遮,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,115評(píng)論 3 395
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來价淌,“玉大人申眼,你說我怎么就攤上這事〔跻拢” “怎么了?”我有些...
    開封第一講書人閱讀 164,614評(píng)論 0 354
  • 文/不壞的土叔 我叫張陵巷蚪,是天一觀的道長(zhǎng)病毡。 經(jīng)常有香客問我,道長(zhǎng)屁柏,這世上最難降的妖魔是什么啦膜? 我笑而不...
    開封第一講書人閱讀 58,671評(píng)論 1 293
  • 正文 為了忘掉前任,我火速辦了婚禮淌喻,結(jié)果婚禮上僧家,老公的妹妹穿的比我還像新娘。我一直安慰自己裸删,他們只是感情好八拱,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,699評(píng)論 6 392
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著涯塔,像睡著了一般肌稻。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上匕荸,一...
    開封第一講書人閱讀 51,562評(píng)論 1 305
  • 那天爹谭,我揣著相機(jī)與錄音,去河邊找鬼榛搔。 笑死诺凡,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的践惑。 我是一名探鬼主播腹泌,決...
    沈念sama閱讀 40,309評(píng)論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼,長(zhǎng)吁一口氣:“原來是場(chǎng)噩夢(mèng)啊……” “哼童本!你這毒婦竟也來了真屯?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 39,223評(píng)論 0 276
  • 序言:老撾萬榮一對(duì)情侶失蹤穷娱,失蹤者是張志新(化名)和其女友劉穎绑蔫,沒想到半個(gè)月后运沦,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,668評(píng)論 1 314
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡配深,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,859評(píng)論 3 336
  • 正文 我和宋清朗相戀三年携添,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片篓叶。...
    茶點(diǎn)故事閱讀 39,981評(píng)論 1 348
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡烈掠,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出缸托,到底是詐尸還是另有隱情左敌,我是刑警寧澤,帶...
    沈念sama閱讀 35,705評(píng)論 5 347
  • 正文 年R本政府宣布俐镐,位于F島的核電站矫限,受9級(jí)特大地震影響,放射性物質(zhì)發(fā)生泄漏佩抹。R本人自食惡果不足惜叼风,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,310評(píng)論 3 330
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望棍苹。 院中可真熱鬧无宿,春花似錦、人聲如沸枢里。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,904評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽坡垫。三九已至梭灿,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間冰悠,已是汗流浹背堡妒。 一陣腳步聲響...
    開封第一講書人閱讀 33,023評(píng)論 1 270
  • 我被黑心中介騙來泰國(guó)打工, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留溉卓,地道東北人皮迟。 一個(gè)月前我還...
    沈念sama閱讀 48,146評(píng)論 3 370
  • 正文 我出身青樓,卻偏偏與公主長(zhǎng)得像桑寨,于是被迫代替她去往敵國(guó)和親伏尼。 傳聞我的和親對(duì)象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,933評(píng)論 2 355

推薦閱讀更多精彩內(nèi)容