一个 Gin 项目结构示例

├── gin
│   ├──  Router
│          └── router.go
│   ├──  Middlewares
│          └── corsMiddleware.go
│   ├──  Controllers
│          └── testController.go
│   ├──  Services
│          └── testService.go
│   ├──  Models
│          └── testModel.go
│   ├──  Databases
│          └── mysql.go
│   ├──  Sessions
│          └── session.go
└── main.go

  • 使用gorm访问数据库
  • gin 为项目根目录
  • main.go 为入口文件
  • Router 为路由目录
  • Middlewares 为中间件目录
  • Controllers 为控制器目录(MVC)
  • Services 为服务层目录,这里把DAO逻辑也写入其中,如果分开也可以
  • Models 为模型目录
  • Databases 为数据库初始化目录
  • Sessions 为session初始化目录
  • 文件 引用顺序 大致如下:
    main.go(在main中关闭数据库) - router(Middlewares) - Controllers - Services(sessions) - Models - Databases
  • Databases / mysql
package Mysql

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

var DB *gorm.DB

func init()  {
    var err error
       // 妈的,密码被爬虫转得全网都是
    DB, err = gorm.Open("mysql", "wuyu:password@/gin?charset=utf8&parseTime=True&loc=Local")
    if err != nil {
        fmt.Printf("mysql connect error %v", err)
    }
    if DB.Error != nil {
        fmt.Printf("database error %v", DB.Error)
    }
}
  • Models / testModel.go
package Models

import (
    "gin/Databases"
)

type Test struct {
    Id int
    Testcol string `gorm:"column:testcol"`
}

// 设置Test的表名为`test`
// func (Test) TableName() string {
//     return "test"
// }

func (this *Test) Insert() (id int, err error) {
    result := Mysql.DB.Create(&this)
    id = this.Id
    if result.Error != nil {
        err = result.Error
        return
    }
    return
}
  • Services / testService.go
package Services

import (
    "gin/Models"
)

type Test struct {
    Id int `json:"id"` 
    Testcol string `json:"testcol"`
}

func (this *Test) Insert() (id int, err error) {
    var testModel Models.Test
    testModel.Id = this.Id
    testModel.Testcol = this.Testcol
    id, err = testModel.Insert()
    return
}
  • Controllers / testController.go
package Controllers

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

func TestInsert(c *gin.Context) {
    var testService Services.Test

    err := c.ShouldBindJSON(&testService)
    if err != nil {
        c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
        return
    }

    id, err := testService.Insert()
    if err != nil {
        c.JSON(http.StatusOK, gin.H{
            "code": -1,
            "message": "Insert() error!",
        })
        return
    }
    c.JSON(http.StatusOK, gin.H{
        "code": 1,
        "message": "success",
        "data": id,
    })

}
  • Router / router.go
package Router

import (
    "github.com/gin-gonic/gin"
    "gin/Controllers"
    "gin/Middlewares"
    "gin/Sessions"
    "github.com/gin-contrib/sessions"
)

func InitRouter() {
    router := gin.Default()
    // 要在路由组之前全局使用「跨域中间件」, 否则OPTIONS会返回404
    router.Use(Middlewares.Cors())
    // 使用 session(cookie-based)
    router.Use(sessions.Sessions("myyyyysession", Sessions.Store))
    v1 := router.Group("v1")
    {
         v1.POST("/testinsert", Controllers.TestInsert)
    }
    
    router.Run(":8080")
}
  • Middlewares / corsMiddleware.go
package Middlewares

import (
    "github.com/gin-gonic/gin"
    "net/http"
)
// 跨域中间件
func Cors() gin.HandlerFunc {
    return func(c *gin.Context) {
        method := c.Request.Method
        origin := c.Request.Header.Get("Origin")
        if origin != "" {
            c.Header("Access-Control-Allow-Origin", origin)
            c.Header("Access-Control-Allow-Methods", "POST, GET, OPTIONS, PUT, DELETE, UPDATE")
            c.Header("Access-Control-Allow-Headers", "Origin, X-Requested-With, Content-Type, Accept, Authorization")
            c.Header("Access-Control-Expose-Headers", "Content-Length, Access-Control-Allow-Origin, Access-Control-Allow-Headers, Cache-Control, Content-Language, Content-Type")
            c.Header("Access-Control-Allow-Credentials", "false")
            c.Set("content-type", "application/json")
        }
        if method == "OPTIONS" {
            c.AbortWithStatus(http.StatusNoContent)
        }
        c.Next()
    }
}
  • Sessions/session.go
package Sessions

import (
    "github.com/gin-contrib/sessions"
    "github.com/gin-contrib/sessions/cookie"
    "github.com/gin-gonic/gin"
    "time"
    "strconv"
)

var Store = cookie.NewStore([]byte("very-very-secret"))

func SetSession(c *gin.Context, username string) string {
    session := sessions.Default(c)
    sessionId := "sessionIdxxxxxxxok"
    session.Set(sessionId, username)
    session.Save()
    return sessionId
}

func GetSession(c *gin.Context, sessionId string) (username string) {
    session := sessions.Default(c)
    result := session.Get(sessionId)
    username = result.(string)
    return
}
  • main.go
package main

import (
    "gin/Router"
    "gin/Databases"
)

func main() {
    defer Mysql.DB.Close()
    Router.InitRouter()
}
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
禁止转载,如需转载请通过简信或评论联系作者。
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,402评论 6 499
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,377评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,483评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,165评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,176评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,146评论 1 297
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,032评论 3 417
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,896评论 0 274
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,311评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,536评论 2 332
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,696评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,413评论 5 343
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,008评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,659评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,815评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,698评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,592评论 2 353