feat(cmd/gf): add NullFieldPattern option for command gf gen dao to convert null field to pointer (#4119)

Author: wufeng5702

cmd/gf/internal/cmd/cmd_z_unit_gen_dao_null_field_test.go

@@ -0,0 +1,95 @@
+// Copyright GoFrame gf Author(https://goframe.org). All Rights Reserved.
+//
+// This Source Code Form is subject to the terms of the MIT License.
+// If a copy of the MIT was not distributed with this file,
+// You can obtain one at https://github.com/gogf/gf.
+
+package cmd
+
+import (
+	"fmt"
+	"path/filepath"
+	"testing"
+
+	"github.com/gogf/gf/v2/os/gfile"
+	"github.com/gogf/gf/v2/test/gtest"
+	"github.com/gogf/gf/v2/text/gstr"
+	"github.com/gogf/gf/v2/util/guid"
+	"github.com/gogf/gf/v2/util/gutil"
+
+	"github.com/gogf/gf/cmd/gf/v2/internal/cmd/gendao"
+)
+
+func Test_Gen_Dao_Null_Field(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,
+				Group: group,
+				NullFieldPattern: []string{
+					"table_?",
+				},
+			}
+		)
+
+		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_null_filed_pointer")
+		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 expectFiles {
+			t.Assert(gfile.GetContents(files[i]), gfile.GetContents(expectFiles[i]))
+		}
+	})
+}

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

@@ -41,6 +41,7 @@ type (
 		TablesEx           string   `name:"tablesEx"            short:"x"  brief:"{CGenDaoBriefTablesEx}"`
 		ShardingPattern    []string `name:"shardingPattern"     short:"sp" brief:"{CGenDaoBriefShardingPattern}"`
 		Group              string   `name:"group"               short:"g"  brief:"{CGenDaoBriefGroup}" d:"default"`
+		NullFieldPattern   []string `name:"nullFieldPattern"    short:"nf" brief:"{CGenDaoNullFieldPattern}"`
 		Prefix             string   `name:"prefix"              short:"f"  brief:"{CGenDaoBriefPrefix}"`
 		RemovePrefix       string   `name:"removePrefix"        short:"r"  brief:"{CGenDaoBriefRemovePrefix}"`
 		RemoveFieldPrefix  string   `name:"removeFieldPrefix"   short:"rf" brief:"{CGenDaoBriefRemoveFieldPrefix}"`

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

@@ -133,6 +133,18 @@ func generateStructFieldDefinition(
 				localTypeNameStr = "string"
 			}
 		}
+
+		// convert null filed in the database to pointer in package entity.
+		if !in.IsDo && field.Null && !strings.HasPrefix(localTypeNameStr, "*") && len(in.NullFieldPattern) > 0 {
+			for _, pattern := range in.NullFieldPattern {
+				regPattern := gstr.Replace(pattern, "?", `(.+)`)
+				match := gregex.IsMatchString(regPattern, in.TableName)
+				if match {
+					localTypeNameStr = "*" + localTypeNameStr
+					break
+				}
+			}
+		}
 	}
 
 	var (

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

@@ -75,6 +75,10 @@ CONFIGURATION SUPPORT
 	CGenDaoBriefGroup             = `
 specifying the configuration group name of database for generated ORM instance,
 it's not necessary and the default value is "default"
+`
+	CGenDaoBriefNullFieldPattern = `
+pattern for table fields that are NULL by default, the generated entity struct attribute type 
+will be pointer type *T instead of T, e.g. "table_?"
 `
 	CGenDaoBriefJsonCase = `
 generated json tag case for model struct, cases are as follows:
@@ -141,6 +145,7 @@ func init() {
 		`CGenDaoBriefFieldMapping`:       CGenDaoBriefFieldMapping,
 		`CGenDaoBriefShardingPattern`:    CGenDaoBriefShardingPattern,
 		`CGenDaoBriefGroup`:              CGenDaoBriefGroup,
+		`CGenDaoBriefNullFieldPattern`:   CGenDaoBriefNullFieldPattern,
 		`CGenDaoBriefJsonCase`:           CGenDaoBriefJsonCase,
 		`CGenDaoBriefTplDaoIndexPath`:    CGenDaoBriefTplDaoIndexPath,
 		`CGenDaoBriefTplDaoInternalPath`: CGenDaoBriefTplDaoInternalPath,

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

@@ -0,0 +1,22 @@
+// =================================================================================
+// This file is auto-generated by the GoFrame CLI tool. You may modify it as needed.
+// =================================================================================
+
+package dao
+
+import (
+	"for-gendao-test/pkg/dao/internal"
+)
+
+// tableUserDao is the data access object for the table table_user.
+// You can define custom methods on it to extend its functionality as needed.
+type tableUserDao struct {
+	*internal.TableUserDao
+}
+
+var (
+	// TableUser is a globally accessible object for table table_user operations.
+	TableUser = tableUserDao{internal.NewTableUserDao()}
+)
+
+// Add your custom methods and functionality below.