go web skeleton

Go Web Skeleton

Полный скелет веб -приложения Golang.

中文说明

Содержит:

• Можно использовать для приложений интерфейса API, приложений командной строки CLI, веб -приложений
• Библиотека журналов gookit/slog Configuration используется
• Swagger API -документация генерация конфигурации
• Поддержка с несколькими языками, рендеринг просмотра, проверка данных запроса
• Настройка управления чтением, загрузка в соответствии с средой, многопрофильной поддержкой
• Содержит Redis, MySQL, Mongo для инициализации и простого использования
• Используйте go mod для установки зависимостей управления

Структура проекта

Github Project https://github.com/inhere/go-web-celeton

 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 Packages

Используйте ✅ Mark Current Compante Package Go

HTTP Service

Предоставить HTTP Service и маршрутизацию

• Гукит/Рукс ✅

Другой :

Приложение CLI

Приложение командной строки

• Гукит/GCLI ✅

Конфигурация

Управление конфигурацией

• Несколько конфигураций формата: Gookit/config ✅
  • Конфигурация INI: GOOKIT/INI

Регистрация

• Гукит/Слога ✅
• Sirupsen/Logrus
  • Разделение журнала: Rifflock/Lfshook
  • Разделение журнала: Lestrat-Go/File-RotateLogs
• go.uber.org/zap

База данных ORM

Mysql:

• go-xorm/xorm
• Jinzhu/Gorm ✅

Mongodb:

• github.com/globalsign/mgo

Кеш

• Кэш: Гукит/Кэш ✅

Redis:

• go-redis/redis ✅
• Гомодуле/Реджиго

Проверка данных

Запросить проверку данных

• Гукит/проверка ✅
• Go-Playground/Validator

Сериализация данных

Высокопроизводительная библиотека сериализации

Json:

• json-iterator/Go

Другие пакеты

• I18N Язык: Гукит/I18N ✅
• Просмотр рендеринг: gookit/easytpl ✅

Центр регистра конфигурации:

• Eureka Client: PDOK/GO-EUREKA-Client не используется
• NACOS CLIENT:

Дополнительные композиции

Вспомогательная библиотека

• Создание документов Swagger:
  • Go-Swagger, документация сложна, но более мощная
  • Документы и использование Swaggo/Swag относительно просты, достаточно только генерирующих документов.
• Проверьте вспомогательную библиотеку для быстрого утверждения strestr/sotion
• Инструмент отладки: Davecgh/Go-Ship Deep Printing Golang Переменные данные

Дополнительные компоненты

• UB Swagger: рендеринг документа Swagger
• Dockerfile : Docker Image Script для производственной среды, основанная на альпийском языке, создайте изображение проекта с приблизительным размером около 30 м.
• makefile : Некоторые команды Make были созданы, чтобы помочь быстро генерировать документацию и создать изображения.

Начинать

• Во -первых, клонировать хранилище скелета в свой местный каталог
• Переименовать каталог go-web-skeleton на имя вашего проекта.
• Перейдите к проекту и замените github.com/inhere/go-web-skeleton с именем проекта (для файла GO)
• Поиск еще раз и замените все go-web-skeleton на название вашего проекта (в основном Dockerfile, Makefile)
• Запустить go mod tidy , чтобы установить зависимые библиотеки
• Запустите проект: go run main.go

Init Project

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/Project-Layout

Лицензия

Грань