go web skeleton

ไปที่เว็บ Skeleton

โครงกระดูกแอปพลิเคชันเว็บ Golang ที่สมบูรณ์

中文说明

ประกอบด้วย:

• สามารถใช้สำหรับแอปพลิเคชันอินเตอร์เฟส API, แอปพลิเคชันบรรทัดคำสั่ง CLI, เว็บแอปพลิเคชัน
• LOG Library gookit/slog การกำหนดค่าที่ใช้
• Swagger API การสร้างการกำหนดค่าการกำหนดค่าเอกสาร
• การสนับสนุนหลายภาษาดูการเรนเดอร์ร้องขอการตรวจสอบความถูกต้องของข้อมูล
• กำหนดค่าการจัดการอ่านโหลดตามสภาพแวดล้อมการสนับสนุนหลายไฟล์
• มี 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
  • บันทึกการแยก: lestrat-go/file-rotatelogs
• go.uber.org/zap

ฐานข้อมูล ORM

mysql:

• go-xorm/xorm
• jinzhu/gorm ✅

MongoDB:

• github.com/globalsign/mgo

แคช

• แคช: GOOKIT/CACHE ✅

Redis:

• go-redis/redis ✅
• Gomodule/redigo

การตรวจสอบข้อมูล

ขอการตรวจสอบข้อมูล

• gookit/ตรวจสอบ✅
• go-playground/validator

การทำให้เป็นอนุกรมข้อมูล

ห้องสมุดการทำให้เป็นอนุกรมประสิทธิภาพสูง

JSON:

• JSON-TINETORATOR/GO

แพ็คเกจอื่น ๆ

• ภาษา i18n: gookit/i18n ✅
• ดูการแสดงผล: Gookit/EasyTpl ✅

กำหนดค่าศูนย์ทะเบียน:

• ไคลเอนต์ยูเรก้า: PDOK/go-eureka-client ไม่ได้ใช้
• ไคลเอนต์ NACOS:

Compoents พิเศษ

ห้องสมุดเสริม

• การสร้างเอกสาร Swagger:
  • Go-Swagger เอกสารมีความซับซ้อน แต่มีประสิทธิภาพมากกว่า
  • เอกสารและการใช้งาน Swaggo/Swag นั้นค่อนข้างง่ายมีเพียงการสร้างเอกสารก็เพียงพอแล้ว
• ทดสอบไลบรารีเสริมสำหรับการยืนยันอย่างรวดเร็ว/เป็นพยาน
• เครื่องมือการดีบัก: Davecgh/Go-Spew Deep Printing Golang Variable Data

ส่วนประกอบเพิ่มเติม

• Swagger UI: การแสดงผลเอกสาร Swagger
• Dockerfile : Docker Image Build Script สำหรับสภาพแวดล้อมการผลิตตามอัลไพน์สร้างภาพโครงการที่มีขนาดประมาณ 30 เมตร
• makefile : คำสั่ง Make อย่างรวดเร็วบางอย่างได้ถูกสร้างขึ้นเพื่อช่วยสร้างเอกสารและสร้างภาพอย่างรวดเร็ว

เริ่ม

• ก่อนอื่นให้โคลนที่เก็บโครงกระดูกไปยังไดเรกทอรีท้องถิ่นของคุณ
• เปลี่ยนชื่อไดเรกทอรี go-web-skeleton เป็นชื่อโครงการของคุณ
• ไปที่โครงการและแทนที่ github.com/inhere/go-web-skeleton ด้วยชื่อโครงการของคุณ (สำหรับไฟล์ GO)
• ค้นหาอีกครั้งและแทนที่ go-web-skeleton ทั้งหมดด้วยชื่อโครงการของคุณ (ส่วนใหญ่ DockerFile, MakeFile)
• Run go mod tidy เพื่อติดตั้งไลบรารีที่ขึ้นอยู่กับ
• เรียกใช้โครงการ: go run main.go

โครงการ init

go run ./cmd/appinit

การสร้างเอกสาร Swagger

การติดตั้ง:

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 Check

หมายเหตุ: คุณต้องติดตั้ง GoLint ก่อน

golint ./...

อ้างอิง

• Golang-Standards/Project-Layout

ใบอนุญาต

มิกซ์