go web skeleton

Go Squelette Web

Un squelette d'application Web Golang complet.

中文说明

Contient:

• Peut être utilisé pour les applications d'interface API, les applications de ligne de commande CLI, les applications Web
• Log Library gookit/slog Configuration utilisée
• Génération de configuration de la documentation de l'API Swagger
• Support multi-langues, afficher le rendu, demander la validation des données
• Configurer la gestion de lecture, le chargement selon l'environnement, le support multi-fichiers
• Contient Redis, MySQL, Mongo pour l'initialisation et une utilisation simple
• Utilisez go mod pour installer les dépendances de gestion

Structure du projet

Github Project 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.
...

Rendre par tree -d 2 ./

Faire des forfaits

Utiliser ✅ Marque Current Used GO Package

Service http

Fournir un service HTTP et un routage

• GOOKIT / RUX ✅

Autre :

Application CLI

Application de ligne de commande

• GOOKIT / GCLI ✅

Configuration

Gestion de la configuration

• Configurations de format multiples: gookit / config ✅
  • Configuration INI: GOOKIT / INI

Enregistrement

• GOOKIT / SLOG ✅
• Sirupsen / Logrus
  • Fractionnement de journal: rifflock / lfshook
  • Fractionnement des journaux: lestrrat-go / file-rotatelogs
• go.uber.org/zap

ORM de base de données

Mysql:

• go-xorm / xorm
• Jinzhu / gorm ✅

MongoDB:

• github.com/globalsign/mgo

Cache

• Cache: Gookit / Cache ✅

Redis:

• go-redis / redis ✅
• gomodule / redigo

Validation des données

Demander la validation des données

• Gookit / Valider ✅
• go-playground / validator

Sérialisation des données

Bibliothèque de sérialisation haute performance

JSON:

• json-iterator / go

Autres packages

• Langue i18n: gookit / i18n ✅
• Voir le rendu: gookit / easytpl ✅

Centre de registre de configuration:

• Client Eureka: PDOK / Go-eureka-Client non utilisé
• Client Nacos:

Compoants supplémentaires

Bibliothèque auxiliaire

• Génération de documents de fanfaronnade:
  • aller-swagger la documentation est complexe mais plus puissante
  • Les documents Swaggo / Swag et l'utilisation sont relativement simples, seulement la génération de documents suffit
• Testez la bibliothèque auxiliaire pour une affirmation rapide stretchr / témoigner
• Outil de débogage: DATA DONNÉES DAVECGH / GO-SPEW SPED PRIMING GOLANG

Composants supplémentaires

• Swagger UI: rendu de document de fanfaronnade
• Dockerfile : Script de construction d'image docker pour l'environnement de production, basé sur Alpine, construisez une image de projet d'une taille estimée d'environ 30 m
• makefile : certaines commandes de Make Quick-On ont été construites pour aider à générer rapidement des images de documentation et de construire.

Commencer

• Tout d'abord, clone le référentiel squelette de votre répertoire local
• Renommez le répertoire go-web-skeleton au nom de votre projet.
• Accédez au projet et remplacez github.com/inhere/go-web-skeleton par le nom de votre projet (pour le fichier go)
• Recherchez à nouveau et remplacez tous go-web-skeleton par le nom de votre projet (principalement Dockerfile, Makefile)
• Exécutez go mod tidy pour installer des bibliothèques dépendantes
• Exécutez le projet: go run main.go

Projet INIT

go run ./cmd/appinit

Génération des documents de fanfaronnade

installation:

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

Veuillez vérifier la documentation et les exemples de swaggo/swag

Généré pour le répertoire spécifié:

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

Avis:

swaggo/swag est le champ d'analyse description des informations du commentaire du champ

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

Aide

• Faire le test

Go test
// output coverage
Go test -cover

• Projet de mise en forme

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

• Exécuter le chèque de Golint

Remarque: vous devez d'abord installer GoLint .

golint ./...

Référer

• Golang-standards / Project-Layout

Licence

Mit