[go] Go 언어에서 패키지 구조 설계하기

11 Dec 2023

Go 언어는 강력한 표준 라이브러리와 간결한 구조로 알려져 있습니다. 이러한 특징을 고려하여 효율적이고 유지보수가 쉬운 패키지 구조를 설계하는 것이 중요합니다. 이번 포스트에서는 Go 언어에서의 패키지 구조 설계에 대해 알아보겠습니다.

1. 패키지 구조 중요성

Go 언어에서 패키지는 코드를 모듈화하고 재사용 가능하게 만드는 핵심 요소입니다. 적절한 패키지 구조는 코드 관리를 용이하게 하고, 다른 프로젝트에서 해당 패키지를 손쉽게 활용할 수 있도록 도와줍니다.

2. 폴더 구조 설계

Go 언어에서는 일반적으로 프로젝트 루트에 src, pkg, bin 디렉토리를 포함한 GOPATH 환경을 사용합니다. 여기서 src는 소스 코드를 포함하는 곳이며, pkg는 컴파일된 패키지를 저장하는 곳입니다. bin은 실행 가능한 바이너리를 저장하는 곳입니다.

프로젝트 루트 ├── src │ └── github.com │ └── username │ └── projectname │ └── main.go ├── pkg └── bin

이러한 구조를 따르면 다른 프로젝트에서 해당 패키지를 가져다 쓸 때 GOPATH를 통해 쉽게 import할 수 있습니다.

3. 패키지 네이밍 규칙

패키지의 이름은 해당 패키지가 하는 일을 정확하게 표현하고, 짧고 간결해야 합니다. 일반적으로 소문자로 작성하며, 여러 단어의 경우에는 snake case를 사용합니다. 또한, 패키지의 네이밍은 해당 패키지가 하는 일을 명확하게 이해할 수 있도록 작성해야 합니다.

package main

import (
	"fmt"
	"github.com/username/projectname/utilities"
)

func main() {
	fmt.Println(utilities.Add(1, 2))
}

위의 예시에서 utilities 패키지는 기능 추가를 수행하는 패키지로써, 해당 역할을 잘 표현하고 있습니다.

4. 의존성 관리

Go 모듈을 이용하여 의존성을 관리하는 것이 권장됩니다. Go 모듈을 사용하면 패키지의 의존성을 명확하게 관리할 수 있으며, 버전 관리에 용이합니다. go.mod 파일을 통해 의존성을 관리하며, go get 명령어를 사용하여 필요한 패키지를 쉽게 가져올 수 있습니다.

module github.com/username/projectname

go 1.15

require (
	github.com/somepackage v1.2.3
)

5. 종합적인 예제

위의 내용을 종합적으로 적용하여 간단한 패키지 구조를 예제로 살펴보겠습니다.

프로젝트 루트 ├── src │ └── github.com │ └── username │ └── projectname │ ├── main.go │ ├── utilities │ │ ├── math.go │ │ └── string.go ├── pkg └── bin

위의 예제에서 utilities 패키지 안에 math.go와 string.go 파일을 만들어 관련 기능들을 구현하는 것을 확인할 수 있습니다.

6. 참고 자료

이번 포스트를 통해 Go 언어에서의 패키지 구조 설계에 대해 알아보았습니다. 적절한 패키지 구조를 따르면 코드의 유지보수성을 높일 뿐 아니라, 다른 프로젝트에서 해당 패키지를 손쉽게 재사용할 수 있게 됩니다.

목차