go web skeleton

去網絡骨架

完整的Golang Web應用程序骨架。

中文說明

包含：

• 可用於API接口應用程序，CLI命令行應用程序，Web應用程序
• log庫gookit/slog配置
• Swagger API文檔配置生成
• 多語言支持，查看渲染，請求數據驗證
• 配置閱讀管理，根據環境加載，多文件支持
• 包含redis，mysql，mongo，用於初始化和簡單使用
• 使用go mod安裝管理依賴項

項目結構

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

通過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
• 金祖/戈爾特

Mongodb：

• github.com/globalsign/mgo

快取

• 緩存：gookit/cache✅

redis：

• go-redis/redis✅
• gomodule/redigo

數據驗證

請求數據驗證

• gookit/veration✅
• Go-playground/驗證器

數據序列化

高性能序列化庫

JSON：

• JSON-ITERATOR/GO

其他軟件包

• I18N語言：gookit/i18n✅
• 查看渲染：gookit/easytpl✅

配置註冊中心：

• Eureka客戶端：不使用PDOK/GO-EUREKA-CLIENT
• NACOS客戶：

額外的組合

輔助圖書館

• Swagger文檔生成：
  • 張開文檔很複雜，但功能更強大
  • 史瓦戈/贓物文檔和用法相對簡單，只有生成文檔就足夠了
• 測試輔助庫中的快速斷言stretchr/vistifie
• 調試工具：Davecgh/Go-Spew Deep Printing Golang變量數據

其他組件

• Swagger UI：Swagger文件渲染
• Dockerfile ：基於Alpine的Docker Image構建腳本構建生產環境的腳本，構建一個項目圖像，其估計尺寸約為30 m
• makefile ：已經構建了一些快速的命令，以幫助快速生成文檔並構建圖像。

開始

• 首先，克隆骨骼存儲庫到您的本地目錄
• 將go-web-skeleton目錄重命名為您的項目名稱。
• 轉到項目，用您的項目名稱替換github.com/inhere/go-web-skeleton （用於go file）
• 再次搜索並用您的項目名稱替換所有go-web-skeleton （主要是Dockerfile，makefile）
• 運行go mod tidy以安裝依賴庫
• 運行項目： go run main.go

初始化項目

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標準/項目layout

執照

麻省理工學院