gin api接口代码布局

00 参考代码仓库

https://gitee.com/babyb/gin_grom_restful_api

1 新建数据库和表

新建一个blog 数据库, 当然, 你也可以给数据库起名叫test
库中新建一个用户表, 建表语句如下:

CREATE TABLE `users` (
  `id` bigint(20) NOT NULL AUTO_INCREMENT,
  `username` varchar(255) CHARACTER SET utf8 DEFAULT NULL,
  `password` varchar(255) CHARACTER SET utf8 DEFAULT NULL,
  PRIMARY KEY (`id`)
) ENGINE=MyISAM AUTO_INCREMENT=3 DEFAULT CHARSET=utf8mb4;

目录结构

简单规划一下目录结构, 与main.go平级的目录:
api database models router;
router 用于处理路由
database 用于链接数据库
models用于各个数据表内容的增删改查
api 则用于接收router 传递的参数, 并调用数据库, 相当于 php/java 里的 controller

image.png

先做好路由的处理

router 文件夹中创建 router.go

image.png

router.go 代码内容如下:

package router

import (
    "github.com/gin-gonic/gin"
    . "blog/api"
)

/*
InnitRouter 路由初始化
*/
func InnitRouter() *gin.Engine{
    router := gin.Default()
    router.GET("/users", Users)
    return router;
}

需要注意的是:
import "blog/api"
1 src 作为绝对路径的根目录, 本地引入其他包中的代码是, 通过绝对路径引入
2 "blog/api" 前面的点 . 的意思是, 引入包内所有内容, 保内函数就可以直接用了, 下面的router.GET("/users", Users) 中的 Users 就是 api 中的Users 方法

创建 api 层的方法

在 api 文件夹中创建 user.go,
user.go 代码如下:

package api

import (
    "github.com/gin-gonic/gin"
    "net/http"
)

func Users(c *gin.Context){
    c.JSON(http.StatusOK, gin.H{
        "code" : 1,
        "data" : "用户列表",
    })
}

注意点 : Users 的方法的参数类型必须是 *gin.Context, 否则, router.go 中会报错

修改main.go 中的代码:

package main

import (
    "blog/router"
)
func main() {
    r := router.InnitRouter();
    r.Run(":8081");
}

我们通过 postman 访问 localhost:8081/users方法

image.png

返回内容与 api 文件夹下面的 user.go 中的一致

image.png

开始操作数据库

创建数据库连接, 在 database 文件夹中创建, database.go 文件, 内容如下:

需要注意的点时, 数据连接放到 init( ) 方法中, init表示包初始化的时候执行的函数, 如果函数名写成 main, 会在操作数据的时候报错

package database

import (
    "fmt"
    _ "github.com/go-sql-driver/mysql" //加载mysql驱动
    "github.com/jinzhu/gorm"
    //_ "github.com/jinzhu/gorm/dialects/mysql"
)

var Db *gorm.DB


func init()  {
    var err error
    Db, err = gorm.Open("mysql", "root:qgKj2017@tcp(127.0.0.1:3306)/blog?charset=utf8&parseTime=True&loc=Local&timeout=10ms")
    if err != nil {
        fmt.Printf("mysql connect error %v", err)
    }
    if Db.Error != nil {
        fmt.Printf("database error %v", Db.Error)
    }
}

models 文件夹中新建 user.go, 用于操作 users表中的数据
代码如下:
注意点: 根据gorm规范, 表名默认是复数形式 , users,
我们的结构体 User 会与 users 对应起来

package models
import (
    orm  "blog/database"
)
type User struct {
    ID       int64  `json:"id"`       // 列名为 `id`
    Username string `json:"username"` // 列名为 `username`
    Password string `json:"password"` // 列名为 `password`
}

//列表
func (user *User) Users() (users []User, err error) {
    if err = orm.Db.Find(&users).Error; err != nil {
        return
    }
    return
}

api 目录下的user.go 修改成如下:

api 中的代码, 用于从路由中获取参数, 去数据库进行相关操作并处理错误信息

package api
//
import (
    "fmt"
    "github.com/gin-gonic/gin"
    "net/http"
    model "blog/models"
)


