add more comment

zouyx · Sep 16, 2020 · 4ec1603 · 4ec1603
1 parent 1fe49dd
commit 4ec1603
Show file tree

Hide file tree

Showing 9 changed files with 20 additions and 11 deletions.
diff --git a/component/remote/abs.go b/component/remote/abs.go
@@ -24,6 +24,7 @@ import (
 	"github.com/zouyx/agollo/v4/protocol/http"
 )
 
+// AbsApolloConfig 抽象 apollo 配置
 type AbsApolloConfig struct {
 	remoteApollo ApolloConfig
 }

diff --git a/component/remote/async.go b/component/remote/async.go
@@ -39,6 +39,7 @@ const (
 	defaultContentKey = "content"
 )
 
+// CreateAsyncApolloConfig 创建异步 apollo 配置
 func CreateAsyncApolloConfig() ApolloConfig {
 	a := &asyncApolloConfig{}
 	a.remoteApollo = a

diff --git a/component/remote/remote.go b/component/remote/remote.go
@@ -22,10 +22,16 @@ import (
 	"github.com/zouyx/agollo/v4/protocol/http"
 )
 
+// ApolloConfig apollo 配置
 type ApolloConfig interface {
+	// GetNotifyURLSuffix 获取异步更新路径
 	GetNotifyURLSuffix(notifications string, config config.AppConfig) string
+	// GetSyncURI 获取同步路径
 	GetSyncURI(config config.AppConfig, namespaceName string) string
+	// Sync 同步获取 Apollo 配置
 	Sync(appConfig *config.AppConfig) []*config.ApolloConfig
+	// CallBack 根据 namespace 获取 callback 方法
 	CallBack(namespace string) http.CallBack
+	// SyncWithNamespace 通过 namespace 同步 apollo 配置
 	SyncWithNamespace(namespace string, appConfig *config.AppConfig) *config.ApolloConfig
 }
diff --git a/component/remote/sync.go b/component/remote/sync.go
@@ -30,6 +30,7 @@ import (
 	"path"
 )
 
+// CreateSyncApolloConfig 创建同步获取 Apollo 配置
 func CreateSyncApolloConfig() ApolloConfig {
 	a := &syncApolloConfig{}
 	a.remoteApollo = a

diff --git a/env/config/apollo_config.go b/env/config/apollo_config.go
@@ -73,7 +73,7 @@ type ApolloConnConfig struct {
 	sync.RWMutex
 }
 
-//ApolloConfig apollo配置
+// ApolloConfig apollo配置
 type ApolloConfig struct {
 	ApolloConnConfig
 	Configurations map[string]interface{} `json:"configurations"`

diff --git a/env/file/file_handler.go b/env/file/file_handler.go
@@ -24,6 +24,6 @@ import (
 //FileHandler 备份文件读写
 type FileHandler interface {
 	WriteConfigFile(config *config.ApolloConfig, configPath string) error
-	GetConfigFile(configDir string, appId string, namespace string) string
-	LoadConfigFile(configDir string, appId string, namespace string) (*config.ApolloConfig, error)
+	GetConfigFile(configDir string, appID string, namespace string) string
+	LoadConfigFile(configDir string, appID string, namespace string) (*config.ApolloConfig, error)
 }
diff --git a/env/file/json/json.go b/env/file/json/json.go
@@ -47,8 +47,8 @@ func (fileHandler *FileHandler) WriteConfigFile(config *config.ApolloConfig, con
 }
 
 // GetConfigFile get real config file
-func (fileHandler *FileHandler) GetConfigFile(configDir string, appId string, namespace string) string {
-	key := fmt.Sprintf("%s-%s", appId, namespace)
+func (fileHandler *FileHandler) GetConfigFile(configDir string, appID string, namespace string) string {
+	key := fmt.Sprintf("%s-%s", appID, namespace)
 	fullPath := configFileMap[key]
 	if fullPath == "" {
 		filePath := fmt.Sprintf("%s%s", key, Suffix)
@@ -62,8 +62,8 @@ func (fileHandler *FileHandler) GetConfigFile(configDir string, appId string, na
 }
 
 //LoadConfigFile load config from file
-func (fileHandler *FileHandler) LoadConfigFile(configDir string, appId string, namespace string) (*config.ApolloConfig, error) {
-	configFilePath := fileHandler.GetConfigFile(configDir, appId, namespace)
+func (fileHandler *FileHandler) LoadConfigFile(configDir string, appID string, namespace string) (*config.ApolloConfig, error) {
+	configFilePath := fileHandler.GetConfigFile(configDir, appID, namespace)
 	log.Info("load config file from :", configFilePath)
 	c, e := jsonFileConfig.Load(configFilePath, func(b []byte) (interface{}, error) {
 		config := &config.ApolloConfig{}

diff --git a/extension/file_test.go b/extension/file_test.go
@@ -34,11 +34,11 @@ func (r *TestFileHandler) WriteConfigFile(config *config.ApolloConfig, configPat
 }
 
 //GetConfigFile 获得配置文件路径
-func (r *TestFileHandler) GetConfigFile(configDir string, appId string, namespace string) string {
+func (r *TestFileHandler) GetConfigFile(configDir string, appID string, namespace string) string {
 	return ""
 }
 
-func (r *TestFileHandler) LoadConfigFile(configDir string, appId string, namespace string) (*config.ApolloConfig, error) {
+func (r *TestFileHandler) LoadConfigFile(configDir string, appID string, namespace string) (*config.ApolloConfig, error) {
 	return nil, nil
 }
 

diff --git a/start_test.go b/start_test.go
@@ -210,12 +210,12 @@ func (fileHandler *testFileHandler) WriteConfigFile(config *config.ApolloConfig,
 }
 
 // GetConfigFile get real config file
-func (fileHandler *testFileHandler) GetConfigFile(configDir string, appId string, namespace string) string {
+func (fileHandler *testFileHandler) GetConfigFile(configDir string, appID string, namespace string) string {
 	return ""
 }
 
 // LoadConfigFile load config from file
-func (fileHandler *testFileHandler) LoadConfigFile(configDir string, appId string, namespace string) (*config.ApolloConfig, error) {
+func (fileHandler *testFileHandler) LoadConfigFile(configDir string, appID string, namespace string) (*config.ApolloConfig, error) {
 	return nil, nil
 }