Bazel 모듈은 여러 버전이 있을 수 있는 Bazel 프로젝트로, 각각 종속된 다른 모듈에 대한 메타데이터를 게시합니다. 이는 Maven 아티팩트, npm 패키지, Go 모듈 또는 Cargo 크레이트와 같은 다른 종속 항목 관리 시스템의 익숙한 개념과 유사합니다.
모듈의 저장소 루트 (WORKSPACE 파일 옆)에 MODULE.bazel 파일이 있어야 합니다. 이 파일은 모듈의 매니페스트로, 이름, 버전, 직접 종속 항목 목록 및 기타 정보를 선언합니다. 기본적인 예는 다음과 같습니다.
module(name = "my-module", version = "1.0")
bazel_dep(name = "rules_cc", version = "0.0.1")
bazel_dep(name = "protobuf", version = "3.19.0")
MODULE.bazel 파일에서 사용할 수 있는 지시어 전체 목록을 참조하세요.
모듈 확인을 수행하기 위해 Bazel은 먼저 루트 모듈의 MODULE.bazel 파일을 읽은 다음 전체 종속 항목 그래프를 발견할 때까지 Bazel 레지스트리에 종속 항목의 MODULE.bazel 파일을 반복적으로 요청합니다.
기본적으로 Bazel은 사용할 각 모듈의 한 버전을 선택합니다. Bazel은 각 모듈을 저장소로 표현하고 레지스트리를 다시 참조하여 각 저장소를 정의하는 방법을 알아봅니다.
버전 형식
Bazel은 생태계가 다양하고 프로젝트에서는 다양한 버전 관리 체계를 사용합니다. 현재 가장 인기 있는 프로젝트는 SemVer이지만 Abseil과 같은 다른 스키마를 사용하는 주요 프로젝트도 있습니다(버전이 날짜 기반(예: 20210324.2)임).
따라서 Bzlmod는 좀 더 편안한 버전의 SemVer 사양을 채택합니다. 차이점은 다음과 같습니다.
- SemVer는 버전의 '출시' 부분이
MAJOR.MINOR.PATCH세그먼트 3개로 구성되어야 한다고 규정합니다. Bazel에서는 이 요구사항이 완화되어 원하는 수의 세그먼트가 허용됩니다. - SemVer에서 '해제' 부분의 각 세그먼트는 숫자만 사용해야 합니다. Bazel에서는 문자도 느슨하게 사용할 수 있으며 비교 시맨틱스는 '출시 전' 부분의 '식별자'와 일치합니다.
- 또한 주 버전, 부 버전, 패치 버전 증가 시맨틱스는 적용되지 않습니다. 그러나 이전 버전과의 호환성을 나타내는 방법은 호환성 수준을 참조하세요.
유효한 SemVer 버전은 유효한 Bazel 모듈 버전입니다. 또한 두 SemVer 버전 a 및 b은 Bazel 모듈 버전과 비교할 때 동일한 경우에만 a < b를 비교합니다.
버전 선택
다이아몬드 종속 항목 문제는 버전이 지정된 종속 항목 관리 공간의 주요 요소입니다. 종속 항목 그래프가 있다고 가정해 보겠습니다.
A 1.0
/ \
B 1.0 C 1.1
| |
D 1.0 D 1.1
어떤 버전의 D를 사용해야 하나요? 이 문제를 해결하기 위해 Bzlmod는 Go 모듈 시스템에 도입된 최소 버전 선택(MVS) 알고리즘을 사용합니다. MVS는 모듈의 모든 새 버전이 이전 버전과 호환된다고 가정하므로 모든 종속 항목에서 지정한 가장 높은 버전을 선택합니다 (이 예에서는 D 1.1). '미니멀'이라고 하는 이유는 D 1.1이 요구사항을 충족할 수 있는 가장 초기 버전이기 때문입니다. D 1.2 이상이라도 Google에서 선택하지 않습니다. MVS를 사용하면 고충실도와 재현성이 있는 버전 선택 프로세스를 만들 수 있습니다.
야크 버전
레지스트리는 특정 취약점을 방지해야 할 경우(예: 보안 취약점) 양키로 선언할 수 있습니다. 버벅거림 버전의 모듈을 선택하면 Bazel에서 오류가 발생합니다. 이 오류를 해결하려면 더 이상 가져오지 않은 버전으로 업그레이드하거나 --allow_yanked_versions 플래그를 사용하여 가져온 버전을 명시적으로 허용하세요.
호환성 수준
Go에서는 이전 버전과 호환되지 않는 모듈의 버전을 별도의 모듈로 취급하기 때문에 MVS의 이전 버전과의 호환성이 작동합니다. SeemVer 측면에서 A 1.x과 A 2.x는 별개의 모듈로 간주되며 해결된 종속 항목 그래프에 공존할 수 있습니다. 이는 결과적으로 Go의 패키지 경로에 메이저 버전을 인코딩하여 가능하므로 컴파일 시간이나 연결 시간 충돌이 없습니다.
그러나 Bazel은 이러한 보장을 제공할 수 없으므로 이전 버전과 호환되지 않는 버전을 감지하려면 '주 버전' 번호가 필요합니다. 이 번호를 호환성 수준이라고 하며, module() 지시문의 각 모듈 버전에 의해 지정됩니다. 이 정보를 사용하면 Bazel이 동일한 종속 항목의 다른 호환성 수준이 확인된 모듈의 버전이 해결된 종속 항목 그래프에 있음을 감지하면 오류가 발생할 수 있습니다.
재정의
MODULE.bazel 파일에 재정의를 지정하여 Bazel 모듈 해상도의 동작을 변경합니다. 루트 모듈의 재정의만 적용됩니다. 모듈이 종속 항목으로 사용되는 경우 재정의는 무시됩니다.
각 재정의는 특정 모듈 이름에 지정되어 종속 항목 그래프의 모든 버전에 영향을 미칩니다. 루트 모듈의 재정의만 적용되지만 루트 모듈에 직접 종속되지 않는 전이 종속 항목에 적용될 수 있습니다.
단일 버전 재정의
single_version_override는 여러 용도로 사용됩니다.
version속성을 사용하면 종속 항목 그래프에서 요청된 종속 항목의 버전과 관계없이 특정 버전에 종속 항목을 고정할 수 있습니다.registry속성을 사용하면 일반적인 레지스트리 선택 프로세스를 따르는 대신 특정 레지스트리에서 종속 항목을 강제 적용할 수 있습니다.patch*속성을 사용하면 다운로드한 모듈에 적용할 패치 집합을 지정할 수 있습니다.
이러한 속성은 모두 선택사항이며 조합하여 사용할 수 있습니다.
다중 버전 재정의
multiple_version_override를 지정하여 동일한 종속 항목의 여러 버전이 해결된 종속 항목 그래프에 공존할 수 있도록 합니다.
모듈의 허용된 버전에 관한 명시적 목록을 지정할 수 있으며, 이는 종속 항목 그래프에 해결 전이 되어야 합니다. 허용된 각 버전에 따라 일부 전이 종속 항목이 있어야 합니다. 해결 후에는 허용된 모듈 버전만 유지되고, Bazel은 모듈의 다른 버전을 동일한 호환성 수준에서 허용되는 가장 높은 허용 버전으로 업그레이드합니다. 동일한 호환성 수준에서 허용된 더 높은 버전이 없으면 Bazel에서 오류가 발생합니다.
예를 들어 해결 방법 전에 종속 항목 그래프에 1.1, 1.3, 1.5, 1.7, 2.0 버전이 있고 메이저 버전이 호환성 수준인 경우:
1.3,1.7,2.0를 허용하는 다중 버전 재정의를 사용하면1.1가1.3로 업그레이드되고1.5가1.7로 업그레이드되며 다른 버전은 동일하게 유지됩니다.1.7과 업그레이드할 동일한 호환성 수준의 상위 버전이 없으므로1.5및2.0를 허용하는 다중 버전 재정의에서 오류가 발생합니다.1.9및2.0를 허용하는 다중 버전 재정의는 해결 전에 종속 항목 그래프에1.9가 없기 때문에 오류가 발생합니다.
또한 사용자는 단일 버전 재정의와 마찬가지로 registry 속성을 사용하여 레지스트리를 재정의할 수도 있습니다.
레지스트리가 아닌 재정의
레지스트리가 아닌 재정의는 버전 해상도에서 모듈을 완전히 삭제합니다. Bazel은 이러한 MODULE.bazel 파일을 레지스트리가 아닌 저장소 자체에서 요청합니다.
Bazel은 다음과 같은 비 레지스트리 재정의를 지원합니다.
저장소 이름 및 엄격한 deps
모듈을 지원하는 저장소의 표준 이름은 module_name~version입니다 (예: bazel_skylib~1.0.3). 레지스트리가 아닌 재정의가 있는 모듈의 경우 version 부분을 override 문자열로 바꿉니다. 표준 이름 형식은 반드시 사용해야 하는 API가 아니며 언제든지 변경될 수 있습니다.
bazel_dep 지시어의 repo_name 속성에 달리 명시되지 않는 한 모듈을 직접 종속 항목에 지원하는 저장소의 명확한 이름은 기본적으로 모듈 이름으로 사용됩니다. 즉, 모듈은 직접 종속 항목만 찾을 수 있습니다. 이렇게 하면 전이 종속 항목 변경으로 인한 실수로 인한 손상을 방지할 수 있습니다.
모듈 확장은 모듈의 표시 범위에 추가 저장소를 도입할 수도 있습니다.