mirror of
https://github.com/gin-gonic/gin.git
synced 2026-06-12 00:28:37 +08:00
Fix concurrent-safe route registration
Add sync.RWMutex to protect concurrent access to the trees slice in Engine struct. This fixes a data race between addRoute() and Routes() functions where one goroutine appends to trees while another reads from it. Changes: - Add mu sync.RWMutex field to Engine struct - Protect addRoute() with Lock/Unlock - Protect Routes() with RLock/RUnlock - Add TestConcurrentAddRouteAndRoutes to test concurrent access Fixes #4457
This commit is contained in:
parent
d7776de7d4
commit
3af7291718
9
gin.go
9
gin.go
@ -96,6 +96,10 @@ type Engine struct {
|
|||||||
// (used for routing HTTP requests) happens only once, even if called multiple times concurrently.
|
// (used for routing HTTP requests) happens only once, even if called multiple times concurrently.
|
||||||
routeTreesUpdated sync.Once
|
routeTreesUpdated sync.Once
|
||||||
|
|
||||||
|
|
||||||
|
// mu protects concurrent access to trees
|
||||||
|
mu sync.RWMutex
|
||||||
|
|
||||||
// RedirectTrailingSlash enables automatic redirection if the current route can't be matched but a
|
// RedirectTrailingSlash enables automatic redirection if the current route can't be matched but a
|
||||||
// handler for the path with (without) the trailing slash exists.
|
// handler for the path with (without) the trailing slash exists.
|
||||||
// For example if /foo/ is requested but a route only exists for /foo, the
|
// For example if /foo/ is requested but a route only exists for /foo, the
|
||||||
@ -368,6 +372,9 @@ func (engine *Engine) addRoute(method, path string, handlers HandlersChain) {
|
|||||||
|
|
||||||
debugPrintRoute(method, path, handlers)
|
debugPrintRoute(method, path, handlers)
|
||||||
|
|
||||||
|
engine.mu.Lock()
|
||||||
|
defer engine.mu.Unlock()
|
||||||
|
|
||||||
root := engine.trees.get(method)
|
root := engine.trees.get(method)
|
||||||
if root == nil {
|
if root == nil {
|
||||||
root = new(node)
|
root = new(node)
|
||||||
@ -388,6 +395,8 @@ func (engine *Engine) addRoute(method, path string, handlers HandlersChain) {
|
|||||||
// Routes returns a slice of registered routes, including some useful information, such as:
|
// Routes returns a slice of registered routes, including some useful information, such as:
|
||||||
// the http method, path, and the handler name.
|
// the http method, path, and the handler name.
|
||||||
func (engine *Engine) Routes() (routes RoutesInfo) {
|
func (engine *Engine) Routes() (routes RoutesInfo) {
|
||||||
|
engine.mu.RLock()
|
||||||
|
defer engine.mu.RUnlock()
|
||||||
for _, tree := range engine.trees {
|
for _, tree := range engine.trees {
|
||||||
routes = iterate("", tree.method, routes, tree.root)
|
routes = iterate("", tree.method, routes, tree.root)
|
||||||
}
|
}
|
||||||
|
|||||||
33
gin_test.go
33
gin_test.go
@ -1067,6 +1067,39 @@ func TestLiteralColonWithHTTPServer(t *testing.T) {
|
|||||||
assert.Contains(t, w2.Body.String(), "foo")
|
assert.Contains(t, w2.Body.String(), "foo")
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestConcurrentAddRouteAndRoutes(t *testing.T) {
|
||||||
|
router := New()
|
||||||
|
|
||||||
|
done := make(chan bool)
|
||||||
|
|
||||||
|
for i := 0; i < 10; i++ {
|
||||||
|
go func(n int) {
|
||||||
|
router.GET(fmt.Sprintf("/route%d", n), func(c *Context) {
|
||||||
|
c.String(http.StatusOK, fmt.Sprintf("route%d", n))
|
||||||
|
})
|
||||||
|
router.POST(fmt.Sprintf("/route%d", n), func(c *Context) {
|
||||||
|
c.String(http.StatusOK, fmt.Sprintf("route%d", n))
|
||||||
|
})
|
||||||
|
done <- true
|
||||||
|
}(i)
|
||||||
|
}
|
||||||
|
|
||||||
|
for i := 0; i < 10; i++ {
|
||||||
|
go func() {
|
||||||
|
_ = router.Routes()
|
||||||
|
done <- true
|
||||||
|
}()
|
||||||
|
}
|
||||||
|
|
||||||
|
for i := 0; i < 20; i++ {
|
||||||
|
<-done
|
||||||
|
}
|
||||||
|
|
||||||
|
routes := router.Routes()
|
||||||
|
assert.Len(t, routes, 20)
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
// Test that updateRouteTrees is called only once
|
// Test that updateRouteTrees is called only once
|
||||||
func TestUpdateRouteTreesCalledOnce(t *testing.T) {
|
func TestUpdateRouteTreesCalledOnce(t *testing.T) {
|
||||||
SetMode(TestMode)
|
SetMode(TestMode)
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user