feat(cmd/gf): support generating pointer type field in DO files for command `gf gen dao` by smzgl · Pull Request #4653 · gogf/gf

smzgl · 2026-01-22T15:08:01Z

feat: gf gen dao 增加一个参数 doUseTypePtr , 使得生成do结构体的时候, 字段类型都是指针, 而不是interface{} #4582

lingcoder · 2026-01-23T02:41:14Z

这个能加点场景测试么？有点怕怕，会不会在orm使用环节出现问题。。。

smzgl · 2026-01-23T03:10:15Z

生成代码是从生成entity复制过来，增加了* 感觉不用怕：）

smzgl · 2026-01-23T03:18:14Z

可以参考现有的场景补充一下。

smzgl · 2026-01-25T19:04:47Z

测试用例已添加

gqcn · 2026-02-11T07:40:52Z

+		NoModelComment     bool                                     `name:"noModelComment"      short:"m"  brief:"{CGenDaoBriefNoModelComment}" orphan:"true"`
+		Clear              bool                                     `name:"clear"               short:"a"  brief:"{CGenDaoBriefClear}" orphan:"true"`
+		GenTable           bool                                     `name:"genTable"            short:"gt" brief:"{CGenDaoBriefGenTable}" orphan:"true"`
+		TypePointerSupport bool                                     `name:"typePointerSupport"  short:"tp" brief:"{CGenDoBriefTypePointerSupport}" orphan:"true"`


TypePointerSupport -> PtrTypeInDoField。

默认使用any，当用户显式配置该选项才启用该特性。

Copilot

Pull request overview

Adds a new gf gen dao option to generate DO structs with pointer-typed fields (instead of any/interface{}), improving type validation when using DO models.

Changes:

Introduces typePointerSupport option to generate DO fields as pointers when possible.
Updates DO generation logic to emit *T (unless already pointer/slice/map) instead of any.
Adds/updates unit tests and golden testdata fixtures for pointer-typed DO output.

Reviewed changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 7 comments.

Show a summary per file

File	Description
cmd/gf/internal/cmd/gendao/gendao.go	Adds a new CLI flag field (`TypePointerSupport`) to the `gf gen dao` input struct.
cmd/gf/internal/cmd/gendao/gendao_tag.go	Adds the flag’s brief/help text constant and registers it for templated CLI help.
cmd/gf/internal/cmd/gendao/gendao_do.go	Updates DO struct post-processing to optionally convert field types to pointers.
cmd/gf/internal/cmd/cmd_z_unit_gen_dao_test.go	Adds new tests for pointer-typed DO generation across default/typeMapping/fieldMapping scenarios.
cmd/gf/internal/cmd/testdata/gendao/**/do_type_pointer/table_user.go	New golden fixtures for pointer-typed DO output.
cmd/gf/internal/cmd/testdata/gendao/**/do_pointer_type/table_user.go	Additional golden fixtures (currently appear unused).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-02-11T07:52:47Z

+// =================================================================================
+// Code generated and maintained by GoFrame CLI tool. DO NOT EDIT.
+// =================================================================================
+
+package do
+
+import (
+	"github.com/gogf/gf/v2/frame/g"
+	"github.com/gogf/gf/v2/os/gtime"
+)
+
+// TableUser is the golang structure of table table_user for DAO operations like Where/Data.
+type TableUser struct {
+	g.Meta    `orm:"table:table_user, do:true"`
+	Id        *int        //
+	Passport  *string     //
+	Password  *string     //
+	Nickname  *string     //
+	CreatedAt *gtime.Time //
+	UpdatedAt *gtime.Time //
+}


This sqlite3 golden file is under model/do_pointer_type, but the sqlite3 test asserts against model/do/table_user.go and there are no repo references to do_pointer_type. If this fixture isn’t used by any test, it should be removed to avoid confusion.

Suggested change

// =================================================================================

// Code generated and maintained by GoFrame CLI tool. DO NOT EDIT.

// =================================================================================

package do

import (

"github.com/gogf/gf/v2/frame/g"

"github.com/gogf/gf/v2/os/gtime"

)

