Cómo usar etiquetas de structs en Go

Introducción

Las estructuras, o structs, se utilizan para recopilar varios datos en una unidad. Estas recopilaciones de información se utilizan para describir conceptos de nivel más alto, como un valor Address compuesto de parámetros Street, City, State y PostalCode. Cuando lee esta información desde sistemas como bases de datos o API, pude usar las etiquetas “struct” para controlar la manera en que se asigna esta información a los campos de una struct. Las etiquetas de structs son pequeños fragmentos de metadatos adjuntos a campos de una struct que proporcionan instrucciones a otro código de Go que funciona con las structs.

¿Qué aspecto tiene una etiqueta de struct?

Las etiquetas de struct de Go son anotaciones que aparecen después del tipo en una declaración de struct de Go. Cada etiqueta se compone de cadenas cortas asociadas con algún valor correspondiente.

Una etiqueta de struct tiene este aspecto y se cierra cerrada con caracteres de acento grave `.

type User struct {
	Name string `example:"name"`
}

Otro código de Go será capaz de examinar estas structs y extraer los valores asignados a claves específicas que solicita. Las etiquetas de structs no afectan al funcionamiento de su código sin no hay otro código que las examine.

Pruebe este ejemplo para ver el aspecto de las etiquetas de structs y que, sin código de otro paquete, no tendrán ningún efecto.

package main

import "fmt"

type User struct {
	Name string `example:"name"`
}

func (u *User) String() string {
	return fmt.Sprintf("Hi! My name is %s", u.Name)
}

func main() {
	u := &User{
		Name: "Sammy",
	}

	fmt.Println(u)
}

El resultado será el siguiente:

Output
Hi! My name is Sammy

En este ejemplo se define un tipo de User con un campo Name. El campo Name tiene la etiqueta de struct example:"name". En una conversación, nos referiríamos a esta etiqueta específica en la conversación como la “etiqueta de struct de ejemplo” porque en ella se utiliza la palabra “example” como clave. La etiqueta de struct example tiene el valor "name" para el campo Name. En el tipo User, también definimos el método String() requerido por la interfaz fmt.Stringer. Esto se invocará automáticamente cuando pasemos el tipo a fmt.PrintIn y nos dará la oportunidad de producir una versión con buen formato de nuestra struct.

En el cuerpo de main, creamos una nueva instancia de nuestro tipo User y la pasamos a fmt.PrintIn. Aunque la struct tenía una etiqueta de struct presente, vemos que no afecta al funcionamiento de este código de Go. Se comportará exactamente igual que si la etiqueta de struct no estuviese presente.

Para usar las etiquetas de struct a fin de conseguir algo, se debe escribir otro código de Go para examinar las structs en el tiempo de ejecución. La biblioteca estándar tiene paquetes que utilizan las etiquetas de structs como parte de su funcionamiento. El más popular es encoding/json.

Encoding JSON

La notación de objetos JavaScript (JSON) es un formato textual pensado para codificar conjuntos de datos organizados bajo diferentes claves de cadena. Normalmente, se utiliza para comunicar datos entre diferentes programas, ya que el formato es suficientemente sencillo como para que existan bibliotecas para decodificarlo en muchos lenguajes diferentes. El siguiente es un ejemplo de JSON:

{
  "language": "Go",
  "mascot": "Gopher"
}

Este objeto JSON contiene dos claves: language y mascot. Después de estas claves se encuentran los valores asociados. Aquí, la clave language es un valor de Go y mascot tiene asignado el valor Gopher.

El codificador JSON de la biblioteca estándar utiliza etiquetas de struct como anotaciones que indican a este la forma en que desearía nombrar sus campos en el resultado de JSON. Estos mecanismos de codificación y decodificación de JSON pueden encontrarse en el paquete encoding/json.

Pruebe este ejemplo para ver la forma en que JSON se codifica sin etiquetas de struct:

package main

import (
	"encoding/json"
	"fmt"
	"log"
	"os"
	"time"
)

type User struct {
	Name          string
	Password      string
	PreferredFish []string
	CreatedAt     time.Time
}

func main() {
	u := &User{
		Name:      "Sammy the Shark",
		Password:  "fisharegreat",
		CreatedAt: time.Now(),
	}

	out, err := json.MarshalIndent(u, "", "  ")
	if err != nil {
		log.Println(err)
		os.Exit(1)
	}

	fmt.Println(string(out))
}

Esto imprimirá el siguiente resultado:

Output
{
  "Name": "Sammy the Shark",
  "Password": "fisharegreat",
  "CreatedAt": "2019-09-23T15:50:01.203059-04:00"
}

Definimos una struct que describe un usuario con campos que incluyen su nombre, su contraseña y el momento de creación del usuario. En la función main, creamos una instancia de este usuario suministrando valores para todos los campos a excepción de PreferredFish (a Sammy le gusta todo el pescado). Luego pasamos la instancia de User a la función json.MarshalIndent. Esto se utiliza para que podamos ver con mayor facilidad el resultado de JSON sin usar una herramienta de formato externa. Esta invocación podría sustituirse por json.Marshal(u) para recibir JSON sin ningún espacio en blanco adicional. Los dos argumentos adicionales para json.MarshalIndent controlan el prefijo del resultado (que omitimos con la cadena vacía) y los caracteres que se usarán para hacer sangría, que aquí son dos caracteres de espacio. Cualquier error producido a partir de json.MarshalIndent se registra y el programa se cierra usando os.Exit(1). Finalmente, emitimos el []byte devuelto de json.MarshalIndent hacia una string y entregamos la cadena resultante a fmt.PrintIn para su impresión en el terminal.

Los campos de la struct aparecen exactamente como los nombramos. Este no es el estilo JSON típico que podría esperar, que utiliza CamelCase para los nombres de los campos. Podrá cambiar los nombres del campo para que sigan la capitalización CamelCase en este ejemplo siguiente: Como verá cuando ejecute este ejemplo, esto no funcionará porque los nombres deseados del campo entran en conflicto con las reglas de Go sobre nombres de campo exportados.

package main

import (
	"encoding/json"
	"fmt"
	"log"
	"os"
	"time"
)

type User struct {
	name          string
	password      string
	preferredFish []string
	createdAt     time.Time
}

func main() {
	u := &User{
		name:      "Sammy the Shark",
		password:  "fisharegreat",
		createdAt: time.Now(),
	}

	out, err := json.MarshalIndent(u, "", "  ")
	if err != nil {
		log.Println(err)
		os.Exit(1)
	}

	fmt.Println(string(out))
}

Con esto, se presentará el siguiente resultado:

Output
{}

En esta versión, alteramos los nombres de los campos para que tengan estilo CamelCase. Ahora Name es name, Password es password y, por último, CreatedAt es createdAt. En el cuerpo de main, cambiamos la creación de instancia de nuestra struct para que use estos nuevos nombres. Luego pasamos la struct a la función json.MarshlIndent como antes. El resultado, esta vez es un objeto JSON vacío, {}.

Los campos con estilo CamelCase requieren que el primer carácter esté en minúscula. Aunque en JSON no se tiene en cuenta la forma en que usted asigna nombres a sus campos, en Go sí se considera, ya que indica la visibilidad del campo fuera del paquete. Debido a que el paquete encoding/json es independiente del paquete main que usamos, debemos poner en mayúscula el primer carácter a fin de que sea visible para encoding/json. Parecería que nos hallamos en un impasse y necesitamos alguna forma de notificar al codificador de JSON que nos gustaría nombrar este campo.

Usar etiquetas de struct para controlar la codificación

Puede modificar el ejemplo anterior para que tenga campos exportados que estén codificados correctamente con nombres de campos con estilo CamelCase realizando en cada campo anotaciones con una etiqueta de struct. La etiqueta de struct que encoding/json reconoce tiene una clave de json y un valor que controla el resultado. Cuando se disponga la versión en estilo CamelCase de los nombres del campo como valor para la clave json, el codificador usará ese nombre como alternativa. En este ejemplo, se corrigen los dos intentos anteriores:

package main

import (
	"encoding/json"
	"fmt"
	"log"
	"os"
	"time"
)

type User struct {
	Name          string    `json:"name"`
	Password      string    `json:"password"`
	PreferredFish []string  `json:"preferredFish"`
	CreatedAt     time.Time `json:"createdAt"`
}

func main() {
	u := &User{
		Name:      "Sammy the Shark",
		Password:  "fisharegreat",
		CreatedAt: time.Now(),
	}

	out, err := json.MarshalIndent(u, "", "  ")
	if err != nil {
		log.Println(err)
		os.Exit(1)
	}

	fmt.Println(string(out))
}

El resultado será el siguiente:

Output
{
  "name": "Sammy the Shark",
  "password": "fisharegreat",
  "preferredFish": null,
  "createdAt": "2019-09-23T18:16:17.57739-04:00"
}

Cambiamos los nombres de campos para que sean visibles para otros paquetes disponiendo en mayúsculas las primeras letras de sus nombres. Sin embargo, esta vez añadimos etiquetas de struct en el formato de json:"name", donde "name" era el nombre que queríamos que json.MarshalIndent usarara al imprimir nuestra struct como JSON.

De esta manera, configuramos nuestro JSON correctamente. Tenga en cuenta, sin embargo, que los campos para algunos valores se imprimieron aunque no establecimos dichos valores. El codificador también JSON puede eliminar estos campos, si lo desea.

Eliminar campos JSON vacíos

Normalmente, nos conviene suprimir campos de salida que no están establecidos en JSON. Debido a que todos los tipos de Go tienen un “valor cero”, algún valor predeterminado en el que se fijan, el paquete encoding/json necesita información adicional para poder indicar que algún campo debería considerarse como no establecido cuando asume este valor cero. En la parte del valor de cualquier etiqueta de struct json, puede añadir un sufijo al nombre deseado de su campo con ,omitempty para indicar al codificador JSON que suprima el resultado de este campo cuando se fije en el valor cero. En el siguiente ejemplo, se corrigen los ejemplos anteriores para que no produzcan campos vacíos:

package main

import (
	"encoding/json"
	"fmt"
	"log"
	"os"
	"time"
)

type User struct {
	Name          string    `json:"name"`
	Password      string    `json:"password"`
	PreferredFish []string  `json:"preferredFish,omitempty"`
	CreatedAt     time.Time `json:"createdAt"`
}

func main() {
	u := &User{
		Name:      "Sammy the Shark",
		Password:  "fisharegreat",
		CreatedAt: time.Now(),
	}

	out, err := json.MarshalIndent(u, "", "  ")
	if err != nil {
		log.Println(err)
		os.Exit(1)
	}

	fmt.Println(string(out))
}

El resultado de este ejemplo será el siguiente:

Output
{
  "name": "Sammy the Shark",
  "password": "fisharegreat",
  "createdAt": "2019-09-23T18:21:53.863846-04:00"
}

Modificamos los ejemplos anteriores para que el campo PreferredFish ahora tenga la etiqueta de struct json:"preferredFish,omitempty". La presencia del aumento ,omitempty hace que el codificador de JSON omita ese campo, ya que decidimos dejar su configuración indefinida. Esto tenía el valor null en los resultados de nuestros ejemplos anteriores.

Este resultado es mucho mejor, pero aún se imprime la contraseña del usuario. El paquete encoding/json ofrece otra alternativa que nos permite ignorar los campos privados por completo.

Ignorar campos privados

Algunos campos deben exportarse desde las structs para que otros paquetes puedan interactuar correctamente con el tipo. Sin embargo, la naturaleza de esos campos puede ser sensible, de modo que en estas circunstancias nos gustaría que el codificador de JSON ignorase el campo por completo, incluso cuando esté establecido. Esto se hace usando el valor especial - como argumento del valor para una etiqueta de struct json:.

En este ejemplo se corrige el problema de la exposición de la contraseña del usuario.

package main

import (
	"encoding/json"
	"fmt"
	"log"
	"os"
	"time"
)

type User struct {
	Name      string    `json:"name"`
	Password  string    `json:"-"`
	CreatedAt time.Time `json:"createdAt"`
}

func main() {
	u := &User{
		Name:      "Sammy the Shark",
		Password:  "fisharegreat",
		CreatedAt: time.Now(),
	}

	out, err := json.MarshalIndent(u, "", "  ")
	if err != nil {
		log.Println(err)
		os.Exit(1)
	}

	fmt.Println(string(out))
}

Cuando ejecute este ejemplo, verá este resultado:

Output
{
  "name": "Sammy the Shark",
  "createdAt": "2019-09-23T16:08:21.124481-04:00"
}

Lo único que cambiamos en este ejemplo respecto de los anteriores es que el campo de contraseña ahora utiliza el valor especial "-" para su etiqueta de struct json:. Vemos que en el resultado de este ejemplo, el campo contraseña ya no está presente.

Estas características del paquete encoding/json, ,omitempty y "-" no son estándares. La acción que se aplique a través de un paquete en los valores de una etiqueta de struct depende de su implementación. Debido a que el paquete encoding/jason es parte de la biblioteca estándar, otros paquetes implementaron también estas funciones de la misma forma por convención. Sin embargo, es importante leer la documentación de cualquier paquete de terceros que utilice etiquetas de struct para conocer lo que es y no es compatible.

Conclusión

Las etiquetas de struct ofrecen una alternativa poderosa para aumentar la funcionalidad del código que funciona con sus structs. Muchos paquetes de bibliotecas estándares y de terceros ofrecen formas de personalizar su operación a través de etiquetas de structs. El uso efectivo de estas en su código proporciona este comportamiento de personalización y documenta de forma sucinta la forma en que estos campos se usan para futuros desarrolladores.