go web skeleton

اذهب للهيكل العظمي

هيكل عظمي كامل لتطبيق ويب Golang.

中文说明

يتضمن:

• يمكن استخدامها لتطبيقات واجهة API ، وتطبيقات سطر الأوامر CLI ، وتطبيقات الويب
• سجل مكتبة gookit/slog Configuration
• توليد تكوين وثائق واجهة برمجة التطبيقات Swagger
• دعم متعدد اللغات ، عرض عرض ، طلب التحقق من صحة البيانات
• تكوين إدارة القراءة ، التحميل وفقًا للبيئة ، دعم متعدد الملفات
• يحتوي على redis و mysql و mongo للتهيئة والاستخدام البسيط
• استخدم go mod لتثبيت تبعيات الإدارة

هيكل المشروع

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

تقديم بواسطة tree -d 2 ./

اذهب الحزم

استخدم ✅ وضع علامة على حزمة GO الحالية المستخدمة

خدمة HTTP

توفير خدمة HTTP والتوجيه

• Gookit/Rux ✅

آخر :

تطبيق CLI

تطبيق سطر الأوامر

• Gookit/GCLI ✅

إعدادات

إدارة التكوين

• تكوينات تنسيق متعددة: gookit/config ✅
  • تكوين INI: gookit/ini

قطع الأشجار

• Gookit/slog ✅
• Sirupsen/logrus
  • تقسيم السجل: rifflock/lfshook
  • تقسيم السجل: lestrrat-go/file-rotatelogs
• go.uber.org/zap

قاعدة البيانات orm

MySQL:

• go-xorm/xorm
• Jinzhu/gorm ✅

مونغودب:

• github.com/globalsign/mgo

مخبأ

• ذاكرة التخزين المؤقت: Gokit/Cache ✅

ريديس:

• go-redis/redis ✅
• gomodule/redigo

التحقق من صحة البيانات

طلب التحقق من صحة البيانات

• Gookit/التحقق من صحة ✅
• Go-Playground/Deatitator

تسلسل البيانات

مكتبة تسلسل عالية الأداء

JSON:

• json-iterator/go

حزم أخرى

• I18n اللغة: gookit/i18n ✅
• عرض العرض: gookit/easytpl ✅

مركز تسجيل التكوين:

• عميل Eureka: PDOK/GO-EUREKA-CLIENT غير مستخدم
• عميل NACOS:

مكونات إضافية

مكتبة مساعدة

• توليد مستندات Swagger:
  • go-swagger الوثائق معقدة ولكنها أقوى
  • مستندات Swaggo/Swag والاستخدام بسيطة نسبيًا ، فقط توليد المستندات تكفي
• اختبر المكتبة الإضافية للتأكيد السريع تمتد/شهادات
• أداة تصحيح الأخطاء: Davecgh/Go-Spew Deep Printing Golang Data

مكونات إضافية

• Swagger UI: تقديم مستندات Swagger
• Dockerfile : برنامج Docker Image Build Script لبيئة الإنتاج ، استنادًا إلى جبال الألب ، قم بإنشاء صورة للمشروع بحجم تقديري حوالي 30 م
• makefile : تم تصميم بعض الأوامر السريعة للمساعدة في إنشاء الوثائق وإنشاء الصور بسرعة.

يبدأ

• أولاً ، استنساخ مستودع الهيكل العظمي إلى الدليل المحلي الخاص بك
• أعد تسمية دليل go-web-skeleton إلى اسم مشروعك.
• انتقل إلى المشروع واستبدل github.com/inhere/go-web-skeleton باسم مشروعك (للحصول على ملف GO)
• ابحث مرة أخرى واستبدل جميع go-web-skeleton باسم مشروعك (Dockerfile بشكل رئيسي ، Makefile)
• قم بتشغيل go mod tidy لتثبيت المكتبات المعتمدة
• تشغيل المشروع: go run main.go

مشروع init

go run ./cmd/appinit

Swagger Docs Generation

تثبيت:

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

يرجى التحقق من وثائق وأمثلة من swaggo/swag

تم إنشاؤه إلى الدليل المحدد:

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

يلاحظ:

swaggo/swag هي معلومات وصف مجال التحليل من تعليق الحقل

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

يساعد

• قم بإجراء الاختبار

Go test
// output coverage
Go test -cover

• تنسيق مشروع

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

• تشغيل فحص Golint

ملاحظة: تحتاج إلى تثبيت GoLint أولاً.

golint ./...

يشير إلى

• Golang-Standards/project-layout

رخصة

معهد ماساتشوستس للتكنولوجيا