微服务完整特性及相关组件从v2.4版本开始提供。

基本介绍

GoFrame框架支持微服务模式开发，提供了常用的微服务组件、开发工具、开发教程帮助团队快速微服务转型。

简单示例

GoFrame微服务组件的低藕及通用化设计的，组件化使用支持大部分的微服务通信协议。在官方文档中，我们以HTTP及GRPC协议为示例，介绍微服务的开发以及组件工具的使用。由于HTTP Web开发已经有比较丰富完善的独立章节介绍，因此微服务章节大部分介绍以GRPC为主。

HTTP微服务示例

https://github.com/gogf/gf/tree/master/example/registry/file

server.go

  1. package main
  3. import (
  4.     "github.com/gogf/gf/contrib/registry/file/v2"
  5.     "github.com/gogf/gf/v2/frame/g"
  6.     "github.com/gogf/gf/v2/net/ghttp"
  7.     "github.com/gogf/gf/v2/net/gsvc"
  8.     "github.com/gogf/gf/v2/os/gfile"
  9. )
  11. func main() {
  12.     gsvc.SetRegistry(file.New(gfile.Temp("gsvc")))
  14.     s := g.Server(`hello.svc`)
  15.     s.BindHandler("/", func(r *ghttp.Request) {
  16.         g.Log().Info(r.Context(), `request received`)
  17.         r.Response.Write(`Hello world`)
  18.     })
  19.     s.Run()
  20. }

可以看到，一个HTTP的微服务端和一个普通的Web Server端没什么差异，但是顶部多了一行代码：

  1. gsvc.SetRegistry(file.New(gfile.Temp("gsvc")))

这行代码用于启用并注册当前服务使用的注册发现组件，在该示例中使用的file.New(gfile.Temp("gsvc"))是基于本地系统文件的服务注册发现组件，其中的gfile.Temp("gsvc")指定的是存放服务文件的路径，例如在Linux/MacOS系统下，指向的是/tmp/gsvc目录。基于文件系统的注册发现仅用于本地微服务示例，不能用于跨节点通信。在生产环境时，我们往往会使用其他的服务注册发现组件，例如 etcd, polaris, zookeeper等，框架的社区组件中已经提供了常用的服务注册发现组件的实现。

其次，在该示例中，我们给Server设置了一个名字hello.svc，该名字表示该Server绑定的微服务的名称，服务名称作为微服务的唯一标识，用于服务间的识别通信。当服务注册组件注册启用时，HTTP Server在运行时将会把自己的访问地址注册到服务注册组件中，方便其他服务通过相同组件按照服务名称进行访问。

client.go

  1. package main
  3. import (
  4.     "time"
  6.     "github.com/gogf/gf/contrib/registry/file/v2"
  7.     "github.com/gogf/gf/v2/frame/g"
  8.     "github.com/gogf/gf/v2/net/gsvc"
  9.     "github.com/gogf/gf/v2/os/gctx"
  10.     "github.com/gogf/gf/v2/os/gfile"
  11. )
  13. func main() {
  14.     gsvc.SetRegistry(file.New(gfile.Temp("gsvc")))
  16.     client := g.Client()
  17.     for i := 0; i < 10; i++ {
  18.         ctx := gctx.New()
  19.         res, err := client.Get(ctx, `http://hello.svc/`)
  20.         if err != nil {
  21.             panic(err)
  22.         }
  23.         g.Log().Debug(ctx, res.ReadAllString())
  24.         res.Close()
  25.         time.Sleep(time.Second)
  26.     }
  27. }

客户端通过g.Client()创建一个HTTP Client，并通过http://hello.svc/地址访问服务端，其中的hello.svc即先前的Server端绑定的微服务名称。当客户端通过微服务名称访问的时候，服务注册发现组件将会在底层进行检索，并找到对应的服务端地址进行通信。

执行结果

先执行server.go服务端运行一个简单的服务，随后再执行client.go通过服务名称请求服务。

