详解 gRPC 客户端长连接机制实现

时间：2025-02-24 10:25:46

本文作者：

熊喵君，原文链接：/2020/09/01/GRPC-CLIENT-CONN-LASTING/

转载

Go语言中文网 公众号 Golang爱好者社区，这里有精选的网站上数千篇优秀文章供你学习，内容涵盖Golang基础系列教程、实战教程等优秀开源项目实践，同时会分享职场经验。每周获取Golang一周资讯等值得关注的内容

0x00 前言

HTTP2 是一个全双工的流式协议, 服务端也可以主动 ping 客户端, 且服务端还会有一些检测连接可用性和控制客户端 ping 包频率的配置。gRPC 就是采用 HTTP2 来作为其基础通信模式的，所以默认的 gRPC 客户端都是长连接。 有这么一种场景，需要客户端和服务端保持持久的长连接，即无论服务端、客户端异常断开或重启，长连接都要具备重试保活（当然前提是两方重启都成功）的需求。在 gRPC 中，对于已经建立的长连接，服务端异常重启之后，客户端一般会收到如下错误：

rpc error: code = Unavailable desc = transport is closing

大部分的 gRPC 客户端封装都没有很好的处理这类 case，参见 Warden 关于 Server 端服务重启后 Client 连接断开之后的重试问题[1]，对于这种错误，推荐有两种处理方法：

  1. 重试：在客户端调用失败时，选择以指数退避（Exponential Backoff ）来优雅进行重试
  2. 增加 keepalive 的保活策略
  3. 增加重连（auto reconnect）策略

这篇文章就来分析下如何实现这样的客户端保活（keepalive）逻辑。提到保活机制，我们先看下 gRPC 的 keepalive 机制[2]。 0x01 HTTP2 的 GOAWAY 帧 HTTP2 使用 GOAWAY 帧信号来控制连接关闭，GOAWAY 用于启动连接关闭或发出严重错误状态信号。GOAWAY 语义为允许端点正常停止接受新的流，同时仍然完成对先前建立的流的处理，当 client 收到这个包之后就会主动关闭连接。下次需要发送数据时，就会重新建立连接。GOAWAY 是实现 机制的重要保证。

gRPC 客户端 keepalive

gRPC 客户端提供 keepalive 配置如下：

var kacp = {
 Time:                10 * , // send pings every 10 seconds if there is no activity
 Timeout:             ,      // wait 1 second for ping ack before considering the connection dead
 PermitWithoutStream: true,             // send pings even without active streams
}
//Dial 中传入 keepalive 配置
conn, err := (*addr, (), (kacp))

参数的含义如下:

  • Time：如果没有 activity， 则每隔 10s 发送一个 ping 包
  • Timeout：如果 ping ack 1s 之内未返回则认为连接已断开
  • PermitWithoutStream：如果没有 active 的 stream， 是否允许发送 ping 联想到，在项目中 ssh 客户端[3] 和 mysql 客户端中都有着类似的实现，即单独开启协程来实现 keepalive：如下面的代码（以 ssh 为例）： 
go func() {
    t := (2 * )
    defer ()
    for range  {
        _, _, err := ("keepalive@", true, nil)
        if err != nil {
            return
        }
    }
}()

gPRC 的实现

在 grpc-go 的 newHTTP2Client[4] 方法中，有下面的逻辑：即在新建一个 HTTP2Client 的时候会启动一个 goroutine 来处理 keepalive

// newHTTP2Client constructs a connected ClientTransport to addr based on HTTP2
// and starts to receive messages on it. Non-nil error returns if construction
// fails.
func newHTTP2Client(connectCtx, ctx , addr , opts ConnectOptions, onPrefaceReceipt func(), onGoAway func(GoAwayReason), onClose func()) (_ *http2Client, err error) {
    ...
 if  {
   = (&)
  go ()
    }
    ...
}

接下来，看下 keepalive 方法[5] 的实现：

func (t *http2Client) keepalive() {
 p := &ping{data: [8]byte{}} //ping 的内容
 timer := () // 启动一个定时器, 触发时间为配置的 Time 值
 //for loop
 for {
  select {
  // 定时器触发
  case <-:
   if atomic.CompareAndSwapUint32(&, 1, 0) {
    ()
    continue
   }
   // Check if keepalive should go dormant.
   ()
   if len() < 1 && ! {
    // Make awakenKeepalive writable.
    <-
    ()
    select {
    case <-:
     // If the control gets here a ping has been sent
     // need to reset the timer with .
    case <-():
     return
    }
   } else {
    ()
    if channelz.IsOn() {
     atomic.AddInt64(&, 1)
    }
    // Send ping.
    (p)
   }

   // By the time control gets here a ping has been sent one way or the other.
   ()
   select {
   case <-:
    if atomic.CompareAndSwapUint32(&, 1, 0) {
     ()
     continue
    }
    ()
    return
   case <-():
    if !timer.Stop() {
     <-
    }
    return
   }
  // 上层通知 context 结束
  case <-():
   if !timer.Stop() {
    // 返回 false，表示 timer 未被销毁
    <-
   }
   return
  }
 }
}

