Как передать аргументы обработчикам маршрутизаторов в Golang с помощью Gin web framework?

Я использую Джин,https://gin-gonic.github.io/gin/, чтобы построить простой RESTful JSON API с Golang.

маршруты настроены примерно так:

func testRouteHandler(c *gin.Context) {
    // do smth
}

func main() {
    router := gin.Default()
    router.GET("/test", testRouteHandler)
    router.Run(":8080")
}

мой вопрос в том, как я могу передать аргумент функции testRouteHandler? Например, общим подключением к базе данных может быть то, что нужно повторно использовать среди маршрутов.

Это лучший способ иметь это в глобальной переменной? Или есть какой-то путь пройти вдоль дополнительной переменной к функции testRouteHandler? Существуют ли необязательные аргументы для функций в Go?

PS. Я только начинаю учиться идти, так что может быть что-то очевидное, что мне не хватает :)

13
go go-gin

4 ответов

используя ссылку, которую я разместил в комментариях, я создал простой пример.

package main

import (
    "log"

    "github.com/gin-gonic/gin"
    "github.com/jinzhu/gorm"
    _ "github.com/mattn/go-sqlite3"
)

// ApiMiddleware will add the db connection to the context
func ApiMiddleware(db gorm.DB) gin.HandlerFunc {
    return func(c *gin.Context) {
        c.Set("databaseConn", db)
        c.Next()
    }
}

func main() {
    r := gin.New()

    // In this example, I'll open the db connection here...
    // In your code you would probably do it somewhere else
    db, err := gorm.Open("sqlite3", "./example.db")
    if err != nil {
        log.Fatal(err)
    }

    r.Use(ApiMiddleware(db))

    r.GET("/api", func(c *gin.Context) {
        // Don't forget type assertion when getting the connection from context.
        dbConn, ok := c.MustGet("databaseConn").(gorm.DB)
        if !ok {
            // handle error here...
        }

        // do your thing here...
    })

    r.Run(":8080")
}

Это просто простой POC. Но я верю, что это только начало. Надеюсь, это поможет.

12

Я бы избегал заполнения зависимостей "области приложения" (например, пула соединений DB) в контекст запроса. Ваши два "самых простых" варианта:

  1. сделать его глобальным. Это нормально для небольших проектов, и *sql.DB потокобезопасным.
  2. передайте его явно в закрытии, чтобы возвращаемый тип удовлетворял gin.HandlerFunc

например

// SomeHandler returns a `func(*gin.Context)` to satisfy Gin's router methods
// db could turn into an 'Env' struct that encapsulates all of your
// app dependencies - e.g. DB, logger, env vars, etc.
func SomeHandler(db *sql.DB) gin.HandlerFunc {
    fn := func(c *gin.Context) {
        // Your handler code goes in here - e.g.
        rows, err := db.Query(...)

        c.String(200, results)
    }

    return gin.HandlerFunc(fn)
}

func main() {
    db, err := sql.Open(...)
    // handle the error

    router := gin.Default()
    router.GET("/test", SomeHandler(db))
    router.Run(":8080")
}
10

поздно на вечеринку, пока вот мое предложение. Инкапсулировать методы в объект с частными/публичными vars в нем:

package main

import (
    "log"

    "github.com/gin-gonic/gin"
    "github.com/jinzhu/gorm"
    _ "github.com/mattn/go-sqlite3"
)

type HandlerA struct {
    Db gorm.DB
}

func (this *HandlerA) Get(c *gin.Context) {

    log.Info("[%#f]", this.Db)
    // do your thing here...
}

func main() {
    r := gin.New()

    // Init, should be separate, but it's ok for this sample:
    db, err := gorm.Open("sqlite3", "./example.db")
    if err != nil {
        log.Fatal(err)
    }

    Obj := new(HandlerA)
    Obj.Db = db // Or init inside Object

    r := gin.New()

    Group := r.Group("api/v1/")
    {
        Group.GET("/storage", Obj.Get)
    }

    r.Run(":8080")
}
1

хорошо, я привел вам простой пример. Это должно сработать. Вы можете продлить его в соответствии с вашими потребностями

func main() {
    router := gin.Default()
    router.GET("/test/:id/:name", testRouteHandler)
    router.Run(":8080")
}

func testRouteHandler(c *gin.Context) {
    id := c.Params.ByName("id")
    name := c.Params.ByName("name")
}

теперь вам придется вызвать свой обработчик, как показано ниже http://localhost:8080/test/1/myname

0