基本概念 on Apache Dubbo

Dubbo-go 的应用和接口

Mon, 01 Jan 0001 00:00:00 +0000

此文档已经不再维护。您当前查看的是快照版本。如果想要查看最新版本的文档，请参阅最新版本。

Dubbo-go 服务层级

Dubbo-go 服务层级为两个级别：分别是应用级别(App Level)和接口级别(Interface Level)，该服务分层与框架配置结构息息相关。

如下图所示，可以看到，应用级别的组件以浅红色标注，接建立如下文件目录口级别的组件以浅蓝色标注：

1. 应用级别组件

应用级别组件的特点：被当前应用的所有接口级别组件共用。

应用级别的主要组件如下：

应用信息模块

包含应用维度相关信息，包括应用名、版本号、数据上报方式等
Consumer 模块

Consumer 模块负责客户端相关信息，包括一个或多个引用（Reference）结构，以及超时、客户端过滤器（consumer filter）等相关信息。
Provider 模块

Provider 模块负责服务端相关信息，包括一个或多个服务（Service）结构、服务端过滤器（provider filter）等相关信息。
注册中心（Registry）模块

注册中心模块负责定义好所要使用的一系列注册中心，例如框架支持的ZK、Nacos、ETCD等中间件。应用级别的注册模块只负责声明，由接口级别的组件进行引用，引用时以用户自定义的注册中心ID（registryID) 作为索引。
协议（Protocol）模块

协议模块只存在于服务端。

协议模块关心服务的暴露信息，例如协议名、服务监听IP、端口号等信息。协议模块属于应用级别，只负责声明，由接口级别的组件进行引用，引用时以用户自定义的协议ID（protocolID) 作为索引。
元数据中心模块

元数据中心类似于注册中心模块，负责声明框架需要使用的元数据中心，从而将元数据成功上报。
配置中心模块
路由模块
日志模块
监控模块

2. 接口级别组件

服务（Service）模块

服务模块被使用于任何暴露的服务，声明接口暴露所需的信息，包括例如接口名、协议、序列化方式等，负责单个服务接口的暴露。
引用（Reference）模块

饮用模块被使用于需要调用的远程服务的客户端，其声明了需要请求接口所需的信息，包括例如接口名、协议、序列化方式等、负责特定协议的抽象，参与客户端的生成。

3. 说明

暴露的服务是接口级别的，一个用户定义的 Provider Struct/一个用户定义的Consumer Struct，对应一个Service/Reference 模块，一个应用可以同时存在Consumer 模块和 Provider 模块，因此可以同时存在多个Service/Reference 模块。

Dubbo-go的配置

Mon, 01 Jan 0001 00:00:00 +0000

此文档已经不再维护。您当前查看的是快照版本。如果想要查看最新版本的文档，请参阅最新版本。

Dubbo-go 配置项

1. 配置结构

1.1 框架配置结构

根配置

ProviderConfig

ConsumerConfig

1.2 配置例子

