Skip to content

zh_userguide

Jump to bottom
Ray edited this page Nov 7, 2017 · 16 revisions

基本介绍

Motan是高性能的RPC服务化框架，Motan提供了强大服务治理功能以及优秀的扩展能力。Motan-go是Motan的golang版本实现，除了提供了client与server与其他语言版本进行交互外，Motan-go还提供了agent为不同语言使用Motan框架进行跨语言服务治理提供了支持。

架构概述

Motan-go的基本交互方式请参考Motan架构概述

模块概述

Motan-go的各模块的作用与Motan java版本的基本一致, 但是实现方式与java版本略有不同，其中transport部分在client端与server端分别由endpoint和server两个模块实现。 Motan-go的代码结构按package进行主要功能模块进行划分，各package功能可以参考GoDoc文档。

自定义扩展实现

强大的扩展能力是Motan框架的特点之一，Motan-go通过扩展注册机制来支持自定义扩展，通过自定义扩展可以方便适配不同的系统或增加定制化功能。 Motan-go的各类扩展实现是通过ExtentionFactory来管理，Motan-go给出了默认实现类DefaultExtentionFactory，DefaultExtentionFactory提供了各类扩展实现类的注册与获取机制，并会提前注册所有的扩展实现。在实际使用client、server、agent时会默认使用DefaultExtentionFactory，用户只需要注册自定义实现即可，这是推荐的扩展方式。

也可以使用自定义的ExtentionFactory实现来替换默认的DefaultExtentionFactory，但需要对所有扩展的使用方式比较了解，不建议一般用户通过此种方式进行扩展。

主要扩展点

Motan-go对各主要功能都提供了可扩展能力，并提供了多种默认实现可供选择。主要扩展点如下：

  • Registry: 不同注册中心扩展。目前支持zookeeper和direct，后续会支持其他注册中心，例如consul等
  • Filter: filter是在请求处理中对reques和response进行处理的机制，提供endpointFilter和clusterFilter两个插入点。使用filter进行功能扩展是推荐的扩展方式。默认提供accesslog、metric等filter。
  • HaStrategy: 高可用策略扩展点，默认提供failover。后续将提供backup request等策略
  • LoadBalance: 负载均衡策略扩展点。默认实现random、roundrobin。同时给出了支持跨group权重处理的warper实现类，方便不同LB策略支持按权重跨group负载均衡
  • EndPoint: endpoint为调用远程server的扩展点，可以理解为点对点直连场景下的client。默认提供motan协议实现与grpc实现。
  • Provider: 具体rpc服务的实现类扩展，可以是调用本地代码实现，也可以是跨进程实现。默认提供本地服务实现调用与CGI跨进程调用。
  • Server: 不同类型的server实现，一般与协议绑定。默认提供MotanServer实现。
  • MessageHandler: 针对默认Server实现MotanServer的不同类型消息处理扩展。
  • Serialization: 可以进行不同类型序列化实现扩展。默认支持simple序列化。

自定义扩展注册

实现一个扩展

实现一个自定义扩展需要实现上述扩展点接口的全部方法，以实现一个endpointFilter为例，需要先实现 endpointFilter接口中声明的方法。如下：

type MyEndPointFilter struct {
	url  *motancore.URL
	next motancore.EndPointFilter
}

// 获取此filter的index。index用来决定不同filter的执行顺序，index越小会越先执行。
func (m *MyEndPointFilter) GetIndex() int {
	return 20
}

func (m *MyEndPointFilter) GetName() string {
	return "myfilter"
}

// filter必须为多例模式，NewFilter用来创建一个新的filter实例。
func (m *MyEndPointFilter) NewFilter(url *motancore.URL) motancore.Filter {
	return &MyEndPointFilter{url: url}
}

//filter调用是嵌套模式，filter的最内层会调用实际endpoint进行远程请求。
func (m *MyEndPointFilter) Filter(caller motancore.Caller, request motancore.Request) motancore.Response {
	fmt.Printf("before call. request:%+v\n", request)
	// must call next filter in Filter implement
	response := m.GetNext().Filter(caller, request)
	fmt.Printf("after call. response:%+v\n", response)
	return response
}

func (m *MyEndPointFilter) HasNext() bool {
	return m.next != nil
}

// 设置filter链中的下一个filter
func (m *MyEndPointFilter) SetNext(nextFilter motancore.EndPointFilter) {
	m.next = nextFilter
}

// 获取filter链中的下一个filter
func (m *MyEndPointFilter) GetNext() motancore.EndPointFilter {
	return m.next
}

// filter 类型。filter分为endpointFilter 与clusterFilter，分别在调用的不同位置执行filter过滤行为
func (m *MyEndPointFilter) GetType() int32 {
	return motancore.EndPointFilterType
}

注册实现扩展类

实现了扩展类之后，需要把扩展类注册到ExtentionFactory，注册时需要一个扩展类的唯一标识，以及一个创建新扩展类的方法。用上面的MyEndPointFilter为例，注册到默认工厂类的方式如下：

weiboExtFactory := motan.GetDefaultExtFactory() //获取默认注册工厂类。
weiboExtFactory.RegistExtFilter("myfilter", func() motancore.Filter {
	return &MyEndPointFilter{}
}) //注册的唯一标识，即name为`myfilter`，注册的是创建一个新的`myfilter`类的匿名方法。

自定义扩展使用

在完成了自定义扩展的注册后，可以通过配置使用自定义扩展类。一般是通过在refer、service的对应配置项中使用注册时的name即可。例如上例中的myfilter，使用方法如下：

motan-refer:
  mytest-motan2:
    path: com.weibo.motan2.test.Motan2TestService
    registry: direct-registry
    serialization: simple
    basicRefer: mybasicRefer
    filter: "accessLog, myfilter" #此处配置了两个filter，一个`accessLog`为系统自带的访问日志记录filter，另一个是自定义的`myfilter`。

配置后，myfilter会在调用中生效。上述自定义扩展的例子可以参考main/agentdemo.go

Motan2协议

Simple序列化

中文文档

Clone this wiki locally