Skip to content

Latest commit

 

History

History
96 lines (73 loc) · 3.6 KB

plugin.md

File metadata and controls

96 lines (73 loc) · 3.6 KB

Filter plugin

Gateway中的很多功能都是使用Filter来实现的，用户的大部分功能需求都可以使用Filter来解决。所以Filter被设计成Plugin机制，借助于Go1.8的plugin机制，可以很好的扩展Gateway。

Request处理流程

request -> filter预处理 -> 转发请求 -> filter后置处理 -> 响应客户端

整个逻辑处理符合以下规则:

  • filter预处理返回错误，流程立即终止，并且使用filter返回的状态码响应客户端
  • filter后置处理返回错误，使用filter返回的状态码响应客户端
  • 转发请求，后端返回的状态码>=500，调用filter的错误处理接口

Filter接口定义

// Filter filter interface
type Filter interface {
	Name() string
	Init(cfg string) error

	Pre(c Context) (statusCode int, err error)
	Post(c Context) (statusCode int, err error)
	PostErr(c Context)
}

// Context filter context
type Context interface {
	StartAt() time.Time
	EndAt() time.Time

	OriginRequest() *fasthttp.RequestCtx
	ForwardRequest() *fasthttp.Request
	Response() *fasthttp.Response

	API() *metapb.API
	DispatchNode() *metapb.DispatchNode
	Server() *metapb.Server
	Analysis() *util.Analysis

	SetAttr(key string, value interface{})
	GetAttr(key string) interface{}
}

// BaseFilter base filter support default implemention
type BaseFilter struct{}

// Pre execute before proxy
func (f BaseFilter) Pre(c Context) (statusCode int, err error) {
	return http.StatusOK, nil
}

// Post execute after proxy
func (f BaseFilter) Post(c Context) (statusCode int, err error) {
	return http.StatusOK, nil
}

// PostErr execute proxy has errors
func (f BaseFilter) PostErr(c Context) {

}

这些相关的定义都在github.com/fagongzi/gateway/pkg/filter包中，每一个Filter都需要导入。其中的Context的上下文接口，提供了Filter和Gateway交互的能力;BaseFilter定义了默认行为。

Gateway加载Filter插件机制

func newExternalFilter(filterSpec *conf.FilterSpec) (filter.Filter, error) {
	p, err := plugin.Open(filterSpec.ExternalPluginFile)
	if err != nil {
		return nil, err
	}

	s, err := p.Lookup("NewExternalFilter")
	if err != nil {
		return nil, err
	}

	sf := s.(func() (filter.Filter, error))
	return sf()
}

每一个外部的Filter插件，对外提供NewExternalFilter，返回一个filter.Filter实现，或者错误。

Go1.8 Plugin的问题

当编写的自定义插件的时候，有一个问题涉及到Go1.8的一个Bug。所以编写的自定义插件必须在Gateway的Project下编译的插件才能被正确加载。

Go1.9.2以上版本

支持插件项目独立目录，但是不能有自己的vender目录，否则加载的时候一样会出现1.8的问题。

自定义插件例子

可以参考这个例子实现自己的插件 参考JWT插件

启动自定义插件

Proxy组件有一个--filter选项来指定Gateway使用的插件以及顺序。默认情况下Gateway使用一下的内置插件顺序：--filter WHITELIST --filter WHITELIST --filter ANALYSIS --filter RATE-LIMITING --filter CIRCUIT-BREAKER --filter HTTP-ACCESS --filter HEADER --filter XFORWARD --fiter VALIDATION。例如我们开发好了一个插件JWT，并且编译成为jwt.so文件，可以加上启动参数加载插件：--filter WHITELIST --filter WHITELIST --filter ANALYSIS --filter RATE-LIMITING --filter CIRCUIT-BREAKER --filter HTTP-ACCESS --filter HEADER --filter XFORWARD --fiter VALIDATION --filter JWT:/plugins/jwt.so:/plugins/jwt.json，自定义插件的格式：名称:插件文件:插件配置