jdgabriel/go-learning

API example learning in live

Aprendendo GO

Sumário

• 1. Download & Instalação
  • 1.1. Download
  • 1.2. Instalando com ZSH
• 2. Start
  • 2.1. Iniciando o módulo principal
• 3. Convenções
  • 3.1. Métodos públicos e privados do pacote
  • 3.2. Importando pacotes
• 4. Tipos de estruturas e variáveis
• 5. Makefile
• 6. Documentação com Swagger

Download & Instalação

Download

https://go.dev/doc/install

Instalando com ZSH

1. Instalando go (Substitua X pela versão atual)

 rm -rf /usr/local/go && tar -C /usr/local -xzf goX.XX.X.linux-amd64.tar.gz

2. Adicione os paths do GO no .zshrc

# Add Go lang paths
export GOPATH=$HOME/go
export GOROOT=/usr/local/go
export GOBIN=$GOPATH/bin
export PATH=$PATH:$GOPATH
export PATH=$PATH:$GOROOT/bin

3. Teste o funcionamento

go version

Start

Iniciando o módulo principal

Por convenção e padronização o go usa packages externos da linguagem com o link do repositório, seja Github ou de outro lugar.
Para iniciar uma aplicação em go, precisamos iniciar o go mod

go mod init github.com/jdgabriel/go-learning

Ao iniciar o módulo será criado o arquivo: go.mod

// go.mod
module github.com/jdgabriel/go-learning

go 1.22.4

Convenções

Métodos públicos e privados do pacote

Todo novo módulo deve-se ter na primeira linha do arquivo o nome do pacote

package NOME_DO_MODULO
// e.g. package main
// e.g. package router
// e.g. package user

Norma	Tipo	Exemplo
Primeira letra maiúscula	PUBLICA	func Initialize(){ //... }
Primeira letra minúscula	PRIVADA	func initialize(){ //... }

Importando pacotes

Para importar um pacote temos duas maneiras, a direta e a indireta

Método direto

go get -u github.com/gin-gonic/gin

Método indireto

Importar dentro do arquivo que vai usar o módulo

import "github.com/gin-gonic/gin"

Assim temos que executar o seguinte comando. Este comando faz o download de todos os pacotes relacionados diretamente e indiretamente com seu projeto, e pacotes existentes.

go mod tidy

Após o comando será criado um arquivo, o go.sum onde temos o lock de todas as versões dos pacotes instalados no projeto.
Agora o o go.mod terá dois require

module github.com/jdgabriel/go-learning

go 1.22.4

// direct
require github.com/gin-gonic/gin v1.10.0

require (
	... // indirect
)

Tipos de estruturas e variáveis

Tipo	Padrão	~	Exemplo
Declarative	:=	Criar uma variável e atribuir o retorno	v1 := router.Group("/api/v1")
Pointer	*	Endereço do objeto em memória para ser usado em qualquer ponto do projeto	*gin.Engine
Struct	struct	Equivalente a um objeto	type Product struct {...}
Address	&	Indicação de endereço de uma struct criada	return &Logger {...}
Func Args	...interface{} OU interface{}	Representa a interface ou um "array" de argumentos da função. Com interface fazia ou definida	func (log *Logger) Info(v ...interface{}) {}

Makefile

Scripts para rodar o projeto

Rode qualquer comando com make <COMANDO>

1. Rodar o projeto | make run

run:
	@go run main.go

2. Rodar o projeto com documentação :8080/docs/index.html

run-with-docs:
	@swag init
	@go run main.go

3. Build do projeto para a pasta cmd/

build:
	@go build -o cmd/$(APP_NAME) main.go

3. Build do projeto para a pasta cmd/

test:
	@go test ./ ...

4. Iniciar documentação

docs:
	@swag init

5. Limpar pastas de documentos e binário do projeto

clean:
	@rm -f cmd/$(APP_NAME)
	@rm -rf ./docs

Documentação

Swagger

http://localhost:8080/docs/index.html