go web skeleton

Gehen Sie Web -Skelett

Ein komplettes Golang -Web -Anwendungsskelett.

中文说明

Enthält:

• Kann für API -Schnittstellenanwendungen, CLI -Befehlszeilenanwendungen, Webanwendungen verwendet werden
• Protokollbibliothek gookit/slog -Konfiguration verwendet
• Swagger API -Dokumentation Konfigurationsgenerierung
• Support mit mehrsprachiger Sprache, Ansichtsrendern, Anforderungsdatenvalidierung
• Konfigurieren Sie die Leseverwaltung, laden Sie gemäß Umgebung, Multi-File-Unterstützung
• Enthält Redis, MySQL, Mongo für die Initialisierung und einfache Verwendung
• Verwenden Sie go mod , um die Verwaltungsabhängigkeiten zu installieren

Projektstruktur

Github-Projekt https://github.com/inhere/go-web-skeletton

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

durch tree -d 2 ./

Pakete gehen

Verwenden Sie ✅ markieren Sie aktuelles GO -Paket

HTTP -Service

Bieten Sie HTTP -Service und Routing an

• Gookit/Rux ✅

Andere :

CLI -Anwendung

Befehlszeilenanwendung

• Gookit/Gcli ✅

Konfiguration

Konfigurationsverwaltung

• Mehrfachformatkonfigurationen: Gookit/Konfiguration ✅
  • INI -Konfiguration: Gookit/INI

Protokollierung

• Gookit/Slog ✅
• Sirupsen/Logrus
  • Protokollaufteilung: Rifflock/LFSHOOK
  • Protokollaufteilung: Lestrat-Go/Datei-Rotatelogs
• go.uber.org/zap

Datenbank ORM

MySQL:

• Go-Xorm/Xorm
• Jinzhu/Gorm ✅

MongoDB:

• github.com/globalsign/mgo

Cache

• Cache: Gookit/Cache ✅

Redis:

• Go-Redis/Redis ✅
• Gomodule/Redigo

Datenvalidierung

Datenvalidierung anfordern

• Gookit/Validate ✅
• Go-Playground/Validator

Datenserialisierung

Hochleistungs-Serialisierungsbibliothek

JSON:

• JSON-Iiterator/Go

Andere Pakete

• I18n Sprache: Gookit/i18n ✅
• Rendering anzeigen: Gookit/EasyTPL ✅

Konfigurationsregisterzentrum:

• Eureka Client: PDOK/Go-Eureka-Client nicht verwendet
• NACOS -Kunde:

Zusätzliche Kompoenten

Hilfsbibliothek

• Swagger -Dokumentgenerierung:
  • Go-Swagger Die Dokumentation ist komplex, aber mächtiger
  • Swaggo/Swag -Dokumente und Verwendung sind relativ einfach, nur Dokumente generieren sind ausreichend
• Testen Sie die Auxiliary -Bibliothek, um eine schnelle Aussage -Stretchr/auszusagen
• Debugging-Tool: DaVECGH/GO-Spew Deep Printing Golang Variable Data

Zusätzliche Komponenten

• Swagger UI: Rendering von Swagger -Dokumenten
• Dockerfile : Docker Image Build -Skript für die Produktionsumgebung basierend auf Alpine, erstellen Sie ein Projektbild mit einer geschätzten Größe von etwa 30 m
• makefile : Es wurden einige schnelle Make-Befehle erstellt, um schnell Dokumentationen zu generieren und Bilder zu erstellen.

Start

• Klonen Sie zunächst das Skelett -Repository in Ihr lokales Verzeichnis
• Benennen Sie das go-web-skeleton Verzeichnis in Ihren Projektnamen um.
• Gehen Sie zum Projekt und ersetzen Sie github.com/inhere/go-web-skeleton durch Ihren Projektnamen (für Go-Datei)
• Suchen Sie erneut und ersetzen Sie das gesamte go-web-skeleton durch Ihren Projektnamen (hauptsächlich Dockerfile, Makefile)
• Laufen Sie go mod tidy , um abhängige Bibliotheken zu installieren
• Führen Sie das Projekt aus: go run main.go

Init -Projekt

go run ./cmd/appinit

Swagger -Dokumente Generation

Installation:

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

Bitte überprüfen Sie die Dokumentation und Beispiele von swaggo/swag

Generiert in das angegebene Verzeichnis:

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

Beachten:

swaggo/swag ist die Analyse -Feldbeschreibungsinformationen aus dem Kommentar des Feldes

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

Helfen

• Führen Sie den Test durch

Go test
// output coverage
Go test -cover

• Formatierungsprojekt

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

• Golint -Check ausführen

Hinweis: Sie müssen zuerst GoLint installieren.

golint ./...

Verweisen

• GOLANG-STANDARDS/PROJEKTE LAYOUT

Lizenz

MIT