メインコンテンツへスキップする

ミックスイン

Mixinを使用すると、コンポジションを使用して他のスキーマに注入できるent.Schemaコードの再利用可能な箇所を作成することができます。

ent.Mixinインターフェイスは以下のとおりです:

type Mixin interface {
// Fieldsは、スキーマに追加するフィールドのスライスを返します
Fields() []Field
// Edgesは、スキーマに追加するエッジのスライスを返します
Edges() []Edge
// Indexesは、スキーマに追加するインデックスのスライスを返します
Fields() []Field
// Hooksは、スキーマに追加すフックのスライスを返します
// ミックスインフックはスキーマフックの前に実行されることに注意してください
Hooks() []Hook
// Policy は、スキーマに追加するためのプライバシーポリシーを返します
// ミックスインポリシーはスキーマポリシーの前に実行されることに注意してください
Policy() Policy
// Annotationsは、スキーマアノテーションに追加する
// スキーマアノテーションのリストを返します
Annotations() []schema.Annotation
}

使用例

Mixin の一般的な使用例は、スキーマに共通のフィールドのリストを混在させることです

package schema

import (
"time"

"entgo.io/ent"
"entgo.io/ent/schema/field"
"entgo.io/ent/schema/mixin"
)

// -------------------------------------------------
// ミックスインの定義

// TimeMixinは、schemaパッケージでtimeフィールドを共有するために、
// ent.Mixinを実装しています。
type TimeMixin struct{
// 残りのメソッドの実装を避けるために
// `mixin.Schema`を埋め込みます
mixin.Schema
}

func (TimeMixin) Fields() []ent.Field {
return []ent.Field{
field.Time("created_at").
Immutable().
Default(time.Now),
field.Time("updated_at").
Default(time.Now).
UpdateDefault(time.Now),
}
}

// DetailsMixin implements the ent.Mixin for sharing
// entity details fields with package schemas.

// DetailsMixinは、エンティティの詳細フィールドを
// schemaパッケージで共有するためのent.Mixinを実装しています。
type DetailsMixin struct{
// 残りのメソッドの実装を避けるために
// `mixin.Schema`を埋め込みます
mixin.Schema
}

func (DetailsMixin) Fields() []ent.Field {
return []ent.Field{
field.Int("age").
Positive(),
field.String("name").
NotEmpty(),
}
}

// -------------------------------------------------
// Schema definition

// UserスキーマはmTimeMixinとDetailsMixinをミックスインしているため、
// `created_at`、`updated_at`、`age`、`name`、`nickname`の5つのフィールドを持っています
type User struct {
ent.Schema
}

func (User) Mixin() []ent.Mixin {
return []ent.Mixin{
TimeMixin{},
DetailsMixin{},
}
}

func (User) Fields() []ent.Field {
return []ent.Field{
field.String("nickname").
Unique(),
}
}

// PetスキーマはDetailsMixinフィールドをミックスインしているので、
// `age`、`name` 、`weight`の3つのフィールドを持っています
type Pet struct {
ent.Schema
}

func (Pet) Mixin() []ent.Mixin {
return []ent.Mixin{
DetailsMixin{},
}
}

func (Pet) Fields() []ent.Field {
return []ent.Field{
field.Float("weight"),
}
}

ビルトインミックスイン

mixinパッケージには、create_timeupdate_timeフィールドをスキーマに追加するために使用できるいくつかのビルトインミックスインが用意されています。

これらを使用するには、 mixin.Time ミックスインをスキーマに以下のように追加します:

package schema

import (
"entgo.io/ent"
"entgo.io/ent/schema/mixin"
)

type Pet struct {
ent.Schema
}

func (Pet) Mixin() []ent.Mixin {
return []ent.Mixin{
mixin.Time{},
// create_timeにはmixin.CreateTime、
// update_timeにはmixin.UpdateTimeがあります
}
}