Merge branch 'gogf:master' into feat-3539

Author: jswxstw

cmd/gf/internal/cmd/cmd_z_unit_gen_dao_test.go

@@ -71,6 +71,7 @@ func Test_Gen_Dao_Default(t *testing.T) {
 				NoModelComment:     false,
 				Clear:              false,
 				TypeMapping:        nil,
+				FieldMapping:       nil,
 			}
 		)
 		err = gutil.FillStructWithDefault(&in)
@@ -171,6 +172,7 @@ func Test_Gen_Dao_TypeMapping(t *testing.T) {
 						Import: "github.com/shopspring/decimal",
 					},
 				},
+				FieldMapping: nil,
 			}
 		)
 		err = gutil.FillStructWithDefault(&in)
@@ -213,6 +215,108 @@ func Test_Gen_Dao_TypeMapping(t *testing.T) {
 	})
 }
 
+func Test_Gen_Dao_FieldMapping(t *testing.T) {
+	gtest.C(t, func(t *gtest.T) {
+		var (
+			err        error
+			db         = testDB
+			table      = "table_user"
+			sqlContent = fmt.Sprintf(
+				gtest.DataContent(`gendao`, `user.tpl.sql`),
+				table,
+			)
+		)
+		defer dropTableWithDb(db, table)
+		array := gstr.SplitAndTrim(sqlContent, ";")
+		for _, v := range array {
+			if _, err = db.Exec(ctx, v); err != nil {
+				t.AssertNil(err)
+			}
+		}
+		defer dropTableWithDb(db, table)
+
+		var (
+			path  = gfile.Temp(guid.S())
+			group = "test"
+			in    = gendao.CGenDaoInput{
+				Path:               path,
+				Link:               link,
+				Tables:             "table_user",
+				TablesEx:           "",
+				Group:              group,
+				Prefix:             "",
+				RemovePrefix:       "",
+				JsonCase:           "",
+				ImportPrefix:       "",
+				DaoPath:            "",
+				DoPath:             "",
+				EntityPath:         "",
+				TplDaoIndexPath:    "",
+				TplDaoInternalPath: "",
+				TplDaoDoPath:       "",
+				TplDaoEntityPath:   "",
+				StdTime:            false,
+				WithTime:           false,
+				GJsonSupport:       false,
+				OverwriteDao:       false,
+				DescriptionTag:     false,
+				NoJsonTag:          false,
+				NoModelComment:     false,
+				Clear:              false,
+				TypeMapping: map[gendao.DBFieldTypeName]gendao.CustomAttributeType{
+					"int": {
+						Type:   "int64",
+						Import: "",
+					},
+				},
+				FieldMapping: map[gendao.DBTableFieldName]gendao.CustomAttributeType{
+					"table_user.score": {
+						Type:   "decimal.Decimal",
+						Import: "github.com/shopspring/decimal",
+					},
+				},
+			}
+		)
+		err = gutil.FillStructWithDefault(&in)
+		t.AssertNil(err)
+
+		err = gfile.Mkdir(path)
+		t.AssertNil(err)
+
+		// for go mod import path auto retrieve.
+		err = gfile.Copy(
+			gtest.DataPath("gendao", "go.mod.txt"),
+			gfile.Join(path, "go.mod"),
+		)
+		t.AssertNil(err)
+
+		_, err = gendao.CGenDao{}.Dao(ctx, in)
+		t.AssertNil(err)
+		defer gfile.Remove(path)
+
+		// files
+		files, err := gfile.ScanDir(path, "*.go", true)
+		t.AssertNil(err)
+		t.Assert(files, []string{
+			filepath.FromSlash(path + "/dao/internal/table_user.go"),
+			filepath.FromSlash(path + "/dao/table_user.go"),
+			filepath.FromSlash(path + "/model/do/table_user.go"),
+			filepath.FromSlash(path + "/model/entity/table_user.go"),
+		})
+		// content
+		testPath := gtest.DataPath("gendao", "generated_user_field_mapping")
+		expectFiles := []string{
+			filepath.FromSlash(testPath + "/dao/internal/table_user.go"),
+			filepath.FromSlash(testPath + "/dao/table_user.go"),
+			filepath.FromSlash(testPath + "/model/do/table_user.go"),
+			filepath.FromSlash(testPath + "/model/entity/table_user.go"),
+		}
+		for i, _ := range files {
+			t.Assert(gfile.GetContents(files[i]), gfile.GetContents(expectFiles[i]))
+		}
+	})
+}
+
 func execSqlFile(db gdb.DB, filePath string, args ...any) error {
 	sqlContent := fmt.Sprintf(
 		gfile.GetContents(filePath),
@@ -271,6 +375,7 @@ func Test_Gen_Dao_Issue2572(t *testing.T) {
 				NoModelComment:     false,
 				Clear:              false,
 				TypeMapping:        nil,
+				FieldMapping:       nil,
 			}
 		)
 		err = gutil.FillStructWithDefault(&in)
@@ -359,6 +464,7 @@ func Test_Gen_Dao_Issue2616(t *testing.T) {
 				NoModelComment:     false,
 				Clear:              false,
 				TypeMapping:        nil,
+				FieldMapping:       nil,
 			}
 		)
 		err = gutil.FillStructWithDefault(&in)
