避免在 labstack/echo 的路由中使用全局变量
avoiding global variables in routes for labstack/echo
我正在使用 labstack/echo webserver and gofight 进行单元测试。在学习 go 时,想知道是否有用于访问(嵌入式)echo 结构之外的状态的 go 习语。例如:
type WebPlusDB struct {
web *echo.Echo
db *databaseInterface
}
func NewEngine() *echo.Echo {
e := echo.New()
e.GET("/hello", route_hello)
return e
}
func NewWebPlusDb() {
e := NewEngine()
db := database.New()
return WebPlusDB{e,db}
}
// for use in unit tests
func NewFakeEngine() *WebPlusDB {
e := NewEngine()
db := fakeDatabase.New()
return WebPlusDB{e,db}
}
func route_hello(c echo.Context) error {
log.Printf("Hello world\n")
// how do I access WebPlusDB.db from here?
return c.String(http.StatusOK, "hello world")
}
然后在测试代码中我使用:
import (
"github.com/labstack/echo"
"github.com/appleboy/gofight"
"github.com/stretchr/testify/assert"
"testing"
)
func TestHelloWorld(t *testing.T) {
r := gofight.New()
r.GET("/hello").
Run(NewFakeEngine(), func(r gofight.HTTPResponse, rq gofight.HTTPRequest) {
assert.Equal(t, http.StatusOK, r.Code)
assert.Equal(t, "hello world", r.Body.String())
// test database access
})
}
最简单 解决方案是必须使用全局变量而不是在 "WebPlusDB" 中嵌入 echo 并在其中添加状态。我想要更好的封装。我想我应该使用类似于 WebPlusDB 结构的东西,而不是 echo.Echo 加上全局状态。这对于单元测试来说可能并不重要,但在更大的计划中正确地做事(在这种情况下避免全局变量)我想知道。
是否有解决办法或者这是echo设计的弱点?
它有中间件的扩展点,但数据库后端并不是真正的 middleware as defined here。
注意:我在这里使用数据库来说明常见情况,但它可以是任何东西(我实际上使用的是 amqp)
看起来你可以扩展context接口,但它是在哪里创建的?这看起来像是使用了一种 downcast:
e.GET("/", func(c echo.Context) error {
cc := c.(*CustomContext)
}
我认为(也许不正确)这只允许在接口上使用 echo.Context.Echo() returns 类型而不是接口。
您可以将实例的方法作为函数值传递,这可能是最直接的处理方式:
type WebPlusDB struct {
web *echo.Echo
db *databaseInterface
}
func (w WebPlusDB) route_hello(c echo.Context) error {
log.Printf("Hello world\n")
// do whatever with w
return c.String(http.StatusOK, "hello world")
}
func NewEngine() *echo.Echo {
e := echo.New()
w := NewWebPlusDb()
e.GET("/hello", w.route_hello)
return e
}
我正在使用 labstack/echo webserver and gofight 进行单元测试。在学习 go 时,想知道是否有用于访问(嵌入式)echo 结构之外的状态的 go 习语。例如:
type WebPlusDB struct {
web *echo.Echo
db *databaseInterface
}
func NewEngine() *echo.Echo {
e := echo.New()
e.GET("/hello", route_hello)
return e
}
func NewWebPlusDb() {
e := NewEngine()
db := database.New()
return WebPlusDB{e,db}
}
// for use in unit tests
func NewFakeEngine() *WebPlusDB {
e := NewEngine()
db := fakeDatabase.New()
return WebPlusDB{e,db}
}
func route_hello(c echo.Context) error {
log.Printf("Hello world\n")
// how do I access WebPlusDB.db from here?
return c.String(http.StatusOK, "hello world")
}
然后在测试代码中我使用:
import (
"github.com/labstack/echo"
"github.com/appleboy/gofight"
"github.com/stretchr/testify/assert"
"testing"
)
func TestHelloWorld(t *testing.T) {
r := gofight.New()
r.GET("/hello").
Run(NewFakeEngine(), func(r gofight.HTTPResponse, rq gofight.HTTPRequest) {
assert.Equal(t, http.StatusOK, r.Code)
assert.Equal(t, "hello world", r.Body.String())
// test database access
})
}
最简单 解决方案是必须使用全局变量而不是在 "WebPlusDB" 中嵌入 echo 并在其中添加状态。我想要更好的封装。我想我应该使用类似于 WebPlusDB 结构的东西,而不是 echo.Echo 加上全局状态。这对于单元测试来说可能并不重要,但在更大的计划中正确地做事(在这种情况下避免全局变量)我想知道。
是否有解决办法或者这是echo设计的弱点? 它有中间件的扩展点,但数据库后端并不是真正的 middleware as defined here。
注意:我在这里使用数据库来说明常见情况,但它可以是任何东西(我实际上使用的是 amqp)
看起来你可以扩展context接口,但它是在哪里创建的?这看起来像是使用了一种 downcast:
e.GET("/", func(c echo.Context) error {
cc := c.(*CustomContext)
}
我认为(也许不正确)这只允许在接口上使用 echo.Context.Echo() returns 类型而不是接口。
您可以将实例的方法作为函数值传递,这可能是最直接的处理方式:
type WebPlusDB struct {
web *echo.Echo
db *databaseInterface
}
func (w WebPlusDB) route_hello(c echo.Context) error {
log.Printf("Hello world\n")
// do whatever with w
return c.String(http.StatusOK, "hello world")
}
func NewEngine() *echo.Echo {
e := echo.New()
w := NewWebPlusDb()
e.GET("/hello", w.route_hello)
return e
}