gin api接口代码布局

作者: 愚蠢的二师弟 | 来源:发表于2020-02-15 12:28 被阅读0次

gin api接口代码布局
golang+gin实现文件下载GET接口API
golang第六天
Developing a RESTful API with Go
API是什么？
2020-10-15Go-Gin API c.JSON(stat
Retrofit+RxJava相关
nodejs之express 单线程高并发测试
使用Golang的Gin框架和vue编写web应用
Go实战项目【六】中间件token鉴权和app升级功能

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
}

gin api接口代码布局
00 参考代码仓库 https://gitee.com/babyb/gin_grom_restful_api 1...
golang+gin实现文件下载GET接口API
golang+gin 实现文件下载GET接口api 1.api接口格式http://ip:port/downloa...
golang第六天
学习web框架gin demo代码接口测试工具：postman 打卡时间: 23:25
Developing a RESTful API with Go
Developing a RESTful API with Go and Gin 本教程介绍了使用 Go 和Gin...
API是什么？
API文档 API接口一般分为接口描述、接口地址、请求方法、请求参数、相应内容、错误代码、实例几个部分。 1、接口...
2020-10-15Go-Gin API c.JSON(stat
Go-Gin API c.JSON(status, gin.H{"errmessage":result.Error...
Retrofit+RxJava相关
准备关键代码 1.定义api接口 2.创建Retrofit 3. 调用api接口,获取Observable,并进...
nodejs之express 单线程高并发测试
测试接口为restful api 测试代码如下：
使用Golang的Gin框架和vue编写web应用
背景: 之前使用Golang的Gin框架进行一些运维内部后端的API接口开发，对外提供提供json类型的数据响应，...
Go实战项目【六】中间件token鉴权和app升级功能
Middleware中间件使用中间件可以对api接口访问前后做处理。例如token校验。接下来使用gin框架的中...

gin api接口代码布局

00 参考代码仓库

1 新建数据库和表

目录结构

先做好路由的处理

创建 api 层的方法

修改main.go 中的代码:

开始操作数据库

相关文章