README
¶
定数自動生成
生成処理の書き方
以下のコードは ./defs ディレクトリ内の定義ファイルをすべて読み込み定数生成するコードです。
このコードは main.go という名前で配置し、そのディレクトリで
go generate
と実行することで、main関数が実行され定数が自動生成されます。
//go:generate go run .
package main
import (
"os"
"path/filepath"
"github.com/rabee-inc/go-pkg/codegen"
)
const defsDir = "./defs"
func main() {
// defsDir 内のすべての yaml ファイルを読み込む
files, err := os.ReadDir(defsDir)
if err != nil {
panic(err)
}
for _, file := range files {
if !file.IsDir() {
path := filepath.Join(defsDir, file.Name())
codegen.ExportByYaml(path)
}
}
}
yaml の書き方
基本的にスネークケースで記載を推奨。キャメルケースには対応していません。
settings
settings:
package: パッケージ名
output: 出力先 (go generate を実行するディレクトリからの相対パス)
注意事項
同じディレクトリに同じpackage名で出力することはできません
types
types:
定数の型名:
comment: コメント # 必須
only_backend: true # 任意: バックエンドでしか使用しない値かどうか。true の場合はフロントに返す値に含めません
type: int # 任意 (int | int64 | string | float) (デフォルト = string)
extends: # 任意: meta data に追加するプロパティ。 (ID と Name 以外に追加でプロパティを含める場合に使用してください)
プロパティ名: 型名 # 必須: 型名 (int | int64 | string | float | 他の types で定義した型 | またそれぞれのslice)
defs: # 別途記載
defs
以下の3種類の書き方があります。
ショートハンド
変数名: Name の値
入力例
types:
comment: アイテム
item:
defs:
private: 非公開
public: 公開
出力
// Item ... アイテム
type Item string
const (
ItemPrivate Item = "private"
ItemPublic Item = "public"
)
type ItemMetaData ConstantMetaData[Item]
var Items = []*ItemMetaData{
{
ID: ItemPrivate,
Name: "非公開",
},
{
ID: ItemPublic,
Name: "公開",
},
}
var ItemMap map[Item]*ItemMetaData
ID を変更する場合
変数名:
id: ID の値
name: Name の値
入力例
types:
comment: アイテム
type: int
item:
defs:
private:
id: 1
name: 非公開
public:
id: 2
name: 公開
出力
// Item ... アイテム
type Item int
const (
ItemPrivate Item = 1
ItemPublic Item = 2
)
type ItemMetaData ConstantMetaData[Item]
var Items = []*ItemMetaData{
{
ID: ItemPrivate,
Name: "非公開",
},
{
ID: ItemPublic,
Name: "公開",
},
}
var ItemMap map[Item]*ItemMetaData
ID と Name 以外にプロパティを追加する場合
extends を定義してその値をプロパティに追加します。
入力例
types:
item:
comment: アイテム
extends:
color: string
defs:
private:
name: 非公開
color: red
public:
name: 公開
color: green
出力
// Item ... アイテム
type Item string
const (
ItemPrivate Item = "private"
ItemPublic Item = "public"
)
type ItemMetaData ConstantMetaData[Item]
var Items = []*ItemMetaData{
{
ID: ItemPrivate,
Name: "非公開",
Color: "red"
},
{
ID: ItemPublic,
Name: "公開",
Color: "green"
},
}
var ItemMap map[Item]*ItemMetaData
extends に他の types で定義した型を指定する場合
extends には他の types で定義した型を指定する事ができます。(sliceを指定することもできます。)
その型のdefsのkey名を値として指定してください。
入力例
types:
color:
comment: 色
defs:
red: 赤
green: 緑
blue: 青
item:
comment: アイテム
extends:
color: color
colors: "[]color"
defs:
private:
name: 非公開
color: red
colors: [red, blue]
public:
name: 公開
color: green
colors: [green, red]
出力(item部分のみ)
// Item ... アイテム
type Item string
func (c Item) String() string {
return string(c)
}
func (c Item) Meta() (*ItemMetaData, bool) {
m, ok := ItemMap[c]
return m, ok
}
func (c Item) Name() string {
if m, ok := c.Meta(); ok {
return m.Name
}
return ""
}
const (
ItemPrivate Item = "private"
ItemPublic Item = "public"
)
type ItemMetaData struct {
ID Item `json:"id"`
Name string `json:"name"`
Color Color `json:"color"`
Colors []Color `json:"colors"`
}
var Items = []*ItemMetaData{
{
ID: ItemPrivate,
Name: "非公開",
Color: ColorRed,
Colors: []Color{ColorRed, ColorBlue},
},
{
ID: ItemPublic,
Name: "公開",
Color: ColorGreen,
Colors: []Color{ColorGreen, ColorRed},
},
}
var ItemMap map[Item]*ItemMetaData
groups
groups を使うと、extends で追加したプロパティをまとめて指定することができます。
入力例
types:
item:
comment: アイテム
extends:
category: string
groups:
- props:
category: animal
defs:
dog: 犬
cat: 猫
- props:
category: plant
defs:
tomato: トマト
potato: ポテト
出力
// Item ... アイテム
type Item string
func (c Item) String() string {
return string(c)
}
func (c Item) Meta() (*ItemMetaData, bool) {
m, ok := ItemMap[c]
return m, ok
}
func (c Item) Name() string {
if m, ok := c.Meta(); ok {
return m.Name
}
return ""
}
const (
ItemDog Item = "dog"
ItemCat Item = "cat"
ItemTomato Item = "tomato"
ItemPotato Item = "potato"
)
type ItemMetaData struct {
ID Item `json:"id"`
Name string `json:"name"`
Category string `json:"category"`
}
var Items = []*ItemMetaData{
{
ID: ItemDog,
Name: "犬",
Category: "animal",
},
{
ID: ItemCat,
Name: "猫",
Category: "animal",
},
{
ID: ItemTomato,
Name: "トマト",
Category: "plant",
},
{
ID: ItemPotato,
Name: "ポテト",
Category: "plant",
},
}
var ItemMap map[Item]*ItemMetaData
templates > extends_defs
extends に指定する内容をあらかじめ定義しておくことができます。 同じinterfaceでMetaDataのプロパティを扱うことができるため、メンテナンス性が向上します。
- extends_defs で指定した定義をextendsで指定するには
extends: extends_defs のkey名とします。 - 通常のextendsと同様に、他のtypeを指定することもできます。
- この指定を行った場合は、通常のextendsの指定と以下の違いがあります。
- 他のtypesで同じextendsの定義を指定している場合は、同じinterfaceを実装します。
- Propsメソッドが使用できます。このメソッドは、IDを除くMetaDataのプロパティを取得します。
- 他のtypesで同じextendsの定義を指定している場合は、MetaDataのプロパティの型は同じ型になります。
入力例
templates:
extends_defs:
with_category:
category: string
types:
item:
comment: アイテム
extends: with_category
defs:
water:
name: 水
category: drink
potato:
name: ポテト
category: food
出力
type WithCategoryMetaDataProps struct {
Name string `json:"name"`
Category string `json:"category"`
}
type WithCategoryMetaData[T WithCategory] struct {
ID T
*WithCategoryMetaDataProps
}
type WithCategory interface {
Props() (*WithCategoryMetaDataProps, bool)
}
// Item ... アイテム
type Item string
func (c Item) String() string {
return string(c)
}
func (c Item) Props() (*WithCategoryMetaDataProps, bool) {
if m, ok := c.Meta(); ok {
return m.WithCategoryMetaDataProps, ok
}
return nil, false
}
func (c Item) Meta() (*ItemMetaData, bool) {
m, ok := ItemMap[c]
return m, ok
}
func (c Item) Name() string {
if m, ok := c.Meta(); ok {
return m.Name
}
return ""
}
const (
ItemWater Item = "water"
ItemPotato Item = "potato"
)
type ItemMetaData WithCategoryMetaData[Item]
var Items = []*ItemMetaData{
{
ID: ItemWater,
WithCategoryMetaDataProps: &WithCategoryMetaDataProps{
Name: "水",
Category: "drink",
},
},
{
ID: ItemPotato,
WithCategoryMetaDataProps: &WithCategoryMetaDataProps{
Name: "ポテト",
Category: "food",
},
},
}
var ItemMap map[Item]*ItemMetaData
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ExportByYaml ¶
ExportByYaml ... yaml ファイルからコードを生成し、ファイルに出力する
func GenerateByYamlFile ¶ added in v1.9.0
GenerateByYamlFile ... yaml ファイルからコードを生成する
func GenerateCheckSum ¶ added in v1.9.0
GenerateCheckSum ... チェックサムを生成する
Types ¶
This section is empty.
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.