dubbo:
 application: # 应用配置
 name: dubbo-go
 module: local
 version: 1.0.0 
 owner: zhaoyunxing
 organization: dubbo-go 
 metadata-type: local # 元数据上报方式，默认为本地
 metadata-report: # 元数据上报配置, 不包含此字段则不开启元数据上报，应用级服务发现依赖此字段，参考例子：https://github.com/apache/dubbo-go-samples/tree/45a0d843b54e4922c240900e63516176cc7da4f6/registry/servicediscovery
 protocol: nacos # 元数据上报方式，支持nacos/zookeeper 
 address: 127.0.0.1:8848 
 username: ""
 password: ""
 timeout: "3s"
 group: "dubbo"
 protocols:
 tripleProtocol: # triple协议定义，参考例子https://github.com/apache/dubbo-go-samples/tree/f7febed9d686cb940ea55d34b5baa567d7574a44/rpc/tri
 name: tri # 网络协议，支持tri/dubbo/jsonrpc/grpc
 port: 20001
 dubboProtocol: # dubbo协议定义，参考例子https://github.com/apache/dubbo-go-samples/tree/f7febed9d686cb940ea55d34b5baa567d7574a44/rpc/dubbo
 name: dubbo
 port: 20000
 params: # dubbo 传输层配置，此字段不配置则使用协议默认值
 reconnect-interval: 0
 connection-number: 1
 heartbeat-period: 5s
 session-timeout: 180s
 pool-size: 64
 pool-ttl: 600
 getty-session-param:
 compress-encoding: false
 tcp-no-delay: true
 tcp-keep-alive: true
 keep-alive-period: 120s
 tcp-r-buf-size: 262144
 tcp-w-buf-size: 65536
 pkg-rq-size: 1024
 pkg-wq-size: 512
 tcp-read-timeout: 1s
 tcp-write-timeout: 5s
 wait-timeout: 1s
 max-msg-len: 1024000
 session-name: client
 config-center: # 配置中心，参考例子：https://github.com/apache/dubbo-go-samples/tree/f7febed9d686cb940ea55d34b5baa567d7574a44/configcenter
 protocol: nacos # 支持 nacos/zookeeper/apollo
 address: 127.0.0.1:8848
 group: dubbo
 namespace: dubbo
 timeout: 10s
 params:
 username: nacos
 password: 123456
 registries: # 注册中心配置，参考例子 https://github.com/apache/dubbo-go-samples/tree/f7febed9d686cb940ea55d34b5baa567d7574a44/metrics
 zk:
 protocol: zookeeper
 timeout: 3s
 address: 127.0.0.1:2181
 nacos:
 timeout: 5s
 address: 127.0.0.1:8848
 etcd:
 address: 127.0.0.1:2379
 consumer: # 客户端配置
 request_timeout: 3s
 filter: myClientFilter # 客户端 filters name，多个则逗号隔开
 registry-ids: zk # 使用上面定义的注册中心id
 max-wait-time-for-service-discovery: 3s # 服务发现最长等待时间
 references:
 GreeterImpl:
 protocol: dubboProtocol
 serialization: hessian2 # 序列化方式
 interface: com.apache.dubbo.sample.basic.IGreeter # 接口名，需要与服务端一致
 provider: # 服务端配置
 registry-ids: zk # 使用上面定义的注册中心id
 services:
 DubboGreeterImpl:
 filter: myServerFilter, myServerFilter2 # server filters name 
 protocol-ids: dubboProtocol # 使用上面定义的协议id
 serialization: hessian2 # hessian 序列化方式
 interface: com.apache.dubbo.sample.basic.IGreeter # 接口名，需要与客户端一致
 TripleGreeterImpl:
 protocol-ids: tripleProtocol # 使用上面定义的协议id
 serialization: protobuf # pb 序列化方式
 interface: com.apache.dubbo.sample.basic.TripleService # 接口名，需要与客户端一致
 logger: # 日志配置，参考例子：https://github.com/apache/dubbo-go-samples/tree/f7febed9d686cb940ea55d34b5baa567d7574a44/logger
 zap-config:
 level: info # 日志级别
 lumberjack-config: 
 filename: logs.log # 文件输出目录
 maxSize: 1
 maxAge: 3
 maxBackups: 5
 localTime: true
 compress: false
 metrics: # 数据上报配置，参考例子：https://github.com/apache/dubbo-go-samples/tree/f7febed9d686cb940ea55d34b5baa567d7574a44/metrics
 enable: true # 数据上报开关，默认开启
 path: /custom-metrics-path # 拉模式数据上报本地监听path 默认/metrics
 port: 9091 # 拉模式数据上报本地监听端口，默认9090

2. 框架读取配置方式

2.1 从文件读取

需要按照上述配置结构，定义 dubbogo.yml 文件，并在应用启动之前设置环境变量 DUBBO_GO_CONFIG_PATH为 dubbogo.yml 的位置。
在代码中，调用 config.Load 方法，启动框架。一个例子如下：

// export DUBBO_GO_CONFIG_PATH= PATH_TO_SAMPLES/helloworld/go-client/conf/dubbogo.yml
func main() {
 // set consumer struct if needed
 config.SetConsumerService(grpcGreeterImpl)
 
 // config loader start
 if err := config.Load(); err != nil {
 panic(err)
 }
 
 logger.Info("start to test dubbo")
 req := &api.HelloRequest{
 Name: "laurence",
 }
 // do RPC invocation
 reply, err := grpcGreeterImpl.SayHello(context.Background(), req)
 if err != nil {
 logger.Error(err)
 }
 logger.Infof("client response result: %v\n", reply)
}

2.2 配置 API

用户无需使用配置文件，可直接在代码中以 API 的调用的形式写入配置，如前面"快速开始"部分所提供的例子:

Dubbo-go 的网络协议

Mon, 01 Jan 0001 00:00:00 +0000

此文档已经不再维护。您当前查看的是快照版本。如果想要查看最新版本的文档，请参阅最新版本。

网络协议

1. 网络协议是什么

