go generate & stringer

go generate orquesta generadores de código.

stringer es el generador de "hola mundo": las constantes tipadas obtienen un método String() correcto sin reflexión.

Resumen

Coloca comentarios //go:generate encima de funciones o tipos en cualquier archivo .go.

Ejecuta go generate ./... desde la raíz del módulo para ejecutar esos comandos.

stringer emite un archivo *_string.go con String() para enums basados en int.

Los equipos confirman la salida generada y vuelven a ejecutar los generadores cuando cambian los tipos.

Receta

Flujo de trabajo de generación de referencia rápida.

//go:generate stringer -type=Status -trimprefix=Status
 
type Status int
 
const (
    StatusPending Status = iota
    StatusActive
    StatusDone
)

go install golang.org/x/tools/cmd/stringer@latest
go generate ./...
go test ./...

Cuándo usar esto:

• Los enums registrados en métricas, APIs o UI necesitan nombres de cadena estables
• Quieres String() en tiempo de compilación sin mantener manualmente sentencias switch
• CI debe fallar cuando los archivos generados se desvíen de los tipos fuente
• Estás introduciendo cualquier herramienta go generate (mockgen, protobuf, stringer)

Ejemplo de Trabajo

Mini-módulo completo con salida de stringer verificada.

// status.go
package job
 
//go:generate stringer -type=Status -trimprefix=Status
 
type Status int
 
const (
    StatusPending Status = iota
    StatusRunning
    StatusFailed
    StatusSucceeded
)
 
func (s Status) IsTerminal() bool {
    return s == StatusFailed || s == StatusSucceeded
}

Después de go generate:

// status_string.go (generado)
package job
 
import "strconv"
 
func _() {
    _ = x[StatusPending-0]
}
 
const _Status_name = "PendingRunningFailedSucceeded"
 
var _Status_index = [...]uint8{0, 7, 14, 20, 29}
 
func (i Status) String() string {
    if i < 0 || i >= Status(len(_Status_index)-1) {
        return "Status(" + strconv.FormatInt(int64(i), 10) + ")"
    }
    return _Status_name[_Status_index[i]:_Status_index[i+1]]
}

// job_test.go
package job
 
import "testing"
 
func TestStatusString(t *testing.T) {
    if StatusRunning.String() != "Running" {
        t.Fatal(StatusRunning.String())
    }
}

Lo que esto demuestra:

• -trimprefix elimina el prefijo redundante Status de la salida de cadena
• El archivo generado vive junto a la fuente con una cabecera DO NOT EDIT (stringer la añade)
• Los valores numéricos inválidos obtienen una cadena de respaldo segura Status(99)
• Las pruebas bloquean el comportamiento sin reflexión

Análisis Profundo

Cómo Funciona go generate

• Escanea archivos .go en busca de líneas que comiencen con //go:generate
• Ejecuta cada comando con $GOFILE y $GOPACKAGE establecidos en el archivo contenedor
• No analiza dependencias; el orden sigue el orden de recorrido de archivos
• Los fallos detienen las directivas restantes de ese paquete a menos que lo escriptees de otra manera

Generadores Comunes

Comprobación de Desviación en CI

go generate ./...
git diff --exit-code || (echo "ejecuta go generate y confirma"; exit 1)

Notas de Go

// Mantén los generadores en el módulo de herramientas o tools.go con la etiqueta de compilación
//go:build tools
 
package tools
 
import _ "golang.org/x/tools/cmd/stringer"

Posibles Problemas

• Esperar que go build ejecute generate - No lo hará. Solución: Makefile, paso de CI o hook de pre-commit.
• Editar archivos generados - La próxima generación sobrescribirá las correcciones. Solución: Cambiar las banderas del generador o las entradas de la plantilla.
• stringer después de renombrar constantes - Cadenas obsoletas hasta la regeneración. Solución: Añadir puerta de CI de generación+diferencia.
• Múltiples tipos en un archivo - Cada uno necesita su propia directiva o lista -type. Solución: Líneas //go:generate separadas por tipo.
• Vendoring de stringer - Fija la versión de golang.org/x/tools en tools.go para una CI reproducible. Solución: go install en la versión del módulo fijada en CI.
• Archivos generados en ruido de revisión de código - Grandes diferencias en ajustes de enums. Solución: Commits dedicados para la regeneración.

Alternativas

Preguntas Frecuentes

Relacionado

• Creación de Generadores de Código Personalizados - escribe tu propio generador
• Reflexión vs Generación de Código en Go - codegen vs reflect
• Directivas de Migración de API y go:fix en Línea - herramientas de migración
• Mejores Prácticas de Reflexión y Generación de Código - reglas de flujo de trabajo de equipo

Versiones de Stack: Esta página fue escrita para Go 1.26.x (predeterminado GC de Green Tea, modernizadores de go fix - verifica el parche en la compilación), chi (última - verifica en la compilación), gin (última - verifica en la compilación), echo (última - verifica en la compilación), google.golang.org/grpc (última - verifica en la compilación), sigs.k8s.io/controller-runtime (última - verifica en la compilación), kubebuilder (última - verifica en la compilación), tinygo (última - verifica objetivos de placa en la compilación), wazero (última - verifica en la compilación), y golangci-lint (última - verifica el conjunto de linters en la compilación).

pbqrthvqrf.vb|ptvb505|202607