go web skeleton

Pergi kerangka web

Kerangka aplikasi web golang lengkap.

中文说明

Berisi:

• Dapat digunakan untuk aplikasi antarmuka API, aplikasi baris perintah CLI, aplikasi web
• Log Library gookit/slog Digunakan
• Pembuatan konfigurasi dokumentasi API Swagger
• Dukungan multi-bahasa, melihat rendering, meminta validasi data
• Konfigurasikan Manajemen Baca, Muat Menurut Lingkungan, Dukungan Multi-File
• Berisi redis, mysql, mongo untuk inisialisasi dan penggunaan sederhana
• Gunakan go mod untuk menginstal dependensi manajemen

Struktur proyek

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

Render by tree -d 2 ./

Pergi paket

Gunakan ✅ Tandai Paket GO saat ini

Layanan HTTP

Menyediakan layanan dan perutean HTTP

• gookit/rux ✅

Lainnya :

Aplikasi CLI

Aplikasi baris perintah

• gookit/gcli ✅

Konfigurasi

Manajemen Konfigurasi

• Beberapa konfigurasi format: gookit/config ✅
  • Konfigurasi INI: Gookit/INI

Logging

• gookit/slog ✅
• Sirupsen/Logrus
  • Log pemisahan: Rifflock/lfshook
  • Pemisahan log: lestrrat-go/file-rotatelogs
• go.uber.org/zap

Database ORM

Mysql:

• Go-xorm/xorm
• Jinzhu/Gorm ✅

MongoDB:

• github.com/globalsign/mgo

Cache

• Cache: gookit/cache ✅

Redis:

• go-redis/redis ✅
• gomodule/redigo

Validasi data

Meminta validasi data

• gookit/validasi ✅
• Go-Playground/Validator

Serialisasi data

Perpustakaan Serialisasi Kinerja Tinggi

JSON:

• json-iterator/go

Paket lainnya

• I18N Bahasa: Gookit/i18n ✅
• Lihat Rendering: Gookit/Easytpl ✅

Config Register Center:

• Eureka Client: PDOK/Go-Eureka-Client tidak digunakan
• Klien NACOS:

Kompoen tambahan

Perpustakaan tambahan

• Generasi Dokumen Swagger:
  • GO-BAJAM Dokumentasi itu rumit tetapi lebih kuat
  • Dokumen dan penggunaan Swaggo/Swag relatif sederhana, hanya menghasilkan dokumen yang cukup
• Uji Perpustakaan Bantu untuk Peregangan Cepat Stretchr/Bersaksi
• Alat debugging: data variabel golang deep-spew/go-spew dalam

Komponen tambahan

• Swagger UI: Rendering dokumen Swagger
• Dockerfile : Docker Image Build Script untuk Lingkungan Produksi, Berdasarkan Alpine, Bangun Gambar Proyek dengan ukuran perkiraan sekitar 30 m
• makefile : Beberapa perintah pembuatan cepat telah dibangun untuk membantu dengan cepat menghasilkan dokumentasi dan membangun gambar.

Awal

• Pertama, klon repositori kerangka ke direktori lokal Anda
• Ganti nama direktori go-web-skeleton ke nama proyek Anda.
• Buka proyek dan ganti github.com/inhere/go-web-skeleton dengan nama proyek Anda (untuk file go)
• Cari lagi dan ganti semua go-web-skeleton dengan nama proyek Anda (terutama Dockerfile, Makefile)
• Jalankan go mod tidy untuk menginstal perpustakaan dependen
• Jalankan Proyek: go run main.go

Proyek init

go run ./cmd/appinit

Generasi Dokumen Swagger

instalasi:

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

Silakan periksa dokumentasi dan contoh swaggo/swag

Dihasilkan ke direktori yang ditentukan:

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

Melihat:

swaggo/swag adalah informasi deskripsi bidang parsing dari komentar lapangan

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

Membantu

• Jalankan tes

Go test
// output coverage
Go test -cover

• Proyek pemformatan

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

• Jalankan cek Golint

Catatan: Anda perlu menginstal GoLint terlebih dahulu.

golint ./...

Merujuk

• Golang-Standards/Project-Layout

Lisensi

Mit