从客户端的 keepalive 实现中梳理下执行逻辑：

  1. 填充 ping 包内容, 为 [8]byte{}，创建定时器, 触发时间为用户配置中的 Time
  2. 循环处理，select 的两大分支，一为定时器触发后执行的逻辑，另一分支为 ()，即 keepalive 的上层应用调用了 cancel 结束 context 子树
  3. 核心逻辑在定时器触发的过程中

gRPC 服务端的 keepalive

gRPC 的服务端主要有两块逻辑： 接收并相应客户端的 ping 包 单独启动 goroutine 探测客户端是否存活 gRPC 服务端提供 keepalive 配置，分为两部分 和 ，如下：

var kaep = {
 MinTime:             5 * , // If a client pings more than once every 5 seconds, terminate the connection
 PermitWithoutStream: true,            // Allow pings even when there are no active streams
}

var kasp = {
 MaxConnectionIdle:     15 * , // If a client is idle for 15 seconds, send a GOAWAY
 MaxConnectionAge:      30 * , // If any connection is alive for more than 30 seconds, send a GOAWAY
 MaxConnectionAgeGrace: 5 * ,  // Allow 5 seconds for pending RPCs to complete before forcibly closing connections
 Time:                  5 * ,  // Ping the client if it is idle for 5 seconds to ensure the connection is still active
 Timeout:               1 * ,  // Wait 1 second for the ping ack before assuming the connection is dead
}

func main(){
 ...
 s := ((kaep), (kasp))
 ...
}

：

  • MinTime：如果客户端两次 ping 的间隔小于 5s，则关闭连接
  • PermitWithoutStream：即使没有 active stream, 也允许 ping ：
  • MaxConnectionIdle：如果一个 client 空闲超过 15s, 发送一个 GOAWAY, 为了防止同一时间发送大量 GOAWAY, 会在 15s 时间间隔上下浮动 15*10%, 即 15+1.5 或者 15-1.5
  • MaxConnectionAge：如果任意连接存活时间超过 30s, 发送一个 GOAWAY
  • MaxConnectionAgeGrace：在强制关闭连接之间, 允许有 5s 的时间完成 pending 的 rpc 请求
  • Time：如果一个 client 空闲超过 5s, 则发送一个 ping 请求
  • Timeout：如果 ping 请求 1s 内未收到回复, 则认为该连接已断开

gRPC 的实现

服务端处理客户端的 ping 包的 response 的逻辑在 handlePing 方法[6] 中。handlePing 方法会判断是否违反两条 policy, 如果违反则将 pingStrikes++, 当违反次数大于 maxPingStrikes(2) 时, 打印一条错误日志并且发送一个 goAway 包，断开这个连接，具体实现如下：

func (t *http2Server) handlePing(f *) {
 if f.IsAck() {
  if  ==  &&  != nil {
   close()
   return
  }
  // Maybe it's a BDP ping.
  if  != nil {
   ()
  }
  return
 }
 pingAck := &ping{ack: true}
 copy([:], [:])
 (pingAck)

 now := ()
 defer func() {
   = now
 }()
 // A reset ping strikes means that we don't need to check for policy
 // violation for this ping and the pingStrikes counter should be set
 // to 0.
 if atomic.CompareAndSwapUint32(&, 1, 0) {
   = 0
  return
 }
 ()
 ns := len()
 ()
 if ns < 1 && ! {
  // Keepalive shouldn't be active thus, this new ping should
  // have come after at least defaultPingTimeout.
  if (defaultPingTimeout).After(now) {
   ++
  }
 } else {
  // Check if keepalive policy is respected.
  if ().After(now) {
   ++
  }
 }

 if  > maxPingStrikes {
  // Send goaway and close the connection.
  if (logLevel) {
   ("transport: Got too many pings from the client, closing the connection.")
  }
  (&goAway{code: , debugData: []byte("too_many_pings"), closeConn: true})
 }
}

注意，对 pingStrikes 累加的逻辑：

  • (defaultPingTimeout).After(now)：
  • ().After(now)： 