// TableUser is the golang structure of table table_user for DAO operations like Where/Data.

type TableUser struct {

g.Meta `orm:"table:table_user, do:true"`

Id *int //

Passport *string //

Password *string //

Nickname *string //

CreatedAt *gtime.Time //

UpdatedAt *gtime.Time //

}

// This file previously contained a sqlite3 golden fixture for `table_user` under

// `model/do_pointer_type`, but it is no longer used by any tests. It is

// intentionally left blank to avoid confusion with the active fixtures under

// `model/do/`.

package do

Copilot · 2026-02-11T07:52:48Z

+					if in.TypePointerSupport {
+						return fmt.Sprintf(`%s *%s %s`, match[1], match[2], match[3])
+					}
+
 					return fmt.Sprintf(`%s any %s`, match[1], match[3])


With TypePointerSupport enabled this replacement path changes field types to pointers; the nearby comment above this block says "replace all types to any" which is no longer accurate. Please update that comment to reflect the conditional behavior (any vs pointer) to avoid misleading future maintenance.

Copilot · 2026-02-11T07:52:48Z

+		StdTime            bool                                     `name:"stdTime"             short:"s"  brief:"{CGenDaoBriefStdTime}" orphan:"true"`
+		WithTime           bool                                     `name:"withTime"            short:"w"  brief:"{CGenDaoBriefWithTime}" orphan:"true"`
+		GJsonSupport       bool                                     `name:"gJsonSupport"        short:"n"  brief:"{CGenDaoBriefGJsonSupport}" orphan:"true"`
+		OverwriteDao       bool                                     `name:"overwriteDao"        short:"v"  brief:"{CGenDaoBriefOverwriteDao}" orphan:"true"`
+		DescriptionTag     bool                                     `name:"descriptionTag"      short:"c"  brief:"{CGenDaoBriefDescriptionTag}" orphan:"true"`
+		NoJsonTag          bool                                     `name:"noJsonTag"           short:"k"  brief:"{CGenDaoBriefNoJsonTag}" orphan:"true"`
+		NoModelComment     bool                                     `name:"noModelComment"      short:"m"  brief:"{CGenDaoBriefNoModelComment}" orphan:"true"`
+		Clear              bool                                     `name:"clear"               short:"a"  brief:"{CGenDaoBriefClear}" orphan:"true"`
+		GenTable           bool                                     `name:"genTable"            short:"gt" brief:"{CGenDaoBriefGenTable}" orphan:"true"`
+		TypePointerSupport bool                                     `name:"typePointerSupport"  short:"tp" brief:"{CGenDoBriefTypePointerSupport}" orphan:"true"`
+		TypeMapping        map[DBFieldTypeName]CustomAttributeType  `name:"typeMapping"  short:"y"  brief:"{CGenDaoBriefTypeMapping}"  orphan:"true"`
+		FieldMapping       map[DBTableFieldName]CustomAttributeType `name:"fieldMapping" short:"fm" brief:"{CGenDaoBriefFieldMapping}" orphan:"true"`


The new flag typePointerSupport reuses short option tp, which is already used by tablePath. Short option collisions can make the CLI parsing ambiguous or fail. Please choose a unique short name (or remove the short alias) for typePointerSupport while keeping tablePath’s existing tp for backward compatibility.

Suggested change

StdTime bool `name:"stdTime" short:"s" brief:"{CGenDaoBriefStdTime}" orphan:"true"`

WithTime bool `name:"withTime" short:"w" brief:"{CGenDaoBriefWithTime}" orphan:"true"`

GJsonSupport bool `name:"gJsonSupport" short:"n" brief:"{CGenDaoBriefGJsonSupport}" orphan:"true"`

OverwriteDao bool `name:"overwriteDao" short:"v" brief:"{CGenDaoBriefOverwriteDao}" orphan:"true"`

DescriptionTag bool `name:"descriptionTag" short:"c" brief:"{CGenDaoBriefDescriptionTag}" orphan:"true"`

