entのschemaからのコード生成の仕組みを把握する

podhmo

ent/ent: An entity framework for Go

やること

entのschema経由でのコード生成の仕組みを把握する
- どのパッケージのどの関数が呼ばれているのかを把握する
schemaの定義時に利用できるメソッドが制限される仕組みを把握する

podhmo

結論 https://zenn.dev/link/comments/a1172d2d0f7c15

podhmo

entのschemaの生成について

以下の様なコードから始まる( ent init で生成されたものを利用する )。


package schema

import "entgo.io/ent"

// User holds the schema definition for the User entity.
type User struct {
    ent.Schema
}


// Fields of the User.
func (User) Fields() []ent.Field {
    return []ent.Field{
        field.Int("age").
            Positive(),
        field.String("name").
            Default("unknown"),
    }
}

// Edges of the User.
func (User) Edges() []ent.Edge {
    return nil
}

podhmo

schemaからのコード生成は go generate ./ent で実行される

具体的には https://github.com/ent/ent/blob/master/examples/start/ent/generate.go

// Copyright 2019-present Facebook Inc. All rights reserved.
// This source code is licensed under the Apache 2.0 license found
// in the LICENSE file in the root directory of this source tree.

package ent

//go:generate go run -mod=mod entgo.io/ent/cmd/ent generate --header "// Copyright 2019-present Facebook Inc. All rights reserved.\n// This source code is licensed under the Apache 2.0 license found\n// in the LICENSE file in the root directory of this source tree.\n\n// Code generated by ent, DO NOT EDIT." ./schema

podhmo

go run 経由で cmd/ent generate のサブコマンドが実行される。

これは、実質 entc.Generate() を呼んでいる

つまり、entcを理解すれば良い。

podhmo

entc.Generate()の挙動について

podhmo

entc.Generate()の定義

実際の実装はgenerate()の方。LoadGraph()してgraph.Gen()。

生成の仕組みではなく定義の仕組みが知りたいので見るべきはLoadGraph()

entgo.io/ent/entc/genの方を覗けば良い。

podhmo

NewGraph()は本当にきれいなコード

addNode()
addEdges()
relationのcheck
foreign keyのcheck
addIndexes()
aliasesとか諸々

知りたいことはここではなく、引数となるschemasの取得だった。

podhmo

Config.Load()が知りたかった内容

config.load() して
某かのtemplateでExecuteTemplate()
main.go的なコードを生成し
go runで実行
出力結果を UnmarshalSchema() を利用して結果を返す

podhmo

UnmarshalSchema()は実質json.Unmarshal()

podhmo

config.load()はgo/packages経由でschemaの定義を取り出す。

面白いのは、go/types経由でInterfaceを実装している定義を取り出しているところだと思う。

podhmo

entのschemaで定義できるメソッド

これは、GenerateSchema()を覗いても良いし、pkg.go.devを覗いても良い。

podhmo

MarshalSchemaか

podhmo

schemaの定義はこのあたり

podhmo

Fieldの追加は Fields() で行い、Field 自体は以下のようなインターフェイスしか使えない。

実際の定義はinternal (stringを例にする）

podhmo

ここでDescriptorとは、メタデータを保持するために使うもの

Descriptor -- serialize のためのフィールドの定義 (goType(), checkGoType())を保持する
各種builderでのメソッド -- 属性のsetter

:memo: reflectが使われている

podhmo

つまり、

自由度が制限されたbuilderを各種setterとして扱い、これはString()みたいな関数がfactoryとして機能し、descriptorはmetadata
定義されたschemaを実行するmain.goを生成し、それをgo runで実行、metadataはJSONとして転写される
転写された文字列をJSONとして扱いschemaの設定値を得る。コード生成自体はこの設定値を利用していい感じに生成