repack gorm package

Author: zhufuyi

.github/RELEASE.md

@@ -1,3 +1,4 @@
 ## Change log
 
-- Modify sponge ui.
+- Add auto test scripts.
+- Repack gorm package.

pkg/ggorm/README.md

@@ -0,0 +1,101 @@
+### mysql
+
+`mysql` library wrapped in [gorm](gorm.io/gorm), with added features such as tracer, paging queries, etc.
+
+<br>
+
+### Example of use
+
+#### Initializing the connection
+
+```go
+    import (
+        "github.com/zhufuyi/sponge/pkg/ggorm"
+    )
+
+    var dsn = "root:123456@(192.168.1.6:3306)/test?charset=utf8mb4&parseTime=True&loc=Local"
+
+    // (1) connect to the database using the default settings
+    db, err := ggorm.InitMysql(dsn)
+
+    // (2) customised settings to connect to the database
+    db, err := ggorm.Init(
+        dsn,
+        ggorm.WithLogging(logger.Get()),  // print log
+        ggorm.WithLogRequestIDKey("request_id"),  // print request_id
+        ggorm.WithMaxIdleConns(5),
+        ggorm.WithMaxOpenConns(50),
+        ggorm.WithConnMaxLifetime(time.Minute*3),
+        // ggorm.WithSlowThreshold(time.Millisecond*100),  // only print logs that take longer than 100 milliseconds to execute
+        // ggorm.WithEnableTrace(),  // enable tracing
+        // ggorm.WithRWSeparation(SlavesDsn, MastersDsn...)  // read-write separation
+        // ggorm.WithGormPlugin(yourPlugin)  // custom gorm plugin
+    )
+```
+
+<br>
+
+#### Model
+
+```go
+package model
+
+import (
+	"github.com/zhufuyi/sponge/pkg/ggorm"
+)
+
+// UserExample object fields mapping table
+type UserExample struct {
+	ggorm.Model `gorm:"embedded"`
+
+	Name   string `gorm:"type:varchar(40);unique_index;not null" json:"name"`
+	Age    int    `gorm:"not null" json:"age"`
+	Gender string `gorm:"type:varchar(10);not null" json:"gender"`
+}
+
+// TableName get table name
+func (table *UserExample) TableName() string {
+	return gorm.GetTableName(table)
+}
+```
+
+<br>
+
+#### Transaction
+
+```go
+    func createUser() error {
+        // note that you should use tx as the database handle when you are in a transaction
+        tx := db.Begin()
+        defer func() {
+            if err := recover(); err != nil { // rollback after a panic during transaction execution
+                tx.Rollback()
+                fmt.Printf("transaction failed, err = %v\n", err)
+            }
+        }()
+
+        var err error
+        if err = tx.Error; err != nil {
+            return err
+        }
+
+        if err = tx.Where("id = ?", 1).First(table).Error; err != nil {
+            tx.Rollback()
+            return err
+        }
+
+        panic("mock panic")
+
+        if err = tx.Create(&userExample{Name: "Mr Li", Age: table.Age + 2, Gender: "male"}).Error; err != nil {
+            tx.Rollback()
+            return err
+        }
+
+        return tx.Commit().Error
+    }
+```
+<br>
+
+### gorm User Guide
+
+- https://gorm.io/zh_CN/docs/index.html

pkg/ggorm/base_model.go

@@ -0,0 +1,45 @@
+package mysql
+
+import (
+	"reflect"
+	"time"
+
+	"github.com/huandu/xstrings"
+	"gorm.io/gorm"
+)
+
+// Model embedded structs, add `gorm: "embedded"` when defining table structs
+type Model struct {
+	ID        uint64         `gorm:"column:id;AUTO_INCREMENT;primary_key" json:"id"`
+	CreatedAt time.Time      `gorm:"column:created_at" json:"createdAt"`
+	UpdatedAt time.Time      `gorm:"column:updated_at" json:"updatedAt"`
+	DeletedAt gorm.DeletedAt `gorm:"column:deleted_at;index" json:"-"`
+}
+
+// Model2 embedded structs, json tag named is snake case
+type Model2 struct {
+	ID        uint64         `gorm:"column:id;AUTO_INCREMENT;primary_key" json:"id"`
+	CreatedAt time.Time      `gorm:"column:created_at" json:"created_at"`
+	UpdatedAt time.Time      `gorm:"column:updated_at" json:"updated_at"`
+	DeletedAt gorm.DeletedAt `gorm:"column:deleted_at;index" json:"-"`
+}
+
+// KV map type
+type KV = map[string]interface{}
+
+// GetTableName get table name
+func GetTableName(object interface{}) string {
+	tableName := ""
+
+	typeof := reflect.TypeOf(object)
+	switch typeof.Kind() {
+	case reflect.Ptr:
+		tableName = typeof.Elem().Name()
+	case reflect.Struct:
+		tableName = typeof.Name()
+	default:
+		return tableName
+	}
+
+	return xstrings.ToSnakeCase(tableName)
+}

pkg/ggorm/gorm.go

