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/constant/default.go

@@ -51,9 +51,9 @@ const (
 const (
 	DEFAULT_KEY               = "default"
 	PREFIX_DEFAULT_KEY        = "default."
-	DEFAULT_SERVICE_FILTERS   = "echo,token,accesslog,tps,generic_service,execute,pshutdown"
-	DEFAULT_REFERENCE_FILTERS = "cshutdown"
-	GENERIC_REFERENCE_FILTERS = "generic"
+	DEFAULT_SERVICE_FILTERS   = EchoFilterKey + "," + TokenFilterKey + "," + AccessLogFilterKey + "," + TpsLimitFilterKey + "," + GenericServiceFilterKey + "," + ExecuteLimitFilterKey + "," + GracefulShutdownProviderFilterKey
+	DEFAULT_REFERENCE_FILTERS = GracefulShutdownConsumerFilterKey
+	GENERIC_REFERENCE_FILTERS = GenericFilterKey
 	GENERIC                   = "$invoke"
 	ECHO                      = "$echo"
 )

common/constant/key.go

@@ -60,6 +60,29 @@ const (
 	REFERENCE_FILTER_KEY = "reference.filter"
 )
 
+// Filter Keys
+const (
+	AccessLogFilterKey                = "accesslog"
+	ActiveFilterKey                   = "active"
+	AuthConsumerFilterKey             = "sign"
+	AuthProviderFilterKey             = "auth"
+	EchoFilterKey                     = "echo"
+	ExecuteLimitFilterKey             = "execute"
+	GenericFilterKey                  = "generic"
+	GenericServiceFilterKey           = "generic_service"
+	GracefulShutdownProviderFilterKey = "pshutdown"
+	GracefulShutdownConsumerFilterKey = "cshutdown"
+	HystrixConsumerFilterKey          = "hystrix_consumer"
+	HystrixProviderFilterKey          = "hystrix_provider"
+	MetricsFilterKey                  = "metrics"
+	SeataFilterKey                    = "seata"
+	SentinelProviderFilterKey         = "sentinel-provider"
+	SentinelConsumerFilterKey         = "sentinel-consumer"
+	TokenFilterKey                    = "token"
+	TpsLimitFilterKey                 = "tps"
+	TracingFilterKey                  = "tracing"
+)
+
 const (
 	TIMESTAMP_KEY                          = "timestamp"
 	REMOTE_TIMESTAMP_KEY                   = "remote.timestamp"
@@ -74,7 +97,6 @@ const (
 	FORKS_KEY                              = "forks"
 	DEFAULT_FORKS                          = 2
 	DEFAULT_TIMEOUT                        = 1000
-	ACCESS_LOG_KEY                         = "accesslog"
 	TPS_LIMITER_KEY                        = "tps.limiter"
 	TPS_REJECTED_EXECUTION_HANDLER_KEY     = "tps.limit.rejected.handler"
 	TPS_LIMIT_RATE_KEY                     = "tps.limit.rate"
@@ -85,8 +107,6 @@ const (
 	EXECUTE_LIMIT_KEY                      = "execute.limit"
 	DEFAULT_EXECUTE_LIMIT                  = "-1"
 	EXECUTE_REJECTED_EXECUTION_HANDLER_KEY = "execute.limit.rejected.handler"
-	PROVIDER_SHUTDOWN_FILTER               = "pshutdown"
-	CONSUMER_SHUTDOWN_FILTER               = "cshutdown"
 	SERIALIZATION_KEY                      = "serialization"
 	PID_KEY                                = "pid"
 	SYNC_REPORT_KEY                        = "sync.report"
@@ -251,11 +271,8 @@ const (
 	AttachmentKey = DubboCtxKey("attachment")
 )
 
+// Auth filter
 const (
-	// name of consumer sign filter
-	CONSUMER_SIGN_FILTER = "sign"
-	// name of consumer sign filter
-	PROVIDER_AUTH_FILTER = "auth"
 	// name of service filter
 	SERVICE_AUTH_KEY = "auth"
 	// key of authenticator

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]()
 }

config/config_loader_test.go

@@ -77,10 +77,10 @@ func TestConfigLoader(t *testing.T) {
 }
 
 func TestLoad(t *testing.T) {
-	extension.SetFilter(constant.CONSUMER_SHUTDOWN_FILTER, func() filter.Filter {
+	extension.SetFilter(constant.GracefulShutdownConsumerFilterKey, func() filter.Filter {
 		return &mockGracefulShutdownFilter{}
 	})
-	extension.SetFilter(constant.PROVIDER_SHUTDOWN_FILTER, func() filter.Filter {
+	extension.SetFilter(constant.GracefulShutdownProviderFilterKey, func() filter.Filter {
 		return &mockGracefulShutdownFilter{}
 	})
 

config/graceful_shutdown.go

@@ -60,10 +60,10 @@ func GracefulShutdownInit() {
 	signal.Notify(signals, ShutdownSignals...)
 
 	// retrieve ShutdownConfig for gracefulShutdownFilter
-	if filter, ok := extension.GetFilter(constant.CONSUMER_SHUTDOWN_FILTER).(Setter); ok && GetConsumerConfig().ShutdownConfig != nil {
+	if filter, ok := extension.GetFilter(constant.GracefulShutdownConsumerFilterKey).(Setter); ok && GetConsumerConfig().ShutdownConfig != nil {
 		filter.Set(GracefulShutdownFilterShutdownConfig, GetConsumerConfig().ShutdownConfig)
 	}
-	if filter, ok := extension.GetFilter(constant.PROVIDER_SHUTDOWN_FILTER).(Setter); ok && GetProviderConfig().ShutdownConfig != nil {
+	if filter, ok := extension.GetFilter(constant.GracefulShutdownProviderFilterKey).(Setter); ok && GetProviderConfig().ShutdownConfig != nil {
 		filter.Set(GracefulShutdownFilterShutdownConfig, GetProviderConfig().ShutdownConfig)
 	}
 

config/graceful_shutdown_test.go

@@ -29,10 +29,10 @@ import (
 )
 
 func TestGracefulShutdownInit(t *testing.T) {
-	extension.SetFilter(constant.CONSUMER_SHUTDOWN_FILTER, func() filter.Filter {
+	extension.SetFilter(constant.GracefulShutdownConsumerFilterKey, func() filter.Filter {
 		return &mockGracefulShutdownFilter{}
 	})
-	extension.SetFilter(constant.PROVIDER_SHUTDOWN_FILTER, func() filter.Filter {
+	extension.SetFilter(constant.GracefulShutdownProviderFilterKey, func() filter.Filter {
 		return &mockGracefulShutdownFilter{}
 	})
 	GracefulShutdownInit()

config/reference_config_test.go

@@ -385,7 +385,7 @@ func (p *mockRegistryProtocol) GetRegistries() []registry.Registry {
 
 func mockFilter() {
 	consumerFiler := &mockShutdownFilter{}
-	extension.SetFilter(constant.CONSUMER_SHUTDOWN_FILTER, func() filter.Filter {
+	extension.SetFilter(constant.GracefulShutdownConsumerFilterKey, func() filter.Filter {
 		return consumerFiler
 	})
 }

config/service_config.go

@@ -304,7 +304,7 @@ func (c *ServiceConfig) getUrlMap() url.Values {
 	urlMap.Set(constant.SERVICE_FILTER_KEY, mergeValue(providerConfig.Filter, c.Filter, constant.DEFAULT_SERVICE_FILTERS))
 
 	// filter special config
-	urlMap.Set(constant.ACCESS_LOG_KEY, c.AccessLog)
+	urlMap.Set(constant.AccessLogFilterKey, c.AccessLog)
 	// tps limiter
 	urlMap.Set(constant.TPS_LIMIT_STRATEGY_KEY, c.TpsLimitStrategy)
 	urlMap.Set(constant.TPS_LIMIT_INTERVAL_KEY, c.TpsLimitInterval)

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)