增加Graceful关闭机制

Author: storezhang

.idea/echox.iml

@@ -19,7 +19,7 @@ type Echo struct {
 }
 
 func New(opts ...option) *Echo {
-	options := defaultOptions()
+	options := defaultOptions
 	for _, opt := range opts {
 		opt.apply(options)
 	}
@@ -96,17 +96,41 @@ func (e *Echo) Start(opts ...startOption) (err error) {
 	}
 
 	// 在另外的协程中启动服务器，实现优雅地关闭（Graceful Shutdown）
-	go func() {
+	if options.graceful {
+		go func() {
+			err = e.graceful(options)
+		}()
+	} else {
 		err = e.Echo.Start(e.options.addr)
-	}()
+	}
+
+	return
+}
+
+func (e *Echo) Stop(opts ...stopOption) error {
+	options := defaultStopOptions()
+	for _, opt := range opts {
+		opt.applyStop(options)
+	}
+
+	ctx, cancel := context.WithTimeout(context.Background(), options.timeout)
+	defer cancel()
+
+	return e.Echo.Shutdown(ctx)
+}
+
+func (e *Echo) graceful(options *startOptions) (err error) {
+	if err = e.Echo.Start(e.options.addr); nil != err {
+		return
+	}
 
 	// 等待系统退出中断并响应
 	quit := make(chan os.Signal)
 	signal.Notify(quit, os.Interrupt)
 	<-quit
 	ctx, cancel := context.WithTimeout(context.Background(), options.shutdownTimeout)
 	defer cancel()
-	err = e.Shutdown(ctx)
+	err = e.Echo.Shutdown(ctx)
 
 	return
 }

echo.go

@@ -0,0 +1,29 @@
+package echox
+
+import (
+	`time`
+)
+
+var (
+	_ startOption = (*optionShutdownTimeout)(nil)
+	_ stopOption  = (*optionShutdownTimeout)(nil)
+)
+
+type optionShutdownTimeout struct {
+	timeout time.Duration
+}
+
+// ShutdownTimeout 配置退出超时时间
+func ShutdownTimeout(timeout time.Duration) *optionShutdownTimeout {
+	return &optionShutdownTimeout{
+		timeout: timeout,
+	}
+}
+
+func (st *optionShutdownTimeout) applyStart(options *startOptions) {
+	options.shutdownTimeout = st.timeout
+}
+
+func (st *optionShutdownTimeout) applyStop(options *stopOptions) {
+	options.timeout = st.timeout
+}

option_shutdown_timeout.go

@@ -1,8 +1,22 @@
 package echox
 
-import (
-	`time`
-)
+var defaultOptions = &options{
+	addr:       ":9000",
+	binder:     true,
+	validate:   true,
+	banner:     false,
+	error:      errorHandlerFunc,
+	crosEnable: true,
+	cros: crosConfig{
+		origins:     []string{"*"},
+		credentials: true,
+	},
+	panicStack: panicStackConfig{
+		size:              4 << 10,
+		disableStackAll:   false,
+		disablePrintStack: false,
+	},
+}
 
 type options struct {
 	// 地址
@@ -19,8 +33,7 @@ type options struct {
 	inits []initFunc
 	// 错误处理
 	error errorHandler
-	// 退出超时时间
-	shutdownTimeout time.Duration
+
 	// 跨域
 	crosEnable bool
 	cros       crosConfig
@@ -29,24 +42,3 @@ type options struct {
 	// 打印堆栈信息
 	panicStack panicStackConfig
 }
-
-func defaultOptions() *options {
-	return &options{
-		addr:            ":9000",
-		binder:          true,
-		validate:        true,
-		banner:          false,
-		error:           errorHandlerFunc,
-		shutdownTimeout: 30 * time.Second,
-		crosEnable:      true,
-		cros: crosConfig{
-			origins:     []string{"*"},
-			credentials: true,
-		},
-		panicStack: panicStackConfig{
-			size:              4 << 10,
-			disableStackAll:   false,
-			disablePrintStack: false,
-		},
-	}
-}

options.go

@@ -0,0 +1,14 @@
+package echox
+
+var _ startOption = (*startOptionGraceful)(nil)
+
+type startOptionGraceful struct{}
+
+// Graceful 配置Graceful退出机制
+func Graceful() *startOptionGraceful {
+	return &startOptionGraceful{}
+}
+
+func (g *startOptionGraceful) applyStart(startOptions *startOptions) {
+	startOptions.graceful = true
+}

start_option_graceful.go

@@ -5,14 +5,18 @@ import (
 )
 
 type startOptions struct {
-	// 退出超时时间
+	*options
+
+	graceful        bool
 	shutdownTimeout time.Duration
-	// 初始化路由方法
-	routes []routeFunc
+	routes          []routeFunc
 }
 
 func defaultStartOptions() *startOptions {
 	return &startOptions{
+		options: defaultOptions,
+
+		graceful:        false,
 		shutdownTimeout: 30 * time.Second,
 		routes: []routeFunc{func(group *Group) {
 			group.Get("/routes", routeHandler).Name = "所有路由信息"

start_option_shutdown_timeout.go

@@ -0,0 +1,5 @@
+package echox
+
+type stopOption interface {
+	applyStop(options *stopOptions)
+}

start_options.go

@@ -0,0 +1,20 @@
+package echox
+
+import (
+	`time`
+)
+
+type stopOptions struct {
+	*options
+
+	// 退出超时时间
+	timeout time.Duration
+}
+
+func defaultStopOptions() *stopOptions {
+	return &stopOptions{
+		options: defaultOptions,
+
+		timeout: 30 * time.Second,
+	}
+}