func (t *http2Server) handlePing(f *) {
 ...
 if ns < 1 && ! {
  // Keepalive shouldn't be active thus, this new ping should
  // have come after at least defaultPingTimeout.
  if (defaultPingTimeout).After(now) {
   ++
  }
 } else {
  // Check if keepalive policy is respected.
  if ().After(now) {
   ++
  }
 }
 if  > maxPingStrikes {
  // Send goaway and close the connection.
  errorf("transport: Got too many pings from the client, closing the connection.")
  (&goAway{code: , debugData: []byte("too_many_pings"), closeConn: true})
 }
}

keepalive 相关代码

gRPC 服务端新建一个 HTTP2 server 的时候会启动一个单独的 goroutine 处理 keepalive 逻辑，newHTTP2Server 方法[7]：

func newHTTP2Server(conn , config *ServerConfig) (_ ServerTransport, err error) {
 ...
 go ()
 ...
}

简单分析下 keepalive 的实现，核心逻辑是启动 3 个定时器，分别为 maxIdle、maxAge 和 keepAlive，然后在 for select 中处理相关定时器触发事件：

  • maxIdle 逻辑：判断 client 空闲时间是否超出配置的时间, 如果超时, 则调用 , 该方法会发送一个 GOAWAY 包 maxAge 逻辑：触发之后首先调用 发送 GOAWAY 包, 接着重置定时器, 时间设置为 MaxConnectionAgeGrace, 再次触发后调用 () 直接关闭（有些 graceful 的意味）
  • keepalive 逻辑：首先判断 activity 是否为 1, 如果不是则置 pingSent 为 true, 并且发送 ping 包, 接着重置定时器时间为 Timeout, 再次触发后如果 activity 不为 1（即未收到 ping 的回复） 并且 pingSent 为 true, 则调用 () 关闭连接 
func (t *http2Server) keepalive() {
 p := &ping{}
 var pingSent bool
 maxIdle := ()
 maxAge := ()
 keepalive := ()
 // NOTE: All exit paths of this function should reset their
 // respective timers. A failure to do so will cause the
 // following clean-up to deadlock and eventually leak.
 defer func() {
  // 退出前，完成定时器的回收工作
  if !maxIdle.Stop() {
   <-
  }
  if !maxAge.Stop() {
   <-
  }
  if !keepalive.Stop() {
   <-
  }
 }()
 for {
  select {
  case <-:
   ()
   idle := 
   if idle.IsZero() { // The connection is non-idle.
    ()
    ()
    continue
   }
   val :=  - (idle)
   ()
   if val <= 0 {
    // The connection has been idle for a duration of  or more.
    // Gracefully close the connection.
    (, []byte{})
    // Resetting the timer so that the clean-up doesn't deadlock.
    (infinity)
    return
   }
   (val)
  case <-:
   (, []byte{})
   ()
   select {
   case <-:
    // Close the connection after grace period.
    ()
    // Resetting the timer so that the clean-up doesn't deadlock.
    (infinity)
   case <-():
   }
   return
  case <-:
   if atomic.CompareAndSwapUint32(&, 1, 0) {
    pingSent = false
    ()
    continue
   }
   if pingSent {
    ()
    // Resetting the timer so that the clean-up doesn't deadlock.
    (infinity)
    return
   }
   pingSent = true
   if () {
    atomic.AddInt64(&, 1)
   }
   (p)
   ()
  case <-():
   return
  }
 }
}

实现健壮的长连接客户端

参考资料 [1] Warden 关于 Server 端服务重启后 Client 连接断开之后的重试问题: /go-kratos/kratos/issues/177

[2] keepalive 机制: /grpc/grpc/blob/master/doc/

[3] ssh 客户端: /2019/10/20/HOW-TO-BUILD-A-SSHD-WITH-GOLANG/#客户端-keepalive-机制

[4] newHTTP2Client: /grpc/grpc-go/blob/master/internal/transport/http2_client.go#L166

[5] keepalive 方法: /grpc/grpc-go/blob/master/internal/transport/http2_client.go#L1350

[6] handlePing 方法: /grpc/grpc-go/blob/master/internal/transport/http2_server.go#L693

[7] newHTTP2Server 方法: /grpc/grpc-go/blob/master/internal/transport/http2_server.go#L129

[8] 服务端: /grpc/grpc-go/blob/master/examples/features/keepalive/server/

[9] 客户端: /grpc/grpc-go/blob/master/examples/features/keepalive/client/

[10] GRPC 开箱手册: /post/6844904096474857485

相关文章