func Users(c *gin.Context){

    var user model.User

    result, err := user.Users();

    if err != nil{
        fmt.Print(err)
        c.JSON(http.StatusOK, gin.H{
            "code":    -1,
            "message": "抱歉未找到相关信息",
        })
        return
    }

    c.JSON(http.StatusOK, gin.H{
        "code" : 1,
        "data" : result,
    })
}

main.go 修改成如下代码:

package main

import (
    "blog/router"
    orm "blog/database"
)


func main() {
    //当整个项目流程关闭后就关闭数据库链接
    defer  orm.Db.Close()
    r := router.InnitRouter();
    r.Run(":8081");
}

用postman 请求查询接口
用get 方法 localhost:8081/users

image.png

数据库中没有值, 所以查到空数组

向数据库中插入两条数据

 insert into users(username, `password`)
 values ('老大', "123"),('老二' ,'456')

再执行查询操作 , 结果如下:

image.png

最后 , 总结:
1 import 导入本地包的时候, 需要使用绝对路径, 而绝对路径的根目录是 GOPATH下的 src目录
2 数据库链接初始化好放到 init 方法中, 否则会在查询的时候报错

写完增删改查后, 所有代码最终如下:
main.go

package main

import (
    "blog/router"
    orm "blog/database"
)


func main() {
    //当整个项目流程关闭后就关闭数据库链接
    defer  orm.Db.Close()
    r := router.InnitRouter();
    r.Run(":8081");
}

router 目录下 router.go

package router

import (
    "github.com/gin-gonic/gin"
    . "blog/api"
)

/*
InnitRouter 路由初始化
*/
func InnitRouter() *gin.Engine{
    router := gin.Default()
    router.GET("/users", Users)   // 查询的接口是 users , 复数
    router.POST("/user", Store)
    router.PUT("/user/:id", Update)
    router.DELETE("/user/:id", Del)
    return router;
}

database 目录下
database.go

package database

import (
    "fmt"
    _ "github.com/go-sql-driver/mysql" //加载mysql驱动
    "github.com/jinzhu/gorm"
    //_ "github.com/jinzhu/gorm/dialects/mysql"
)

var Db *gorm.DB


func init()  {
    var err error
    Db, err = gorm.Open("mysql", "root:qgKj2017@tcp(127.0.0.1:3306)/blog?charset=utf8&parseTime=True&loc=Local&timeout=10ms")
    if err != nil {
        fmt.Printf("mysql connect error %v", err)
    }
    if Db.Error != nil {
        fmt.Printf("database error %v", Db.Error)
    }
}

api 下 user.go

package api
//
import (
    "fmt"
    "github.com/gin-gonic/gin"
    "net/http"
    model "blog/models"
    "strconv"
)


func Users(c *gin.Context){

    var user model.User

    result, err := user.Users();

    if err != nil{
        fmt.Print(err)
        c.JSON(http.StatusOK, gin.H{
            "code":    -1,
            "message": "抱歉未找到相关信息",
        })
        return
    }

    c.JSON(http.StatusOK, gin.H{
        "code" : 1,
        "data" : result,
    })
}
//
////添加数据
func Store(c *gin.Context) {
    var user model.User
    user.Username = c.Request.FormValue("username")
    user.Password = c.Request.FormValue("password")
    fmt.Println("user", user.Username, user.Password);
    id, err := user.Insert()
    if err != nil {
        c.JSON(http.StatusOK, gin.H{
            "code":    -1,
            "message": "添加失败",
        })
        return
    }
    c.JSON(http.StatusOK, gin.H{
        "code":  1,
        "message": "添加成功",
        "data":    id,
    })
}

func Del(c *gin.Context){
    var user model.User
    id, err := strconv.ParseInt(c.Param("id"), 10, 64)
    result, err := user.Destroy(id)
    if err != nil || result.ID == 0 {
        c.JSON(http.StatusOK, gin.H{
            "code":    -1,
            "message": "删除失败",
        })
        return
    }
    c.JSON(http.StatusOK, gin.H{
        "code":    1,
        "message": "删除成功",
    })
}


//修改数据
func Update(c *gin.Context) {
    var user model.User
    id, err := strconv.ParseInt(c.Param("id"), 10, 64)
    user.Username = c.Request.FormValue("username")
    user.Password = c.Request.FormValue("password")
    result, err := user.Update(id)
    if err != nil || result.ID == 0 {
        c.JSON(http.StatusOK, gin.H{
            "code":    -1,
            "message": "修改失败",
        })
        return
    }
    c.JSON(http.StatusOK, gin.H{
        "code":    1,
        "message": "修改成功",
    })
}

