go web skeleton

Es esqueleto web

Un esqueleto completo de la aplicación web de Golang.

中文说明

Contiene:

• Se puede utilizar para aplicaciones de interfaz API, aplicaciones de línea de comandos CLI, aplicaciones web
• Log biblioteca gookit/slog utilizada
• Generación de configuración de documentación de la API de Swagger
• Soporte de varios idiomas, vista de vista, Validación de datos de solicitud
• Configurar la gestión de lectura, cargar según el entorno, el soporte de múltiples archivos
• Contiene Redis, MySQL, Mongo para la inicialización y el uso simple
• Use go mod para instalar las dependencias de gestión

Estructura de proyectos

Proyecto 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 ./

Paquetes de Go

Usar el paquete ✅ Mark Current Used GO

Servicio HTTP

Proporcionar servicio y enrutamiento HTTP

• Gookit/Rux ✅

Otro :

Aplicación CLI

Aplicación de línea de comandos

• Gookit/GCLI ✅

Configuración

Gestión de configuración

• Configuraciones de formato múltiple: Gookit/config ✅
  • Configuración INI: Gookit/INI

Explotación florestal

• Gookit/Slog ✅
• Sirupsen/Logrus
  • División de registro: rifflock/lfshook
  • División de registro: lestrat-go/file-rotateLogs
• Go.uber.org/zap

Base de datos ORM

Mysql:

• go-xorm/xorm
• Jinzhu/Gorm ✅

MongoDB:

• github.com/globalsign/mgo

Cache

• Cache: Gookit/Cache ✅

Redis:

• GO-REDIS/REDIS ✅
• gomódulo/redigo

Validación de datos

Solicitar validación de datos

• Gookit/validar ✅
• Go-Playground/Validator

Serialización de datos

Biblioteca de serialización de alto rendimiento

JSON:

• json-iterator/go

Otros paquetes

• I18N Idioma: Gookit/i18n ✅
• Ver Renderización: Gookit/EasyTPL ✅

Centro de registro de configuración:

• Cliente Eureka: PDOK/GO-EUREKA-CLIENT no se usa
• Cliente de NACOS:

Componentes adicionales

Biblioteca auxiliar

• Generación de documentos Swagger:
  • go-swagger La documentación es compleja pero más poderosa
  • Los documentos y el uso de Swaggo/Swag son relativamente simples, solo generar documentos es suficiente
• Pruebe la biblioteca auxiliar para la afirmación rápida el rayo/testificar
• Herramienta de depuración: datos variables de impresión profunda de Davecgh/Go

Componentes adicionales

• Swagger UI: Renderización de documentos de Swagger
• Dockerfile : Docker Image Built Script para el entorno de producción, basado en Alpine, crea una imagen de proyecto con un tamaño estimado de alrededor de 30 m
• makefile : se han construido algunos comandos rápidos para ayudar a generar rápidamente documentación y crear imágenes.

Comenzar

• Primero, clone el repositorio de esqueleto a su directorio local
• Cambie el nombre del directorio go-web-skeleton al nombre de su proyecto.
• Vaya al proyecto y reemplace github.com/inhere/go-web-skeleton con el nombre de su proyecto (para el archivo GO)
• Busque nuevamente y reemplace todo go-web-skeleton con el nombre de su proyecto (principalmente Dockerfile, Makefile)
• Ejecutar go mod tidy para instalar bibliotecas dependientes
• Ejecute el proyecto: go run main.go

Proyecto init

go run ./cmd/appinit

Generación de documentos de Swagger

instalación:

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

Consulte la documentación y los ejemplos de swaggo/swag

Generado en el directorio 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

Aviso:

swaggo/swag es la información de descripción del campo de análisis del comentario del campo

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

Ayuda

• Ejecutar la prueba

Go test
// output coverage
Go test -cover

• Proyecto de formato

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

• Ejecutar cheque de golint

Nota: Primero debe instalar GoLint .

golint ./...

Referirse

• Golang-Standards/Project-Layout

Licencia

MIT