외부 종속 항목 개요

컬렉션을 사용해 정리하기 내 환경설정을 기준으로 콘텐츠를 저장하고 분류하세요.
문제 신고 소스 보기

Bazel은 빌드에 사용된 작업공간의 출처가 아닌 소스 파일 (텍스트와 바이너리 모두)인 외부 종속 항목을 지원합니다. 예를 들어 규칙 세트는 GitHub 저장소, Maven 아티팩트에서 호스팅되는 규칙 세트이거나 현재 작업공간 외부의 로컬 머신의 디렉터리일 수 있습니다.

Bazel 6.0부터 Bazel을 사용하여 외부 종속 항목을 관리하는 두 가지 방법이 있습니다. 하나는 기존의 저장소 중심 WORKSPACE 시스템이고, 새로운 모듈 중심 MODULE.bazel 시스템 (Bzlmod는 코드명이 --enable_bzlmod이며 --enable_bzlmod 플래그를 사용 설정함). 이 두 시스템은 함께 사용할 수 있지만, Bzlmod는 향후 Bazel 출시에서 WORKSPACE 시스템을 대체합니다.

이 문서에서는 두 시스템을 순서대로 자세히 살펴보기 전에 Bazel의 외부 종속 항목 관리와 관련된 개념을 설명합니다.

개념

저장소

Bazel 빌드에서 사용할 소스 파일이 포함된 WORKSPACE 또는 WORKSPACE.bazel 파일이 있는 디렉터리. 주로 repo로 축약되는 경우가 많습니다.

기본 저장소

현재 Bazel 명령어가 실행되는 저장소입니다.

작업공간

모든 Bazel 명령어에서 공유하는 환경은 동일한 기본 저장소에서 실행됩니다.

지금까지 '저장소'와 '작업공간'의 개념은 혼동되었습니다. '작업공간'이라는 용어는 주로 기본 저장소를 지칭하는 데 사용되었으며 심지어 '저장소'의 동의어로도 사용되었습니다.

표준 저장소 이름

저장소를 지정할 수 있는 표준 이름입니다. 작업공간 컨텍스트 내에서 각 저장소에는 단일 표준 이름이 있습니다. 저장소 내 표준 이름이 canonical_name인 타겟은 @@canonical_name//pac/kage:target 라벨로 처리할 수 있습니다 (더블 @ 참고).

기본 저장소에는 항상 표준 이름으로 빈 문자열이 있습니다.

명확한 저장소 이름

다른 특정 저장소의 컨텍스트에서 저장소 주소를 지정할 수 있는 이름입니다. 이는 저장소의 '닉네임'으로 생각할 수 있습니다. 저장소 이름이 michael인 저장소는 저장소 alice의 컨텍스트에서 mike이라는 이름을 가질 수 있지만 저장소 bob의 컨텍스트에서 mickey이라는 이름을 가질 수 있습니다. 이 경우 michael 내 타겟을 alice의 컨텍스트에서 @mike//pac/kage:target 라벨로 처리할 수 있습니다(단일 @ 참고).

반대로 저장소 매핑으로 간주할 수도 있습니다. 각 저장소는 '보이는 저장소 이름'에서 '표준 저장소 이름'으로의 매핑을 유지합니다.

저장소 규칙

Bazel에 저장소를 구체화하는 방법을 알려주는 저장소 정의의 스키마입니다. 예를 들어 '특정 URL에서 ZIP 보관 파일을 다운로드하여 추출', '특정 Maven 아티팩트를 가져와 java_import 대상으로 제공' 또는 단순히 '로컬 디렉터리 심볼릭 링크'로 만들 수 있습니다. 모든 저장소는 적절한 수의 인수로 저장소 규칙을 호출하여 정의됩니다.

자체 저장소 규칙을 작성하는 방법에 대한 자세한 내용은 저장소 규칙을 참조하세요.

가장 일반적인 저장소 규칙은 URL에서 보관 파일을 다운로드하여 추출하는 http_archive와 이미 Bazel 저장소인 로컬 디렉터리를 심볼릭 링크로 연결하는 local_repository입니다.

저장소 가져오기

연결된 저장소 규칙을 실행하여 로컬 디스크에 저장소를 제공하는 작업 작업공간에 정의된 저장소를 가져오기 전에 로컬 디스크에서 사용할 수 없습니다.

일반적으로 Bazel은 저장소에서 무언가를 필요로 하고 저장소를 아직 가져오지 않은 경우에만 저장소를 가져옵니다. 이전에 저장소를 이미 가져온 경우 Bazel은 정의가 변경된 경우에만 다시 가져옵니다.

