[ Kitex 源码解读 ] 服务注册

2022 年 7 月 22 日
本文字数：2007 字
阅读完需：约 7 分钟

Kitex

如果你还不了解 Kitex，可以看看《[ CloudWeGo 微服务实践 - 01 ] 开篇》。

如果你想参与 CloudWeGo 社区，给 Kitex 和其他组件贡献代码，可以看《如何给 CloudWeGo 做贡献》。

服务注册

服务注册与服务发现是 RPC 框架中最重要的组件，地位仅次于加解密与通信的实现。在 Kitex 中，注册中心已经支持了主流的各个组件，如 registry-etcd、registry-nacos、registry-zookeeper、registry-polaris、registry-eureka、registry-consul 等。

服务注册是在服务端做的，将已启动的服务实例添加到注册中心。

用法

我们以 nacos 为例，代码如下：

https://github.com/kitex-contrib/registry-nacos/blob/main/example/basic/server/main.go

func main() {    	// 通过默认配置获取一个注册中心的实例    	// 方法内部有通过默认配置创建一个 nacos 客户端，方便后续与 nacos 交互	r, err := registry.NewDefaultNacosRegistry()	if err != nil {		panic(err)	}  	svr := hello.NewServer(		new(HelloImpl),          		// 以 WithOption 的方式指定注册中心		server.WithRegistry(r),    		server.WithRegistryInfo(&kitexregistry.Info{ServiceName: "Hello"}),		server.WithServiceAddr(&net.TCPAddr{IP: net.IPv4(127, 0, 0, 1), Port: 8080}),	)	if err := svr.Run(); err != nil {		log.Println("server stopped with error:", err)	} else {		log.Println("server stopped")	}}

复制代码

探索过程

实验条件

我们以 registry-nacos 的 custom-config 代码示例为基础进行改造。

registry-nacos v0.0.1
MacOS 12.4
Goland
Docker v20.10.12

环境准备

git clone git@github.com:kitex-contrib/registry-nacos.git 注意要与 Kitex 同级目录下，方便后续如果有必要进行调试。
在 registry-nacos 根目录下执行 make prepare 启动 nacos 注册中心，若命令不支持可手动执行 docker 相关命令，务必确保启动注册中心。

运行案例

我们运行的案例是 custom-config 的 demo。这里的 nacos 客户端参数都可配置，方便调试。

启动服务端

 go run example/custom-config/server/main.go

复制代码

Nacos 管理后台查看

后台地址：http://localhost:8848/nacos/index.html

账号密码都是 nacos

在服务管理 > 服务列表，能看到一组服务

在详情中也能看到具体的实例

以上可以证明是注册成功的。

终止服务

ctrl + c 停止服务端

Nacos 管理后台查看

刷新刚刚的服务详情页面，实例也没有了

源码分析

接口

在 main.go 文件中，我们看到 NewServer 时，server.WithRegistry 接收我们制定的服务注册组件

// kitex/server/option.go:217
// WithRegistry to set a Registry to register servicefunc WithRegistry(r registry.Registry) Option {	return Option{F: func(o *internal_server.Options, di *utils.Slice) {		di.Push(fmt.Sprintf("WithRegistry(%T)", r))
		o.Registry = r	}}}

复制代码

由此我们能看到接收的参数也是一个接口类型，后续我们定制扩展服务注册组件也是基于此的。

// kitex/pkg/registry/registry.go:28
// Registry is extension interface of service registry.type Registry interface {	Register(info *Info) error	Deregister(info *Info) error}

复制代码