models 目录下的user.go

package models
import (
    orm  "blog/database"
    "fmt"
)
type User struct {
    ID       int64  `json:"id"`       // 列名为 `id`
    Username string `json:"username"` // 列名为 `username`
    Password string `json:"password"` // 列名为 `password`
}

//列表
func (user *User) Users() (users []User, err error) {
    if err = orm.Db.Find(&users).Error; err != nil {
        return
    }
    return
}

//添加
//添加
func (user User) Insert() (id int64, err error) {
    //添加数据
    result := orm.Db.Create(&user)
    id = user.ID
    if result.Error != nil {
        err = result.Error
        return
    }
    return
}

//删除数据
func (user *User) Destroy(id int64) (Result User, err error) {
    if err = orm.Db.Select([]string{"id"}).First(&user, id).Error; err != nil {
        return
    }
    if err = orm.Db.Delete(&user).Error; err != nil {
        return
    }
    Result = *user
    return
}

//修改
func (user *User) Update(id int64) (updateUser User, err error) {

    orm.Db.Where("id = ?", id).First(&updateUser);
    fmt.Println("updateUser", updateUser.ID, updateUser.Username)
    fmt.Println("用户信息",  user.Username, user.Password,  user.ID)

    //if err = orm.Db.Select([]string{"id", "username"}).First(&updateUser, id).Error; err != nil {
    //  return
    //}
    ////参数1:是要修改的数据  参数2:是修改的数据
    if err = orm.Db.Model(&updateUser).Updates(&user).Error; err != nil {
        return
    }
    return
}

最后编辑于：2020.02.15 18:52:42

人面猴
序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
沈念sama阅读 212,332评论 6赞 493
死咒
序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
沈念sama阅读 90,508评论 3赞 385
救了他两次的神仙让他今天三更去死
文/潘晓璐我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
开封第一讲书人阅读 157,812评论 0赞 348
道士缉凶录：失踪的卖姜人
文/不坏的土叔我叫张陵，是天一观的道长。经常有香客问我，道长，这世上最难降的妖魔是什么？我笑而不...
开封第一讲书人阅读 56,607评论 1赞 284
港岛之恋（遗憾婚礼）
正文为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
茶点故事阅读 65,728评论 6赞 386
恶毒庶女顶嫁案：这布局不是一般人想出来的
文/花漫我一把揭开白布。她就那样静静地躺着，像睡着了一般。火红的嫁衣衬着肌肤如雪。梳的纹丝不乱的头发上，一...
开封第一讲书人阅读 49,919评论 1赞 290
城市分裂传说
那天，我揣着相机与录音，去河边找鬼。笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。我是一名探鬼主播，决...
沈念sama阅读 39,071评论 3赞 410
双鸳鸯连环套：你想象不到人心有多黑
文/苍兰香墨我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
开封第一讲书人阅读 37,802评论 0赞 268
万荣杀人案实录
序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
沈念sama阅读 44,256评论 1赞 303
护林员之死
正文独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋以下内容为张勋视角年9月15日...
茶点故事阅读 36,576评论 2赞 327
白月光启示录
正文我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
茶点故事阅读 38,712评论 1赞 341
活死人
序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
沈念sama阅读 34,389评论 4赞 332
日本核电站爆炸内幕
正文年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
茶点故事阅读 40,032评论 3赞 316
男人毒药：我在死后第九天来索命
文/蒙蒙一、第九天我趴在偏房一处隐蔽的房顶上张望。院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
开封第一讲书人阅读 30,798评论 0赞 21
一桩弑父案，背后竟有这般阴谋
文/苍兰香墨我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。一阵脚步声响...
开封第一讲书人阅读 32,026评论 1赞 266
情欲美人皮
我被黑心中介骗来泰国打工，没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。一个月前我还...
沈念sama阅读 46,473评论 2赞 360
代替公主和亲
正文我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
茶点故事阅读 43,606评论 2赞 350

gin api接口 代码布局

00 参考代码仓库

1 新建数据库和表

目录结构

先做好路由的处理

创建 api 层的方法

修改main.go 中的代码:

开始操作数据库

推荐阅读更多精彩内容

gin api接口代码布局