データ型のカスタマイズ

GORMは、ユーザーがGORMでよくサポートされているカスタマイズされたデータ型を定義できるようにするいくつかのインターフェースを提供します。jsonを例に見てみましょう。

カスタムデータ型の実装

Scanner / Valuer

カスタマイズされたデータ型は、ScannerとValuerインターフェースを実装する必要があります。これにより、GORMはデータベースへの送受信方法を認識します。

例:

type JSON json.RawMessage

// Scan scan value into Jsonb, implements sql.Scanner interface
func (j *JSON) Scan(value interface{}) error {
  bytes, ok := value.([]byte)
  if !ok {
    return errors.New(fmt.Sprint("Failed to unmarshal JSONB value:", value))
  }

  result := json.RawMessage{}
  err := json.Unmarshal(bytes, &result)
  *j = JSON(result)
  return err
}

// Value return json value, implement driver.Valuer interface
func (j JSON) Value() (driver.Value, error) {
  if len(j) == 0 {
    return nil, nil
  }
  return json.RawMessage(j).MarshalJSON()
}

多くのサードパーティパッケージは`Scanner`/`Valuer`インターフェースを実装しており、GORMと組み合わせて使用できます。例:

import (
  "github.com/google/uuid"
  "github.com/lib/pq"
)

type Post struct {
  ID     uuid.UUID `gorm:"type:uuid;default:uuid_generate_v4()"`
  Title  string
  Tags   pq.StringArray `gorm:"type:text[]"`
}

GormDataTypeInterface

GORMは、タグ`type`からカラムのデータベース型を読み取ります。見つからない場合は、構造体が`GormDBDataTypeInterface`または`GormDataTypeInterface`インターフェースを実装しているかどうかを確認し、その結果をデータ型として使用します。

type GormDataTypeInterface interface {
  GormDataType() string
}

type GormDBDataTypeInterface interface {
  GormDBDataType(*gorm.DB, *schema.Field) string
}

`GormDataType`の結果は、一般的なデータ型として使用され、`schema.Field`のフィールド`DataType`から取得できます。これは、プラグインの作成やフックなどを行う際に役立ちます。

func (JSON) GormDataType() string {
  return "json"
}

type User struct {
  Attrs JSON
}

func (user User) BeforeCreate(tx *gorm.DB) {
  field := tx.Statement.Schema.LookUpField("Attrs")
  if field.DataType == "json" {
    // do something
  }
}

`GormDBDataType`は通常、マイグレーション時に現在のドライバに適したデータ型を返します。例:

func (JSON) GormDBDataType(db *gorm.DB, field *schema.Field) string {
  // use field.Tag, field.TagSettings gets field's tags
  // checkout https://github.com/go-gorm/gorm/blob/master/schema/field.go for all options

  // returns different database type based on driver name
  switch db.Dialector.Name() {
  case "mysql", "sqlite":
    return "JSON"
  case "postgres":
    return "JSONB"
  }
  return ""
}

構造体が`GormDBDataTypeInterface`または`GormDataTypeInterface`インターフェースを実装していない場合、GORMは構造体の最初のフィールドからデータ型を推測します。例として、`NullString`には`string`を使用します。

type NullString struct {
  String string // use the first field's data type
  Valid  bool
}

type User struct {
  Name NullString // data type will be string
}

GormValuerInterface

GORMは`GormValuerInterface`インターフェースを提供しており、コンテキストに基づいてSQL Exprまたは値から作成/更新できます。例:

// GORM Valuer interface
type GormValuerInterface interface {
  GormValue(ctx context.Context, db *gorm.DB) clause.Expr
}

SQL Exprからの作成/更新

type Location struct {
  X, Y int
}

func (loc Location) GormDataType() string {
  return "geometry"
}

func (loc Location) GormValue(ctx context.Context, db *gorm.DB) clause.Expr {
  return clause.Expr{
    SQL:  "ST_PointFromText(?)",
    Vars: []interface{}{fmt.Sprintf("POINT(%d %d)", loc.X, loc.Y)},
  }
}

// Scan implements the sql.Scanner interface
func (loc *Location) Scan(v interface{}) error {
  // Scan a value into struct from database driver
}

type User struct {
  ID       int
  Name     string
  Location Location
}

db.Create(&User{
  Name:     "jinzhu",
  Location: Location{X: 100, Y: 100},
})
// INSERT INTO `users` (`name`,`point`) VALUES ("jinzhu",ST_PointFromText("POINT(100 100)"))

db.Model(&User{ID: 1}).Updates(User{
  Name:  "jinzhu",
  Location: Location{X: 100, Y: 100},
})
// UPDATE `user_with_points` SET `name`="jinzhu",`location`=ST_PointFromText("POINT(100 100)") WHERE `id` = 1

マップからSQL Exprを使用して作成/更新することもできます。SQL Exprからの作成とSQL式による更新で詳細を確認してください。

コンテキストに基づく値

現在のコンテキストに応じて値を作成または更新する場合は、`GormValuerInterface`インターフェースを実装することもできます。例:

type EncryptedString struct {
  Value string
}

func (es EncryptedString) GormValue(ctx context.Context, db *gorm.DB) (expr clause.Expr) {
  if encryptionKey, ok := ctx.Value("TenantEncryptionKey").(string); ok {
    return clause.Expr{SQL: "?", Vars: []interface{}{Encrypt(es.Value, encryptionKey)}}
  } else {
    db.AddError(errors.New("invalid encryption key"))
  }

  return
}

句式表現

クエリヘルパーを作成する場合は、`clause.Expression`インターフェースを実装する構造体を作成できます。

type Expression interface {
  Build(builder Builder)
}

JSONとSQLビルダーで詳細を確認してください。以下は使用例です。

// Generates SQL with clause Expression
db.Find(&user, datatypes.JSONQuery("attributes").HasKey("role"))
db.Find(&user, datatypes.JSONQuery("attributes").HasKey("orgs", "orga"))

// MySQL
// SELECT * FROM `users` WHERE JSON_EXTRACT(`attributes`, '$.role') IS NOT NULL
// SELECT * FROM `users` WHERE JSON_EXTRACT(`attributes`, '$.orgs.orga') IS NOT NULL

// PostgreSQL
// SELECT * FROM "user" WHERE "attributes"::jsonb ? 'role'
// SELECT * FROM "user" WHERE "attributes"::jsonb -> 'orgs' ? 'orga'

db.Find(&user, datatypes.JSONQuery("attributes").Equals("jinzhu", "name"))
// MySQL
// SELECT * FROM `user` WHERE JSON_EXTRACT(`attributes`, '$.name') = "jinzhu"

// PostgreSQL
// SELECT * FROM "user" WHERE json_extract_path_text("attributes"::json,'name') = 'jinzhu'

カスタマイズされたデータ型コレクション

カスタマイズされたデータ型コレクション用のGitHubリポジトリを作成しました。https://github.com/go-gorm/datatypes、プルリクエスト歓迎！