dubbo-go-proxyのpluginsについて話します
5258 ワード
シーケンス
本文は主にdubbo-go-proxyのpluginsを研究する
PluginsGroup
[email protected]/pkg/api/config/api_config.go
// PluginsGroup defines the plugins group info
type PluginsGroup struct {
GroupName string `json:"groupName" yaml:"groupName"`
Plugins []Plugin `json:"plugins" yaml:"plugins"`
}
type Plugin struct {
Name string `json:"name" yaml:"name"`
Version string `json:"version" yaml:"version"`
Priority int `json:"priority" yaml:"priority"`
ExternalLookupName string `json:"externalLookupName" yaml:"externalLookupName"`
}
PluginsGroupはGroupNameとPluginsを定義します.Pluginでは、Name、Version、Priority、ExternalLookupNameのプロパティが定義されています.
PluginsWithFunc
dubbo-go-proxy/pkg/filter/plugins/plugins.go
type PluginsWithFunc struct {
Name string
Priority int
fn context.FilterFunc
}
PluginsWithFuncはName、Priority、contextを定義する.FilterFuncプロパティ
InitPluginsGroup
dubbo-go-proxy/pkg/filter/plugins/plugins.go
// InitPluginsGroup prase api_config.yaml(pluginsGroup) to map[string][]PluginsWithFunc
func InitPluginsGroup(groups []config.PluginsGroup, filePath string) {
if "" == filePath || len(groups) == 0 {
return
}
// load file.so
pls, err := plugin.Open(filePath)
if nil != err {
panic(err)
}
for _, group := range groups {
pwdMap := make(map[string]PluginsWithFunc, len(group.Plugins))
// trans to context.FilterFunc
for _, pl := range group.Plugins {
pwf := PluginsWithFunc{pl.Name, pl.Priority, loadExternalPlugin(&pl, pls)}
pwdMap[pl.Name] = pwf
}
groupWithPluginsMap[group.GroupName] = pwdMap
}
}
InitPluginsGroupは、プロファイルおよびfilePathに基づいてPluginsGroupを初期化します.pluginを通りますOpen(filePath)はpluginをロードする、その後、構成されたgroupsを巡回し、groupNameに従って対応するplugin mapをロードし、PluginsWithFuncを使用してパッケージpluginを記述し、loadExternalPlugginメソッドによってcontextを設定.FilterFunc
loadExternalPlugin
dubbo-go-proxy/pkg/filter/plugins/plugins.go
func loadExternalPlugin(p *config.Plugin, pl *plugin.Plugin) context.FilterFunc {
if nil != p {
logger.Infof("loadExternalPlugin name is :%s,version:%s,Priority:%d", p.Name, p.Version, p.Priority)
sb, err := pl.Lookup(p.ExternalLookupName)
if nil != err {
panic(err)
}
sbf := sb.(func() filter.Filter)
logger.Infof("loadExternalPlugin %s success", p.Name)
return sbf().Do()
}
panic(errEmptyPluginConfig)
}
loadExternalPlugginメソッドExternalLookupNameに従ってpluginのLookupメソッドで対応するfuncをロードし、最後にfilter.FilterのDoメソッドはcontextを返す.FilterFunc
api_config.yaml
name: proxy
description: proxy sample
resources:
- path: '/api/v1/test-dubbo/user'
type: restful
description: user
plugins:
groupNames:
- group2
pluginNames:
- rate limit
- access
methods:
- httpVerb: GET
onAir: true
timeout: 1000ms
inboundRequest:
requestType: http
queryStrings:
- name: name
required: true
integrationRequest:
requestType: http
host: 127.0.0.1:8889
path: /UserProvider/GetUserByName
mappingParams:
- name: queryStrings.name
mapTo: queryStrings.name
group: "test"
version: 1.0.0
- httpVerb: POST
onAir: true
timeout: 1000ms
inboundRequest:
requestType: http
queryStrings:
- name: name
required: true
integrationRequest:
requestType: http
host: 127.0.0.1:8889
path: /UserProvider/CreateUser
group: "test"
version: 1.0.0
pluginFilePath: ""
pluginsGroup:
- groupName: "group1"
plugins:
- name: "rate limit"
version: "0.0.1"
priority: 1000
externalLookupName: "ExternalPluginRateLimit"
- name: "access"
version: "0.0.1"
priority: 1000
externalLookupName: "ExternalPluginAccess"
- groupName: "group2"
plugins:
- name: "blacklist"
version: "0.0.1"
priority: 1000
externalLookupName: "ExternalPluginBlackList"
pluginsGroupは2つのグループを定義し、グループp 1はExternalPlugginRateLimit、ExternalPlugginAccessの2つのpluginを定義した.group 2はExternalPlugingBlackListのpluginを定義する
小結
dubbo-go-proxyはapi_に基づいてpluginsを提供しています.config.yaml定義pluginFilePathおよびpluginsGroupはpluginの初期化を行う.InitPluginsGroupメソッドは、まずfilePathに従ってpluginをロードし、その後loadExternalPlugginメソッドによってExternalLookupNameに従って対応するcontextを見つける.FilterFunc.