Como crear y publicar paquetes en Go 📂

Una necesidad en el mundo de la programación siempre a sido reutilizar nuestro código y funciones, de hecho es una de las reglas de oro, DRY, en español esas siglas significan no te repitas a ti mismo pero muchos de nosotros nos hemos encontrado con el dilema de tener una clase tan útil en un proyecto y pensamos...

Me gustaría poder usar esta clase en este proyecto, ctrl c y ctrl v

Luego pasa que uno de los proyectos se agrega una función extra a esa clase y te das cuenta que también seria buena en la otra, copias la función y los test. Este puede ser un ciclo sin fin, ya te digo puedes estar copiando y pegando funciones de la clase de forma eterna.

La solución es muy sencilla volver esa clase tan útil para ti un paquete independiente con sus propios test y su propio repositorio que podremos usar en todos los proyectos que la necesiten.

Preparemos el entorno

En mi caso dentro de mi proyecto de plantilla que uso para el 80% de mis proyecto, tengo varios sub paquetes que aveces necesito en otros proyectos, donde decidí no usar la plantilla porque era un proyecto pequeño para usar esa plantilla, así que tomaremos uno de ellos en este caso el:

Session Manager: Lo uso normalmente para persistir la session sin depender del framework que use.

Para ello comenzaremos creando nuestra carpeta

~
mkdir session-manager

Luego crearemos un repositorio público en GitHub, que sea público es muy importante en un futuro haré un nuevo artículo dónde haremos un paquete privado, copiamos el link de nuestro repositorio.

Y ahora vamos a inicializar nuestro paquete de go dentro de la carpeta que creamos

~
go mod init github.com/user/repository-name

Seguido de esos inicializaremos el repositorio de Git en la carpeta que creamos.

~
git init

Ahora agregaremos dos archivos más dentro del folder el README.md y la licencia en mi caso usaré MIT.

Subimos todos nuestros archivos al repositorio y ya tenemos nuestro entorno listo para comenzar con el desarrollo de nuestro paquete.

Ahora procedemos a mover nuestra entidad o entidades.

Algunas recomendaciones que les puedo dejar es muevan solo lo estrictamente necesario para el funcionamiento del paquete y sus test algo crucial es tener un paquete con la mayor cantidad de Test Coverage

Para mi caso moveré las interfaces, las estructuras y los tests. Cada una de ellas en archivos diferentes para poder encontrarlas de forma más fácil.

También algo que suelo hacer es mover algunos workflows que uso para comprobar los tests antes de hacer un merge y ver el nivel de test coverage, estos irán a la carpeta .github

Nuestro paquete quedaría de la siguiente forma.

Al archivo que denomino main.go lo uso para describir de manera general el paquete.

Agregamos documentación para nuestro paquete.

En Go podemos documentar nuestro paquete gracias a godoc.org solo agregando comentarios con formato a nuestras entidades.

Les daré un ejemplo de un paquete documentado usando el formato de godoc:

~

  // Package math is a package with mathematical operation
  package math

  const (
    // PI is the pi number with 12 decimal's
    PI float64 = 3.14159265359
  )

  // Calculator struct who will store like methods all our operations
  type Calculator struct {}

  // NewCalculator create a new instance of calculator
  func NewCalculator *Calculator {
    return &Calculator{}
  }

  // SumInt sum a group of int
  func (c *Calculator) SumInt(numbers ...int) int{
    total := 0

    for _,n := range numbers {
      total=total+n
    }

    return total
  }

Este formato hará que cuando subamos nuestro paquete godoc.org formatee nuestros comentarios y los agregue en el apartado de documentación.

Publicando nuestro paquete.

Ahora a llego el momento que a mi parecer es el más interesante es ver nuestro paquete ya dentro de godoc.org para ellos debemos preparar nuestro entorno una vez subido todo nuestro avance al repositorio procederemos a crear un tag.

~
git tag v0.1.0

Luego de crearlo vamos a subir este tag a nuestro repositorio

~
git push origin v0.1.0

Y ahora indicaremos a Go que nuestro paquete esta listo para ser extraído. Debemos remplazar con el enlace de nuestro paquete y la versión que estemos publicando.

~
GOPROXY=proxy.golang.org go list -m github.com/solrac97gr/session-manager@v0.1.5

Usar nuestro paquete en otros proyectos

Una vez nuestro paquete este publicado podemos empezar a usarlo en otros proyectos para ello usaremos la directiva go get

Desde otro proyecto usaremos el siguiente comando

~
go get github.com/solrac97gr/session-manager

Ahora solo bastara con importar nuestro paquete y usar lo que necesitemos de este en nuestros otros proyectos.

~

package main

import github.com/solrac97gr/session-manager

func main() {
  user := struct {
    Name string
    Age int
  } {
    Name: "Carlos",
    Age:26,
  }


  sm := sessionmanager.NewSessionManager()

  s,err :=  sm.CreateSession()
  if err != nil {
    panic(err)
  }

  s.Set("user",user)

  sm.SetAsDefaultSession(s.SessionId())

}

Conclusión

Go nos brinda una herramienta muy sencilla para compartir código entre nuestros proyectos y equipos que debemos aprovechar hay muchos equipos que suelen dar solución a la necesidad de compartir código usando miles de micro servicios, los micro servicios deben ser creados con mucho criterio ya que generan un gasto en infraestructura hay cosas muy pequeñas que no merece la pena hacerlas un micro servicio pero haciéndolo un paquete resolvemos la necesidad de compartir esas funcionalidades. Les dejo un link al paquete que separe de mi plantilla que uso este 2023 para programar proyectos en Go para que puedan verlo, aportar al proyecto y dejar una estrella