Merge pull request '序列化约束升级' (#1) from feature/xml into master

Reviewed-on: #1

abstract/serialize.go

@@ -0,0 +1,36 @@
+// Package abstract ...
+//
+// Description : abstract ...
+//
+// Author : go_developer@163.com<白茶清欢>
+//
+// Date : 2024-10-23 16:54
+package abstract
+
+import "io"
+
+// Serializable 序列化的接口约束
+//
+// Author : go_developer@163.com<白茶清欢>
+//
+// Date : 16:55 2024/10/23
+type Serializable interface {
+	// UnmarshalWithNumber 反序列化，同时解析数字
+	UnmarshalWithNumber(byteData []byte, receiver any) error
+	// UnmarshalWithNumberIgnoreError 反序列化，同时解析数字, 忽略结果的成功与失败
+	UnmarshalWithNumberIgnoreError(byteData []byte, receiver any)
+	// UnmarshalWithNumberForIOReader 从文件流读取数据并反序列化
+	UnmarshalWithNumberForIOReader(ioReader io.ReadCloser, receiver any) error
+	// UnmarshalWithNumberForIOReaderIgnoreError 从文件流读取数据并反序列化, 忽略异常
+	UnmarshalWithNumberForIOReaderIgnoreError(ioReader io.ReadCloser, receiver any)
+	// UnmarshalWithNumberForString 序列化字符串反解析为结构体
+	UnmarshalWithNumberForString(input string, receiver any) error
+	// UnmarshalWithNumberForStringIgnoreError 序列化字符串反解析为结构体,并忽略异常
+	UnmarshalWithNumberForStringIgnoreError(input string, receiver any)
+	// MarshalForByte 序列化为字节数组
+	MarshalForByte(input any) ([]byte, error)
+	MarshalForByteIgnoreError(input any) []byte
+	// MarshalForString 序列化为字符串
+	MarshalForString(input any) (string, error)
+	MarshalForStringIgnoreError(input any) string
+}

file.go

@@ -8,6 +8,7 @@
 package serialize
 
 import (
+	"encoding/xml"
 	"errors"
 	"git.zhangdeman.cn/zhangdeman/consts"
 	"io"
@@ -22,8 +23,6 @@ import (
 	"git.zhangdeman.cn/zhangdeman/util/define"
 
 	"github.com/go-ini/ini"
-
-	yml "gopkg.in/yaml.v3"
 )
 
 var (
@@ -67,7 +66,7 @@ func (f *file) GetProjectPath() (string, error) {
 // Author : go_developer@163.com<白茶清欢>
 //
 // Date : 10:35 下午 2021/4/26
-func (f *file) ReadYmlContent(filePath string, result interface{}) error {
+func (f *file) ReadYmlContent(filePath string, result any) error {
 	if nil == result {
 		return errors.New("接收读取结果的数据指针为NIL")
 	}
@@ -78,7 +77,7 @@ func (f *file) ReadYmlContent(filePath string, result interface{}) error {
 	if fileContent, err = f.ReadFileContent(filePath); nil != err {
 		return err
 	}
-	return yml.Unmarshal(fileContent, result)
+	return Yml.UnmarshalWithNumber(fileContent, result)
 }
 
 // ReadJSONContent 读取JSON内容,并解析到指定的结构体中
@@ -86,7 +85,7 @@ func (f *file) ReadYmlContent(filePath string, result interface{}) error {
 // Author : go_developer@163.com<白茶清欢>
 //
 // Date : 15:23 2022/6/9
-func (f *file) ReadJSONContent(filePath string, result interface{}) error {
+func (f *file) ReadJSONContent(filePath string, result any) error {
 	if nil == result {
 		return errors.New("接收读取结果的数据指针为NIL")
 	}
@@ -105,7 +104,7 @@ func (f *file) ReadJSONContent(filePath string, result interface{}) error {
 // Author : go_developer@163.com<白茶清欢>
 //
 // Date : 13:21 2022/7/2
-func (f *file) ReadIniContent(filePath string, result interface{}) error {
+func (f *file) ReadIniContent(filePath string, result any) error {
 	if nil == result {
 		return errors.New("接收读取结果的数据指针为NIL")
 	}
@@ -117,24 +116,42 @@ func (f *file) ReadIniContent(filePath string, result interface{}) error {
 // Author : go_developer@163.com<白茶清欢>
 //
 // Date : 21:08 2023/7/31
-func (f *file) ReadTomlContent(filePath string, result interface{}) error {
+func (f *file) ReadTomlContent(filePath string, result any) error {
 	if nil == result {
 		return errors.New("接收读取结果的数据指针为NIL")
 	}
-	if _, err := toml.DecodeFile("example.toml", result); err != nil {
+	if _, err := toml.DecodeFile(filePath, result); err != nil {
 		return err
 	}
 	return nil
 }
 
+// ReadXmlContent ...
+//
+// Author : go_developer@163.com<白茶清欢>
+//
+// Date : 18:39 2024/10/23
+func (f *file) ReadXmlContent(filePath string, result any) error {
+	var (
+		fileContent []byte
+		err         error
+	)
+
+	if fileContent, err = f.ReadFileContent(filePath); nil != err {
+		return err
+	}
+
+	return xml.Unmarshal(fileContent, result)
+}
+
 // ReadAnyFileContent 读取任意类型的文件并解析
 //
 // Author : go_developer@163.com<白茶清欢>
 //
 // Date : 13:11 2022/7/2
-func (f *file) ReadAnyFileContent(filePath string, receiver interface{}) error {
+func (f *file) ReadAnyFileContent(filePath string, receiver any) error {
 	var (
-		parseFunc func(filePath string, receiver interface{}) error
+		parseFunc func(filePath string, receiver any) error
 	)
 	filePathArr := strings.Split(filePath, "#@#")
 	fileExt := ""
@@ -147,14 +164,14 @@ func (f *file) ReadAnyFileContent(filePath string, receiver interface{}) error {
 	switch fileExt {
 	case consts.FileTypeJson:
 		parseFunc = f.ReadJSONContent
-	case consts.FileTypeYml:
+	case consts.FileTypeYml, consts.FileTypeYaml:
-		fallthrough
-	case consts.FileTypeYaml:
 		parseFunc = f.ReadYmlContent
 	case consts.FileTypeIni:
 		parseFunc = f.ReadIniContent
 	case consts.FileTypeToml:
 		parseFunc = f.ReadTomlContent
+	case consts.FileTypeXml:
+		parseFunc = f.ReadXmlContent
 	default:
 		return errors.New(fileExt + " 暂不支持当前格式的文件解析")
 	}

go.mod

@@ -11,4 +11,4 @@ require (
 	gopkg.in/yaml.v3 v3.0.1
 )
 
-require git.zhangdeman.cn/zhangdeman/consts v0.0.0-20241015035056-b6f4a6512763
+require git.zhangdeman.cn/zhangdeman/consts v0.0.0-20241023090605-10cff9173059

go.sum

@@ -8,6 +8,8 @@ git.zhangdeman.cn/zhangdeman/consts v0.0.0-20240617073616-39e82fd033ed h1:BGv+y6
 git.zhangdeman.cn/zhangdeman/consts v0.0.0-20240617073616-39e82fd033ed/go.mod h1:IXXaZkb7vGzGnGM5RRWrASAuwrVSNxuoe0DmeXx5g6k=
 git.zhangdeman.cn/zhangdeman/consts v0.0.0-20241015035056-b6f4a6512763 h1:aG59AjZAn/Y+smWoa6l6HQB+yh/Rpml79EvmfjEb6Ks=
 git.zhangdeman.cn/zhangdeman/consts v0.0.0-20241015035056-b6f4a6512763/go.mod h1:IXXaZkb7vGzGnGM5RRWrASAuwrVSNxuoe0DmeXx5g6k=
+git.zhangdeman.cn/zhangdeman/consts v0.0.0-20241023090605-10cff9173059 h1:TPAYdTKKUjgxtCnK38d1Tb4teyQp1C7wYHPdR32yZtM=
+git.zhangdeman.cn/zhangdeman/consts v0.0.0-20241023090605-10cff9173059/go.mod h1:IXXaZkb7vGzGnGM5RRWrASAuwrVSNxuoe0DmeXx5g6k=
 git.zhangdeman.cn/zhangdeman/util v0.0.0-20230810093304-ccb4045065c4 h1:MgZ2f1BkUtfP8D6uDX9S8o+V4wYUw76HlAw3xCH9epA=
 git.zhangdeman.cn/zhangdeman/util v0.0.0-20230810093304-ccb4045065c4/go.mod h1:tPl6isAsRQLZrX8G3/8fCdhN4OcZypdmdHR/PDkd2PY=
 git.zhangdeman.cn/zhangdeman/util v0.0.0-20230815042559-b34984be7444 h1:JVp575weLUX4sfhgjjxotJPxfHio7Ua8KHH3LMRRs2E=

json.go

@@ -38,7 +38,7 @@ type ownJSON struct {
 // Author : go_developer@163.com<白茶清欢>
 //
 // Date : 8:39 下午 2021/9/14
-func (oj *ownJSON) UnmarshalWithNumber(byteData []byte, receiver interface{}) error {
+func (oj *ownJSON) UnmarshalWithNumber(byteData []byte, receiver any) error {
 	decoder := json.NewDecoder(bytes.NewReader(byteData))
 	decoder.UseNumber()
 	return decoder.Decode(receiver)
@@ -49,7 +49,7 @@ func (oj *ownJSON) UnmarshalWithNumber(byteData []byte, receiver interface{}) er
 // Author : go_developer@163.com<白茶清欢>
 //
 // Date : 20:46 2023/12/24
-func (oj *ownJSON) UnmarshalWithNumberIgnoreError(byteData []byte, receiver interface{}) {
+func (oj *ownJSON) UnmarshalWithNumberIgnoreError(byteData []byte, receiver any) {
 	_ = oj.UnmarshalWithNumber(byteData, receiver)
 }
 
@@ -58,7 +58,7 @@ func (oj *ownJSON) UnmarshalWithNumberIgnoreError(byteData []byte, receiver inte
 // Author : go_developer@163.com<白茶清欢>
 //
 // Date : 8:43 下午 2021/9/14
-func (oj *ownJSON) UnmarshalWithNumberForIOReader(ioReader io.ReadCloser, receiver interface{}) error {
+func (oj *ownJSON) UnmarshalWithNumberForIOReader(ioReader io.ReadCloser, receiver any) error {
 	decoder := json.NewDecoder(ioReader)
 	decoder.UseNumber()
 	return decoder.Decode(receiver)
@@ -69,7 +69,7 @@ func (oj *ownJSON) UnmarshalWithNumberForIOReader(ioReader io.ReadCloser, receiv
 // Author : go_developer@163.com<白茶清欢>
 //
 // Date : 20:47 2023/12/24
-func (oj *ownJSON) UnmarshalWithNumberForIOReaderIgnoreError(ioReader io.ReadCloser, receiver interface{}) {
+func (oj *ownJSON) UnmarshalWithNumberForIOReaderIgnoreError(ioReader io.ReadCloser, receiver any) {
 	_ = oj.UnmarshalWithNumberForIOReader(ioReader, receiver)
 	return
 }
@@ -79,7 +79,7 @@ func (oj *ownJSON) UnmarshalWithNumberForIOReaderIgnoreError(ioReader io.ReadClo
 // Author : go_developer@163.com<白茶清欢>
 //
 // Date : 21:50 2023/7/22
-func (oj *ownJSON) UnmarshalWithNumberForString(input string, receiver interface{}) error {
+func (oj *ownJSON) UnmarshalWithNumberForString(input string, receiver any) error {
 	return oj.UnmarshalWithNumber([]byte(input), receiver)
 }
 
@@ -88,7 +88,7 @@ func (oj *ownJSON) UnmarshalWithNumberForString(input string, receiver interface
 // Author : go_developer@163.com<白茶清欢>
 //
 // Date : 20:48 2023/12/24
-func (oj *ownJSON) UnmarshalWithNumberForStringIgnoreError(input string, receiver interface{}) {
+func (oj *ownJSON) UnmarshalWithNumberForStringIgnoreError(input string, receiver any) {
 	oj.UnmarshalWithNumberIgnoreError([]byte(input), receiver)
 }
 
@@ -97,12 +97,24 @@ func (oj *ownJSON) UnmarshalWithNumberForStringIgnoreError(input string, receive
 // Author : go_developer@163.com<白茶清欢>
 //
 // Date : 21:56 2023/7/22
-func (oj *ownJSON) MarshalForByte(input interface{}) []byte {
+func (oj *ownJSON) MarshalForByte(input any) ([]byte, error) {
 	buffer := bytes.NewBuffer([]byte{})
 	encoder := json.NewEncoder(buffer)
 	encoder.SetEscapeHTML(false)
-	_ = encoder.Encode(input)
+	if err := encoder.Encode(input); nil != err {
-	return buffer.Bytes()
+		return nil, err
+	}
+	return buffer.Bytes(), nil
+}
+
+// MarshalForByteIgnoreError 序列化并忽略异常
+//
+// Author : go_developer@163.com<白茶清欢>
+//
+// Date : 17:16 2024/10/23
+func (oj *ownJSON) MarshalForByteIgnoreError(input any) []byte {
+	byteData, _ := oj.MarshalForByte(input)
+	return byteData
 }
 
 //	MarshalForString 序列化并返回字符串
@@ -110,8 +122,21 @@ func (oj *ownJSON) MarshalForByte(input interface{}) []byte {
 // Author : go_developer@163.com<白茶清欢>
 //
 // Date : 21:56 2023/7/22
-func (oj *ownJSON) MarshalForString(input interface{}) string {
+func (oj *ownJSON) MarshalForString(input any) (string, error) {
-	return string(oj.MarshalForByte(input))
+	byteData, err := oj.MarshalForByte(input)
+	if nil != err {
+		return "", err
+	}
+	return string(byteData), nil
+}
+
+// MarshalForStringIgnoreError ...
+//
+// Author : go_developer@163.com<白茶清欢>
+//
+// Date : 17:19 2024/10/23
+func (oj *ownJSON) MarshalForStringIgnoreError(input any) string {
+	return string(oj.MarshalForByteIgnoreError(input))
 }
 
 // Transition 数据结构转换 map/slice/struct => struct | struct =>  map/slice/struct
@@ -119,8 +144,8 @@ func (oj *ownJSON) MarshalForString(input interface{}) string {
 // Author : go_developer@163.com<白茶清欢>
 //
 // Date : 18:25 2023/12/29
-func (oj *ownJSON) Transition(input interface{}, receiver interface{}) error {
+func (oj *ownJSON) Transition(input any, receiver any) error {
-	return oj.UnmarshalWithNumber(oj.MarshalForByte(input), receiver)
+	return oj.UnmarshalWithNumber(oj.MarshalForByteIgnoreError(input), receiver)
 }
 
 // TransitionIgnoreError ...
@@ -128,8 +153,8 @@ func (oj *ownJSON) Transition(input interface{}, receiver interface{}) error {
 // Author : go_developer@163.com<白茶清欢>
 //
 // Date : 16:57 2024/1/10
-func (oj *ownJSON) TransitionIgnoreError(input interface{}, receiver interface{}) {
+func (oj *ownJSON) TransitionIgnoreError(input any, receiver any) {
-	_ = oj.UnmarshalWithNumber(oj.MarshalForByte(input), receiver)
+	_ = oj.UnmarshalWithNumber(oj.MarshalForByteIgnoreError(input), receiver)
 }
 
 // MergeDataForMap  合并数据到map
@@ -137,15 +162,15 @@ func (oj *ownJSON) TransitionIgnoreError(input interface{}, receiver interface{}
 // Author : go_developer@163.com<白茶清欢>
 //
 // Date : 16:48 2024/1/10
-func (oj *ownJSON) MergeDataForMap(ignoreError bool, dataList ...interface{}) (map[string]interface{}, error) {
+func (oj *ownJSON) MergeDataForMap(ignoreError bool, dataList ...any) (map[string]any, error) {
-	res := make(map[string]interface{})
+	res := make(map[string]any)
 	for _, data := range dataList {
 		if nil == data {
 			continue
 		}
 		var (
 			err     error
-			itemRes map[string]interface{}
+			itemRes map[string]any
 		)
 
 		if err = oj.Transition(data, &itemRes); nil != err {
@@ -167,7 +192,7 @@ func (oj *ownJSON) MergeDataForMap(ignoreError bool, dataList ...interface{}) (m
 // Author : go_developer@163.com<白茶清欢>
 //
 // Date : 17:00 2024/1/10
-func (oj *ownJSON) MergeDataForMapIgnoreError(dataList ...interface{}) map[string]interface{} {
+func (oj *ownJSON) MergeDataForMapIgnoreError(dataList ...any) map[string]any {
 	res, _ := oj.MergeDataForMap(true, dataList)
 	return res
 }
@@ -177,7 +202,7 @@ func (oj *ownJSON) MergeDataForMapIgnoreError(dataList ...interface{}) map[strin
 // Author : go_developer@163.com<白茶清欢>
 //
 // Date : 17:07 2024/1/10
-func (oj *ownJSON) MergeDataForReceiver(receiver interface{}, dataList ...interface{}) error {
+func (oj *ownJSON) MergeDataForReceiver(receiver any, dataList ...any) error {
 	res, err := oj.MergeDataForMap(false, dataList)
 	if nil != err {
 		return err
@@ -193,7 +218,7 @@ func (oj *ownJSON) MergeDataForReceiver(receiver interface{}, dataList ...interf
 // Author : go_developer@163.com<白茶清欢>
 //
 // Date : 5:45 下午 2021/11/5
-func (oj *ownJSON) ConsoleOutput(data interface{}) {
+func (oj *ownJSON) ConsoleOutput(data any) {
 	var out bytes.Buffer
 	switch reflect.TypeOf(data).Kind() {
 	case reflect.Slice:
@@ -205,7 +230,7 @@ func (oj *ownJSON) ConsoleOutput(data interface{}) {
 	case reflect.Struct:
 		fallthrough
 	case reflect.Ptr:
-		_ = json.Indent(&out, []byte(oj.MarshalForString(data)+"\n"), "", "\t")
+		_ = json.Indent(&out, []byte(oj.MarshalForStringIgnoreError(data)+"\n"), "", "\t")
 		_, _ = out.WriteTo(os.Stdout)
 		return
 	case reflect.Int:

xml.go

@@ -0,0 +1,69 @@
+// Package serialize ...
+//
+// Description : serialize ...
+//
+// Author : go_developer@163.com<白茶清欢>
+//
+// Date : 2024-10-23 17:51
+package serialize
+
+import (
+	"bytes"
+	"encoding/xml"
+	"io"
+)
+
+var (
+	Xml = &ownXml{}
+)
+
+type ownXml struct{}
+
+func (o *ownXml) UnmarshalWithNumber(byteData []byte, receiver any) error {
+	return xml.NewDecoder(bytes.NewReader(byteData)).Decode(receiver)
+}
+
+func (o *ownXml) UnmarshalWithNumberIgnoreError(byteData []byte, receiver any) {
+	_ = o.UnmarshalWithNumber(byteData, receiver)
+	return
+}
+
+func (o *ownXml) UnmarshalWithNumberForIOReader(ioReader io.ReadCloser, receiver any) error {
+	return xml.NewDecoder(ioReader).Decode(receiver)
+}
+
+func (o *ownXml) UnmarshalWithNumberForIOReaderIgnoreError(ioReader io.ReadCloser, receiver any) {
+	_ = o.UnmarshalWithNumberForIOReader(ioReader, receiver)
+	return
+}
+
+func (o *ownXml) UnmarshalWithNumberForString(input string, receiver any) error {
+	return o.UnmarshalWithNumber([]byte(input), receiver)
+}
+
+func (o *ownXml) UnmarshalWithNumberForStringIgnoreError(input string, receiver any) {
+	_ = o.UnmarshalWithNumberForString(input, receiver)
+	return
+}
+
+func (o *ownXml) MarshalForByte(input any) ([]byte, error) {
+	return xml.Marshal(input)
+}
+
+func (o *ownXml) MarshalForByteIgnoreError(input any) []byte {
+	byteData, _ := o.MarshalForByte(input)
+	return byteData
+}
+
+func (o *ownXml) MarshalForString(input any) (string, error) {
+	byteData, err := o.MarshalForByte(input)
+	if nil != err {
+		return "", err
+	}
+	return string(byteData), nil
+}
+
+func (o *ownXml) MarshalForStringIgnoreError(input any) string {
+	str, _ := o.MarshalForString(input)
+	return str
+}

yml.go

@@ -0,0 +1,68 @@
+// Package serialize ...
+//
+// Description : serialize ...
+//
+// Author : go_developer@163.com<白茶清欢>
+//
+// Date : 2024-10-23 17:06
+package serialize
+
+import (
+	"bytes"
+	"gopkg.in/yaml.v3"
+	"io"
+)
+
+var (
+	Yml = ownYml{}
+)
+
+type ownYml struct{}
+
+func (o *ownYml) MarshalForByte(input any) ([]byte, error) {
+	return yaml.Marshal(input)
+}
+
+func (o *ownYml) MarshalForByteIgnoreError(input any) []byte {
+	byteData, _ := o.MarshalForByte(input)
+	return byteData
+}
+
+func (o *ownYml) MarshalForString(input any) (string, error) {
+	byteData, err := o.MarshalForByte(input)
+	if nil != err {
+		return "", err
+	}
+	return string(byteData), nil
+}
+
+func (o *ownYml) MarshalForStringIgnoreError(input any) string {
+	return string(o.MarshalForByteIgnoreError(input))
+}
+
+func (o *ownYml) UnmarshalWithNumber(byteData []byte, receiver any) error {
+	return yaml.NewDecoder(bytes.NewReader(byteData)).Decode(receiver)
+}
+
+func (o *ownYml) UnmarshalWithNumberIgnoreError(byteData []byte, receiver any) {
+	_ = o.UnmarshalWithNumber(byteData, receiver)
+	return
+}
+
+func (o *ownYml) UnmarshalWithNumberForIOReader(ioReader io.ReadCloser, receiver any) error {
+	return yaml.NewDecoder(ioReader).Decode(receiver)
+}
+
+func (o *ownYml) UnmarshalWithNumberForIOReaderIgnoreError(ioReader io.ReadCloser, receiver any) {
+	_ = o.UnmarshalWithNumberForIOReader(ioReader, receiver)
+	return
+}
+
+func (o *ownYml) UnmarshalWithNumberForString(input string, receiver any) error {
+	return o.UnmarshalWithNumber([]byte(input), receiver)
+}
+
+func (o *ownYml) UnmarshalWithNumberForStringIgnoreError(input string, receiver any) {
+	_ = o.UnmarshalWithNumberForString(input, receiver)
+	return
+}