go web skeleton

Vá Skeleton da Web

Um esqueleto completo de aplicativo da Web de Golang.

中文说明

Contém:

• Pode ser usado para aplicativos de interface de API, aplicativos de linha de comando da CLI, aplicativos da web
• Log Library gookit/slog Configuração usada
• geração de configuração de documentação da API Swagger
• Suporte de vários idiomas, renderização de visualização, Validação de dados de solicitação
• Configurar gerenciamento de leitura, carregar de acordo com o ambiente, suporte a vários arquivos
• Contém Redis, MySQL, Mongo para inicialização e uso simples
• Use go mod para instalar as dependências de gerenciamento

Estrutura do projeto

Projeto Github https://github.com/inhere/go-web-skeleton

 api/ API interface application handlers
  |- controller/
  |- middleware/
  |_ routes.go
app/ Common directory (public methods, application initialization, public components, etc.)
cmd/ CLI command line application commands
  |_ cliapp/ command line application entry file (main)
config/ Application configuration directory (basic configuration plus various environment configurations)
model/  Data and logic code directory
  |- form/  Request form structure data definition, form validation configuration
  |- logic/ Logic processing
  |- mongo/ MongoDB data collection model definition
  |- mysql/ MySQL data form model definition
  |_ rds/   Redis data model definition
resource/   Non-code resources used by some projects (language files, view template files, etc.)
runtime/    Temporary file directory (file cache, log files, etc.)
static/     Static resource directory (js, css, etc.)
main.go     Web application entry file
Dockerfile  Dockerfile
Makefile    Has written some common shortcut commands to help package, build docker, generate documentation, run tests, etc.
...

renderizar por tree -d 2 ./

Vá pacotes

Use ✅ Mark Current Usado Go Package

Serviço HTTP

Fornecer serviço HTTP e roteamento

• gookit/rux ✅

Outro :

Aplicação da CLI

Aplicativo da linha de comando

• gookit/gcli ✅

Configuração

Gerenciamento de configuração

• Configurações múltiplas de formato: gookit/config ✅
  • Configuração da INI: gookit/ini

Log

• gookit/slog ✅
• Sirpsen/Logrus
  • Divisão de log: rifflock/lfshook
  • Divisão de log: lestrat-go/file-rotatelogs
• go.uber.org/zap

Banco de dados ORM

Mysql:

• go-xorm/xorm
• Jinzhu/Gorm ✅

MongoDB:

• github.com/globalsign/mgo

Cache

• Cache: gookit/cache ✅

Redis:

• Go-Redis/Redis ✅
• Gomodule/Redigo

Validação de dados

Solicitar validação de dados

• gookit/validate ✅
• Go-playground/Validator

Serialização de dados

Biblioteca de serialização de alto desempenho

JSON:

• JSON-TITERATOR/GO

Outros pacotes

• Idioma i18n: gookit/i18n ✅
• Visualize a renderização: gookit/easytpl ✅

Config Register Center:

• Cliente Eureka: pdok/go-eureka-client não usado
• cliente NACOS:

Compostos extras

Biblioteca Auxiliar

• Gerenciamento de documentos Swagger:
  • ir-despertar a documentação é complexa, mas mais poderosa
  • Documentos e uso de swaggo/swag são relativamente simples, apenas gerar documentos é suficiente
• Teste a Biblioteca Auxiliar para obter o Stretchr/Testify
• Ferramenta de depuração: DATA DE DATA DE DEVIDADE DA DAVECGH/GO-GOED GOLANG DE GOLANG

Componentes adicionais

• Swagger Ui: Swagger Document Rendering
• Dockerfile : Docker Image Build Script para o ambiente de produção, baseado em alpino, construa uma imagem do projeto com um tamanho estimado de cerca de 30 m
• makefile : Alguns comandos rápidos de fabricação foram criados para ajudar a gerar rapidamente documentação e criar imagens.

Começar

• Primeiro, clone o repositório esqueleto ao seu diretório local
• Renomeie o diretório go-web-skeleton para o nome do seu projeto.
• Vá para o projeto e substitua github.com/inhere/go-web-skeleton pelo nome do projeto (para o arquivo go)
• Pesquise novamente e substitua todo go-web-skeleton pelo nome do seu projeto (principalmente Dockerfile, Makefile)
• Run go mod tidy para instalar bibliotecas dependentes
• Execute o projeto: go run main.go

Projeto init

go run ./cmd/appinit

Swagger Docs Generation

instalação:

go get -u github.com/swaggo/swag/cmd/swag

Verifique a documentação e exemplos de swaggo/swag

Gerado para o diretório especificado:

swag init -o static
# This file will be generated at the same time. It can be deleted if it is not needed.
rm static/docs.go

Perceber:

swaggo/swag é o campo Parsing Descrição Informações do comentário do campo

 type SomeModel struct {
	// the name description
	Name   string `json:"name" example:"tom"`
}	

Ajuda

• Execute o teste

Go test
// output coverage
Go test -cover

• Projeto de formatação

gofmt -s -l ./
go fmt ./...

• Execute a verificação do Golint

Nota: Você precisa instalar GoLint primeiro.

golint ./...

Consulte

• Golang-Standards/Project-Layout

Licença

Mit