How to pass arguments to router handlers in Golang using Gin web framework?

Question

I'm using Gin, https://gin-gonic.github.io/gin/, to build a simple RESTful JSON API with Golang.

The routes are setup with something like this:

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

My question is how can I pass down an argument to the testRouteHandler function? For example a common database connection could be something that one wants to reuse among routes.

Is the best way to have this in a global variable? Or is there some way in Go to pass along an extra variable to the testRouteHandler function? Are there optional arguments for functions in Go?

PS. I'm just getting started in learning Go, so could be something obvious that I'm missing :)

Answer 1

I would avoid stuffing 'application scoped' dependencies (e.g. a DB connection pool) into a request context. Your two 'easiest' options are:

1. Make it a global. This is OK for smaller projects, and *sql.DB is thread-safe.
2. Pass it explicitly in a closure so that the return type satisfies gin.HandlerFunc

e.g.

// 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") }