feat(generator): 添加代码生成模板常量定义

- 新增 consts.go 定义 DO NOT EDIT 标记常量 - 添加控制器生成模板相关常量定义 - 添加 SDK 客户端生成模板常量定义 - 添加数据访问对象(DAO)生成模板常量定义 - 添加枚举、协议缓冲区实体和服务生成模板常量定义 - 添加数据库表字段定义模板常量定义
2026-04-08 14:11:46 +08:00
parent d01b2973df
commit fd1a6686b1
34 changed files with 3389 additions and 7 deletions
@@ -0,0 +1,139 @@
+// 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 consts
+
+const TemplateGenDaoIndexContent = `
+// =================================================================================
+// This file is auto-generated by the GoFrame CLI tool. You may modify it as needed.
+// =================================================================================
+
+package {{.TplPackageName}}
+
+import (
+	"{{.TplImportPrefix}}/internal"
+)
+
+// {{.TplTableNameCamelLowerCase}}Dao is the data access object for the table {{.TplTableName}}.
+// You can define custom methods on it to extend its functionality as needed.
+type {{.TplTableNameCamelLowerCase}}Dao struct {
+	*internal.{{.TplTableNameCamelCase}}Dao
+}
+
+var (
+    // {{.TplTableNameCamelCase}} is a globally accessible object for table {{.TplTableName}} operations.
+	{{.TplTableNameCamelCase}} = {{.TplTableNameCamelLowerCase}}Dao{
+{{- if .TplTableSharding -}}
+    internal.New{{.TplTableNameCamelCase}}Dao({{.TplTableNameCamelLowerCase}}ShardingHandler),
+{{- else -}}
+    internal.New{{.TplTableNameCamelCase}}Dao(),
+{{- end -}}
+	}
+)
+
+{{if .TplTableSharding -}}
+// {{.TplTableNameCamelLowerCase}}ShardingHandler is the handler for sharding operations.
+// You can fill this sharding handler with your custom implementation.
+func {{.TplTableNameCamelLowerCase}}ShardingHandler(m *database.Model) *database.Model {
+	m = m.Sharding(database.ShardingConfig{
+		Table:  database.ShardingTableConfig{
+			Enable: true,
+			Prefix: "{{.TplTableShardingPrefix}}",
+			// Replace Rule field with your custom sharding rule.
+			// Or you can use "&database.DefaultShardingRule{}" for default sharding rule.
+			Rule: nil,
+        },
+		Schema: database.ShardingSchemaConfig{},
+	})
+	return m
+}
+{{- end}}
+
+// Add your custom methods and functionality below.
+
+`
+
+const TemplateGenDaoInternalContent = `
+// ==========================================================================
+// Code generated and maintained by GoFrame CLI tool. DO NOT EDIT. {{.TplCreatedAtDatetimeStr}}
+// ==========================================================================
+
+package internal
+
+import (
+	"context"
+
+	"git.magicany.cc/black1552/gin-base/database"
+	"github.com/gogf/gf/v2/frame/g"
+)
+
+// {{.TplTableNameCamelCase}}Dao is the data access object for the table {{.TplTableName}}.
+type {{.TplTableNameCamelCase}}Dao struct {
+	table   string          // table is the underlying table name of the DAO.
+	group   string          // group is the database configuration group name of the current DAO.
+	columns {{.TplTableNameCamelCase}}Columns // columns contains all the column names of Table for convenient usage.
+    handlers []database.ModelHandler // handlers for customized model modification.
+}
+
+// {{.TplTableNameCamelCase}}Columns defines and stores column names for the table {{.TplTableName}}.
+type {{.TplTableNameCamelCase}}Columns struct {
+	{{.TplColumnDefine}}
+}
+
+// {{.TplTableNameCamelLowerCase}}Columns holds the columns for the table {{.TplTableName}}.
+var {{.TplTableNameCamelLowerCase}}Columns = {{.TplTableNameCamelCase}}Columns{
+	{{.TplColumnNames}}
+}
+
+// New{{.TplTableNameCamelCase}}Dao creates and returns a new DAO object for table data access.
+func New{{.TplTableNameCamelCase}}Dao(handlers ...database.ModelHandler) *{{.TplTableNameCamelCase}}Dao {
+	return &{{.TplTableNameCamelCase}}Dao{
+		group:   "{{.TplGroupName}}",
+		table:   "{{.TplTableName}}",
+		columns: {{.TplTableNameCamelLowerCase}}Columns,
+        handlers: handlers,
+	}
+}
+
+// DB retrieves and returns the underlying raw database management object of the current DAO.
+func (dao *{{.TplTableNameCamelCase}}Dao) DB() database.DB {
+	return g.DB(dao.group)
+}
+
+// Table returns the table name of the current DAO.
+func (dao *{{.TplTableNameCamelCase}}Dao) Table() string {
+	return dao.table
+}
+
+// Columns returns all column names of the current DAO.
+func (dao *{{.TplTableNameCamelCase}}Dao) Columns() {{.TplTableNameCamelCase}}Columns {
+	return dao.columns
+}
+
+// Group returns the database configuration group name of the current DAO.
+func (dao *{{.TplTableNameCamelCase}}Dao) Group() string {
+	return dao.group
+}
+
+// Ctx creates and returns a Model for the current DAO. It automatically sets the context for the current operation.
+func (dao *{{.TplTableNameCamelCase}}Dao) Ctx(ctx context.Context) *database.Model {
+	model := dao.DB().Model(dao.table)
+	for _, handler := range dao.handlers {
+		model = handler(model)
+	}
+	return model.Safe().Ctx(ctx)
+}
+
+// Transaction wraps the transaction logic using function f.
+// It rolls back the transaction and returns the error if function f returns a non-nil error.
+// It commits the transaction and returns nil if function f returns nil.
+//
+// Note: Do not commit or roll back the transaction in function f,
+// as it is automatically handled by this function.
+func (dao *{{.TplTableNameCamelCase}}Dao) Transaction(ctx context.Context, f func(ctx context.Context, tx database.TX) error) (err error) {
+	return dao.Ctx(ctx).Transaction(ctx, f)
+}
+`
@@ -0,0 +1,20 @@
+// 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 consts
+
+const TemplateGenDaoDoContent = `
+// =================================================================================
+// Code generated and maintained by GoFrame CLI tool. DO NOT EDIT. {{.TplCreatedAtDatetimeStr}}
+// =================================================================================
+
+package {{.TplPackageName}}
+
+{{.TplPackageImports}}
+
+// {{.TplTableNameCamelCase}} is the golang structure of table {{.TplTableName}} for DAO operations like Where/Data.
+{{.TplStructDefine}}
+`
@@ -0,0 +1,20 @@
+// 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 consts
+
+const TemplateGenDaoEntityContent = `
+// =================================================================================
+// Code generated and maintained by GoFrame CLI tool. DO NOT EDIT. {{.TplCreatedAtDatetimeStr}}
+// =================================================================================
+
+package {{.TplPackageName}}
+
+{{.TplPackageImports}}
+
+// {{.TplTableNameCamelCase}} is the golang structure for table {{.TplTableName}}.
+{{.TplStructDefine}}
+`
@@ -0,0 +1,35 @@
+// 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 consts
+
+const TemplateGenTableContent = `
+// =================================================================================
+// This file is auto-generated by the GoFrame CLI tool. You may modify it as needed.
+// =================================================================================
+
+package {{.TplPackageName}}
+
+import (
+	"context"
+
+	"git.magicany.cc/black1552/gin-base/database"
+)
+
+// {{.TplTableNameCamelCase}} defines the fields of table "{{.TplTableName}}" with their properties.
+// This map is used internally by GoFrame ORM to understand table structure.
+var {{.TplTableNameCamelCase}} = map[string]*database.TableField{
+{{.TplTableFields}}
+}
+
+// Set{{.TplTableNameCamelCase}}TableFields registers the table fields definition to the database instance.
+// db: database instance that implements database.DB interface.
+// schema: optional schema/namespace name, especially for databases that support schemas.
+func Set{{.TplTableNameCamelCase}}TableFields(ctx context.Context, db database.DB, schema ...string) error {
+	return db.GetCore().SetTableFields(ctx, "{{.TplTableName}}", {{.TplTableNameCamelCase}}, schema...)
+}
+
+`