基于gin web框架搭建RESTful API服務(wù)

這篇主要學(xué)習(xí)go項目中的項目結(jié)構(gòu)井辆、項目規(guī)范等知識,ROM采用的database/sql的寫法。

1.技術(shù)框架

利用的是ginweb框架懈凹,然后ROM層選用database/sql弓柱,安裝mysql驅(qū)動沟堡。安裝方式如下:

//使用github上的gin托管地址
$ go get -u github.com/gin-gonic/gin
$ go get github.com/go-sql-driver/mysql

2.項目結(jié)構(gòu)如下

項目結(jié)構(gòu)分析:

  • 1、main.go主要是存放路由矢空,啟動項目航罗;
  • 2、router主要存放路由信息屁药,然后返回一個router粥血;
  • 3、apis存放routerHandler函數(shù)酿箭;
  • 4复亏、databases存放數(shù)據(jù)連接信息;
  • 5缭嫡、models存放數(shù)據(jù)模型缔御,類似Java中POJO對象。
│  main.go
│
├─.idea
│  │  go.iml
│  │  misc.xml
│  │  modules.xml
│  │  workspace.xml
│  │
│  └─inspectionProfiles
├─apis
│      person.go
│
├─databases
│      mysql.go
│
├─models
│      person.go
│
└─router
        router.go
image.png

3.main.go代碼解釋

package main
import (
    //這里講db作為go/databases的一個別名妇蛀,表示數(shù)據(jù)庫連接池
    db "go/databases"
    . "go/router"
)
func main() {
    //當(dāng)整個程序完成之后關(guān)閉數(shù)據(jù)庫連接
    defer db.SqlDB.Close()
    router := InitRouter()
    router.Run(":8080")
}

4.router.go代碼解釋

package router
import (
    "github.com/gin-gonic/gin"
    ."go/apis"
)
func InitRouter() *gin.Engine {
    router := gin.Default()
    //IndexApi為一個Handler
    router.GET("/", IndexApi)
    router.POST("/person", AddPersonApi)
    router.GET("/persons", GetPersonsApi)
    router.GET("/person/:id", GetPersonApi)
    router.PUT("/person/:id", ModPersonApi)
    router.DELETE("/person/:id", DelPersonApi)
    return router
}

5.mysql.go代碼解釋

package databases
import (
    "database/sql"
    _ "github.com/go-sql-driver/mysql"
    "log"
)
//因為我們需要在其他地方使用SqlDB這個變量耕突,所以需要大寫代表public
var SqlDB *sql.DB
//初始化方法
func init() {
    var err error
    SqlDB, err = sql.Open("mysql", "root:123456@tcp(127.0.0.1:3306)/test?parseTime=true")
    if err != nil {
        log.Fatal(err.Error())
    }
    //連接檢測
    err = SqlDB.Ping()
    if err != nil {
        log.Fatal(err.Error())
    }
}

使用sql.Open()方法會創(chuàng)建一個數(shù)據(jù)庫連接池db。這個地步不是數(shù)據(jù)庫連接评架,它是一個連接池眷茁,只有當(dāng)真正的數(shù)據(jù)庫通信的時候才創(chuàng)建連接。例如纵诞,這里的db.Ping()操作上祈。db.SetMaxIdleConns(20)db.SetMaxOpenConns(20)分別設(shè)置數(shù)據(jù)庫的空閑連接和最大打開連接,即向Mysql服務(wù)端發(fā)出的所有連接的最大數(shù)目。

6.models中person.go代碼解釋

package models
import (
   "log"
   db "go/databases"
)
//定義person類型結(jié)構(gòu)
type Person struct {
   Id        int    `json:"id"`
   FirstName string `json:"first_name"`
   LastName  string `json:"last_name"`
}

func (p *Person) AddPerson() (id int64, err error) {
   rs, err := db.SqlDB.Exec("INSERT INTO person(first_name, last_name) VALUES (?, ?)", p.FirstName, p.LastName)
   if err != nil {
      return
   }
   id, err = rs.LastInsertId()
   return
}

