单 Server 多 Service

介绍

从 Kitex v0.8.0 开始，支持在单个 Server 上注册多个 Service 。

目前，该功能适用于：

• gRPC 传输协议，包括基于 HTTP2 的Thrift Streaming (也基于 gRPC) ( >= v0.8.0 )
• Kitex Thrift 和 Protobuf (non-streaming) ( >= v0.9.0 )

使用方法

客户端

如果要用 Kitex Client 请求 MultiService Server，请按照以下说明操作：

1. 将客户端升级到 Kitex 版本 >= v0.9.0
2. 对于 Kitex thrift 和 protobuf（non-streaming）的API:
   1. 使用 TTHeader 作为传输协议client.WithTransportProtocol(transport.TTHeader)
   2. 在客户端添加以下选项：client.WithMetaHandler(transmeta.ClientTTHeaderHandler)

服务器端

准备工作

请使用 Kitex 命令工具 ( >= v0.9.0 ) 为每个 Service 生成代码。更多详情，请参考代码生成工具。

（注：对于使用 gRPC 多服务功能的用户，从 v0.8.0 版本开始，服务注册方面的使用方法略有变化，请升级您的 Kitex 命令工具至 v0.9.0+。更多详情，请参阅“创建 Server 并在 Server 上注册您的 Service”部分。）

代码生成的结果如下所示：

kitex_gen
    |_ api
        |_ servicea
            |_ client.go
            |_ invoker.go
            |_ server.go
            |_ servicea.go
        |_ serviceb
            |_ client.go
            |_ invoker.go
            |_ server.go
            |_ serviceb.go
        |_ ...

您可以在每个 Service 的server.go中看到RegisterService函数。

func RegisterService(svr server.Server, handler XXX, opts ...server.RegisterOption) error {
   if err := svr.RegisterService(serviceInfo(), handler, opts...); err != nil {
      return err
   }
   return nil
}

创建 Server 并在 Server 上注册您的 Service

在 Server 上注册 Service 是一个简单的过程。

首先，创建一台 Server 。然后，通过在您生成的代码中调用RegisterService函数，即可注册 Service 。

可以在同一台 Server 上调用多个 Service ，根据需要注册任意多个 Service 。

package main

import (
   "github.com/cloudwego/kitex/pkg/server"

    servicea "your_servicea_kitex_gen_path"
    serviceb "your_serviceb_kitex_gen_path"
)

func main() {
    // 通过调用 server.NewServer 创建 Server
    svr := server.NewServer(your_server_option)
    // 在 Server 上注册多 Service
    err := servicea.RegisterService(svr, new(ServiceAImpl))
    err = serviceb.RegisterService(svr, new(ServiceBImpl))

    err = svr.Run()

    if err != nil {
       logs.Error("%s", err.Error())
    }
    logs.Stop()
}

备用 Service

假设 Service 之间有相同的命名方法。

// demo.thrift
namespace go api
struct Request {
1: string message
}

struct Response {
1: string message
}

service ServiceA {
Response sameNamedMethod(1: Request req)
}
service ServiceB {
Response sameNamedMethod(1: Request req)
}

在这种情况下，请注意，您需要指定一个 Service 作为备用 Service（Fallback Service）。

当客户端的设置没有满足客户端使用方法一节中的任何条件时，则通过 Fallback Service 以保持兼容性

如果未指定任何 Fallback Service 或指定了多个 Fallback Service ，则在 Server 启动时将返回错误。

请注意，您只能将一个 Service 指定为 Fallback Service 。

生成代码(server.go)中的RegisterService()有一个可选参数：server.RegisterOption。 如果传入server.WithFallback Service选项，则该 Service 将注册为 Fallback Service 。

func main() {
    // 通过调用 server.NewServer 创建 Server
    svr := server.NewServer(your_server_option)
    // 在 Server 上注册多 Service
    // servicea 将成为备用 Service
    servicea.RegisterService(svr, new(ServiceAImpl), server.WithFallbackService())
    serviceb.RegisterService(svr, new(ServiceBImpl))

    err := svr.Run()
    if err != nil {
        logs.Error("%s", err.Error())
    }
    logs.Stop()
}

