Etusivu Tutki Apua
Rekisteröidy Kirjaudu sisään
publics
/
gin-gonic__gin
0
0
Fork 0
Tiedostot Ongelmat 0 Pull-pyynnöt 0 Wiki
Selaa lähdekoodia

docs: add graceful-shutdown example for go 1.8 (#835)

* docs: add graceful-shutdown example for go 1.8

* fix testing

Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>
Bo-Yi Wu 8 vuotta sitten
vanhempi
28b18cd1fb
commit
b8be9df642
7 muutettua tiedostoa jossa 193 lisäystä ja 38 poistoa
Yhdistetty näkymä Näytä diff tilastot
  1. 2 0
      .travis.yml
  2. 2 4
      AUTHORS.md
  3. 1 1
      BENCHMARKS.md
  4. 81 19
      README.md
  5. 45 0
      examples/graceful-shutdown/close/server.go
  6. 48 0
      examples/graceful-shutdown/graceful-shutdown/server.go
  7. 14 14
      gin_integration_test.go

+ 2 - 0
.travis.yml
Näytä tiedosto 

@@ -12,8 +12,10 @@ git:
 
 install:
 
 install:
 
   - go get -v github.com/kardianos/govendor
 
   - go get -v github.com/kardianos/govendor
 
   - govendor sync
 
   - govendor sync
 
+  - go get -u github.com/campoy/embedmd
 
 
 
 script:
 
 script:
 
+  - embedmd -d README.md
 
   - go test -v -covermode=count -coverprofile=coverage.out
 
   - go test -v -covermode=count -coverprofile=coverage.out
 
 
 
 after_success:
 
 after_success:

+ 2 - 4
AUTHORS.md
Näytä tiedosto 

@@ -1,8 +1,6 @@
 
 List of all the awesome people working to make Gin the best Web Framework in Go.
 
 List of all the awesome people working to make Gin the best Web Framework in Go.
 
 
 
-
 
-
 
-##gin 0.x series authors
 
+## gin 0.x series authors
 
 
 
 **Maintainer:** Manu Martinez-Almeida (@manucorporat), Javier Provecho (@javierprovecho)
 
 **Maintainer:** Manu Martinez-Almeida (@manucorporat), Javier Provecho (@javierprovecho)
 
 
 
@@ -226,4 +224,4 @@ People and companies, who have contributed, in alphabetical order.
 
 
 
 
 
 **@yuyabee**
 
 **@yuyabee**
 
-- Fixed README
 
+- Fixed README

+ 1 - 1
BENCHMARKS.md
Näytä tiedosto 

@@ -295,4 +295,4 @@ BenchmarkPossum_GPlusAll      100000         19685 ns/op        6240 B/op
 
 BenchmarkR2router_GPlusAll    100000         16251 ns/op        5040 B/op         76 allocs/op
 
 BenchmarkR2router_GPlusAll    100000         16251 ns/op        5040 B/op         76 allocs/op
 
 BenchmarkRevel_GPlusAll    20000         93489 ns/op       21656 B/op        368 allocs/op
 
 BenchmarkRevel_GPlusAll    20000         93489 ns/op       21656 B/op        368 allocs/op
 
 BenchmarkRivet_GPlusAll   100000         16907 ns/op        5408 B/op         64 allocs/op
 
 BenchmarkRivet_GPlusAll   100000         16907 ns/op        5408 B/op         64 allocs/op
 
-```
 
+```

+ 81 - 19
README.md
Näytä tiedosto 

@@ -1,5 +1,4 @@
 
-
 
-#Gin Web Framework
 
+# Gin Web Framework
 
 
 
 <img align="right" src="https://raw.githubusercontent.com/gin-gonic/gin/master/logo.jpg">
 
 <img align="right" src="https://raw.githubusercontent.com/gin-gonic/gin/master/logo.jpg">
 
 [![Build Status](https://travis-ci.org/gin-gonic/gin.svg)](https://travis-ci.org/gin-gonic/gin)
 
 [![Build Status](https://travis-ci.org/gin-gonic/gin.svg)](https://travis-ci.org/gin-gonic/gin)
 
@@ -16,6 +15,7 @@ Gin is a web framework written in Go (Golang). It features a martini-like API wi
 
 ```sh
 
 ```sh
 
 $ cat test.go
 
 $ cat test.go
 
 ```
 
 ```
 
+
 
 ```go
 
 ```go
 
 package main
 
 package main
 
 
 
@@ -87,28 +87,28 @@ BenchmarkZeus_GithubAll 		| 2000 		| 944234 	| 300688 	| 2648
 
 
 
 1. Download and install it:
 
 1. Download and install it:
 
 
 
-    ```sh
 
-    $ go get gopkg.in/gin-gonic/gin.v1
 
-    ```
 
+```sh
 
+$ go get gopkg.in/gin-gonic/gin.v1
 
+```
 
 
 
 2. Import it in your code:
 
 2. Import it in your code:
 
 
 
-    ```go
 
-    import "gopkg.in/gin-gonic/gin.v1"
 
-    ```
 
+```go
 
+import "gopkg.in/gin-gonic/gin.v1"
 
+```
 
 
 
 3. (Optional) Import `net/http`. This is required for example if using constants such as `http.StatusOK`.
 
 3. (Optional) Import `net/http`. This is required for example if using constants such as `http.StatusOK`.
 
 
 
-    ```go
 
-    import "net/http"
 
-    ```
 
+```go
 
+import "net/http"
 
+```
 
 
 
 4. (Optional) Use latest changes (note: they may be broken and/or unstable):
 
 4. (Optional) Use latest changes (note: they may be broken and/or unstable):
 
 
 
- ```sh  
-    $ GIN_PATH=$GOPATH/src/gopkg.in/gin-gonic/gin.v1
 
-    $ git -C $GIN_PATH checkout develop
 
-    $ git -C $GIN_PATH pull origin develop 
+```sh  
+$ GIN_PATH=$GOPATH/src/gopkg.in/gin-gonic/gin.v1
 
+$ git -C $GIN_PATH checkout develop
 
+$ git -C $GIN_PATH pull origin develop 
 ```
 
 ```
 
 
 
 ## API Examples
 
 ## API Examples
 
@@ -165,6 +165,7 @@ func main() {
 
 ```
 
 ```
 
 
 
 ### Querystring parameters
 
 ### Querystring parameters
 
+
 
 ```go
 
 ```go
 
 func main() {
 
 func main() {
 
 	router := gin.Default()
 
 	router := gin.Default()
 
@@ -315,7 +316,6 @@ func main() {
 
 }
 
 }
 
 ```
 
 ```
 
 
 
-
 
 ### Blank Gin without middleware by default
 
 ### Blank Gin without middleware by default
 
 
 
 Use
 
 Use
 
@@ -323,6 +323,7 @@ Use
 
 ```go
 
 ```go
 
 r := gin.New()
 
 r := gin.New()
 
 ```
 
 ```
 
+
 
 instead of
 
 instead of
 
 
 
 ```go
 
 ```go
 
@@ -450,7 +451,6 @@ func startPage(c *gin.Context) {
 
 }
 
 }
 
 ```
 
 ```
 
 
 
-
 
 ### Multipart/Urlencoded binding
 
 ### Multipart/Urlencoded binding
 
 
 
 ```go
 
 ```go
 
@@ -490,7 +490,6 @@ Test it with:
 
 $ curl -v --form user=user --form password=password http://localhost:8080/login
 
 $ curl -v --form user=user --form password=password http://localhost:8080/login
 
 ```
 
 ```
 
 
 
-
 
 ### XML, JSON and YAML rendering
 
 ### XML, JSON and YAML rendering
 
 
 
 ```go
 
 ```go
 
@@ -561,7 +560,9 @@ func main() {
 
 	router.Run(":8080")
 
 	router.Run(":8080")
 
 }
 
 }
 
 ```
 
 ```
 
+
 
 templates/index.tmpl
 
 templates/index.tmpl
 
+
 
 ```html
 
 ```html
 
 <html>
 
 <html>
 
 	<h1>
 
 	<h1>
 
@@ -589,7 +590,9 @@ func main() {
 
 	router.Run(":8080")
 
 	router.Run(":8080")
 
 }
 
 }
 
 ```
 
 ```
 
+
 
 templates/posts/index.tmpl
 
 templates/posts/index.tmpl
 
+
 
 ```html
 
 ```html
 
 {{ define "posts/index.tmpl" }}
 
 {{ define "posts/index.tmpl" }}
 
 <html><h1>
 
 <html><h1>
 
@@ -599,7 +602,9 @@ templates/posts/index.tmpl
 
 </html>
 
 </html>
 
 {{ end }}
 
 {{ end }}
 
 ```
 
 ```
 
+
 
 templates/users/index.tmpl
 
 templates/users/index.tmpl
 
+
 
 ```html
 
 ```html
 
 {{ define "users/index.tmpl" }}
 
 {{ define "users/index.tmpl" }}
 
 <html><h1>
 
 <html><h1>
 
@@ -680,6 +685,7 @@ func main() {
 
 ```
 
 ```
 
 
 
 ### Using BasicAuth() middleware
 
 ### Using BasicAuth() middleware
 
+
 
 ```go
 
 ```go
 
 // simulate some private data
 
 // simulate some private data
 
 var secrets = gin.H{
 
 var secrets = gin.H{
 
@@ -717,8 +723,8 @@ func main() {
 
 }
 
 }
 
 ```
 
 ```
 
 
 
-
 
 ### Goroutines inside a middleware
 
 ### Goroutines inside a middleware
 
+
 
 When starting inside a middleware or handler, you **SHOULD NOT** use the original context inside it, you have to use a read-only copy.
 
 When starting inside a middleware or handler, you **SHOULD NOT** use the original context inside it, you have to use a read-only copy.
 
 
 
 ```go
 
 ```go
 
@@ -794,6 +800,62 @@ endless.ListenAndServe(":4242", router)
 
 An alternative to endless:
 
 An alternative to endless:
 
 
 
 * [manners](https://github.com/braintree/manners): A polite Go HTTP server that shuts down gracefully.
 
 * [manners](https://github.com/braintree/manners): A polite Go HTTP server that shuts down gracefully.
 
+* [graceful](https://github.com/tylerb/graceful): Graceful is a Go package enabling graceful shutdown of an http.Handler server.
 
+* [grace](https://github.com/facebookgo/grace): Graceful restart & zero downtime deploy for Go servers.
 
+
 
+If you are using Go 1.8, you may not need to use this library! Consider using http.Server's built-in [Shutdown()](https://golang.org/pkg/net/http/#Server.Shutdown) method for graceful shutdowns. See the full [graceful-shutdown](./examples/graceful-shutdown) example with gin.
 
+
 
+[embedmd]:# (examples/graceful-shutdown/graceful-shutdown/server.go go)
 
+```go
 
+// +build go1.8
 
+
 
+package main
 
+
 
+import (
 
+	"context"
 
+	"log"
 
+	"net/http"
 
+	"os"
 
+	"os/signal"
 
+	"time"
 
+
 
+	"github.com/gin-gonic/gin"
 
+)
 
+
 
+func main() {
 
+	router := gin.Default()
 
+	router.GET("/", func(c *gin.Context) {
 
+		time.Sleep(5 * time.Second)
 
+		c.String(http.StatusOK, "Welcome Gin Server")
 
+	})
 
+
 
+	srv := &http.Server{
 
+		Addr:    ":8080",
 
+		Handler: router,
 
+	}
 
+
 
+	go func() {
 
+		// service connections
 
+		if err := srv.ListenAndServe(); err != nil {
 
+			log.Printf("listen: %s\n", err)
 
+		}
 
+	}()
 
+
 
+	// Wait for interrupt signal to gracefully shutdown the server with
 
+	// a timeout of 5 seconds.
 
+	quit := make(chan os.Signal)
 
+	signal.Notify(quit, os.Interrupt)
 
+	<-quit
 
+	log.Println("Shutdown Server ...")
 
+
 
+	ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
 
+	defer cancel()
 
+	if err := srv.Shutdown(ctx); err != nil {
 
+		log.Fatal("Server Shutdown:", err)
 
+	}
 
+	log.Println("Server exist")
 
+}
 
+```
 
 
 
 ## Contributing 
 ## Contributing

+ 45 - 0
examples/graceful-shutdown/close/server.go
Näytä tiedosto 

@@ -0,0 +1,45 @@
 
+// +build go1.8
 
+
 
+package main
 
+
 
+import (
 
+	"log"
 
+	"net/http"
 
+	"os"
 
+	"os/signal"
 
+
 
+	"github.com/gin-gonic/gin"
 
+)
 
+
 
+func main() {
 
+	router := gin.Default()
 
+	router.GET("/", func(c *gin.Context) {
 
+		c.String(http.StatusOK, "Welcome Gin Server")
 
+	})
 
+
 
+	server := &http.Server{
 
+		Addr:    ":8080",
 
+		Handler: router,
 
+	}
 
+
 
+	quit := make(chan os.Signal)
 
+	signal.Notify(quit, os.Interrupt)
 
+
 
+	go func() {
 
+		<-quit
 
+		log.Println("receive interrupt signal")
 
+		if err := server.Close(); err != nil {
 
+			log.Fatal("Server Close:", err)
 
+		}
 
+	}()
 
+
 
+	if err := server.ListenAndServe(); err != nil {
 
+		if err == http.ErrServerClosed {
 
+			log.Println("Server closed under request")
 
+		} else {
 
+			log.Fatal("Server closed unexpect")
 
+		}
 
+	}
 
+
 
+	log.Println("Server exist")
 
+}

+ 48 - 0
examples/graceful-shutdown/graceful-shutdown/server.go
Näytä tiedosto 

@@ -0,0 +1,48 @@
 
+// +build go1.8
 
+
 
+package main
 
+
 
+import (
 
+	"context"
 
+	"log"
 
+	"net/http"
 
+	"os"
 
+	"os/signal"
 
+	"time"
 
+
 
+	"github.com/gin-gonic/gin"
 
+)
 
+
 
+func main() {
 
+	router := gin.Default()
 
+	router.GET("/", func(c *gin.Context) {
 
+		time.Sleep(5 * time.Second)
 
+		c.String(http.StatusOK, "Welcome Gin Server")
 
+	})
 
+
 
+	srv := &http.Server{
 
+		Addr:    ":8080",
 
+		Handler: router,
 
+	}
 
+
 
+	go func() {
 
+		// service connections
 
+		if err := srv.ListenAndServe(); err != nil {
 
+			log.Printf("listen: %s\n", err)
 
+		}
 
+	}()
 
+
 
+	// Wait for interrupt signal to gracefully shutdown the server with
 
+	// a timeout of 5 seconds.
 
+	quit := make(chan os.Signal)
 
+	signal.Notify(quit, os.Interrupt)
 
+	<-quit
 
+	log.Println("Shutdown Server ...")
 
+
 
+	ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
 
+	defer cancel()
 
+	if err := srv.Shutdown(ctx); err != nil {
 
+		log.Fatal("Server Shutdown:", err)
 
+	}
 
+	log.Println("Server exist")
 
+}

+ 14 - 14
gin_integration_test.go
Näytä tiedosto 

@@ -115,17 +115,17 @@ func TestWithHttptestWithAutoSelectedPort(t *testing.T) {
 
 	testRequest(t, ts.URL+"/example")
 
 	testRequest(t, ts.URL+"/example")
 
 }
 
 }
 
 
 
-func TestWithHttptestWithSpecifiedPort(t *testing.T) {
 
-	router := New()
 
-	router.GET("/example", func(c *Context) { c.String(http.StatusOK, "it worked") })
 
-
 
-	l, _ := net.Listen("tcp", ":8033")
 
-	ts := httptest.Server{
 
-		Listener: l,
 
-		Config:   &http.Server{Handler: router},
 
-	}
 
-	ts.Start()
 
-	defer ts.Close()
 
-
 
-	testRequest(t, "http://localhost:8033/example")
 
-}
 
+// func TestWithHttptestWithSpecifiedPort(t *testing.T) {
 
+// 	router := New()
 
+// 	router.GET("/example", func(c *Context) { c.String(http.StatusOK, "it worked") })
 
+
 
+// 	l, _ := net.Listen("tcp", ":8033")
 
+// 	ts := httptest.Server{
 
+// 		Listener: l,
 
+// 		Config:   &http.Server{Handler: router},
 
+// 	}
 
+// 	ts.Start()
 
+// 	defer ts.Close()
 
+
 
+// 	testRequest(t, "http://localhost:8033/example")
 
+// }