Go GRPC如何接入服务发现,解析go-kratos的etcd注册流程

示例代码如下:

func TestDiscovery(t *testing.T) {
    client, err := clientv3.New(clientv3.Config{
        Endpoints: []string{
            "127.0.0.1:2379",
        },
    })
    if err != nil {
        panic(err)
    }
    dis := etcd.New(client)
    endpoint := "discovery:///system_services"
    conn, err := grpc.DialInsecure(context.Background(), grpc.WithDiscovery(dis), grpc.WithEndpoint(endpoint))
    if err != nil {
        panic(err)
    }
    user := v1.NewUserInfoClient(conn)
    reply, _ := user.Detail(context.Background(), &v1.DetailRequest{
        Id: 2,
    })

    t.Logf("%v", reply)
    //panic("boom")

}

这是一个kratos通过etcd调用服务的流程,让我们通过分析kratos的流程来学习一下grpc的使用

endpoint := "discovery:///system_services"
conn, err := grpc.DialInsecure(context.Background(), grpc.WithDiscovery(dis), grpc.WithEndpoint(endpoint))

最开始我们定义了一个endpoint,通过跟踪,发现这个endpoint被直接传给了go标准包grpc中的DialContext

    //github.com/go-kratos/kratos/v2/transport/grpc/client.go:147
    //...
    if insecure {
        grpcOpts = append(grpcOpts, grpc.WithTransportCredentials(grpcinsecure.NewCredentials()))
    }
    if options.tlsConf != nil {
        grpcOpts = append(grpcOpts, grpc.WithTransportCredentials(credentials.NewTLS(options.tlsConf)))
    }
    if len(options.grpcOpts) > 0 {
        grpcOpts = append(grpcOpts, options.grpcOpts...)
    }
    return grpc.DialContext(ctx, options.endpoint, grpcOpts...)

那么这个endpoint里的discovery是什么意思呢?grpc是如何知道我们要调用etcd作为discovery,又是如何获取到服务的链接的呢?

我们继续追踪代码:

//github.com/go-kratos/kratos/v2/transport/grpc/client.go:139
//...
if options.discovery != nil {
        grpcOpts = append(grpcOpts,
            grpc.WithResolvers(
                discovery.NewBuilder(
                    options.discovery,
                    discovery.WithInsecure(insecure),
                )))
    }

发现kratos将discovery包装成一个resolver.Builder传给了grpc.WithResolvers

resolver.Builder由grpc标准包定义:

type Builder interface {
    // Build creates a new resolver for the given target.
    //
    // gRPC dial calls Build synchronously, and fails if the returned error is
    // not nil.
    Build(target Target, cc ClientConn, opts BuildOptions) (Resolver, error)
    // Scheme returns the scheme supported by this resolver.
    // Scheme is defined at https://github.com/grpc/grpc/blob/master/doc/naming.md.
    Scheme() string
}

规定了两个方法,grpc通过第一个Build方法来构建Resolver对象

// Resolver watches for the updates on the specified target.
// Updates include address updates and service config updates.
type Resolver interface {
    // ResolveNow will be called by gRPC to try to resolve the target name
    // again. It's just a hint, resolver can ignore this if it's not necessary.
    //
    // It could be called multiple times concurrently.
    ResolveNow(ResolveNowOptions)
    // Close closes the resolver.
    Close()
}

第二个Schema返回schema的名称,grpc通过这个方法来获取Resolver对象

用实际代码来说明:

//google.golang.org/grpc/clientconn.go:1574
func (cc *ClientConn) parseTargetAndFindResolver() (resolver.Builder, error) {
    channelz.Infof(logger, cc.channelzID, "original dial target is: %q", cc.target)

    var rb resolver.Builder
    parsedTarget, err := parseTarget(cc.target)
    if err != nil {
        channelz.Infof(logger, cc.channelzID, "dial target %q parse failed: %v", cc.target, err)
    } else {
        channelz.Infof(logger, cc.channelzID, "parsed dial target is: %+v", parsedTarget)
        rb = cc.getResolver(parsedTarget.Scheme)
        if rb != nil {
            cc.parsedTarget = parsedTarget
            return rb, nil
        }
    }
//...

这里parseTarget方法解析了我们之前传入的target,规则为[scheme]://[authority]/endpoint

// parseTarget uses RFC 3986 semantics to parse the given target into a
// resolver.Target struct containing scheme, authority and endpoint. Query
// params are stripped from the endpoint.
func parseTarget(target string) (resolver.Target, error) {
    u, err := url.Parse(target)
    if err != nil {
        return resolver.Target{}, err
    }
    // For targets of the form "[scheme]://[authority]/endpoint, the endpoint
    // value returned from url.Parse() contains a leading "/". Although this is
    // in accordance with RFC 3986, we do not want to break existing resolver
    // implementations which expect the endpoint without the leading "/". So, we
    // end up stripping the leading "/" here. But this will result in an
    // incorrect parsing for something like "unix:///path/to/socket". Since we
    // own the "unix" resolver, we can workaround in the unix resolver by using
    // the `URL` field instead of the `Endpoint` field.
    endpoint := u.Path
    if endpoint == "" {
        endpoint = u.Opaque
    }
    endpoint = strings.TrimPrefix(endpoint, "/")
    return resolver.Target{
        Scheme:    u.Scheme,
        Authority: u.Host,
        Endpoint:  endpoint,
        URL:       *u,
    }, nil
}

其中Schema部分放入resolver.Target的Schema里,endpoint部分放入resovler.Target的endpoint中

这里Host部分放入了Authority,官方的说明是:
authority indicates the DNS server to use, although this is only supported by some implementations. (In C-core, the default DNS resolver does not support this, but the c-ares based resolver supports specifying this in the form "IP:port".)
大意是说,只有在某些实现中才会支持,但至少etcd中我们是用不到的

接着通过getResolver方法获取了Schema对应的resolver.Builder

func (cc *ClientConn) getResolver(scheme string) resolver.Builder {
    for _, rb := range cc.dopts.resolvers {
        if scheme == rb.Scheme() {
            return rb
        }
    }
    return resolver.Get(scheme)
}

清楚了grpc如何获取对应的discovery,下面就是grpc如何获取服务的链接了

我们回过头来看kratos中builder.go,这个方法是kratos对resolver.Builder的
实现

//github.com/go-kratos/kratos/v2/transport/grpc/resolver/discovery/builder.go:61
func (b *builder) Build(target resolver.Target, cc resolver.ClientConn, opts resolver.BuildOptions) (resolver.Resolver, error) {
    var (
        err error
        w   registry.Watcher
    )
    done := make(chan struct{}, 1)
    ctx, cancel := context.WithCancel(context.Background())
    go func() {
        w, err = b.discoverer.Watch(ctx, strings.TrimPrefix(target.URL.Path, "/"))
        close(done)
    }()
    select {
    case <-done:
    case <-time.After(b.timeout):
        err = errors.New("discovery create watcher overtime")
    }
    if err != nil {
        cancel()
        return nil, err
    }
    r := &discoveryResolver{
        w:                w,
        cc:               cc,
        ctx:              ctx,
        cancel:           cancel,
        insecure:         b.insecure,
        debugLogDisabled: b.debugLogDisabled,
    }
    go r.watch()
    return r, nil
}

kratos先是调用了etcd的watch方法来对服务状态进行监视,详见:Go操作etcd - 知乎 (zhihu.com)

接着创建了一个协程来调用resolver的watch方法

func (r *discoveryResolver) watch() {
    for {
        select {
        case <-r.ctx.Done():
            return
        default:
        }
        ins, err := r.w.Next()
        if err != nil {
            if errors.Is(err, context.Canceled) {
                return
            }
            log.Errorf("[resolver] Failed to watch discovery endpoint: %v", err)
            time.Sleep(time.Second)
            continue
        }
        r.update(ins)
    }
}

这个方法里kratos自己定义了一个Watcher对象用来监控etcd状态的改变,Next主要用来在每次服务状态改变时获取服务的新实例,在服务状态未改变时会阻塞协程,就不展开了

重点在于update方法

func (r *discoveryResolver) update(ins []*registry.ServiceInstance) {
    addrs := make([]resolver.Address, 0)
    endpoints := make(map[string]struct{})
    for _, in := range ins {
        endpoint, err := endpoint.ParseEndpoint(in.Endpoints, endpoint.Scheme("grpc", !r.insecure))
        if err != nil {
            log.Errorf("[resolver] Failed to parse discovery endpoint: %v", err)
            continue
        }
        if endpoint == "" {
            continue
        }
        // filter redundant endpoints
        if _, ok := endpoints[endpoint]; ok {
            continue
        }
        endpoints[endpoint] = struct{}{}
        addr := resolver.Address{
            ServerName: in.Name,
            Attributes: parseAttributes(in.Metadata),
            Addr:       endpoint,
        }
        addr.Attributes = addr.Attributes.WithValue("rawServiceInstance", in)
        addrs = append(addrs, addr)
    }
    if len(addrs) == 0 {
        log.Warnf("[resolver] Zero endpoint found,refused to write, instances: %v", ins)
        return
    }
    err := r.cc.UpdateState(resolver.State{Addresses: addrs})
    if err != nil {
        log.Errorf("[resolver] failed to update state: %s", err)
    }

    if !r.debugLogDisabled {
        b, _ := json.Marshal(ins)
        log.Infof("[resolver] update instances: %s", b)
    }
}

update方法在服务改变时调用了r.cc.UpdateState,而r.cc是一个resolver.ClientConn对象,接受一个resolver.State对象作为参数

我们可以看到,kratos就是在这里把每次改变服务地址写入进去的。


至此我们已经搞清了所有的疑问,在grpc中如何使用服务发现的方法也已经明晰

首先我们要自己实现一个resolver.Builder与resolver.Resolver,通过WithResovers,resolverBuilder用来生成resolver.Resolver

然后将resolver.Builder通过grpc.WithResolvers传入grpc.DialContext

在resolver.Builder的Build方法中,我们需要调用etcd的watch方法来监视服务状态的改变,并且在服务改变后需要调用resolver.ClientConn的UpdateState方法来改变服务的地址

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,294评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,493评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,790评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,595评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,718评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,906评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,053评论 3 410
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,797评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,250评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,570评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,711评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,388评论 4 332
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,018评论 3 316
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,796评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,023评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,461评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,595评论 2 350

推荐阅读更多精彩内容