vogen - golang의 값 개체 생성기

소개

도메인 기반 디자인(DDD)을 이해하시나요? 아직 완전히 이해하지는 못했습니다.

최근에는 DDD(Domain-Driven Design)에 관한 책에 빠져들고 있습니다. DDD에서는 Value Object라는 개념이 등장합니다. 값 개체는 주로 다음과 같은 특성을 갖습니다(이 문서의 주요 주제와 관련 없는 요소는 의도적으로 생략됨).

• 불변
• 값이 동일하면 객체는 동일한 것으로 간주됩니다

Golang에서 위의 사양을 충족하려면 구현이 다음과 같아야 합니다.

type Person struct {
    name string
}

func NewPerson(name string) Person {
    return Person{name: name}
}

func (o Person) Name() string {
    return o.name
}

func (o Person) Equal(other Person) bool {
    return o.Name() == other.Name() 
}

솔직히 이런 기능을 구현하는 것은 번거로운 작업입니다. 또한 Getter() 또는 Equal()에 대한 단위 테스트를 작성하는 것이 무의미하다고 느껴집니다. '골랭에도 코틀린의 밸류 클래스나 데이터 클래스 같은 게 있었으면 좋겠다'는 생각을 자주 하게 됐어요.

값 개체 코드를 생성합니다.

nao1215/vogen 패키지는 New(), Getter 및 Equal() 메서드를 사용하여 Value Object 코드를 자동으로 생성하는 라이브러리입니다. 이름은 "Value Object Generator"를 의미합니다.

이 라이브러리를 사용하면 Golang의 값 개체에 대한 메타데이터를 작성하고 해당 메타데이터를 기반으로 코드가 자동으로 생성됩니다. 이 사양에 대한 영감은 shogo82148/myddlmaker(메타데이터에서 DB DDL을 생성하는 라이브러리)에서 나왔습니다.

사용 목적

일반적인 사용법은 value_object/gen/main.go에서 메타데이터를 정의하고 go generate ./...를 실행하여 value_object/value_object.go 파일을 생성하는 것입니다. 여러 파일에 걸쳐 출력을 배포하는 것도 가능합니다.

아래는 value_object/gen/main.go에 대한 구현 예입니다.

package main

import (
    "fmt"
    "path/filepath"

    "github.com/nao1215/vogen"
)

//go:generate go run main.go

func main() {
    // Step 1: Create a Vogen instance with custom file path and package name.
    // By default, the file path is "value_objects.go" and the package name is "vo".
    gen, err := vogen.New(
        vogen.WithFilePath(filepath.Join("testdata", "example_output.go")),
        vogen.WithPackageName("vo_example"),
    )
    if err != nil {
        fmt.Printf("Failed to create Vogen instance: %v\n", err)
        return
    }

    // Step 2: Append the ValueObject definition
    if err := gen.AppendValueObjects(
        vogen.ValueObject{
            StructName: "Person",
            Fields: []vogen.Field{
                {Name: "Name", Type: "string", Comments: []string{"Name is the name of the person."}},
                {Name: "Age", Type: "int", Comments: []string{"Age is the age of the person."}},
            },
            Comments: []string{
                "Person is a Value Object to describe the feature of vogen.",
                "This is sample comment.",
            },
        },
        // Use auto generated comments.
        vogen.ValueObject{
            StructName: "Address",
            Fields: []vogen.Field{
                {Name: "City", Type: "string"},
            },
        },
    ); err != nil {
        fmt.Printf("Failed to append ValueObject: %v\n", err)
        return
    }

    // Step 3: Generate the code
    if err := gen.Generate(); err != nil {
        fmt.Printf("Failed to generate code: %v\n", err)
        return
    }
}

vogen.New()에서는 생성된 코드의 파일 경로와 패키지 이름을 지정할 수 있지만 이는 선택 사항입니다. 생략하면 기본적으로 vo 패키지 아래에 value_objects.go 파일이 생성됩니다.

vogen.ValueObject()는 메타데이터에 해당합니다. 구조체 및 해당 필드에 대한 주석은 선택 사항입니다. 생략하면 영혼 없는 영어 댓글이 출력됩니다. 유형의 경우 정의된 유형(사용자 정의 유형)을 지정할 수 있지만 이러한 경우 모듈 경로도 제공해야 합니다. 정의된 유형은 아직 테스트되지 않았기 때문에 예제 코드에서는 의도적으로 생략했습니다(테스트는 추후에 예정되어 있습니다).

자동 생성 코드

다음은 위의 샘플을 사용하여 자동으로 생성된 코드입니다.

// Code generated by vogen. DO NOT EDIT.
package vo_example

import (
    "fmt"
)

// Person is a Value Object to describe the feature of vogen.
// This is sample comment.
type Person struct {
    // Name is the name of the person.
    name string
    // Age is the age of the person.
    age int
}

// NewPerson creates a new instance of Person.
func NewPerson(name string, age int) Person {
    return Person{name: name, age: age}
}

// Name returns the name field.
func (o Person) Name() string {
    return o.name
}

// Age returns the age field.
func (o Person) Age() int {
    return o.age
}

// Equal checks if two Person objects are equal.
func (o Person) Equal(other Person) bool {
    return o.Name() == other.Name() && o.Age() == other.Age()
}

// Address represents a value object.
type Address struct {
    city string
}

// NewAddress creates a new instance of Address.
func NewAddress(city string) Address {
    return Address{city: city}
}

// City returns the city field.
func (o Address) City() string {
    return o.city
}

// Equal checks if two Address objects are equal.
func (o Address) Equal(other Address) bool {
    return o.City() == other.City()
}

내가 이 글을 쓴 이유

vogen 패키지와 같은 기능이 Golang 사용자에게 흥미로울지 알고 싶었습니다.

위 내용은 vogen - golang의 값 개체 생성기의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!