v1.0 支持使用js脚本扩展字段类型

.github/workflows/go.yml

@@ -19,7 +19,7 @@ jobs:
     - name: Set up Go
       uses: actions/setup-go@v3
       with:
-        go-version: '1.20'
+        go-version: '1.21'
 
     - run: go build -o bin/${{ github.event.repository.name }}_linux_x64 . 
     - run: CGO_ENABLED=0 GOOS=windows GOARCH=amd64 go build -o bin/${{ github.event.repository.name }}_win_x64.exe 

README.md

@@ -121,11 +121,15 @@ table_export -g csv_test,csv_test.csv
 
 # TODO
 
-在1.0版本中会加入数据检测，自定义复合类型，自定义枚举，特殊后处理等功能。
-
+目前1.0版本中已经支持，后续会更新使用文档
+ - 数据检测
+ - 自定义复合类型(使用go或者js脚本扩展)
+ - 自定义枚举
 
+TODO ：添加特殊后处理等功能。
 
 ## Credits
 
 - [LuaTableOptimizer](https://github.com/lujian101/LuaTableOptimizer) 使用了lua表优化工具，在此基础上做了更进一步的优化
-- [luban](https://github.com/focus-creative-games/luban) 使用了二进制序列化的代码和一些思路
+- [luban](https://github.com/focus-creative-games/luban) 使用了二进制序列化的代码和一些思路
+- [goja](https://github.com/dop251/goja) js的脚本引擎，使用js来扩展自定义类型和表后处理

component/goja/table_engine/module.go

@@ -0,0 +1,90 @@
+package table_engine
+
+import (
+	"github.com/821869798/table-export/config"
+	"github.com/821869798/table-export/field_type"
+	"github.com/dop251/goja"
+	"github.com/dop251/goja_nodejs/require"
+	_ "github.com/dop251/goja_nodejs/util"
+)
+
+type TableEngine struct {
+	runtime *goja.Runtime
+	//util        *goja.Object
+}
+
+func (c *TableEngine) NewTableFieldClass(name string) *field_type.TableFieldClass {
+	return field_type.NewTableFieldClass(name)
+}
+
+func (c *TableEngine) NewTableFieldType(fieldType int) *field_type.TableFieldType {
+	return field_type.NewTableFieldType(field_type.EFieldType(fieldType))
+}
+
+func (c *TableEngine) NewTableFieldEnumType(name string) *field_type.TableFieldType {
+	return field_type.NewTableFieldEnumType(name)
+}
+
+func (c *TableEngine) NewTableFieldArrayType(value *field_type.TableFieldType) *field_type.TableFieldType {
+	return field_type.NewTableFieldArrayType(value)
+}
+
+func (c *TableEngine) NewTableFieldMapType(key *field_type.TableFieldType, value *field_type.TableFieldType) *field_type.TableFieldType {
+	return field_type.NewTableFieldMapType(key, value)
+}
+
+func (c *TableEngine) NewTableFieldClassType(class *field_type.TableFieldClass) *field_type.TableFieldType {
+	return field_type.NewTableFieldClassType(class)
+}
+
+//func (c *TableEngine) log(p func(string)) func(goja.FunctionCall) goja.Value {
+//	return func(call goja.FunctionCall) goja.Value {
+//		if format, ok := goja.AssertFunction(c.util.Get("format")); ok {
+//			ret, err := format(c.util, call.Arguments...)
+//			if err != nil {
+//				panic(err)
+//			}
+//
+//			p(ret.String())
+//		} else {
+//			panic(c.runtime.NewTypeError("util.format is not a function"))
+//		}
+//
+//		return nil
+//	}
+//}
+
+func Require(runtime *goja.Runtime, module *goja.Object) {
+	requireWithPrinter()(runtime, module)
+}
+
+func RequireWithPrinter() require.ModuleLoader {
+	return requireWithPrinter()
+}
+
+func requireWithPrinter() require.ModuleLoader {
+	return func(runtime *goja.Runtime, module *goja.Object) {
+		c := &TableEngine{
+			runtime: runtime,
+		}
+
+		//c.util = require.Require(runtime, "util").(*goja.Object)
+
+		o := module.Get("exports").(*goja.Object)
+		o.Set("NewTableFieldClass", c.NewTableFieldClass)
+		o.Set("NewTableFieldType", c.NewTableFieldType)
+		o.Set("NewTableFieldEnumType", c.NewTableFieldEnumType)
+		o.Set("NewTableFieldArrayType", c.NewTableFieldArrayType)
+		o.Set("NewTableFieldMapType", c.NewTableFieldMapType)
+		o.Set("NewTableFieldClassType", c.NewTableFieldClassType)
+		o.Set("TableConfig", config.GlobalConfig.Table)
+	}
+}
+
+func Enable(runtime *goja.Runtime) {
+	runtime.Set("tableEngine", require.Require(runtime, "tableEngine"))
+}
+
+func init() {
+	require.RegisterNativeModule("tableEngine", Require)
+}

config/config_rule.go

@@ -42,42 +42,3 @@ type RawMetaRuleUnitLua struct {
 func (r *RawMetaRuleUnitLua) RuleExportType() ExportType {
 	return ExportType_Lua
 }
-
-type RawMetaRuleUnitCSBin struct {
-	CodeTempDir       string   `toml:"code_temp_dir"`
-	DataTempDir       string   `toml:"data_temp_dir"`
-	GenCodeDir        string   `toml:"gen_code_dir"`
-	DataBinDir        string   `toml:"data_bin_dir"`
-	GenCodeNamespace  string   `toml:"code_namespace"`
-	GenCodeHead       string   `toml:"gen_code_head"`
-	CodeNotFoundKey   string   `toml:"code_not_found_key"`
-	GenOptimizeData   bool     `toml:"gen_optimize"`
-	EnumFiles         []string `toml:"enum_files"`
-	EnumDefinePrefix  string   `toml:"enum_define_prefix"`
-	ClassDefinePrefix string   `toml:"class_define_prefix"`
-	BuiltinFieldTypes []string `toml:"builtin_field_types"`
-}
-
-func (r *RawMetaRuleUnitCSBin) RuleExportType() ExportType {
-	return ExportType_CS_Bin
-}
-
-func (r *RawMetaRuleUnitCSBin) ActiveOptimizeData() bool {
-	return r.GenOptimizeData
-}
-
-func (r *RawMetaRuleUnitCSBin) GetEnumFiles() []string {
-	return r.EnumFiles
-}
-
-func (r *RawMetaRuleUnitCSBin) GetEnumDefinePrefix() string {
-	return r.EnumDefinePrefix
-}
-
-func (r *RawMetaRuleUnitCSBin) GetClassDefinePrefix() string {
-	return r.ClassDefinePrefix
-}
-
-func (r *RawMetaRuleUnitCSBin) GetBuiltinFieldTypes() []string {
-	return r.BuiltinFieldTypes
-}

config/config_rule_csbin.go

@@ -0,0 +1,45 @@
+package config
+
+type RawMetaRuleUnitCSBin struct {
+	CodeTempDir       string   `toml:"code_temp_dir"`
+	DataTempDir       string   `toml:"data_temp_dir"`
+	GenCodeDir        string   `toml:"gen_code_dir"`
+	DataBinDir        string   `toml:"data_bin_dir"`
+	GenCodeNamespace  string   `toml:"code_namespace"`
+	GenCodeHead       string   `toml:"gen_code_head"`
+	CodeNotFoundKey   string   `toml:"code_not_found_key"`
+	GenOptimizeData   bool     `toml:"gen_optimize"`
+	EnumFiles         []string `toml:"enum_files"`
+	EnumDefinePrefix  string   `toml:"enum_define_prefix"`
+	ClassDefinePrefix string   `toml:"class_define_prefix"`
+	BuiltinFieldTypes []string `toml:"builtin_field_types"`
+	ScriptFieldTypes  []string `toml:"script_field_types"`
+}
+
+func (r *RawMetaRuleUnitCSBin) RuleExportType() ExportType {
+	return ExportType_CS_Bin
+}
+
+func (r *RawMetaRuleUnitCSBin) ActiveOptimizeData() bool {
+	return r.GenOptimizeData
+}
+
+func (r *RawMetaRuleUnitCSBin) GetEnumFiles() []string {
+	return r.EnumFiles
+}
+
+func (r *RawMetaRuleUnitCSBin) GetEnumDefinePrefix() string {
+	return r.EnumDefinePrefix
+}
+
+func (r *RawMetaRuleUnitCSBin) GetClassDefinePrefix() string {
+	return r.ClassDefinePrefix
+}
+
+func (r *RawMetaRuleUnitCSBin) GetBuiltinFieldTypes() []string {
+	return r.BuiltinFieldTypes
+}
+
+func (r *RawMetaRuleUnitCSBin) GetExtFieldTypeScriptPath() []string {
+	return r.ScriptFieldTypes
+}

config/define.go

@@ -22,4 +22,5 @@ type MetaRuleUnitPlus interface {
 	GetEnumDefinePrefix() string
 	GetClassDefinePrefix() string
 	GetBuiltinFieldTypes() []string
+	GetExtFieldTypeScriptPath() []string
 }

convert/apiconvert/idatavisitor.go

@@ -23,4 +23,5 @@ type IDataVisitor interface {
 	AcceptCommonMap(r map[interface{}]interface{}, KeyType *field_type.TableFieldType, ValueType *field_type.TableFieldType)
 	AcceptClass(r map[string]interface{}, class *field_type.TableFieldClass)
 	AcceptClassString(r map[string]string, class *field_type.TableFieldClass)
+	AcceptClassNull(class *field_type.TableFieldClass)
 }

convert/visitor/binary.go

@@ -202,3 +202,13 @@ func (b *BinaryVisitor) AcceptClassString(r map[string]string, class *field_type
 		}
 	}
 }
+
+func (b *BinaryVisitor) AcceptClassNull(class *field_type.TableFieldClass) {
+	for _, field := range class.AllFields() {
+		// 使用默认值解析
+		err := wrap.RunDataVisitorString(b, field.Type, "")
+		if err != nil {
+			slog.Fatalf("export binary AcceptClass failed: %v", err)
+		}
+	}
+}

convert/wrap/wrap_class.go

@@ -34,6 +34,10 @@ func (c *classWrap) DataVisitorString(visitor apiconvert.IDataVisitor, fieldType
 }
 
 func (c *classWrap) DataVisitorValue(visitor apiconvert.IDataVisitor, fieldType *field_type.TableFieldType, origin interface{}) error {
+	if origin == nil {
+		visitor.AcceptClassNull(fieldType.Class)
+		return nil
+	}
 	switch value := origin.(type) {
 	case map[string]interface{}:
 		visitor.AcceptClass(value, fieldType.Class)
@@ -44,7 +48,7 @@ func (c *classWrap) DataVisitorValue(visitor apiconvert.IDataVisitor, fieldType
 	case string:
 		return RunDataVisitorString(visitor, fieldType, value)
 	default:
-		return errors.New(fmt.Sprintf("[DataVisitorValue|map] no support type[%T]", origin))
+		return errors.New(fmt.Sprintf("[DataVisitorValue|class] no support type[%T]", origin))
 	}
 }
 

convert/wrap/wrap_double.go

@@ -59,16 +59,21 @@ func (b *doubleWrap) DataVisitorString(visitor apiconvert.IDataVisitor, fieldTyp
 }
 
 func (b *doubleWrap) DataVisitorValue(visitor apiconvert.IDataVisitor, fieldType *field_type.TableFieldType, origin interface{}) error {
-	value, ok := origin.(float64)
-	if ok {
+	switch value := origin.(type) {
+	case float64:
 		visitor.AcceptDouble(value)
 		return nil
+	case float32:
+		visitor.AcceptDouble(float64(value))
+		return nil
+	case int64:
+		visitor.AcceptDouble(float64(value))
+		return nil
+	case string:
+		return b.DataVisitorString(visitor, fieldType, value)
+	default:
+		return errors.New(fmt.Sprintf("[DataVisitorValue|double] no support type[%T]", origin))
 	}
-	stringValue, ok := origin.(string)
-	if ok {
-		return b.DataVisitorString(visitor, fieldType, stringValue)
-	}
-	return errors.New(fmt.Sprintf("[DataVisitorValue|double] no support type[%T]", origin))
 }
 
 func (b *doubleWrap) CodePrintValue(print apiconvert.ICodePrinter, fieldType *field_type.TableFieldType, fieldName string, reader string, depth int32) string {

convert/wrap/wrap_enum.go

@@ -84,6 +84,9 @@ func (e *enumWrap) DataVisitorValue(visitor apiconvert.IDataVisitor, fieldType *
 	case int:
 		visitor.AcceptInt(int32(value))
 		return nil
+	case float64:
+		visitor.AcceptInt(int32(value))
+		return nil
 	case string:
 		return e.DataVisitorString(visitor, fieldType, value)
 	default:

convert/wrap/wrap_float.go

@@ -70,6 +70,9 @@ func (b *floatWrap) DataVisitorValue(visitor apiconvert.IDataVisitor, fieldType
 	case float64:
 		visitor.AcceptFloat(float32(value))
 		return nil
+	case int64:
+		visitor.AcceptFloat(float32(value))
+		return nil
 	case string:
 		return b.DataVisitorString(visitor, fieldType, value)
 	default:

convert/wrap/wrap_int.go

@@ -69,6 +69,9 @@ func (b *intWrap) DataVisitorValue(visitor apiconvert.IDataVisitor, fieldType *f
 	case int:
 		visitor.AcceptInt(int32(value))
 		return nil
+	case float64:
+		visitor.AcceptInt(int32(value))
+		return nil
 	case string:
 		return b.DataVisitorString(visitor, fieldType, value)
 	default:

convert/wrap/wrap_long.go

@@ -59,16 +59,24 @@ func (b *longWrap) DataVisitorString(visitor apiconvert.IDataVisitor, fieldType
 }
 
 func (b *longWrap) DataVisitorValue(visitor apiconvert.IDataVisitor, fieldType *field_type.TableFieldType, origin interface{}) error {
-	value, ok := origin.(int64)
-	if ok {
+	switch value := origin.(type) {
+	case int64:
 		visitor.AcceptLong(value)
 		return nil
+	case int32:
+		visitor.AcceptLong(int64(value))
+		return nil
+	case int:
+		visitor.AcceptLong(int64(value))
+		return nil
+	case float64:
+		visitor.AcceptLong(int64(value))
+		return nil
+	case string:
+		return b.DataVisitorString(visitor, fieldType, value)
+	default:
+		return errors.New(fmt.Sprintf("[DataVisitorValue|long] no support type[%T]", origin))
 	}
-	stringValue, ok := origin.(string)
-	if ok {
-		return b.DataVisitorString(visitor, fieldType, stringValue)
-	}
-	return errors.New(fmt.Sprintf("[DataVisitorValue|long] no support type[%T]", origin))
 }
 
 func (b *longWrap) CodePrintValue(print apiconvert.ICodePrinter, fieldType *field_type.TableFieldType, fieldName string, reader string, depth int32) string {

convert/wrap/wrap_uint.go

@@ -70,6 +70,18 @@ func (b *uintWrap) DataVisitorValue(visitor apiconvert.IDataVisitor, fieldType *
 	case uint64:
 		visitor.AcceptUInt(uint32(value))
 		return nil
+	case int:
+		visitor.AcceptUInt(uint32(value))
+		return nil
+	case float64:
+		visitor.AcceptUInt(uint32(value))
+		return nil
+	case int64:
+		visitor.AcceptUInt(uint32(value))
+		return nil
+	case int32:
+		visitor.AcceptUInt(uint32(value))
+		return nil
 	case string:
 		return b.DataVisitorString(visitor, fieldType, value)
 	default: