如何关闭所有grpc服务器流usign gracefulStop?

时间:2019-10-21 06:23:58

标签: go grpc grpc-go

我正在尝试停止所有从服务器端连接到流服务器的客户端。 实际上,我正在使用GracefulStop方法来优雅地处理它。

我正在等待通道上的os.Interrupt信号以执行gRPC的正常停止。但是当客户端连接时,它卡在server.GracefulStop()上。

func (s *Service) Subscribe(_ *empty.Empty, srv clientapi.ClientApi_SubscribeServer) error {
    ctx := srv.Context()

    updateCh := make(chan *clientapi.Update, 100)
    stopCh := make(chan bool)
    defer func() {
        stopCh<-true
        close(updateCh)
    }

    go func() {
        ticker := time.NewTicker(1 * time.Second)
        defer func() {
            ticker.Stop()
            close(stopCh)
        }
        for {
            select {
            case <-stopCh:
                return
            case <-ticker.C:
                updateCh<- &clientapi.Update{Name: "notification": Payload: "sample notification every 1 second"}
            }
        }
    }()

    for {
        select {
        case <-ctx.Done():
            return ctx.Err()

        case notif := <-updateCh:
            err := srv.Send(notif)
            if err == io.EOF {
                return nil
            }

            if err != nil {
                s.logger.Named("Subscribe").Error("error", zap.Error(err))
                continue
            }
        }
    }
}

我希望方法context中的ctx.Done()可以处理它并中断for循环。 如何关闭像这样的所有响应流?

2 个答案:

答案 0 :(得分:2)

为您的gRPC服务创建一个 global context。因此,遍历各个部分:

  • 每个gRPC服务请求都将使用此上下文(以及客户端上下文)来满足该请求
  • os.Interrupt处理程序将取消全局上下文;从而取消任何当前正在运行的请求
  • 最后发出server.GracefulStop()-应该等待所有活动的gRPC调用结束(如果他们没有立即看到取消消息)

例如,在设置gRPC服务时:

pctx := context.Background()
globalCtx, globalCancel := context.WithCancel(pctx)

mysrv := MyService{
    gctx: globalCtx
}

s := grpc.NewServer()
pb.RegisterMyService(s, mysrv)

os.Interrupt处理程序启动并等待关闭:

globalCancel()
server.GracefulStop()

gRPC方法:

func(s *MyService) SomeRpcMethod(ctx context.Context, req *pb.Request) error {

    // merge client and server contexts into one `mctx`
    // (client context will cancel if client disconnects)
    // (server context will cancel if service Ctrl-C'ed)

    mctx, mcancel := mergeContext(ctx, s.gctx)

    defer mcancel() // so we don't leak, if neither client or server context cancels

    // RPC WORK GOES HERE
    // RPC WORK GOES HERE
    // RPC WORK GOES HERE

    // pass mctx to any blocking calls:
    // - http REST calls
    // - SQL queries etc.
    // - or if running a long loop; status check the context occasionally like so:

    // Example long request (10s)
    for i:=0; i<10*1000; i++ {
        time.Sleep(1*time.Milliscond)

        // poll merged context
        select {
            case <-mctx.Done():
                return fmt.Errorf("request canceled: %s", mctx.Err())
            default:
        }
    }
}

并且:

func mergeContext(a, b context.Context) (context.Context, context.CancelFunc) {
    mctx, mcancel := context.WithCancel(a) // will cancel if `a` cancels

    go func() {
        select {
        case <-mctx.Done(): // don't leak go-routine on clean gRPC run
        case <-b.Done():
            mcancel() // b canceled, so cancel mctx 
        }
    }()

    return mctx, mcancel
}

答案 1 :(得分:1)

通常,客户端需要假设RPC可以随时终止(例如由于连接错误或服务器电源故障)。因此,我们要做的是GracefulStop,睡眠一小段时间,以使进行中的RPC有机会自然完成,然后对服务器进行硬Stop。如果确实需要使用此终止信号来结束RPC,则@colminator的答案可能是最佳选择。但是这种情况并不常见,如果您发现有必要在服务器关闭时手动结束流式RPC,则可能需要花一些时间来分析设计。