另一种避免 Server 启动错误而不指定 Fallback Service 的方法是使用server.WithRefuseTrafficWithoutServiceName选项。

使用此选项，即使您没有为名称冲突的方法指定 Fallback Service ，启动 Server 时也不会返回错误。

但在使用此选项时，必须注意以下事项：

当server.WithRefuseTrafficWithoutServiceName选项启用后，如果客户端的设置没有满足客户端使用方法一节中的任何条件，则会出现错误消息：

no service name while the server has WithRefuseTrafficWithoutServiceName option enabled

如何不回退到备用 Service（不依赖方法名称来查找服务）

在某些情况下，虽然为服务之间具有相同名称的方法指定了 Fallback Service，但是客户端的请求可能期望调用与 Fallback Service 不同的服务。

在这种情况下，请确保客户端的设置满足客户端使用方法一节中的条件。

获取ServiceName和MethodName

• 服务名称

idlService, ok := kitexutil.GetIDLServiceName(ctx)

• 方法名称

method, ok := kitexutil.GetMethod(ctx)

中间件

一般来说和以前一样，只是在调用NewServer时需要添加选项:

options = append(options, server.WithMiddleware(yourMiddleware))
svr := server.NewServer(options...)

您可以使用前述方法来获得每个请求的 service/method，以便区分处理。

区分流式/非流式方法

确定请求是否具有流式处理底层协议的推荐方法是检查请求/响应参数的类型：

注意: Kitex 服务器支持对传入请求的协议探测，对于 gRPC/Protobuf Unary 方法，它同时接受 gRPC 请求和 KitexProtobuf(TTHeader + Pure Protobuf Payload) 请求, 因此 仅依靠 RPCInfo 中的方法名称可能并不准确。

客户端中间件示例

客户端 中间件应依赖于resp类型:

func clientMWForIdentifyStreamingRequests(next endpoint.Endpoint) endpoint.Endpoint {
    return func(ctx context.Context, req, resp interface{}) (err error) {
        if _, ok := resp.(*streaming.Result); ok {
            // it's a streaming request
            return next(ctx, req, resp)
        } else {
            // it's a non-streaming request
            return next(ctx, req, resp)
        }
    }
}

服务端中间件示例

服务端 中间件应依赖于req类型:

func serverMWForIdentifyStreamingRequests(next endpoint.Endpoint) endpoint.Endpoint {
    return func(ctx context.Context, req, resp interface{}) (err error) {
        if _, ok := req.(*streaming.Args); ok {
            // it's a streaming request
            return next(ctx, req, resp)
        } else {
            // it's a non-streaming request
            return next(ctx, req, resp)
        }
    }
}

常见问题解答

1.单 Server 多 Service 和 Combine Service 有什么区别？

• Combine Service（通过生成带有 -combine-service 标志的代码，将多个 Service 合并成一个统一的 Service 形成的 Service）
  • 所有 Service（Combine Service 和被合并的每个 Service）的代码都会生成。
  • Service 的所有方法名称必须是唯一的。
  • 一个 Server 上只能注册一个 Service (即 combine service）。 否则，您将收到一条错误消息，提示您“在注册 Combine Service 时只能注册一个 Service”。
• 单 Server 多 Service（即 Multiple Services，更推荐使用）
  • 每个 Service 的代码都会单独生成。
  • Service 之间的方法名称可以相同，但也有一些限制。请选一个解决方案：
    • 您需要为冲突的方法指定备用 Service（Fallback Service） 。
    • 创建 Server 时增加server.WithRefuseTrafficWithoutServiceName选项。 并请确保客户端的设置满足客户端使用方法一节中的条件。

2. Service 注册失败的原因？

可能的原因如下：

• 当您注册的 Service 之间具有相同名称的方法时，未指定备用 Service。请指定备用 Service 。
• 您正在尝试在 Server 上同时注册 Combine Service 和其他 Service 。 请注意，Combine Service 只能在 Server 上单独注册。如果您还想注册其他 Service ，则需要将这些 Service 合并到 Combine Service 中，或者在不使用 Combine Service 的情况下单独注册每个 Service 。