Mixin

Mixin 允许您创建可复用的 ent.Schema 代码，用与合成添加到其他 schemas

ent.Mixin 接口如下：

  1. type Mixin interface {
  2.     // Fields 数组的返回值会被添加到 schema 中。
  3.     Fields() []Field
  4.     // Edges 数组返回值会被添加到 schema 中。
  5.     Edges() []Edge
  6.     // Indexes 数组的返回值会被添加到 schema 中。
  7.     Indexes() []Index
  8.     // Hooks 数组的返回值会被添加到 schema 中。
  9.     // 请注意，mixin 的钩子会在 schema 的钩子之前被执行。
  10.     Hooks() []Hook
  11.     // Policy 数组的返回值会被添加到 schema 中。
  12.     //请注意，mixin（混入）的 policy（策略）会在 schema 的 policy 之前被执行。
  13.     Policy() Policy
  14.     // Annotations 方法返回要添加到 Schema 中的注解列表。
  15.     Annotations() []schema.Annotation
  16. }

示例

Mixin 多用于：将你 Schema 中常用的字段抽象出来。

  1. package schema
  4. import (
  5.     "time"
  8.     "entgo.io/ent"
  9.     "entgo.io/ent/schema/field"
  10.     "entgo.io/ent/schema/mixin"
  11. )
  14. // -------------------------------------------------
  15. // Mixin definition
  18. // TimeMixin implements the ent.Mixin for sharing
  19. // time fields with package schemas.
  20. type TimeMixin struct{
  21.     // We embed the `mixin.Schema` to avoid
  22.     // implementing the rest of the methods.
  23.     mixin.Schema
  24. }
  27. func (TimeMixin) Fields() []ent.Field {
  28.     return []ent.Field{
  29.         field.Time("created_at").
  30.             Immutable().
  31.             Default(time.Now),
  32.         field.Time("updated_at").
  33.             Default(time.Now).
  34.             UpdateDefault(time.Now),
  35.     }
  36. }
  39. // DetailsMixin implements the ent.Mixin for sharing
  40. // entity details fields with package schemas.
  41. type DetailsMixin struct{
  42.     // We embed the `mixin.Schema` to avoid
  43.     // implementing the rest of the methods.
  44.     mixin.Schema
  45. }
  48. func (DetailsMixin) Fields() []ent.Field {
  49.     return []ent.Field{
  50.         field.Int("age").
  51.             Positive(),
  52.         field.String("name").
  53.             NotEmpty(),
  54.     }
  55. }
  58. // -------------------------------------------------
  59. // Schema definition
  62. // User schema mixed-in the TimeMixin and DetailsMixin fields and therefore
  63. // has 5 fields: `created_at`, `updated_at`, `age`, `name` and `nickname`.
  64. type User struct {
  65.     ent.Schema
  66. }
  69. func (User) Mixin() []ent.Mixin {
  70.     return []ent.Mixin{
  71.         TimeMixin{},
  72.         DetailsMixin{},
  73.     }
  74. }
  77. func (User) Fields() []ent.Field {
  78.     return []ent.Field{
  79.         field.String("nickname").
  80.             Unique(),
  81.     }
  82. }
  85. // Pet schema mixed-in the DetailsMixin fields and therefore
  86. // has 3 fields: `age`, `name` and `weight`.
  87. type Pet struct {
  88.     ent.Schema
  89. }
  92. func (Pet) Mixin() []ent.Mixin {
  93.     return []ent.Mixin{
  94.         DetailsMixin{},
  95.     }
  96. }
  99. func (Pet) Fields() []ent.Field {
  100.     return []ent.Field{
  101.         field.Float("weight"),
  102.     }
  103. }

内置Mixin

mixin包提供了一些内置的mixin，它们可以用于在schema中添加create_time和update_time 字段。

若要使用它们，请将 mixin.Time mixin 添加到您的schema，如下：

  1. package schema
  4. import (
  5.     "entgo.io/ent"
  6.     "entgo.io/ent/schema/mixin"
  7. )
  10. type Pet struct {
  11.     ent.Schema
  12. }
  15. func (Pet) Mixin() []ent.Mixin {
  16.     return []ent.Mixin{
  17.         mixin.Time{},
  18.         // Or, mixin.CreateTime only for create_time
  19.         // and mixin.UpdateTime only for update_time.
  20.     }
  21. }