NoJsonTag bool `name:"noJsonTag" short:"k" brief:"{CGenDaoBriefNoJsonTag}" orphan:"true"`

NoModelComment bool `name:"noModelComment" short:"m" brief:"{CGenDaoBriefNoModelComment}" orphan:"true"`

Clear bool `name:"clear" short:"a" brief:"{CGenDaoBriefClear}" orphan:"true"`

GenTable bool `name:"genTable" short:"gt" brief:"{CGenDaoBriefGenTable}" orphan:"true"`

TypePointerSupport bool `name:"typePointerSupport" short:"tp" brief:"{CGenDoBriefTypePointerSupport}" orphan:"true"`

TypeMapping map[DBFieldTypeName]CustomAttributeType `name:"typeMapping" short:"y" brief:"{CGenDaoBriefTypeMapping}" orphan:"true"`

FieldMapping map[DBTableFieldName]CustomAttributeType `name:"fieldMapping" short:"fm" brief:"{CGenDaoBriefFieldMapping}" orphan:"true"`

StdTime bool `name:"stdTime" short:"s" brief:"{CGenDaoBriefStdTime}" orphan:"true"`

WithTime bool `name:"withTime" short:"w" brief:"{CGenDaoBriefWithTime}" orphan:"true"`

GJsonSupport bool `name:"gJsonSupport" short:"n" brief:"{CGenDaoBriefGJsonSupport}" orphan:"true"`

OverwriteDao bool `name:"overwriteDao" short:"v" brief:"{CGenDaoBriefOverwriteDao}" orphan:"true"`

DescriptionTag bool `name:"descriptionTag" short:"c" brief:"{CGenDaoBriefDescriptionTag}" orphan:"true"`

NoJsonTag bool `name:"noJsonTag" short:"k" brief:"{CGenDaoBriefNoJsonTag}" orphan:"true"`

NoModelComment bool `name:"noModelComment" short:"m" brief:"{CGenDaoBriefNoModelComment}" orphan:"true"`

Clear bool `name:"clear" short:"a" brief:"{CGenDaoBriefClear}" orphan:"true"`

GenTable bool `name:"genTable" short:"gt" brief:"{CGenDaoBriefGenTable}" orphan:"true"`

TypePointerSupport bool `name:"typePointerSupport" short:"tps" brief:"{CGenDoBriefTypePointerSupport}" orphan:"true"`

TypeMapping map[DBFieldTypeName]CustomAttributeType `name:"typeMapping" short:"y" brief:"{CGenDaoBriefTypeMapping}" orphan:"true"`

FieldMapping map[DBTableFieldName]CustomAttributeType `name:"fieldMapping" short:"fm" brief:"{CGenDaoBriefFieldMapping}" orphan:"true"`

Copilot · 2026-02-11T07:52:48Z

+			filepath.FromSlash(testPath + "/model/entity/table_user.go"),
+		}
+		for i := range files {
+			_ = gfile.PutContents(expectFiles[i], gfile.GetContents(files[i]))


This test currently overwrites the golden testdata files via gfile.PutContents(...), which will mutate the repository fixture on local runs/CI and can hide regressions. This line should be removed or kept commented out like the other tests.

Suggested change

_ = gfile.PutContents(expectFiles[i], gfile.GetContents(files[i]))

// Do not overwrite golden files here; just compare contents.

Copilot · 2026-02-11T07:52:48Z

+		defer dropTableWithDb(db, table)
+		array := gstr.SplitAndTrim(sqlContent, ";")
+		for _, v := range array {
+			if _, err = db.Exec(ctx, v); err != nil {
+				t.AssertNil(err)
+			}
+		}


The test sets up the table without dropping it first, and also defers dropTableWithDb twice. If the table already exists (e.g., when running this test in isolation), the CREATE will fail before the deferred drop runs. Consider calling dropTableWithDb(db, table) before executing the SQL and keep only a single defer dropTableWithDb(db, table) after successful setup.

Suggested change

defer dropTableWithDb(db, table)

array := gstr.SplitAndTrim(sqlContent, ";")

for _, v := range array {

if _, err = db.Exec(ctx, v); err != nil {

t.AssertNil(err)

}

}

// Ensure the table does not already exist before setup.

dropTableWithDb(db, table)

array := gstr.SplitAndTrim(sqlContent, ";")

for _, v := range array {

if _, err = db.Exec(ctx, v); err != nil {

t.AssertNil(err)

}

}

// Drop the table after the test finishes.

Copilot · 2026-02-11T07:52:49Z

+		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)
+


