go에서 mod파일 사용하는 방법

 

Go에서 go.mod 파일은 Go 모듈을 관리하기 위한 파일입니다.

모듈은 Go 언어에서 패키지의 의존성을 관리하고, 프로젝트를 조직하는 방법입니다.

모듈은 여러 패키지를 포함하는 단위이며, go.mod 파일은 해당 모듈의 정보를 저장하고 의존성을 정의합니다.

go.mod 파일 사용하는 법

1. go mod init으로 모듈 초기화

Go 모듈 시스템을 사용하려면 먼저 프로젝트 루트에서 모듈을 초기화해야 합니다. go mod init 명령어를 통해 go.mod 파일이 생성되며, 모듈 관리가 시작됩니다.

go mod init <모듈이름>

예시:

go mod init github.com/user/myproject

이 명령어는 github.com/user/myproject라는 모듈을 초기화하며, go.mod 파일이 생성됩니다.

생성된 go.mod 파일 예시:

module github.com/user/myproject

go 1.20

• module 키워드는 프로젝트의 모듈 이름을 정의합니다.
• go는 프로젝트에서 사용할 Go 버전을 정의합니다.

2. 외부 패키지 추가하기

Go 모듈은 프로젝트에서 사용할 외부 패키지나 라이브러리를 관리합니다. 외부 패키지를 임포트할 때, Go는 자동으로 해당 패키지를 다운로드하고 go.mod에 의존성을 추가합니다.

예시: 외부 패키지 설치 및 사용

go get github.com/gorilla/mux

이 명령어는 github.com/gorilla/mux 패키지를 다운로드하고, go.mod 파일에 의존성을 추가합니다.

go.mod 파일:

module github.com/user/myproject

go 1.20

require github.com/gorilla/mux v1.8.0 // 외부 패키지 추가

이제 github.com/gorilla/mux 패키지를 프로젝트에서 사용할 수 있습니다.

3. go.sum 파일

외부 패키지를 설치하거나 의존성을 추가하면, Go는 패키지의 버전과 해시 값을 기록한 go.sum 파일을 생성합니다. 이 파일은 의존성의 무결성을 보장하기 위한 용도로 사용됩니다.

github.com/gorilla/mux v1.8.0 h1:...
github.com/gorilla/mux v1.8.0/go.mod h1:...

go.sum 파일은 패키지 관리에서 중요한 역할을 하므로, 함께 소스 코드 관리 도구(예: Git)로 추적하는 것이 좋습니다.

4. 모듈 업데이트하기

모듈을 업데이트하거나 새로운 버전의 외부 패키지를 사용하려면 go get 명령어를 사용하여 버전을 지정할 수 있습니다.

go get github.com/gorilla/mux@v1.8.0

이 명령어는 github.com/gorilla/mux의 1.8.0 버전을 설치하고, go.mod 파일을 업데이트합니다.

5. 의존성 정리하기

프로젝트에서 더 이상 사용하지 않는 의존성을 정리하려면 go mod tidy 명령어를 사용합니다. 이 명령어는 go.mod와 go.sum 파일에서 불필요한 의존성을 제거합니다.

go mod tidy

이 명령어를 실행하면 현재 프로젝트에서 사용되지 않는 패키지를 go.mod와 go.sum에서 삭제합니다.

6. 로컬 모듈 경로 설정하기

프로젝트 내부에서 다른 로컬 모듈을 참조하려면 replace 지시어를 사용하여 특정 경로로 대체할 수 있습니다. 이는 개발 중에 로컬 경로의 모듈을 테스트할 때 유용합니다.

module github.com/user/myproject

go 1.20

require github.com/user/utils v0.0.0

replace github.com/user/utils => ../utils

위 설정은 github.com/user/utils 모듈을 로컬 디렉토리 ../utils 경로로 대체하여 개발 중 해당 모듈을 로컬에서 참조하도록 합니다.

7. 모듈 버전 관리

Go 모듈은 기본적으로 SemVer(유의적 버전, Semantic Versioning) 규칙을 따릅니다. 예를 들어, v1.2.3은 주버전, 부버전, 수정 버전으로 나뉩니다. 모듈의 주요 업데이트가 있을 때에는 주버전 번호를 증가시킵니다.

require github.com/gorilla/mux v1.8.0

Go는 v1 이하에서는 v0 버전을 테스트용으로 간주하고, v1 이상부터 정식 버전으로 취급합니다.

8. 모듈 제거

특정 패키지를 더 이상 사용하지 않으면, go.mod에서 수동으로 제거할 필요 없이 go mod tidy 명령어를 사용하여 자동으로 제거할 수 있습니다.

요약

• go mod init 명령어로 모듈을 초기화하고 go.mod 파일을 생성합니다.
• go get을 통해 외부 패키지를 추가하며, 의존성 정보는 go.mod 파일에 기록됩니다.
• go sum 파일은 패키지 무결성을 위한 해시 정보를 저장합니다.
• go mod tidy를 통해 불필요한 의존성을 정리할 수 있습니다.
• replace 지시어를 사용하여 로컬 모듈을 참조할 수 있습니다.