Rft: Filter

README.md

@@ -31,7 +31,7 @@ The features that are available for Dubbo-go are:
 - **Dynamic Configure Center & Service Management Configurator**: Zookeeper, [Apollo](https://github.com/apache/dubbo-go/pull/250), [Nacos](https://github.com/apache/dubbo-go/pull/357)
 - **Cluster Strategy**: Failover, [Failfast](https://github.com/apache/dubbo-go/pull/140), [Failsafe/Failback](https://github.com/apache/dubbo-go/pull/136), [Available](https://github.com/apache/dubbo-go/pull/155), [Broadcast](https://github.com/apache/dubbo-go/pull/158), [Forking](https://github.com/apache/dubbo-go/pull/161)
 - **Load Balance**: Random, [RoundRobin](https://github.com/apache/dubbo-go/pull/66), [LeastActive](https://github.com/apache/dubbo-go/pull/65), [ConsistentHash](https://github.com/apache/dubbo-go/pull/261)
-- **Filter**: Echo Health Check, [Circuit Break and Service Downgrade](https://github.com/apache/dubbo-go/pull/133), [TokenFilter](https://github.com/apache/dubbo-go/pull/202), [AccessLogFilter](https://github.com/apache/dubbo-go/pull/214), [TpsLimitFilter](https://github.com/apache/dubbo-go/pull/237), [ExecuteLimitFilter](https://github.com/apache/dubbo-go/pull/246), [GenericServiceFilter](https://github.com/apache/dubbo-go/pull/291), [Auth/Sign](https://github.com/apache/dubbo-go/pull/323), [MetricsFilter](https://github.com/apache/dubbo-go/pull/342), [TracingFilter](https://github.com/apache/dubbo-go/pull/335)
+- [**Filter**](./filter): Echo, Hystrix, Token, AccessLog, TpsLimiter, ExecuteLimit, Generic, Auth/Sign, Metrics, Tracing, Active, Seata, Sentinel
 - **Invoke**: [Generic Invoke](https://github.com/apache/dubbo-go/pull/122)
 - **Monitor**: Opentracing API, [Prometheus](https://github.com/apache/dubbo-go/pull/342)
 - **Tracing**: [For JsonRPC](https://github.com/apache/dubbo-go/pull/335), [For Dubbo](https://github.com/apache/dubbo-go/pull/344), [For gRPC](https://github.com/apache/dubbo-go/pull/397)

README_CN.md

@@ -31,12 +31,12 @@ Dubbo-go中已实现的特性：
 - **动态配置中心与服务治理配置器**: Zookeeper, [Apollo](https://github.com/apache/dubbo-go/pull/250), [Nacos](https://github.com/apache/dubbo-go/pull/357)
 - **集群策略**: Failover, [Failfast](https://github.com/apache/dubbo-go/pull/140), [Failsafe/Failback](https://github.com/apache/dubbo-go/pull/136), [Available](https://github.com/apache/dubbo-go/pull/155), [Broadcast](https://github.com/apache/dubbo-go/pull/158), [Forking](https://github.com/apache/dubbo-go/pull/161)
 - **负载均衡策略**: Random, [RoundRobin](https://github.com/apache/dubbo-go/pull/66), [LeastActive](https://github.com/apache/dubbo-go/pull/65), [ConsistentHash](https://github.com/apache/dubbo-go/pull/261)
-- **过滤器**: Echo Health Check, [Circuit Break and Service Downgrade](https://github.com/apache/dubbo-go/pull/133), [TokenFilter](https://github.com/apache/dubbo-go/pull/202), [AccessLogFilter](https://github.com/apache/dubbo-go/pull/214), [TpsLimitFilter](https://github.com/apache/dubbo-go/pull/237), [ExecuteLimitFilter](https://github.com/apache/dubbo-go/pull/246), [GenericServiceFilter](https://github.com/apache/dubbo-go/pull/291), [Auth/Sign](https://github.com/apache/dubbo-go/pull/323), [MetricsFilter](https://github.com/apache/dubbo-go/pull/342), [TracingFilter](https://github.com/apache/dubbo-go/pull/335)
+- [**过滤器**](./filter): Echo, Hystrix, Token, AccessLog, TpsLimiter, ExecuteLimit, Generic, Auth/Sign, Metrics, Tracing, Active, Seata, Sentinel
 - **调用**: [Generic Invoke](https://github.com/apache/dubbo-go/pull/122)
 - **监控**: Opentracing API, [Prometheus](https://github.com/apache/dubbo-go/pull/342)
 - **Tracing**: [For JsonRPC](https://github.com/apache/dubbo-go/pull/335), [For Dubbo](https://github.com/apache/dubbo-go/pull/344), [For gRPC](https://github.com/apache/dubbo-go/pull/397)
 - **元数据中心**: [Nacos(Local)](https://github.com/apache/dubbo-go/pull/522), [ZooKeeper(Local)](https://github.com/apache/dubbo-go/pull/633), [etcd(Local)](https://github.com/apache/dubbo-go/blob/9a5990d9a9c3d5e6633c0d7d926c156416bcb931/metadata/report/etcd/report.go), [Consul(Local)](https://github.com/apache/dubbo-go/pull/633), [ZooKeeper(Remoting)](https://github.com/apache/dubbo-go/pull/1161)
-- **工具**: [Dubbo-go-cli](https://github.com/apache/dubbo-go/pull/818)
+- **工具**: [Dubbo-go-cli](https://github.com/dubbogo/tools)
 
 ## 开始
 

common/extension/auth.go

@@ -23,7 +23,7 @@ import (
 
 var (
 	authenticators    = make(map[string]func() filter.Authenticator)
-	accesskeyStorages = make(map[string]func() filter.AccessKeyStorage)
+	accessKeyStorages = make(map[string]func() filter.AccessKeyStorage)
 )
 
 // SetAuthenticator puts the @fcn into map with name
@@ -40,16 +40,16 @@ func GetAuthenticator(name string) filter.Authenticator {
 	return authenticators[name]()
 }
 
-// SetAccesskeyStorages will set the @fcn into map with this name
-func SetAccesskeyStorages(name string, fcn func() filter.AccessKeyStorage) {
-	accesskeyStorages[name] = fcn
+// SetAccessKeyStorages will set the @fcn into map with this name
+func SetAccessKeyStorages(name string, fcn func() filter.AccessKeyStorage) {
+	accessKeyStorages[name] = fcn
 }
 
-// GetAccesskeyStorages finds the storage with the @name.
+// GetAccessKeyStorages finds the storage with the @name.
 // Panic if not found
-func GetAccesskeyStorages(name string) filter.AccessKeyStorage {
-	if accesskeyStorages[name] == nil {
-		panic("accesskeyStorages for " + name + " is not existing, make sure you have import the package.")
+func GetAccessKeyStorages(name string) filter.AccessKeyStorage {
+	if accessKeyStorages[name] == nil {
+		panic("accessKeyStorages for " + name + " is not existing, make sure you have import the package.")
 	}
-	return accesskeyStorages[name]()
+	return accessKeyStorages[name]()
 }

filter/README.md

@@ -0,0 +1,38 @@
+# Filter
+
+## Getting Started
+
+Recommended Way: import what you needs, see also [dubbo-go/imports](https://github.com/dubbogo/imports).
+
+```go
+package demo
+
+// use echo and generic filters
+import _ "dubbo.apache.org/dubbo-go/v3/filter/echo"
+import _ "dubbo.apache.org/dubbo-go/v3/filter/generic"
+```
+
+Legacy way: import all filters by one line.
+
+```go
+package demo
+
+import _ "dubbo.apache.org/dubbo-go/v3/filter/filter_impl"
+```
+
+## Contents
+
+- accesslog: Access Log Filter(https://github.com/apache/dubbo-go/pull/214)
+- active
+- auth: Auth/Sign Filter(https://github.com/apache/dubbo-go/pull/323)
+- echo: Echo Health Check Filter
+- execlmt: Execute Limit Filter(https://github.com/apache/dubbo-go/pull/246)
+- generic: Generic Filter(https://github.com/apache/dubbo-go/pull/291)
+- gshutdown: Graceful Shutdown Filter
+- hystrix: Hystric Filter(https://github.com/apache/dubbo-go/pull/133)
+- metrics: Metrics Filter(https://github.com/apache/dubbo-go/pull/342)
+- seata: Seata Filter
+- sentinel: Sentinel Filter
+- token: Token Filter(https://github.com/apache/dubbo-go/pull/202)
+- tps: Tps Limit Filter(https://github.com/apache/dubbo-go/pull/237)
+- tracing: Tracing Filter(https://github.com/apache/dubbo-go/pull/335)

filter/filter_impl/access_log_filter.go → filter/accesslog/filter.go

@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 
-package filter_impl
+package accesslog
 
 import (
 	"context"
@@ -35,7 +35,6 @@ import (
 
 const (
 	// used in URL.
-
 	// nolint
 	FileDateFormat = "2006-01-02"
 	// nolint
@@ -54,11 +53,13 @@ const (
 )
 
 func init() {
-	extension.SetFilter(constant.ACCESS_LOG_KEY, GetAccessLogFilter)
+	extension.SetFilter(constant.ACCESS_LOG_KEY, func() filter.Filter {
+		return NewFilter()
+	})
 }
 
-/*
- * AccessLogFilter
+// Filter for Access Log
+/**
  * Although the access log filter is a default filter,
  * you should config "accesslog" in service's config to tell the filter where store the access log.
  * for example:
@@ -73,27 +74,27 @@ func init() {
  * If the value is one of them, the access log will be record in log file which defined in log.yml
  * AccessLogFilter is designed to be singleton
  */
-type AccessLogFilter struct {
-	logChan chan AccessLogData
+type Filter struct {
+	logChan chan Data
 }
 
 // Invoke will check whether user wants to use this filter.
 // If we find the value of key constant.ACCESS_LOG_KEY, we will log the invocation info
-func (ef *AccessLogFilter) Invoke(ctx context.Context, invoker protocol.Invoker, invocation protocol.Invocation) protocol.Result {
+func (f *Filter) Invoke(ctx context.Context, invoker protocol.Invoker, invocation protocol.Invocation) protocol.Result {
 	accessLog := invoker.GetURL().GetParam(constant.ACCESS_LOG_KEY, "")
 
 	// the user do not
 	if len(accessLog) > 0 {
-		accessLogData := AccessLogData{data: ef.buildAccessLogData(invoker, invocation), accessLog: accessLog}
-		ef.logIntoChannel(accessLogData)
+		accessLogData := Data{data: f.buildAccessLogData(invoker, invocation), accessLog: accessLog}
+		f.logIntoChannel(accessLogData)
 	}
 	return invoker.Invoke(ctx, invocation)
 }
 
 // logIntoChannel won't block the invocation
-func (ef *AccessLogFilter) logIntoChannel(accessLogData AccessLogData) {
+func (f *Filter) logIntoChannel(accessLogData Data) {
 	select {
-	case ef.logChan <- accessLogData:
+	case f.logChan <- accessLogData:
 		return
 	default:
 		logger.Warn("The channel is full and the access logIntoChannel data will be dropped")
@@ -102,7 +103,7 @@ func (ef *AccessLogFilter) logIntoChannel(accessLogData AccessLogData) {
 }
 
 // buildAccessLogData builds the access log data
-func (ef *AccessLogFilter) buildAccessLogData(_ protocol.Invoker, invocation protocol.Invocation) map[string]string {
+func (f *Filter) buildAccessLogData(_ protocol.Invoker, invocation protocol.Invocation) map[string]string {
 	dataMap := make(map[string]string, 16)
 	attachments := invocation.Attachments()
 	itf := attachments[constant.INTERFACE_KEY]
@@ -154,19 +155,19 @@ func (ef *AccessLogFilter) buildAccessLogData(_ protocol.Invoker, invocation pro
 }
 
 // OnResponse do nothing
-func (ef *AccessLogFilter) OnResponse(_ context.Context, result protocol.Result, _ protocol.Invoker, _ protocol.Invocation) protocol.Result {
+func (f *Filter) OnResponse(_ context.Context, result protocol.Result, _ protocol.Invoker, _ protocol.Invocation) protocol.Result {
 	return result
 }
 
 // writeLogToFile actually write the logs into file
-func (ef *AccessLogFilter) writeLogToFile(data AccessLogData) {
+func (f *Filter) writeLogToFile(data Data) {
 	accessLog := data.accessLog
 	if isDefault(accessLog) {
 		logger.Info(data.toLogMessage())
 		return
 	}
 
-	logFile, err := ef.openLogFile(accessLog)
+	logFile, err := f.openLogFile(accessLog)
 	if err != nil {
 		logger.Warnf("Can not open the access log file: %s, %v", accessLog, err)
 		return
@@ -186,7 +187,7 @@ func (ef *AccessLogFilter) writeLogToFile(data AccessLogData) {
 // You may find out that, once we want to write access log into log file,
 // we open the file again and again.
 // It needs to be optimized.
-func (ef *AccessLogFilter) openLogFile(accessLog string) (*os.File, error) {
+func (f *Filter) openLogFile(accessLog string) (*os.File, error) {
 	logFile, err := os.OpenFile(accessLog, os.O_CREATE|os.O_APPEND|os.O_RDWR, LogFileMode)
 	if err != nil {
 		logger.Warnf("Can not open the access log file: %s, %v", accessLog, err)
@@ -221,9 +222,8 @@ func isDefault(accessLog string) bool {
 	return strings.EqualFold("true", accessLog) || strings.EqualFold("default", accessLog)
 }
 
-// GetAccessLogFilter return the instance of AccessLogFilter
-func GetAccessLogFilter() filter.Filter {
-	accessLogFilter := &AccessLogFilter{logChan: make(chan AccessLogData, LogMaxBuffer)}
+func NewFilter() *Filter {
+	accessLogFilter := &Filter{logChan: make(chan Data, LogMaxBuffer)}
 	go func() {
 		for accessLogData := range accessLogFilter.logChan {
 			accessLogFilter.writeLogToFile(accessLogData)
@@ -232,44 +232,44 @@ func GetAccessLogFilter() filter.Filter {
 	return accessLogFilter
 }
 
-// AccessLogData defines the data that will be log into file
-type AccessLogData struct {
+// Data defines the data that will be log into file
+type Data struct {
 	accessLog string
 	data      map[string]string
 }
 
-// toLogMessage convert the AccessLogData to String
-func (ef *AccessLogData) toLogMessage() string {
+// toLogMessage convert the Data to String
+func (d *Data) toLogMessage() string {
 	builder := strings.Builder{}
 	builder.WriteString("[")
-	builder.WriteString(ef.data[constant.TIMESTAMP_KEY])
+	builder.WriteString(d.data[constant.TIMESTAMP_KEY])
 	builder.WriteString("] ")
-	builder.WriteString(ef.data[constant.REMOTE_ADDR])
+	builder.WriteString(d.data[constant.REMOTE_ADDR])
 	builder.WriteString(" -> ")
-	builder.WriteString(ef.data[constant.LOCAL_ADDR])
+	builder.WriteString(d.data[constant.LOCAL_ADDR])
 	builder.WriteString(" - ")
-	if len(ef.data[constant.GROUP_KEY]) > 0 {
-		builder.WriteString(ef.data[constant.GROUP_KEY])
+	if len(d.data[constant.GROUP_KEY]) > 0 {
+		builder.WriteString(d.data[constant.GROUP_KEY])
 		builder.WriteString("/")
 	}
 
-	builder.WriteString(ef.data[constant.INTERFACE_KEY])
+	builder.WriteString(d.data[constant.INTERFACE_KEY])
 
-	if len(ef.data[constant.VERSION_KEY]) > 0 {
+	if len(d.data[constant.VERSION_KEY]) > 0 {
 		builder.WriteString(":")
-		builder.WriteString(ef.data[constant.VERSION_KEY])
+		builder.WriteString(d.data[constant.VERSION_KEY])
 	}
 
 	builder.WriteString(" ")
-	builder.WriteString(ef.data[constant.METHOD_KEY])
+	builder.WriteString(d.data[constant.METHOD_KEY])
 	builder.WriteString("(")
-	if len(ef.data[Types]) > 0 {
-		builder.WriteString(ef.data[Types])
+	if len(d.data[Types]) > 0 {
+		builder.WriteString(d.data[Types])
 	}
 	builder.WriteString(") ")
 
-	if len(ef.data[Arguments]) > 0 {
-		builder.WriteString(ef.data[Arguments])
+	if len(d.data[Arguments]) > 0 {
+		builder.WriteString(d.data[Arguments])
 	}
 	return builder.String()
 }

filter/filter_impl/access_log_filter_test.go → filter/accesslog/filter_test.go

@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 
-package filter_impl
+package accesslog
 
 import (
 	"context"
@@ -34,7 +34,7 @@ import (
 	"dubbo.apache.org/dubbo-go/v3/protocol/invocation"
 )
 
-func TestAccessLogFilter_Invoke_Not_Config(t *testing.T) {
+func TestFilter_Invoke_Not_Config(t *testing.T) {
 	ctrl := gomock.NewController(t)
 	defer ctrl.Finish()
 	url, _ := common.NewURL(
@@ -48,12 +48,12 @@ func TestAccessLogFilter_Invoke_Not_Config(t *testing.T) {
 	attach := make(map[string]interface{}, 10)
 	inv := invocation.NewRPCInvocation("MethodName", []interface{}{"OK", "Hello"}, attach)
 
-	accessLogFilter := GetAccessLogFilter()
+	accessLogFilter := &Filter{}
 	result := accessLogFilter.Invoke(context.Background(), invoker, inv)
 	assert.Nil(t, result.Error())
 }
 
-func TestAccessLogFilterInvokeDefaultConfig(t *testing.T) {
+func TestFilterInvokeDefaultConfig(t *testing.T) {
 	ctrl := gomock.NewController(t)
 	defer ctrl.Finish()
 	url, _ := common.NewURL(
@@ -69,14 +69,14 @@ func TestAccessLogFilterInvokeDefaultConfig(t *testing.T) {
 	attach[constant.GROUP_KEY] = "MyGroup"
 	inv := invocation.NewRPCInvocation("MethodName", []interface{}{"OK", "Hello"}, attach)
 
-	accessLogFilter := GetAccessLogFilter()
+	accessLogFilter := &Filter{}
 	result := accessLogFilter.Invoke(context.Background(), invoker, inv)
 	assert.Nil(t, result.Error())
 }
 
-func TestAccessLogFilterOnResponse(t *testing.T) {
+func TestFilterOnResponse(t *testing.T) {
 	result := &protocol.RPCResult{}
-	accessLogFilter := GetAccessLogFilter()
+	accessLogFilter := &Filter{}
 	response := accessLogFilter.OnResponse(context.TODO(), result, nil, nil)
 	assert.Equal(t, result, response)
 }

filter/filter_impl/active_filter.go → filter/active/filter.go

@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 
-package filter_impl
+package active
 
 import (
 	"context"
@@ -31,27 +31,29 @@ import (
 )
 
 const (
-	active               = "active"
 	dubboInvokeStartTime = "dubboInvokeStartTime"
+	Active               = "active"
 )
 
 func init() {
-	extension.SetFilter(active, GetActiveFilter)
+	extension.SetFilter(Active, func() filter.Filter {
+		return &Filter{}
+	})
 }
 
-// ActiveFilter tracks the requests status
-type ActiveFilter struct{}
+// Filter tracks the requests status
+type Filter struct{}
 
 // Invoke starts to record the requests status
-func (ef *ActiveFilter) Invoke(ctx context.Context, invoker protocol.Invoker, invocation protocol.Invocation) protocol.Result {
+func (f *Filter) Invoke(ctx context.Context, invoker protocol.Invoker, invocation protocol.Invocation) protocol.Result {
 	logger.Infof("invoking active filter. %v,%v", invocation.MethodName(), len(invocation.Arguments()))
 	invocation.(*invocation2.RPCInvocation).SetAttachments(dubboInvokeStartTime, strconv.FormatInt(protocol.CurrentTimeMillis(), 10))
 	protocol.BeginCount(invoker.GetURL(), invocation.MethodName())
 	return invoker.Invoke(ctx, invocation)
 }
 
 // OnResponse update the active count base on the request result.
-func (ef *ActiveFilter) OnResponse(ctx context.Context, result protocol.Result, invoker protocol.Invoker, invocation protocol.Invocation) protocol.Result {
+func (f *Filter) OnResponse(ctx context.Context, result protocol.Result, invoker protocol.Invoker, invocation protocol.Invocation) protocol.Result {
 	startTime, err := strconv.ParseInt(invocation.(*invocation2.RPCInvocation).AttachmentsByKey(dubboInvokeStartTime, "0"), 10, 64)
 	if err != nil {
 		result.SetError(err)
@@ -62,8 +64,3 @@ func (ef *ActiveFilter) OnResponse(ctx context.Context, result protocol.Result,
 	protocol.EndCount(invoker.GetURL(), invocation.MethodName(), elapsed, result.Error() == nil)
 	return result
 }
-
-// GetActiveFilter creates ActiveFilter instance
-func GetActiveFilter() filter.Filter {
-	return &ActiveFilter{}
-}