change conf README

Author: zhufuyi

pkg/conf/README.md

@@ -9,16 +9,17 @@ Parsing yaml, json, toml configuration files to go struct.
 ```go
     import "github.com/zhufuyi/sponge/pkg/conf"
 
-    // Way 1: No listening profile
+    // Way 1: No listening configuration file
     config := &App{}
     err := conf.Parse("test.yml", config)
 
-    // Way 2: Enable listening profile
+    // Way 2: Enable listening configuration file
     config := &App{}
-    fs := []func(){
+    reloads  := []func(){
         func() {
-            fmt.Println("Listening for updates to the configuration file")
+            fmt.Println("close and reconnect mysql")
+            fmt.Println("close and reconnect redis")
         },
     }
-    err := conf.Parse("test.yml", config, fs...)
+    err := conf.Parse("test.yml", config, reloads...)
 ```

pkg/conf/parse.go

@@ -15,7 +15,7 @@ import (
 )
 
 // Parse configuration files to struct, including yaml, toml, json, etc., and turn on listening for configuration file changes if fs is not empty
-func Parse(configFile string, obj interface{}, fs ...func()) error {
+func Parse(configFile string, obj interface{}, reloads ...func()) error {
 	confFileAbs, err := filepath.Abs(configFile)
 	if err != nil {
 		return err
@@ -38,23 +38,45 @@ func Parse(configFile string, obj interface{}, fs ...func()) error {
 		return err
 	}
 
-	if len(fs) > 0 {
-		watchConfig(obj, fs...)
+	if len(reloads) > 0 {
+		watchConfig(obj, reloads...)
+	}
+
+	return nil
+}
+
+// ParseConfigData parse data to struct
+func ParseConfigData(data []byte, format string, obj interface{}, reloads ...func()) error {
+	viper.SetConfigType(format)
+	err := viper.ReadConfig(bytes.NewBuffer(data))
+	if err != nil {
+		return err
+	}
+
+	err = viper.Unmarshal(obj)
+	if err != nil {
+		return err
+	}
+
+	if len(reloads) > 0 {
+		watchConfig(obj, reloads...)
 	}
 
 	return nil
 }
 
 // listening for profile updates
-func watchConfig(obj interface{}, fs ...func()) {
+func watchConfig(obj interface{}, reloads ...func()) {
 	viper.WatchConfig()
+
+	// Note: OnConfigChange is called twice on Windows
 	viper.OnConfigChange(func(e fsnotify.Event) {
 		err := viper.Unmarshal(obj)
 		if err != nil {
 			fmt.Println("viper.Unmarshal error: ", err)
 		} else {
-			for _, f := range fs {
-				f()
+			for _, reload := range reloads {
+				reload()
 			}
 		}
 	})
@@ -123,13 +145,3 @@ func replaceDSN(str string) string {
 
 	return fmt.Sprintf("%s******%s", data[:start+1], data[end:])
 }
-
-// ParseConfigData parse data to struct
-func ParseConfigData(data []byte, format string, obj interface{}) error {
-	viper.SetConfigType(format)
-	err := viper.ReadConfig(bytes.NewBuffer(data))
-	if err != nil {
-		return err
-	}
-	return viper.Unmarshal(obj)
-}

pkg/conf/parse_test.go

@@ -9,18 +9,6 @@ import (
 
 var c = make(map[string]interface{})
 
-func init() {
-	// result error test
-	_ = Parse("test.yml", nil)
-	// not found error test
-	_ = Parse("notfound.yml", &c)
-
-	err := Parse("test.yml", &c)
-	if err != nil {
-		panic(err)
-	}
-}
-
 func TestShow(t *testing.T) {
 	t.Log(Show(c))
 	t.Log(Show(make(chan string)))
@@ -45,21 +33,18 @@ func Test_hideSensitiveFields(t *testing.T) {
 	fmt.Printf(hideSensitiveFields(str))
 }
 
-// test listening for profile updates
-func TestWatch(t *testing.T) {
-	time.Sleep(time.Second)
+// test listening for configuration file updates
+func TestParse(t *testing.T) {
 	conf := make(map[string]interface{})
 
-	fs := []func(){
+	reloads := []func(){
 		func() {
-			fmt.Println("update field 1")
-		},
-		func() {
-			fmt.Println("update field 2")
+			fmt.Println("close and reconnect mysql")
+			fmt.Println("close and reconnect redis")
 		},
 	}
 
-	err := Parse("test.yml", &conf, fs...)
+	err := Parse("test.yml", &conf, reloads...)
 	if err != nil {
 		t.Error(err)
 		return
@@ -75,13 +60,39 @@ func TestWatch(t *testing.T) {
 	time.Sleep(time.Millisecond * 100)
 }
 
+func TestParseErr(t *testing.T) {
+	// result error test
+	err := Parse("test.yml", nil)
+	t.Log(err)
+
+	// not found error test
+	err = Parse("notfound.yml", &c)
+	t.Log(err)
+}
+
 func TestParseConfigData(t *testing.T) {
 	conf := make(map[string]interface{})
+
+	reloads := []func(){
+		func() {
+			fmt.Println("close and reconnect mysql")
+			fmt.Println("close and reconnect redis")
+		},
+	}
+
 	data, _ := os.ReadFile("test.yml")
-	err := ParseConfigData(data, "yaml", &conf)
+	err := ParseConfigData(data, "yaml", &conf, reloads...)
 	if err != nil {
 		t.Error(err)
 		return
 	}
-	t.Log(conf)
+
+	time.Sleep(time.Second)
+	content, _ := os.ReadFile("test.yml")
+	contentChange := append(content, byte('#'))
+	time.Sleep(time.Millisecond * 100)
+	_ = os.WriteFile("test.yml", contentChange, 0666) // change file
+	time.Sleep(time.Millisecond * 100)
+	_ = os.WriteFile("test.yml", content, 0666) // recovery documents
+	time.Sleep(time.Millisecond * 100)
 }