디렉터리 레이아웃

가져온 후에는 저장소는 표준 이름으로 출력 베이스에 있는 하위 디렉터리 external에서 찾을 수 있습니다.

다음 명령어를 실행하여 표준 이름이 canonical_name인 저장소의 콘텐츠를 볼 수 있습니다.

ls $(bazel info output_base)/external/ canonical_name 

Bzlmod로 외부 종속 항목 관리

새로운 외부 종속 항목 하위 시스템인 Bzlmod는 저장소 정의에서 직접 작동하지 않습니다. 대신 모듈에서 종속 항목 그래프를 빌드하고, 그래프 위에서 확장 프로그램을 실행하고, 그에 따라 저장소를 정의합니다.

Bazel 모듈은 여러 버전이 있을 수 있는 Bazel 프로젝트이며, 각 모듈은 종속되는 다른 모듈에 대한 메타데이터를 게시합니다. 모듈의 저장소 루트에서 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")

모듈은 직접 종속 항목만 나열해야 하며, Bzlmod는 Bazel 레지스트리(기본적으로 Bazel 중앙 레지스트리)에서 조회합니다. 레지스트리는 종속 항목의 MODULE.bazel 파일을 제공합니다. 이 파일을 사용하면 Bazel이 버전 확인을 수행하기 전에 전체 종속 항목 그래프를 검색할 수 있습니다.

각 모듈에 대해 한 버전이 선택된 버전 확인 후 Bazel은 레지스트리를 다시 참조하여 각 모듈의 저장소를 정의하는 방법을 알아봅니다(대부분의 경우 http_archive 사용).

또한 모듈은 태그라고 하는 맞춤설정된 데이터를 지정할 수 있습니다. 이 태그는 모듈 확인 후 모듈 확장 프로그램에 의해 추가 저장소를 정의하기 위해 사용됩니다. 이러한 확장에는 저장소 규칙과 유사한 기능이 있으므로 파일 I/O 및 네트워크 요청 전송과 같은 작업을 수행할 수 있습니다. 무엇보다도 Bazel이 다른 패키지 관리 시스템과 상호작용할 수 있도록 허용하는 동시에 Bazel 모듈로 빌드된 종속 항목 그래프를 따릅니다.

WORKSPACE로 저장소 정의

지금까지는 WORKSPACE (또는 WORKSPACE.bazel) 파일에 저장소를 정의하여 외부 종속 항목을 관리할 수 있었습니다. 이 파일은 BUILD 파일과 유사한 문법을 사용하며 빌드 규칙 대신 저장소 규칙을 사용합니다.

다음 스니펫은 WORKSPACE 파일에서 http_archive 저장소 규칙을 사용하는 예입니다.

load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
http_archive(
    name = "foo",
    urls = ["https://example.com/foo.zip"],
    sha256 = "c9526390a7cd420fdcec2988b4f3626fe9c5b51e2959f685e8f4d170d1a9bd96",
)

이 스니펫은 표준 이름이 foo인 저장소를 정의합니다. WORKSPACE 시스템에서는 기본적으로 저장소의 표준 이름이 다른 모든 저장소에도 보이는 이름입니다.

WORKSPACE 시스템의 단점

WORKSPACE 시스템이 도입된 이후 몇 년 동안 사용자가 다음을 비롯한 많은 고충을 신고했습니다.

  • Bazel은 종속 항목의 WORKSPACE 파일을 평가하지 않으므로 모든 종속 항목은 직접 종속 항목 외에도 기본 저장소의 WORKSPACE 파일에서 정의되어야 합니다.
  • 이 문제를 해결하기 위해 프로젝트는 'deps.bzl' 패턴을 채택했습니다. 이 패턴에서는 여러 저장소를 정의하는 매크로를 정의하고 사용자에게 WORKSPACE 파일에서 이 매크로를 호출하도록 요청합니다.
    • 여기에는 고유한 문제가 있습니다. 매크로는 다른 .bzl 파일을 load할 수 없으므로 이러한 프로젝트는 이 'deps' 매크로에서 전이 종속 항목을 정의하거나 사용자가 여러 개의 계층화된 'deps' 매크로를 호출하도록 하여 이 문제를 해결해야 합니다.
    • Bazel은 WORKSPACE 파일을 순차적으로 평가합니다. 또한 종속 항목은 버전 정보 없이 URL과 함께 http_archive를 사용하여 지정됩니다. 즉, 다이아몬드 종속 항목의 경우 버전 확인을 실행할 수 있는 안정적인 방법이 없습니다(ABC에 종속되며 BC는 둘 다 서로 다른 D 버전에 종속됨).