@@ -0,0 +1,158 @@
+// Package mysql is a library wrapped on top of gorm.io/gorm, with added features such as link tracing, paging queries, etc.
+package mysql
+
+import (
+	"database/sql"
+	"fmt"
+	"log"
+	"os"
+
+	"github.com/uptrace/opentelemetry-go-extra/otelgorm"
+	mysqlDriver "gorm.io/driver/mysql"
+	"gorm.io/driver/postgres"
+	"gorm.io/gorm"
+	"gorm.io/gorm/logger"
+	"gorm.io/gorm/schema"
+	"gorm.io/plugin/dbresolver"
+)
+
+// InitMysql init mysql or tidb
+func InitMysql(dsn string, opts ...Option) (*gorm.DB, error) {
+	o := defaultOptions()
+	o.apply(opts...)
+
+	sqlDB, err := sql.Open("mysql", dsn)
+	if err != nil {
+		return nil, err
+	}
+	sqlDB.SetMaxIdleConns(o.maxIdleConns)       // set the maximum number of connections in the idle connection pool
+	sqlDB.SetMaxOpenConns(o.maxOpenConns)       // set the maximum number of open database connections
+	sqlDB.SetConnMaxLifetime(o.connMaxLifetime) // set the maximum time a connection can be reused
+
+	db, err := gorm.Open(mysqlDriver.New(mysqlDriver.Config{Conn: sqlDB}), gormConfig(o))
+	if err != nil {
+		return nil, err
+	}
+	db.Set("gorm:table_options", "CHARSET=utf8mb4") // automatic appending of table suffixes when creating tables
+
+	// register trace plugin
+	if o.enableTrace {
+		err = db.Use(otelgorm.NewPlugin())
+		if err != nil {
+			return nil, fmt.Errorf("using gorm opentelemetry, err: %v", err)
+		}
+	}
+
+	// register read-write separation plugin
+	if len(o.slavesDsn) > 0 {
+		err = db.Use(rwSeparationPlugin(o))
+		if err != nil {
+			return nil, err
+		}
+	}
+
+	// register plugins
+	for _, plugin := range o.plugins {
+		err = db.Use(plugin)
+		if err != nil {
+			return nil, err
+		}
+	}
+
+	return db, nil
+}
+
+// InitPostgresql init postgresql
+func InitPostgresql(dsn string, opts ...Option) (*gorm.DB, error) {
+	o := defaultOptions()
+	o.apply(opts...)
+
+	db, err := gorm.Open(postgres.Open(dsn), gormConfig(o))
+
+	if err != nil {
+		return nil, err
+	}
+
+	// register trace plugin
+	if o.enableTrace {
+		err = db.Use(otelgorm.NewPlugin())
+		if err != nil {
+			return nil, fmt.Errorf("using gorm opentelemetry, err: %v", err)
+		}
+	}
+
+	// register read-write separation plugin
+	if len(o.slavesDsn) > 0 {
+		err = db.Use(rwSeparationPlugin(o))
+		if err != nil {
+			return nil, err
+		}
+	}
+
+	// register plugins
+	for _, plugin := range o.plugins {
+		err = db.Use(plugin)
+		if err != nil {
+			return nil, err
+		}
+	}
+
+	return db, nil
+}
+
+// gorm setting
+func gormConfig(o *options) *gorm.Config {
+	config := &gorm.Config{
+		// disable foreign key constraints, not recommended for production environments
+		DisableForeignKeyConstraintWhenMigrating: o.disableForeignKey,
+		// removing the plural of an epithet
+		NamingStrategy: schema.NamingStrategy{SingularTable: true},
+	}
+
+	// print SQL
+	if o.isLog {
+		if o.gLog == nil {
+			config.Logger = logger.Default.LogMode(o.logLevel)
+		} else {
+			config.Logger = NewCustomGormLogger(o)
+		}
+	} else {
+		config.Logger = logger.Default.LogMode(logger.Silent)
+	}
+
+	// print only slow queries
+	if o.slowThreshold > 0 {
+		config.Logger = logger.New(
+			log.New(os.Stdout, "\r\n", log.LstdFlags), // use the standard output asWriter
+			logger.Config{
+				SlowThreshold: o.slowThreshold,
+				Colorful:      true,
+				LogLevel:      logger.Warn, // set the logging level, only above the specified level will output the slow query log
+			},
+		)
+	}
+
+	return config
+}
+
+func rwSeparationPlugin(o *options) gorm.Plugin {
+	slaves := []gorm.Dialector{}
+	for _, dsn := range o.slavesDsn {
+		slaves = append(slaves, mysqlDriver.New(mysqlDriver.Config{
+			DSN: dsn,
+		}))
+	}
+
+	masters := []gorm.Dialector{}
+	for _, dsn := range o.mastersDsn {
+		masters = append(masters, mysqlDriver.New(mysqlDriver.Config{
+			DSN: dsn,
+		}))
+	}
+
+	return dbresolver.Register(dbresolver.Config{
+		Sources:  masters,
+		Replicas: slaves,
+		Policy:   dbresolver.RandomPolicy{},
+	})
+}