go web skeleton

웹 골격으로 가십시오

완전한 Golang 웹 응용 프로그램 골격.

中文说明

포함

• API 인터페이스 응용 프로그램, CLI 명령 줄 응용 프로그램, 웹 응용 프로그램에 사용할 수 있습니다.
• 로그 라이브러리 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
  • 로그 분할 : lestrrat-go/file-rotatelogs
• go.uber.org/zap

데이터베이스 ORM

mysql :

• go-xorm/xorm
• Jinzhu/Gorm ✅

mongodb :

• github.com/globalsign/mgo

은닉처

• 캐시 : Gookit/캐시 ✅

Redis :

• Go-Redis/Redis ✅
• gomodule/redigo

데이터 검증

데이터 유효성 검사 요청

• Gookit/Validate/
• Go-Playground/Validator

데이터 직렬화

고성능 직렬화 라이브러리

JSON :

• JSON-ATERATOR/GO

다른 패키지

• I18N 언어 : Gookit/i18n ✅
• 렌더링보기 : gookit/easytpl ✅

구성 레지스터 센터 :

• 유레카 클라이언트 : PDOK/GO-EUREKA-CLIENT가 사용되지 않습니다
• NACOS 클라이언트 :

여분의 구성 요소

보조 도서관

• Swagger 문서 생성 :
  • Go-Swagger 문서는 복잡하지만 더 강력합니다
  • Swaggo/Swag 문서 및 사용량은 비교적 간단하며 문서 만 생성하면 충분합니다.
• 빠른 어설 션 스트레칭/증언을 위해 보조 라이브러리를 테스트하십시오
• 디버깅 도구 : Davecgh/Go-Spew Deep Printing Golang 변수 데이터

추가 구성 요소

• Swagger UI : Swagger 문서 렌더링
• Dockerfile : Alpine을 기반으로 한 프로덕션 환경을위한 Docker Image Build Script, 약 30m의 추정 크기의 프로젝트 이미지 구축
• makefile : 문서화를 신속하게 생성하고 이미지를 빌드하는 데 도움이되는 일부 빠른 제작 명령이 구축되었습니다.

시작

• 먼저 골격 저장소를 로컬 디렉토리로 복제하십시오
• go-web-skeleton 디렉토리의 이름을 프로젝트 이름으로 바꿉니다.
• 프로젝트로 이동하여 github.com/inhere/go-web-skeleton 프로젝트 이름으로 교체하십시오 (GO 파일 용)
• 다시 검색하고 모든 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 는 Parsing Field 설명 필드의 의견에서 정보입니다.

 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

특허

MIT