vogen – Wertobjektgenerator in Golang

Einführung

Verstehen Sie Domain-Driven Design (DDD)? Ich habe es immer noch nicht ganz verstanden.

Vor Kurzem habe ich mich intensiv mit Büchern über Domain-Driven Design (DDD) beschäftigt. In DDD taucht das Konzept eines Wertobjekts auf. Ein Wertobjekt weist in erster Linie die folgenden Merkmale auf (Elemente, die nichts mit dem Hauptthema dieses Artikels zu tun haben, werden absichtlich weggelassen):

• Unveränderlich
• Objekte gelten als gleich, wenn ihre Werte gleichwertig sind

Um die oben genannten Spezifikationen in Golang zu erfüllen, müsste die Implementierung etwa so aussehen:

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() 
}

Ehrlich gesagt ist die Implementierung dieser Art von Funktionalität mühsam. Darüber hinaus erscheint es sinnlos, Unit-Tests für Getter() oder Equal() zu schreiben. Ich wünschte oft: „Wenn Golang nur so etwas wie Kotlins Wertklasse oder Datenklasse hätte.“

Erzeugt Wertobjektcode

Das Paket nao1215/vogen ist eine Bibliothek, die automatisch Value Object-Code mit den Methoden New(), Getter und Equal() generiert. Der Name steht für „Value Object Generator“.

Mit dieser Bibliothek schreiben Sie Metadaten für Wertobjekte in Golang und basierend auf diesen Metadaten wird der Code automatisch generiert. Die Inspiration für diese Spezifikation stammt von shogo82148/myddlmaker (einer Bibliothek, die DB DDL aus Metadaten generiert).

Verwendungszweck

Die typische Verwendung umfasst das Definieren von Metadaten in value_object/gen/main.go und das Ausführen von go generic ./..., um die Datei value_object/value_object.go zu generieren. Es ist auch möglich, die Ausgabe auf mehrere Dateien zu verteilen.

Unten finden Sie eine Beispielimplementierung für 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
    }
}

In vogen.New() können Sie den Dateipfad und den Paketnamen für den generierten Code angeben, diese sind jedoch optional. Wenn es weggelassen wird, wird standardmäßig eine value_objects.go-Datei unter dem vo-Paket generiert.

vogen.ValueObject() entspricht den Metadaten. Kommentare für die Struktur und ihre Felder sind optional. Wenn es weggelassen wird, enthält die Ausgabe seelenlose englische Kommentare. Für Typen können Sie definierte Typen (benutzerdefinierte Typen) angeben, in solchen Fällen müssen Sie jedoch auch den Modulpfad angeben. Da definierte Typen noch nicht getestet wurden, habe ich sie im Beispielcode bewusst weggelassen (Tests sind für später geplant).

Automatisch generierter Code

Unten finden Sie den Code, der anhand des obigen Beispiels automatisch generiert wurde:

// 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()
}

Warum ich diesen Artikel geschrieben habe

Ich wollte wissen, ob Funktionen wie das Vogen-Paket für Golang-Benutzer interessant wären.

Das obige ist der detaillierte Inhalt vonvogen – Wertobjektgenerator in Golang. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!