@@ -469,6 +575,7 @@ func Test_Gen_Dao_Issue2746(t *testing.T) {
 				NoModelComment:     false,
 				Clear:              false,
 				TypeMapping:        nil,
+				FieldMapping:       nil,
 			}
 		)
 		err = gutil.FillStructWithDefault(&in)

cmd/gf/internal/cmd/gendao/gendao.go

@@ -58,6 +58,10 @@ CONFIGURATION SUPPORT
 			  import: github.com/shopspring/decimal
 			numeric:
 			  type: string
+		  fieldMapping:
+			table_name.field_name:
+			  type:   decimal.Decimal
+			  import: github.com/shopspring/decimal
 `
 	CGenDaoBriefPath              = `directory path for generated files`
 	CGenDaoBriefLink              = `database configuration, the same as the ORM configuration of GoFrame`
@@ -81,6 +85,7 @@ CONFIGURATION SUPPORT
 	CGenDaoBriefNoModelComment    = `no model comment will be added for each field`
 	CGenDaoBriefClear             = `delete all generated go files that do not exist in database`
 	CGenDaoBriefTypeMapping       = `custom local type mapping for generated struct attributes relevant to fields of table`
+	CGenDaoBriefFieldMapping      = `custom local type mapping for generated struct attributes relevant to specific fields of table`
 	CGenDaoBriefGroup             = `
 specifying the configuration group name of database for generated ORM instance,
 it's not necessary and the default value is "default"