对于 Dubbo-go 微服务框架，网络协议为远程过程调用中负责网络通信的模块，负责应用层到网络层的数据序列化、打包、请求发起、网络端口监听等功能。Dubbo-go 为协议抽象了一套接口如下：

type Protocol interface {
	// Export service for remote invocation
	Export(invoker Invoker) Exporter
	// Refer a remote service
	Refer(url *common.URL) Invoker
	// Destroy will destroy all invoker and exporter, so it only is called once.
	Destroy()
}

该接口包含三个方法。其中 Export 方法负责服务的暴露过程。入参 invoker 为dubbo 的概念，其封装了一个可以被调用的实例。在具体网络协议（例如Triple）实现的 Export 方法中，会针对特定的协议，将封装有一定逻辑的可调用实例 Invoker 以网络端口监听的形式暴露给外部服务，来自外部针对该网络端口的请求将会被 Export 方法开启的监听协程获取，进而根据网络协议进行拆解包和反序列化，得到解析后的请求数据。

Refer 方法负责服务的引用过程，其入参 url 为 dubbo 框架通用的结构，可以描述一个希望引用的服务，url 参数中包含了多个希望引用服务的参数，例如对应服务的接口名(interface)，版本号(version)，使用协议(protocol) 等等。在具体网络协议（例如Triple）实现的 Refer 方法中，会将特定的网络协议封装到 Invoker 可调用实例的方法中，用户层发起的 RPC 调用即可直接通过返回的 Invoker 对象，发起特定协议的网络请求。

Dubbo-go 的注册中心

Mon, 01 Jan 0001 00:00:00 +0000

此文档已经不再维护。您当前查看的是快照版本。如果想要查看最新版本的文档，请参阅最新版本。

注册中心

1. Dubbo 的注册中心是什么

对于 Dubbo-go 微服务框架，注册中心在 RPC 场景下复杂保存 Provider 应用的服务信息。Provider 注册地址到注册中心，Consumer 从注册中心读取和订阅 Provider 地址列表。如图所示：

关于 Dubbo 服务发现细节，详情可参考 Dubbo 官网的概念介绍

Dubbo-go 为注册中心抽象了一套接口如下：

// Registry Extension - Registry
type Registry interface {
	common.Node

	// Register is used for service provider calling, register services
	// to registry. And it is also used for service consumer calling, register
	// services cared about, for dubbo's admin monitoring.
	Register(url *common.URL) error

	// UnRegister is required to support the contract:
	// 1. If it is the persistent stored data of dynamic=false, the
	// registration data can not be found, then the IllegalStateException
	// is thrown, otherwise it is ignored.
	// 2. Unregister according to the full url match.
	// url Registration information, is not allowed to be empty, e.g:
	// dubbo://10.20.153.10/org.apache.dubbo.foo.BarService?version=1.0.0&application=kylin
	UnRegister(url *common.URL) error

	// Subscribe is required to support the contract:
	// When creating new registry extension, pls select one of the
	// following modes.
	// Will remove in dubbogo version v1.1.0
	// mode1: return Listener with Next function which can return
	// subscribe service event from registry
	// Deprecated!
	// subscribe(event.URL) (Listener, error)
	// Will replace mode1 in dubbogo version v1.1.0
	// mode2: callback mode, subscribe with notify(notify listener).
	Subscribe(*common.URL, NotifyListener) error

	// UnSubscribe is required to support the contract:
	// 1. If don't subscribe, ignore it directly.
	// 2. Unsubscribe by full URL match.
	// url Subscription condition, not allowed to be empty, e.g.
	// consumer://10.20.153.10/org.apache.dubbo.foo.BarService?version=1.0.0&application=kylin
	// listener A listener of the change event, not allowed to be empty
	UnSubscribe(*common.URL, NotifyListener) error
}

该接口主要包含四个方法，分别是注册、反注册、订阅、取消订阅。顾名思义，概括了客户端和服务端与注册中心交互的动作。针对普通接口级服务注册发现场景，在Provider 服务启动时，会将自身服务接口信息抽象为一个 url，该 url 包含了客户端发起调用所需的所有信息（ip、端口、协议等），服务端的注册中心组件会将该 url 写入注册中心（例如zk）。客户端启动后，在服务引用 Refer 步骤会通过注册中心组件订阅（Subscribe）需要的服务信息，获取到的服务信息以异步事件更新的形式写入客户端缓存，从而在服务发现成功后，可以根据拿到的服务 url 参数，向对应服务提供者发起调用。