执行后，客户端输出：

  1. $ go run client.go  
  2. 2023-03-14 20:22:10.006 [DEBU] {8054f3a48c484c1760fb416bb3df20a4} Hello world
  3. 2023-03-14 20:22:11.007 [DEBU] {6831cae08c484c1761fb416b9d4df851} Hello world
  4. 2023-03-14 20:22:12.008 [DEBU] {9035761c8d484c1762fb416b1e648b81} Hello world
  5. 2023-03-14 20:22:13.011 [DEBU] {a05a32588d484c1763fb416bc19ff667} Hello world
  6. 2023-03-14 20:22:14.012 [DEBU] {40fdea938d484c1764fb416b8459fc43} Hello world
  7. 2023-03-14 20:22:15.014 [DEBU] {686c9acf8d484c1765fb416b3697d369} Hello world
  8. 2023-03-14 20:22:16.015 [DEBU] {906a470b8e484c1766fb416b85b9867e} Hello world
  9. 2023-03-14 20:22:17.017 [DEBU] {28c7fd468e484c1767fb416b86e5557f} Hello world
  10. 2023-03-14 20:22:18.018 [DEBU] {90d2ad828e484c1768fb416bfcde738f} Hello world
  11. 2023-03-14 20:22:19.019 [DEBU] {d05559be8e484c1769fb416baad06f23} Hello world

