Go Template

Introduction

Go 서버 애플리케이션 개발 시 빠르게 사용할 수 있는 echo 프레임워크 기반 템플릿 프로젝트 입니다.

다음을 내용을 포함합니다.

• 버전 관리
• 패키지 구조
• 각종 스크립트
• 프로파일링
• 샘플 코드

Dependency

이 템플릿에서 사용되는 라이브러리는 다음과 같습니다.

golang 커뮤니티에선 되도록이면 표준 라이브러리리 사용을 권장합니다.

하지만 최소한의 개발 편의를 위해 다음 라이브러리를 사용합니다.

바퀴를 다시 발명하지 않는 것이 좋습니다.

• Logging
  • zerolog
• Testing
  • testify
  • testcontainers
• HTTP Server
  • echo
• Database
  • gorm

Version Management

• go version: 1.23.0

버전 관리 툴로 asdf를 사용합니다.

asdf가 설치되어 있지 않은 경우 다음을 참고하여 설치합니다.

version setting

make asdf

asdf

asdf 설치

golang plugin 설치

1. install asdf

brew install asdf

2. install plugin

asdf plugin add golang https://github.com/asdf-community/asdf-golang.git

3. setting GOROOT

. ~/.asdf/plugins/golang/set-env.zsh

Package Layout

├─ cmd
│  ├── web
│  ├── worker
│  └── etc..
├─ internal
│  ├── app
│  │   ├── api
│  │   ├── domain
│  │   ├── infra
│  └── util
└─ local

패키지 구조는 Standard Go Project Layout을 따릅니다.

• cmd: 주요 애플리케이션 진입점. 이 계층은 서버를 시작하고 애플리케이션의 모든 계층을 연결하는 역할을 합니다.

• internal: 애플리케이션의 내부 패키지입니다.

  • app: 애플리케이션의 핵심 로직이 포함된 패키지입니다.
  • util: 애플리케이션의 여러 부분에서 사용할 수 있는 패키지입니다.

• local: 로컬 개발을 위한 스크립트 및 설정 파일이 존재하는 패키지입니다.

Getting Started

Run

make run module=<module name>

Build

 make build module=<module name>

Docker Build

 make docker module=<module name> tag=<tag name>

Test

 make test

Profiling

애플리케이션 프로파일링을 위한 pprof를 실행합니다.

프로파일링 전 다음과 같은 사전 작업이 필요합니다.

Prerequisite

1. pprof 설치

go install github.com/google/pprof@latest

2. graphviz 설치

brew install graphviz

3. 애플리케이션 pprof 활성화

package main
import _ "net/http/pprof"

func main() {
	// pprof endpoint
	go func() {
		http.ListenAndServe("localhost:6060", nil)
	}()
	// ...main code
}

Run

pprof

make pprof source=<pprof endpoint>
# e.g
# make pprof source=http://localhost:6060/debug/pprof/heap

heap memory 프로파일링

make pprof-heap

goroutine 프로파일링

make pprof-goroutine

cpu 프로파일링

make pprof-cpu

위 명령어 실행 시 브라우저가 열리며 pprof 결과를 확인할 수 있습니다. (기본 url: localhost:9999)

pprof 결과는 $HOME/pprof 디렉토리에 저장됩니다.