Same table setup pattern issue as above: there’s no upfront dropTableWithDb before running the CREATE statements, and dropTableWithDb is deferred twice. This can make the test flaky when the table already exists. Prefer dropping before setup and using a single deferred cleanup.

Copilot · 2026-02-11T07:52:49Z

+// =================================================================================
+// Code generated and maintained by GoFrame CLI tool. DO NOT EDIT.
+// =================================================================================
+
+package do
+
+import (
+	"github.com/gogf/gf/v2/frame/g"
+	"github.com/gogf/gf/v2/os/gtime"
+	"github.com/shopspring/decimal"
+)
+
+// TableUser is the golang structure of table table_user for DAO operations like Where/Data.
+type TableUser struct {
+	g.Meta   `orm:"table:table_user, do:true"`
+	Id       *int64           // User ID
+	Passport *string          // User Passport
+	Password *string          // User Password
+	Nickname *string          // User Nickname
+	Score    *decimal.Decimal // Total score amount.
+	CreateAt *gtime.Time      // Created Time
+	UpdateAt *gtime.Time      // Updated Time
+}


This golden file appears to be unused: there are no references to the do_pointer_type fixture directory anywhere in the repo, and the tests use do_type_pointer instead. Consider removing this duplicate fixture (or renaming/aligning fixtures to a single convention) to reduce testdata clutter.

Suggested change

// =================================================================================

// Code generated and maintained by GoFrame CLI tool. DO NOT EDIT.

// =================================================================================

package do

import (

"github.com/gogf/gf/v2/frame/g"

"github.com/gogf/gf/v2/os/gtime"

"github.com/shopspring/decimal"

)

// TableUser is the golang structure of table table_user for DAO operations like Where/Data.

type TableUser struct {

g.Meta `orm:"table:table_user, do:true"`

Id *int64 // User ID

Passport *string // User Passport

Password *string // User Password

Nickname *string // User Nickname

Score *decimal.Decimal // Total score amount.

CreateAt *gtime.Time // Created Time

UpdateAt *gtime.Time // Updated Time

}

feat: gf gen do support generate pointer type field

1f74425

smzgl added 2 commits January 23, 2026 22:17

test: 提交测试用例, 并修改命令行参数名

584af73

test: 提交测试用例, 并修改命令行参数名

4c7d329

gqcn requested changes Feb 11, 2026

View reviewed changes

gqcn changed the title ~~feat: gf gen do support generate pointer type field~~ feat(cmd/gf): support generating pointer type field in do file for command gf gen dao Feb 11, 2026

gqcn changed the title ~~feat(cmd/gf): support generating pointer type field in do file for command gf gen dao~~ feat(cmd/gf): support generating pointer type field in DO files for command gf gen dao Feb 11, 2026

gqcn requested a review from Copilot February 11, 2026 07:44

Copilot started reviewing on behalf of gqcn February 11, 2026 07:45 View session

Copilot AI reviewed Feb 11, 2026

View reviewed changes

test: 提交测试用例, 并修改命令行参数名

b420712

	_ = gfile.PutContents(expectFiles[i], gfile.GetContents(files[i]))
	// Do not overwrite golden files here; just compare contents.

Uh oh!

Conversation

smzgl commented Jan 22, 2026

Uh oh!

lingcoder commented Jan 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

smzgl commented Jan 23, 2026

Uh oh!

smzgl commented Jan 23, 2026

Uh oh!

smzgl commented Jan 25, 2026

Uh oh!

gqcn Feb 11, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Feb 11, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 11, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 11, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 11, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 11, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 11, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 11, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

lingcoder commented Jan 23, 2026 •

edited

Loading