服务端输出：

  1. $ go run server.go  
  2. 2023-03-14 20:20:06.364 [INFO] pid[96421]: http server started listening on [:61589]
  3. 2023-03-14 20:20:06.364 [INFO] openapi specification is disabled
  4. 2023-03-14 20:20:06.364 [DEBU] service register: &{Head: Deployment: Namespace: Name:hello.svc Version: Endpoints:10.35.12.81:61589 Metadata:map[insecure:true protocol:http]}
  6.    SERVER   | DOMAIN  | ADDRESS | METHOD | ROUTE |                             HANDLER                             |    MIDDLEWARE      
  7. ------------|---------|---------|--------|-------|-----------------------------------------------------------------|--------------------
  8.   hello.svc | default | :61589  | ALL    | /     | main.main.func1                                                 |                    
  9. ------------|---------|---------|--------|-------|-----------------------------------------------------------------|--------------------
  10.   hello.svc | default | :61589  | ALL    | /*    | github.com/gogf/gf/v2/net/ghttp.internalMiddlewareServerTracing | GLOBAL MIDDLEWARE  
  11. ------------|---------|---------|--------|-------|-----------------------------------------------------------------|--------------------
  13. 2023-03-14 20:22:10.006 [INFO] {8054f3a48c484c1760fb416bb3df20a4} request received
  14. 2023-03-14 20:22:11.007 [INFO] {6831cae08c484c1761fb416b9d4df851} request received
  15. 2023-03-14 20:22:12.008 [INFO] {9035761c8d484c1762fb416b1e648b81} request received
  16. 2023-03-14 20:22:13.010 [INFO] {a05a32588d484c1763fb416bc19ff667} request received
  17. 2023-03-14 20:22:14.012 [INFO] {40fdea938d484c1764fb416b8459fc43} request received
  18. 2023-03-14 20:22:15.013 [INFO] {686c9acf8d484c1765fb416b3697d369} request received
  19. 2023-03-14 20:22:16.015 [INFO] {906a470b8e484c1766fb416b85b9867e} request received
  20. 2023-03-14 20:22:17.016 [INFO] {28c7fd468e484c1767fb416b86e5557f} request received
  21. 2023-03-14 20:22:18.017 [INFO] {90d2ad828e484c1768fb416bfcde738f} request received
  22. 2023-03-14 20:22:19.019 [INFO] {d05559be8e484c1769fb416baad06f23} request received

GRPC微服务示例

https://github.com/gogf/gf/tree/master/example/rpc/grpcx/basic

helloworld.proto

grpc和http协议比较大的差异在于grpc需要通过protobuf来实现API接口以及数据结构的定义。

  1. syntax = "proto3";
  3. package protobuf;
  5. option go_package = "github.com/gogf/gf/grpc/example/helloworld/protobuf";
  8. // The greeting service definition.
  9. service Greeter {
  10.   // Sends a greeting
  11.   rpc SayHello (HelloRequest) returns (HelloReply) {}
  12. }
  14. // The request message containing the user's name.
  15. message HelloRequest {
  16.   string name = 1;
  17. }
  19. // The response message containing the greetings
  20. message HelloReply {
  21.   string message = 1;
  22. }

以上protobuf文件通过以下命令执行编译（请提前安装protoc工具）：

  1. gf gen pb

将会生成对应的proto go数据结构文件以及grpc接口文件：

  1. helloworld.pb.go
  2. helloworld_grpc.pb.go

controller.go

控制器用于实现proto中定义的接口方法（如果使用框架标准化工程目录结构，该控制器代码文件也是由框架的gf gen pb工具自动生成，开发者进需要填充对应方法的具体实现即可）：

  1. type Controller struct {
  2.     protobuf.UnimplementedGreeterServer
  3. }
  5. func Register(s *grpcx.GrpcServer) {
  6.     protobuf.RegisterGreeterServer(s.Server, &Controller{})
  7. }
  9. // SayHello implements helloworld.GreeterServer
  10. func (s *Controller) SayHello(ctx context.Context, in *protobuf.HelloRequest) (*protobuf.HelloReply, error) {
  11.     return &protobuf.HelloReply{Message: "Hello " + in.GetName()}, nil
  12. }

config.yaml

服务端配置文件，在该配置文件中指定了该服务的名称为demo。微服务的名称用于服务间通信的唯一识别标识。在不显式配置服务端的监听端口时，服务端将会随机监听可用的本地端口。在微服务模式下，由于使用服务名称进行通信，服务端口往往不需要显式指定，随机监听即可。

  1. grpc:
  2.   name:            "demo"
  3.   logPath:          "./log"
  4.   logStdout:        true
  5.   errorLogEnabled:  true
  6.   accessLogEnabled: true
  7.   errorStack:       true

server.go

grpc服务端，在不显式指定服务端使用的服务注册发现组件时，服务端默认使用系统文件注册发现组件，该组件仅用于单机测试。其中的controller.Register即调用我们通过工具生成的控制器注册方法将具体的接口实现注册到服务端中。

  1. package main
  3. import (
  4.     "github.com/gogf/gf/contrib/rpc/grpcx/v2"
  5.     "github.com/gogf/gf/example/rpc/grpcx/basic/controller"
  6. )
  8. func main() {
  9.     s := grpcx.Server.New()
  10.     controller.Register(s)
  11.     s.Run()
  12. }

client.go

grpc客户端，在创建连接时需要给定服务端服务的具体名称。这里的服务端服务名称为demo，指定的是上面提到的微服务名称。在不显式指定客户端使用的服务注册发现组件时，客户端默认使用系统文件注册发现组件，该组件仅用于单机测试。

  1. package main
  3. import (
  4.     "github.com/gogf/gf/contrib/rpc/grpcx/v2"
  5.     "github.com/gogf/gf/example/rpc/grpcx/basic/protobuf"
  6.     "github.com/gogf/gf/v2/frame/g"
  7.     "github.com/gogf/gf/v2/os/gctx"
  8. )
  10. func main() {
  11.     var (
  12.         ctx    = gctx.New()
  13.         conn   = grpcx.Client.MustNewGrpcClientConn("demo")
  14.         client = protobuf.NewGreeterClient(conn)
  15.     )
  16.     res, err := client.SayHello(ctx, &protobuf.HelloRequest{Name: "World"})
  17.     if err != nil {
  18.         g.Log().Error(ctx, err)
  19.         return
  20.     }
  21.     g.Log().Debug(ctx, "Response:", res.Message)
  22. }

执行结果

服务端输出：可以看到，服务端输出了一下DEBU调试信息，用于显示一些服务注册的细节。同时，由于没有显式指定服务端的监听端口，这里随机监听了本地端口64517。

  1. $ go run server.go  
  2. 2023-03-14 20:50:58.465 [DEBU] set default registry using file registry as no custom registry set
  3. 2023-03-14 20:50:58.466 [DEBU] service register: &{Head: Deployment: Namespace: Name:demo Version: Endpoints:10.35.12.81:64517 Metadata:map[protocol:grpc]}
  4. 2023-03-14 20:50:58.466 [INFO] pid[98982]: grpc server started listening on [:64517]
  5. 2023-03-14 20:52:37.059 {9898c809364a4c17da79e47f3e6c3b8f} /protobuf.Greeter/SayHello, 0.003ms, name:"World", message:"Hello World"

客户端输出：客户端通过微服务名称访问，并接收到了服务端的返回。注意客户端的日志和服务端的日志中，链路跟踪的TraceID是相同的（9898c809364a4c17da79e47f3e6c3b8f），表示同一个请求产生的日志。GoFrame的微服务特性默认开启了链路跟踪能力。

  1. $ go run client.go  
  2. 2023-03-14 20:52:37.060 [DEBU] {9898c809364a4c17da79e47f3e6c3b8f} Response: Hello World

相关文档