Merge pull request #360 from game1991/master

feat: egin提供自定义listener方法
gotomicro · Aug 30, 2023 · afb4e30 · afb4e30
2 parents 69e079d + cffae7f
commit afb4e30
Show file tree

Hide file tree

Showing 4 changed files with 40 additions and 1 deletion.
diff --git a/server/egin/component.go b/server/egin/component.go
@@ -52,6 +52,10 @@ func newComponent(name string, config *Config, logger *elog.Component) *Componen
 		listener:         nil,
 		routerCommentMap: make(map[string]string),
 	}
+	// 判断是否存在自定义listener
+	if config.listener != nil {
+		comp.listener = config.listener
+	}
 
 	if config.EmbedPath != "" {
 		comp.embedWrapper = &EmbedWrapper{
@@ -88,6 +92,18 @@ func (c *Component) Prepare() error {
 
 // Init 初始化
 func (c *Component) Init() error {
+	// 如果没有配置listener
+	if c.config.listener == nil {
+		if err := c.defaultListener(); err != nil {
+			return err
+		}
+	}
+
+	c.config.Port = c.listener.Addr().(*net.TCPAddr).Port
+	return nil
+}
+
+func (c *Component) defaultListener() error {
 	var err error
 	if c.config.Network == "local" {
 		c.listener = newLocalListener()
@@ -97,7 +113,6 @@ func (c *Component) Init() error {
 			c.logger.Panic("new egin server err", elog.FieldErrKind("listen err"), elog.FieldErr(err))
 		}
 	}
-	c.config.Port = c.listener.Addr().(*net.TCPAddr).Port
 	return nil
 }
 

diff --git a/server/egin/config.go b/server/egin/config.go
@@ -4,6 +4,7 @@ import (
 	"crypto/tls"
 	"embed"
 	"fmt"
+	"net"
 	"net/http"
 	"sync"
 	"time"
@@ -55,6 +56,7 @@ type Config struct {
 	aiReqResCelPrg                cel.Program
 	mu                            sync.RWMutex     // mutex for EnableAccessInterceptorReq、EnableAccessInterceptorRes、AccessInterceptorReqResFilter、aiReqResCelPrg
 	recoveryFunc                  gin.RecoveryFunc // recoveryFunc 处理接口没有被 recover 的 panic，默认返回 500 并且没有任何 response body
+	listener                      net.Listener     // a generic network listener 默认是net.Listen()方法生成,如果有需要自行传入可采用option方式进行替换
 }
 
 // DefaultConfig ...

diff --git a/server/egin/options.go b/server/egin/options.go
@@ -3,6 +3,7 @@ package egin
 import (
 	"crypto/tls"
 	"embed"
+	"net"
 	"time"
 
 	"github.com/gin-gonic/gin"
@@ -113,3 +114,9 @@ func WithRecoveryFunc(f gin.RecoveryFunc) Option {
 		c.config.recoveryFunc = f
 	}
 }
+
+func WithListener(listener net.Listener) Option {
+	return func(c *Container) {
+		c.config.listener = listener
+	}
+}
diff --git a/server/egin/options_test.go b/server/egin/options_test.go
@@ -1,6 +1,9 @@
 package egin
 
 import (
+	"io"
+	"net/http"
+	"net/http/httptest"
 	"testing"
 	"time"
 
@@ -92,3 +95,15 @@ func TestWithContextTimeout(t *testing.T) {
 	comp := DefaultContainer().Build(WithContextTimeout(timeout))
 	assert.Equal(t, timeout, comp.config.ContextTimeout)
 }
+
+func TestWithListener(t *testing.T) {
+	server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		// 处理http请求
+		io.WriteString(w, "Hello,Client")
+	}))
+	defer server.Close()
+
+	lister := server.Listener
+	comp := DefaultContainer().Build(WithListener(lister))
+	assert.Equal(t, lister, comp.config.listener)
+}