@@ -162,6 +167,7 @@ func init() {
 		`CGenDaoBriefNoModelComment`:     CGenDaoBriefNoModelComment,
 		`CGenDaoBriefClear`:              CGenDaoBriefClear,
 		`CGenDaoBriefTypeMapping`:        CGenDaoBriefTypeMapping,
+		`CGenDaoBriefFieldMapping`:       CGenDaoBriefFieldMapping,
 		`CGenDaoBriefGroup`:              CGenDaoBriefGroup,
 		`CGenDaoBriefJsonCase`:           CGenDaoBriefJsonCase,
 		`CGenDaoBriefTplDaoIndexPath`:    CGenDaoBriefTplDaoIndexPath,
@@ -201,8 +207,9 @@ type (
 		NoModelComment     bool   `name:"noModelComment"      short:"m"  brief:"{CGenDaoBriefNoModelComment}" orphan:"true"`
 		Clear              bool   `name:"clear"               short:"a"  brief:"{CGenDaoBriefClear}" orphan:"true"`
 
-		TypeMapping map[DBFieldTypeName]CustomAttributeType `name:"typeMapping" short:"y" brief:"{CGenDaoBriefTypeMapping}" orphan:"true"`
-		genItems    *CGenDaoInternalGenItems
+		TypeMapping  map[DBFieldTypeName]CustomAttributeType  `name:"typeMapping" short:"y" brief:"{CGenDaoBriefTypeMapping}" orphan:"true"`
+		FieldMapping map[DBTableFieldName]CustomAttributeType `name:"fieldMapping" short:"fm"  brief:"{CGenDaoBriefFieldMapping}" orphan:"true"`
+		genItems     *CGenDaoInternalGenItems
 	}
 	CGenDaoOutput struct{}
 
@@ -212,7 +219,7 @@ type (
 		TableNames    []string
 		NewTableNames []string
 	}
-
+	DBTableFieldName    = string
 	DBFieldTypeName     = string
 	CustomAttributeType struct {
 		Type   string `brief:"custom attribute type name"`
@@ -363,7 +370,7 @@ func getImportPartContent(ctx context.Context, source string, isDo bool, appendI
 	}
 
 	// Check and update imports in go.mod
-	if appendImports != nil && len(appendImports) > 0 {
+	if len(appendImports) > 0 {
 		goModPath := utils.GetModPath()
 		if goModPath == "" {
 			mlog.Fatal("go.mod not found in current project")
@@ -381,8 +388,9 @@ func getImportPartContent(ctx context.Context, source string, isDo bool, appendI
 				}
 			}
 			if !found {
-				err = gproc.ShellRun(ctx, `go get `+appendImport)
-				mlog.Fatalf(`%+v`, err)
+				if err = gproc.ShellRun(ctx, `go get `+appendImport); err != nil {
+					mlog.Fatalf(`%+v`, err)
+				}
 			}
 			packageImportsArray.Append(fmt.Sprintf(`"%s"`, appendImport))
 		}

cmd/gf/internal/cmd/gendao/gendao_structure.go

@@ -131,6 +131,14 @@ func generateStructFieldDefinition(
 	for _, v := range removeFieldPrefixArray {
 		newFiledName = gstr.TrimLeftStr(newFiledName, v, 1)
 	}
+
+	if in.FieldMapping != nil && len(in.FieldMapping) > 0 {
+		if typeMapping, ok := in.FieldMapping[fmt.Sprintf("%s.%s", in.Tables, newFiledName)]; ok {
+			localTypeNameStr = typeMapping.Type
+			appendImport = typeMapping.Import
+		}
+	}
+
 	attrLines = []string{
 		"    #" + gstr.CaseCamel(newFiledName),
 		" #" + localTypeNameStr,

cmd/gf/internal/cmd/testdata/gendao/generated_user_field_mapping/dao/internal/table_user.go

@@ -0,0 +1,27 @@
+// =================================================================================
+// This is auto-generated by GoFrame CLI tool only once. Fill this file as you wish.
+// =================================================================================
+
+package dao
+
+import (
+	"for-gendao-test/pkg/dao/internal"
+)
+
+// internalTableUserDao is internal type for wrapping internal DAO implements.
+type internalTableUserDao = *internal.TableUserDao
+
+// tableUserDao is the data access object for table table_user.
+// You can define custom methods on it to extend its functionality as you wish.
+type tableUserDao struct {
+	internalTableUserDao
+}
+
+var (
+	// TableUser is globally public accessible object for table table_user operations.
+	TableUser = tableUserDao{
+		internal.NewTableUserDao(),
+	}
+)
+
+// Fill with you ideas below.

cmd/gf/internal/cmd/testdata/gendao/generated_user_field_mapping/dao/table_user.go

@@ -94,6 +94,7 @@ func Test_Grpcx_Grpc_Server_Config_Logger(t *testing.T) {
 			logFilePath    = fmt.Sprintf("/tmp/log/%s.log", gtime.Now().Format("Y-m-d"))
 			logFileContent = gfile.GetContents(logFilePath)
 		)
+		defer gfile.Remove(logFilePath)
 		t.Assert(gfile.Exists(logFilePath), true)
 		t.Assert(gstr.Contains(logFileContent, "TestLogger "), true)
 	})