func (p *Person) GetPersons() (persons []Person, err error) {
   persons = make([]Person, 0)
   rows, err := db.SqlDB.Query("SELECT id, first_name, last_name FROM person")
   defer rows.Close()
   if err != nil {
      return
   }
   for rows.Next() {
      var person Person
      rows.Scan(&person.Id, &person.FirstName, &person.LastName)
      persons = append(persons, person)
   }
   if err = rows.Err(); err != nil {
      return
   }
   return
}

func (p *Person) GetPerson() (person Person, err error) {
   err = db.SqlDB.QueryRow("SELECT id, first_name, last_name FROM person WHERE id=?", p.Id).Scan(
      &person.Id, &person.FirstName, &person.LastName,
   )
   return
}

func (p *Person) ModPerson() (ra int64, err error) {
   stmt, err := db.SqlDB.Prepare("UPDATE person SET first_name=?, last_name=? WHERE id=?")
   defer stmt.Close()
   if err != nil {
      return
   }
   rs, err := stmt.Exec(p.FirstName, p.LastName, p.Id)
   if err != nil {
      return
   }
   ra, err = rs.RowsAffected()
   return
}

func (p *Person) DelPerson() (ra int64, err error) {
   rs, err := db.SqlDB.Exec("DELETE FROM person WHERE id=?", p.Id)
   if err != nil {
      log.Fatalln(err)
   }
   ra, err = rs.RowsAffected()
   return
}

執(zhí)行非query操作登刺,使用dbExec方法籽腕,在MySQL中使用做占位符塘砸。最后我們把插入后的Id返回給客戶端节仿。

GetPersons方法解釋:

讀取MySQL的數(shù)據(jù)需要有一個綁定的過程,db.Query()方法返回一個rows對象掉蔬,這個數(shù)據(jù)庫連接隨即轉(zhuǎn)移到這個對象廊宪,因此我們需要定義rows.Close()操作,然后創(chuàng)建一個[]Person的切片女轿。

使用make箭启,而不是直接使用var persons []Person的聲明方式。還是有所差別的蛉迹,使用make的方式傅寡,當(dāng)數(shù)組切片沒有元素的時候,Json會返回[]北救。如果直接聲明荐操,json會返回null

接下來就是使用rows對象的Next()方法珍策,遍歷所查詢的數(shù)據(jù)托启,一個個綁定到person對象上,最后appendperson切片攘宙。

7.apis中的person.go代碼解釋

package apis

import (
    "net/http"
    "log"
    "fmt"
    "strconv"
    "github.com/gin-gonic/gin"
     ."go/models"
)

func IndexApi(c *gin.Context) {
    c.String(http.StatusOK, "It works")
}

func AddPersonApi(c *gin.Context) {
    firstName := c.Request.FormValue("first_name")
    lastName := c.Request.FormValue("last_name")

    p := Person{FirstName: firstName, LastName: lastName}

    ra, err := p.AddPerson()
    if err != nil {
        log.Fatalln(err)
    }
    msg := fmt.Sprintf("insert successful %d", ra)
    c.JSON(http.StatusOK, gin.H{
        "msg": msg,
    })
}

func GetPersonsApi(c *gin.Context) {
    var p Person
    persons, err := p.GetPersons()
    if err != nil {
        log.Fatalln(err)
    }

    c.JSON(http.StatusOK, gin.H{
        "persons": persons,
    })

}

func GetPersonApi(c *gin.Context) {
    cid := c.Param("id")
    id, err := strconv.Atoi(cid)
    if err != nil {
        log.Fatalln(err)
    }
    p := Person{Id: id}
    person, err := p.GetPerson()
    if err != nil {
        log.Fatalln(err)
    }

    c.JSON(http.StatusOK, gin.H{
        "person": person,
    })

}

func ModPersonApi(c *gin.Context) {
    cid := c.Param("id")
    id, err := strconv.Atoi(cid)
    if err != nil {
        log.Fatalln(err)
    }
    p := Person{Id: id}
    err = c.Bind(&p)
    if err != nil {
        log.Fatalln(err)
    }
    ra, err := p.ModPerson()
    if err != nil {
        log.Fatalln(err)
    }
    msg := fmt.Sprintf("Update person %d successful %d", p.Id, ra)
    c.JSON(http.StatusOK, gin.H{
        "msg": msg,
    })
}

func DelPersonApi(c *gin.Context) {
    cid := c.Param("id")
    id, err := strconv.Atoi(cid)
    if err != nil {
        log.Fatalln(err)
    }
    p := Person{Id: id}
    ra, err := p.DelPerson()
    if err != nil {
        log.Fatalln(err)
    }
    msg := fmt.Sprintf("Delete person %d successful %d", id, ra)
    c.JSON(http.StatusOK, gin.H{
        "msg": msg,
    })
}

其實屯耸,整個項目的結(jié)構(gòu)和CRUD操作跟Java中的思想比較類似,應(yīng)該很容易上手蹭劈。需要注意一點的是疗绣,如果需要將整個項目運行起來,項目的路徑一定Gopath路徑:F:\Go\Project\src;

image.png
image.png

項目啟動結(jié)果如下:

image.png

熟悉了database/sql的寫法后铺韧,下一步就是學(xué)習(xí)ROM框架gorm的寫法多矮,進而學(xué)習(xí)Docker進行部署。

參考資料

https://jasperxu.github.io/gorm-zh/

http://www.reibang.com/p/a3f63b5da74c?utm_campaign=studygolang.com&utm_medium=studygolang.com&utm_source=studygolang.com

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末哈打,一起剝皮案震驚了整個濱河市塔逃,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌前酿,老刑警劉巖,帶你破解...
    沈念sama閱讀 211,376評論 6 491
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件鹏溯,死亡現(xiàn)場離奇詭異罢维,居然都是意外死亡,警方通過查閱死者的電腦和手機,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 90,126評論 2 385
  • 文/潘曉璐 我一進店門肺孵,熙熙樓的掌柜王于貴愁眉苦臉地迎上來匀借,“玉大人,你說我怎么就攤上這事平窘∠爬撸” “怎么了?”我有些...
    開封第一講書人閱讀 156,966評論 0 347
  • 文/不壞的土叔 我叫張陵瑰艘,是天一觀的道長是鬼。 經(jīng)常有香客問我,道長紫新,這世上最難降的妖魔是什么均蜜? 我笑而不...
    開封第一講書人閱讀 56,432評論 1 283
  • 正文 為了忘掉前任,我火速辦了婚禮芒率,結(jié)果婚禮上囤耳,老公的妹妹穿的比我還像新娘肿嘲。我一直安慰自己亿蒸,他們只是感情好,可當(dāng)我...
    茶點故事閱讀 65,519評論 6 385
  • 文/花漫 我一把揭開白布展哭。 她就那樣靜靜地躺著匪蟀,像睡著了一般椎麦。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上萄窜,一...
    開封第一講書人閱讀 49,792評論 1 290
  • 那天铃剔,我揣著相機與錄音,去河邊找鬼查刻。 笑死键兜,一個胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的穗泵。 我是一名探鬼主播普气,決...
    沈念sama閱讀 38,933評論 3 406
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼佃延!你這毒婦竟也來了现诀?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 37,701評論 0 266
  • 序言:老撾萬榮一對情侶失蹤履肃,失蹤者是張志新(化名)和其女友劉穎仔沿,沒想到半個月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體尺棋,經(jīng)...
    沈念sama閱讀 44,143評論 1 303
  • 正文 獨居荒郊野嶺守林人離奇死亡封锉,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 36,488評論 2 327
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片成福。...
    茶點故事閱讀 38,626評論 1 340
  • 序言:一個原本活蹦亂跳的男人離奇死亡碾局,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出奴艾,到底是詐尸還是另有隱情净当,我是刑警寧澤,帶...
    沈念sama閱讀 34,292評論 4 329
  • 正文 年R本政府宣布蕴潦,位于F島的核電站像啼,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏品擎。R本人自食惡果不足惜埋合,卻給世界環(huán)境...
    茶點故事閱讀 39,896評論 3 313
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望萄传。 院中可真熱鬧甚颂,春花似錦、人聲如沸秀菱。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,742評論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽衍菱。三九已至赶么,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間脊串,已是汗流浹背辫呻。 一陣腳步聲響...
    開封第一講書人閱讀 31,977評論 1 265
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留琼锋,地道東北人放闺。 一個月前我還...
    沈念sama閱讀 46,324評論 2 360
  • 正文 我出身青樓,卻偏偏與公主長得像缕坎,于是被迫代替她去往敵國和親怖侦。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 43,494評論 2 348

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