前言

在 go-zero 社区里,常常会有同学问,把 API gatewayRPC service 放在同一个过程内可不可以?怎么弄?有时也会有同学把对外服务和生产队列放在一个过程内。咱们权且不说此种用法正当与否,因为各个公司的业务场景和开发模式的差别,咱们就只来看看此类问题怎么解比拟优雅。

问题举例

咱们用两个 HTTP 服务来举例,咱们有这样两个服务,须要启动在一个过程内的两个不同端口。代码如下:

package mainimport (  "fmt"  "net/http")func morning(w http.ResponseWriter, req *http.Request) {  fmt.Fprintln(w, "morning!")}func evening(w http.ResponseWriter, req *http.Request) {  fmt.Fprintln(w, "evening!")}type Morning struct{}func (m Morning) Start() {  http.HandleFunc("/morning", morning)  http.ListenAndServe("localhost:8080", nil)}func (m Morning) Stop() {  fmt.Println("Stop morning service...")}type Evening struct{}func (e Evening) Start() {  http.HandleFunc("/evening", evening)  http.ListenAndServe("localhost:8081", nil)}func (e Evening) Stop() {  fmt.Println("Stop evening service...")}func main() {  // todo: start both services here}

代码是足够简略的,就是有申请 morning 接口,服务返回 morning!,申请 evening 接口,服务返回 evening 。让咱们来尝试实现一下~

第一次尝试

启动两个服务,不就是把两个服务在 main 里都启动一下吗?咱们来试试

func main() {  var morning Morning  morning.Start()  defer morning.Stop()  var evening Evening  evening.Start()  defer evening.Stop()}

启动完,咱们用 curl 来验证一下

$ curl -i http://localhost:8080/morningHTTP/1.1 200 OKDate: Mon, 18 Apr 2022 02:10:34 GMTContent-Length: 9Content-Type: text/plain; charset=utf-8morning!$ curl -i http://localhost:8081/eveningcurl: (7) Failed to connect to localhost port 8081 after 4 ms: Connection refused

为什么只有 morning 胜利,而 evening 无奈申请呢?

咱们在 main 外面加上打印语句试试

func main() {  fmt.Println("Start morning service...")  var morning Morning  morning.Start()  defer morning.Stop()  fmt.Println("Start evening service...")  var evening Evening  evening.Start()  defer evening.Stop()}

重新启动

$ go run main.goStart morning service...

发现只打印了 Start morning service…,原来 evening 服务压根没有启动。究其原因,是因为 morning.Start() 阻塞了以后 goroutine,后续代码就得不到执行了。

第二次尝试

这时,WaitGroup 就能够派上用场了。WaitGroup 顾名思义,就是用来 wait 一组操作,期待它们告诉能够持续。让咱们来尝试一下。

func main() {  var wg sync.WaitGroup  wg.Add(2)  go func() {    defer wg.Done()    fmt.Println("Start morning service...")    var morning Morning    defer morning.Stop()    morning.Start()  }()  go func() {    defer wg.Done()    fmt.Println("Start evening service...")    var evening Evening    defer evening.Stop()    evening.Start()  }()  wg.Wait()}

启动试试

$ go run main.goStart evening service...Start morning service...

好,两个服务都起来了,咱们用 curl 验证一下

$ curl -i http://localhost:8080/morningHTTP/1.1 200 OKDate: Mon, 18 Apr 2022 02:28:33 GMTContent-Length: 9Content-Type: text/plain; charset=utf-8morning!$ curl -i http://localhost:8081/eveningHTTP/1.1 200 OKDate: Mon, 18 Apr 2022 02:28:36 GMTContent-Length: 9Content-Type: text/plain; charset=utf-8evening!

的确都能够了,咱们看到咱们应用 WaitGroup 的流程是

  1. 记得咱们有几个须要 wait 的服务
  2. 一个一个增加服务
  3. 期待所有服务完结

让咱们看看 go-zero 是怎么做的~

第三次尝试

go-zero 里,咱们提供了一个 ServiceGroup 工具,方便管理多个服务的启动和进行。让咱们看看带入咱们的场景是怎么做的。

import "github.com/zeromicro/go-zero/core/service"// more codefunc main() {  group := service.NewServiceGroup()  defer group.Stop()  group.Add(Morning{})  group.Add(Evening{})  group.Start()}

能够看到,代码的可读性好了很多,并且咱们也不会不小心算错该给 WaitGroup 加几了。并且 ServiceGroup 还保障了后启动的服务先 Stop,跟 defer 成果统一,这样的行为便于资源的清理。

ServiceGroup 不光只是治理了每个服务的 Start/Stop,同时也提供了 graceful shutdown,当收到 SIGTERM 信号的时候会被动调用每个服务的 Stop 办法,对于 HTTP 服务,能够通过 server.Shutdown 来优雅退出,对于 gRPC 服务来说,能够通过 server.GracefulStop() 来优雅退出。

总结

ServiceGroup 的实现其实也是比较简单的,代码一共82行。

$ cloc core/service/servicegroup.go------------------------------------------------------------------Language        files          blank        comment           code------------------------------------------------------------------Go                 1             22             14             82------------------------------------------------------------------

尽管代码短小精悍,然而在 go-zero 里却每个服务(Restful, RPC, MQ)根本都是通过 ServiceGroup 来治理的,能够说十分不便,代码值得一读。

我的项目地址

https://github.com/zeromicro/go-zero

欢送应用 go-zerostar 反对咱们!

微信交换群

关注『微服务实际』公众号并点击 交换群 获取社区群二维码。