Skip to content

Commit d75ce1a

Browse files
committed
✨registerServers and registerCloses is outdated and no use anymore, please update the README.md with real code
1 parent 063b8f6 commit d75ce1a

File tree

1 file changed

+23
-22
lines changed

1 file changed

+23
-22
lines changed

pkg/app/README.md

Lines changed: 23 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,10 @@ import "github.com/go-dev-frame/sponge/pkg/app"
1111

1212
func main() {
1313
initApp()
14-
servers := registerServers()
15-
closes := registerCloses(servers)
14+
services := CreateServices()
15+
closes := Close(services)
1616

17-
a := app.New(servers, closes)
17+
a := app.New(services, closes)
1818
a.Run()
1919
}
2020

@@ -28,39 +28,40 @@ func initApp() {
2828
// ......
2929
}
3030

31-
func registerServers() []app.IServer {
31+
func CreateServices() []app.IServer {
3232
var servers []app.IServer
3333

34-
// create a http service
35-
servers = append(servers, server.NewHTTPServer(
34+
// create an HTTP service
35+
httpAddr := ":8080" // or get from configuration
36+
httpServer := server.NewHTTPServer(
37+
httpAddr,
38+
server.WithHTTPIsProd(true), // run in release mode
39+
)
40+
servers = append(servers, httpServer)
3641

37-
))
38-
39-
// create a grpc service
40-
servers = append(servers, server.NewGRPCServer(
41-
42-
))
43-
44-
// ......
42+
// create a gRPC service (optional)
43+
// grpcServer := server.NewGRPCServer(
44+
//
45+
// )
46+
// servers = append(servers, grpcServer)
4547

4648
return servers
4749
}
4850

49-
func registerCloses(servers []app.IServer) []app.Close {
51+
func Close(servers []app.IServer) []app.Close {
5052
var closes []app.Close
5153

52-
// close server
53-
for _, server := range servers {
54-
closes = append(closes, server.Stop)
54+
// close servers
55+
for _, s := range servers {
56+
closes = append(closes, s.Stop)
5557
}
5658

57-
// close other resource
59+
// close other resources (database, logger, tracing, etc.)
5860
closes = append(closes, func() error {
59-
61+
// TODO: call db.Close()
62+
return nil
6063
})
6164

62-
// ......
63-
6465
return closes
6566
}
6667
```

0 commit comments

Comments
 (0)