이전 페이지를 살펴보면서 한 가지 주제가 반복해서 반복됩니다. 자체 코드 관리는 상당히 간단하지만 종속 항목 관리는 훨씬 더 어렵습니다. 온갖 종류의 종속 항목이 있습니다. 작업 종속 항목(예: '출시를 완료로 표시하기 전에 문서 푸시')도 있고 아티팩트에 종속되기도 합니다(예: '코드를 빌드하려면 최신 버전의 컴퓨터 비전 라이브러리가 있어야 함'). 코드베이스의 다른 부분에 내부 종속 항목이 있거나 다른 팀이나 다른 조직에서 소유한 데이터가 외부 팀이나 조직에 있을 때도 있습니다. 그러나 '이 기능을 사용하려면 먼저 해야 한다'는 개념은 빌드 시스템 설계에서 반복적으로 나타나는 것이며 종속 항목 관리는 빌드 시스템의 가장 기본적인 작업일 것입니다.
모듈 및 종속 항목 처리
Bazel과 같은 아티팩트 기반 빌드 시스템을 사용하는 프로젝트는 모듈 집합으로 나뉘며, 모듈은 BUILD 파일을 통해 서로의 종속 항목을 표현하는 모듈로 구성됩니다. 이러한 모듈과 종속 항목을 올바르게 구성하면 빌드 시스템의 성능과 유지관리에 필요한 작업량에 모두 큰 영향을 미칠 수 있습니다.
세분화된 모듈 및 1:1:1 규칙 사용
아티팩트 기반 빌드를 구성할 때 제기되는 첫 번째 질문은 개별 모듈이 얼마나 많은 기능을 포함해야 하는지 결정하는 것입니다. Bazel에서 모듈은 java_library 또는 go_binary와 같이 빌드 가능한 단위를 지정하는 타겟으로 표현됩니다. 한 극단적으로는 루트에 하나의 BUILD 파일을 배치하고 이 프로젝트의 모든 소스 파일을 재귀적으로 함께 글로빙하여 전체 프로젝트를 단일 모듈에 포함할 수 있습니다. 또한 거의 모든 소스 파일을 자체 모듈로 만들 수 있으므로, 사실상 각 파일이 의존하는 다른 모든 파일에 BUILD 파일을 나열해야 합니다.
대부분의 프로젝트는 이러한 극단적인 수준 사이에 위치하며, 선택할 때는 성능과 유지관리성 사이에서 절충점을 찾아야 합니다. 전체 프로젝트에 단일 모듈을 사용하면 외부 종속 항목을 추가할 때를 제외하고는 BUILD 파일을 건드리지 않아도 되지만, 이는 빌드 시스템이 항상 전체 프로젝트를 항상 한 번에 빌드해야 한다는 것을 의미합니다. 즉, 빌드 일부를 병렬화하거나 배포할 수 없으며 이미 빌드된 부분을 캐시할 수도 없습니다. 파일당 모듈 1개는 반대입니다. 빌드 시스템은 빌드 단계의 캐싱 및 예약에 최대한의 유연성을 제공하지만, 엔지니어는 참조되는 파일을 변경할 때마다 종속 항목 목록을 유지하는 데 더 많은 노력을 기울입니다.
정확한 세부사항은 언어에 따라 다르며 종종 언어 내에서도 다르지만 Google은 일반적으로 작업 기반 빌드 시스템에서 작성하는 것보다 훨씬 작은 모듈을 선호하는 경향이 있습니다. Google의 일반적인 프로덕션 바이너리는 종종 수만 개의 타겟에 의존하며, 중간 규모의 팀도 코드베이스 내에 수백 개의 타겟을 소유할 수 있습니다. 강력한 패키징 개념이 내장된 Java와 같은 언어의 경우 각 디렉터리에는 일반적으로 단일 패키지, 타겟 및 BUILD 파일이 포함됩니다 (Bazel 기반의 또 다른 빌드 시스템인 Pants는 이를 1:1:1 규칙이라고 함). 패키징 규칙이 약한 언어는 BUILD 파일당 여러 타겟을 정의하는 경우가 많습니다.
작은 빌드 대상의 이점은 분산 빌드가 더 빨라지고 대상을 다시 빌드할 필요성이 줄어들기 때문에 실제로 대규모로 나타나기 시작합니다.
세밀한 타겟으로 빌드 시스템이 특정 변경사항의 영향을 받을 수 있는 제한된 테스트 하위 집합만 실행하는 데 있어서 훨씬 더 스마트해질 수 있으므로 테스트가 시작되면 이점은 더욱 매력적입니다. Google은 작은 타겟을 사용할 때 얻을 수 있는 시스템적 이점을 믿기 때문에 개발자에게 부담을 주지 않도록 BUILD 파일을 자동으로 관리하는 도구에 투자하여 단점을 완화하는 데 큰 진전을 이루었습니다.
이러한 도구 중 일부(예: buildifier 및 buildozer)는 buildtools 디렉터리에서 Bazel과 함께 제공됩니다.
모듈 공개 상태 최소화
Bazel 및 기타 빌드 시스템을 사용하면 각 대상이 가시성을 지정할 수 있습니다. 가시성은 가시성에 종속될 수 있는 다른 대상을 결정하는 속성입니다. 비공개 대상은 자체 BUILD 파일 내에서만 참조할 수 있습니다. 대상은 명시적으로 정의된 BUILD 파일 목록의 대상에 더 광범위한 가시성을 부여할 수 있으며, 공개 상태의 경우 작업공간의 모든 대상에 대해 더 광범위한 가시성을 부여할 수 있습니다.
대부분의 프로그래밍 언어와 마찬가지로 일반적으로 최대한 가시성을 최소화하는 것이 좋습니다. 일반적으로 Google 팀은 타겟이 Google의 모든 팀에서 사용할 수 있는 널리 사용되는 라이브러리를 나타내는 경우에만 타겟을 공개합니다.
코드를 사용하기 전에 다른 사람이 협력해야 하는 팀은 고객 타겟의 허용 목록을 대상의 가시성으로 유지합니다. 각 팀의 내부 구현 타겟은 팀이 소유한 디렉터리로만 제한되며 대부분의 BUILD 파일에는 비공개가 아닌 하나의 타겟만 있습니다.
종속 항목 관리
모듈은 서로 참조할 수 있어야 합니다. 코드베이스를 세분화된 모듈로 나누는 경우 이러한 모듈 간의 종속 항목을 관리해야 한다는 단점이 있습니다. 하지만 도구를 사용하면 이를 자동화할 수 있습니다. 이러한 종속 항목을 표현하면 일반적으로 BUILD 파일의 콘텐츠가 됩니다.
내부 종속 항목
세분화된 모듈로 분할된 대규모 프로젝트에서는 대부분의 종속 항목이 내부적일 가능성이 높습니다. 즉, 동일한 소스 저장소에 정의되고 빌드된 다른 대상에 종속될 수 있습니다. 내부 종속 항목은 빌드를 실행하는 동안 사전 빌드된 아티팩트로 다운로드되는 것이 아니라 소스에서 빌드된다는 점에서 외부 종속 항목과 다릅니다. 또한 내부 종속 항목에 '버전'이라는 개념이 없습니다. 대상과 모든 내부 종속 항목은 항상 저장소에서 동일한 커밋/수정으로 빌드됩니다. 내부 종속 항목과 관련하여 신중하게 처리해야 하는 한 가지 문제는 전이 종속 항목을 처리하는 방법입니다 (그림 1). 타겟 A가 공통 라이브러리 타겟 C에 종속되는 타겟 B에 종속된다고 가정해 보겠습니다. 대상 A가 대상 C에 정의된 클래스를 사용할 수 있어야 하나요?
그림 1. 전이 종속 항목
기본 도구와 관련된 한, 여기에는 문제가 없습니다. B와 C는 모두 빌드될 때 타겟 A에 연결되므로 C에 정의된 기호는 A가 알려져 있습니다. Bazel은 수년 동안 이것을 허용했지만 Google이 성장함에 따라 문제를 목격하기 시작했습니다. B가 더 이상 C에 종속될 필요가 없도록 리팩터링되었다고 가정해 보겠습니다. C에 관한 B의 종속 항목이 삭제되면 A와 B의 종속 항목을 통해 C를 사용한 다른 타겟이 중단됩니다. 사실상 대상의 종속 항목은 공개 계약의 일부가 되었고 안전하게 변경할 수 없습니다. 즉, 시간이 지남에 따라 종속 항목이 누적되고 Google의 빌드가 느려지기 시작했습니다.
Google은 결국 Bazel에 '엄격한 전이 종속 항목 모드'를 도입하여 이 문제를 해결했습니다. 이 모드에서 Bazel은 대상이 직접 의존하지 않고 기호를 참조하려고 하는지 감지하고, 참조하려고 하면 종속 항목을 자동으로 삽입하는 데 사용할 수 있는 오류 및 셸 명령어와 함께 실패합니다. Google의 전체 코드베이스에 이 변경사항을 적용하고 수백만 개의 빌드 타겟 중 하나를 모두 리팩터링하여 종속 항목을 명시적으로 나열하는 작업은 수년에 걸친 노력이 필요했지만 그만한 가치가 있습니다. 타겟에 불필요한 종속 항목이 줄어들기 때문에 이제 빌드 속도가 훨씬 빨라지고 엔지니어는 종속된 대상이 손상될까 봐 걱정할 필요 없이 필요하지 않은 종속 항목을 삭제할 수 있습니다.
평소와 같이 엄격한 전이 종속 항목을 적용하면 장단점이 있었습니다. 이제 자주 사용되는 라이브러리를 실수로 가져오는 대신 여러 위치에 명시적으로 나열해야 하고 엔지니어가 BUILD 파일에 종속 항목을 추가하는 데 더 많은 노력을 들여야 했기 때문에 빌드 파일이 더 상세해졌습니다. 이후 Google에서는 개발자의 개입 없이 다수의 누락된 종속 항목을 자동으로 감지하여 BUILD 파일에 추가하여 이러한 반복 업무를 줄이는 도구를 개발했습니다. 그러나 이러한 도구가 없어도 코드베이스가 확장됨에 따라 그에 따른 단점이 있습니다. BUILD 파일에 종속 항목을 명시적으로 추가하는 데는 일회성 비용이 들지만, 암시적 전이 종속 항목을 처리하면 빌드 타겟이 존재하는 한 지속적인 문제가 발생할 수 있습니다. Bazel은 기본적으로 자바 코드에 엄격한 전이 종속 항목을 적용합니다.
외부 종속 항목
종속 항목이 내부용이 아닌 경우 외부에 있어야 합니다. 외부 종속 항목은 빌드 시스템 외부에서 빌드되고 저장되는 아티팩트에 대한 종속 항목입니다. 종속 항목은 아티팩트 저장소에서 직접 가져와서 (일반적으로 인터넷을 통해 액세스) 소스에서 빌드되지 않고 있는 그대로 사용됩니다. 외부 종속 항목과 내부 종속 항목의 가장 큰 차이점 중 하나는 외부 종속 항목에 버전이 있으며 이러한 버전은 프로젝트의 소스 코드와는 별개로 존재한다는 점입니다.
종속 항목 자동 관리와 수동 종속 항목 관리 비교
빌드 시스템을 통해 외부 종속 항목의 버전을 수동 또는 자동으로 관리할 수 있습니다. 수동으로 관리하는 경우 buildfile은 아티팩트 저장소에서 다운로드하려는 버전을 명시적으로 나열하며, 대체로 1.1.4와 같은 시맨틱 버전 문자열을 사용합니다. 자동으로 관리되는 경우 소스 파일이 허용되는 범위의 범위를 지정하며, 빌드 시스템은 항상 최신 버전을 다운로드합니다. 예를 들어 Gradle에서는 종속 항목 버전을 '1.+'로 선언하여 주 버전이 1인 경우 종속 항목의 모든 부 버전 또는 패치 버전이 허용된다고 지정할 수 있습니다.
자동 관리형 종속 항목은 소규모 프로젝트에 편리할 수 있지만, 일반적으로 규모가 크지 않거나 둘 이상의 엔지니어가 작업을 수행하는 프로젝트에서는 재해의 원인이 됩니다. 자동으로 관리되는 종속 항목의 문제는 버전이 업데이트되는 시기를 개발자가 제어할 수 없다는 것입니다. (시맨틱 버전 관리를 사용한다고 주장하더라도) 외부 당사자가 브레이킹 체인지를 하지 않을 수 있다는 보장은 없습니다. 따라서 언젠가 작동한 빌드가 변경사항을 감지하거나 작동 상태로 롤백할 수 있는 쉬운 방법 없이 다음날 손상될 수 있습니다. 빌드가 중단되지 않더라도 추적할 수 없는 미묘한 동작이나 성능 변경사항이 있을 수 있습니다.
반면에 수동으로 관리하는 종속 항목은 소스 제어를 변경해야 하므로 쉽게 검색하고 롤백할 수 있으며, 이전 버전의 저장소를 체크아웃하여 이전 종속 항목으로 빌드할 수도 있습니다. Bazel을 사용하려면 모든 종속 항목의 버전을 수동으로 지정해야 합니다. 중간 규모라 할지라도 수동 버전 관리의 오버헤드는 안정성 측면에서 그만한 가치가 있습니다.
단일 버전 규칙
라이브러리의 서로 다른 버전은 일반적으로 서로 다른 아티팩트로 표현되므로, 이론적으로는 빌드 시스템에서 동일한 외부 종속 항목의 여러 버전을 다른 이름으로 모두 선언할 수 없을 이유가 없습니다. 이렇게 하면 각 대상에서 사용할 종속 항목 버전을 선택할 수 있습니다. 이로 인해 실제로 많은 문제가 발생하므로 Google에서는 코드베이스의 모든 서드 파티 종속 항목에 엄격한 단일 버전 규칙을 적용합니다.
여러 버전을 허용할 때 가장 큰 문제는 다이아몬드 종속 항목 문제입니다. 타겟 A가 타겟 B와 외부 라이브러리의 v1에 종속된다고 가정해 보겠습니다. 타겟 B가 나중에 동일한 외부 라이브러리의 v2 종속 항목을 추가하도록 리팩터링되는 경우 타겟 A는 이제 동일한 라이브러리의 두 다른 버전에 암시적으로 종속되므로 손상됩니다. 사실상 여러 버전의 서드 파티 라이브러리에 타겟의 새 종속 항목을 추가하는 것은 안전하지 않습니다. 해당 타겟의 사용자가 이미 다른 버전에 종속될 수 있기 때문입니다. 단일 버전 규칙을 따르면 이러한 충돌이 불가능합니다. 대상이 서드 파티 라이브러리에 종속 항목을 추가하면 기존 종속 항목은 이미 동일한 버전에 있으므로 공존할 수 있습니다.
전이 외부 종속 항목
외부 종속 항목의 전이 종속 항목을 처리하는 것은 특히 어려울 수 있습니다. Maven Central과 같은 많은 아티팩트 저장소에서 아티팩트가 저장소에 있는 다른 아티팩트의 특정 버전에 종속 항목을 지정할 수 있도록 합니다. Maven 또는 Gradle과 같은 빌드 도구는 기본적으로 각 전이 종속 항목을 재귀적으로 다운로드합니다. 즉, 프로젝트에 단일 종속 항목을 추가하면 총 수십 개의 아티팩트가 다운로드될 수 있습니다.
이는 매우 편리합니다. 새 라이브러리에 종속 항목을 추가할 때 각 라이브러리의 전이 종속 항목을 추적하고 모두 수동으로 추가해야 하기 때문에 매우 편리합니다. 하지만 큰 단점도 있습니다. 서로 다른 라이브러리가 동일한 서드 파티 라이브러리의 서로 다른 버전에 종속될 수 있기 때문에 이 전략은 필연적으로 단일 버전 규칙을 위반하고 다이아몬드 종속 항목 문제로 이어집니다. 타겟이 동일한 종속 항목의 서로 다른 버전을 사용하는 두 개의 외부 라이브러리에 종속된 경우 어느 라이브러리를 얻게 될지 알 수 없습니다. 즉, 새 버전이 일부 종속 항목의 충돌하는 버전을 가져오기 시작하면 외부 종속 항목을 업데이트하면 코드베이스 전체에서 관련이 없어 보이는 오류가 발생할 수 있습니다.
이러한 이유로 Bazel은 전이 종속 항목을 자동으로 다운로드하지 않습니다.
안타깝게도 만병통치약은 없습니다. Bazel의 대안은 저장소의 외부 종속 항목을 모두 나열하는 전역 파일과 저장소 전체에서 해당 종속 항목에 사용되는 명시적 버전을 요구하는 것입니다. 다행히 Bazel은 Maven 아티팩트 집합의 전이 종속 항목이 포함된 이러한 파일을 자동으로 생성할 수 있는 도구를 제공합니다. 이 도구를 한 번 실행하여 프로젝트의 초기 WORKSPACE 파일을 생성한 다음 이 파일을 수동으로 업데이트하여 각 종속 항목의 버전을 조정할 수 있습니다.
그러나 여기서 선택은 편의성과 확장성 중 하나입니다. 소규모 프로젝트는 전이 종속 항목 자체 관리를 걱정할 필요가 없고 자동 전이 종속 항목을 사용하지 않아도 될 수 있습니다. 조직과 코드베이스가 커지고 충돌과 예기치 않은 결과가 점점 더 자주 발생하면 이 전략의 매력도가 떨어집니다. 규모가 클수록 종속 항목을 수동으로 관리하는 비용이 자동 종속 항목 관리로 인해 발생하는 문제를 처리하는 비용보다 훨씬 적습니다.
외부 종속 항목을 사용하여 빌드 결과 캐싱
외부 종속 항목은 대부분 소스 코드를 제공하지 않고 안정화 버전의 라이브러리를 출시하는 서드 파티에서 제공합니다. 일부 조직에서는 자체 코드 중 일부를 아티팩트로 사용할 수도 있습니다. 이를 통해 다른 코드 조각이 내부 종속 항목이 아닌 서드 파티로 종속될 수 있습니다. 아티팩트 빌드 속도는 느리지만 다운로드는 빠른 경우 이론적으로 빌드 속도를 높일 수 있습니다.
하지만 이로 인해 많은 오버헤드와 복잡성이 발생합니다. 누군가가 이러한 각 아티팩트를 빌드하여 아티팩트 저장소에 업로드해야 하며 클라이언트는 최신 버전을 최신 상태로 유지해야 합니다. 또한 시스템의 여러 부분이 저장소의 여러 지점에서 빌드되고 더 이상 소스 트리가 일관적으로 표시되지 않기 때문에 디버깅이 훨씬 더 어려워집니다.
빌드하는 데 시간이 오래 걸리는 아티팩트 문제를 해결하는 더 좋은 방법은 앞에서 설명한 대로 원격 캐싱을 지원하는 빌드 시스템을 사용하는 것입니다. 이러한 빌드 시스템은 모든 빌드의 결과 아티팩트를 엔지니어가 공유하는 위치에 저장하므로 개발자가 최근에 다른 사람이 빌드한 아티팩트를 사용하는 경우 빌드 시스템은 아티팩트를 빌드하는 대신 자동으로 다운로드합니다. 이렇게 하면 아티팩트에 직접 의존하는 경우의 모든 성능 이점을 제공하는 동시에 빌드가 항상 동일한 소스에서 빌드된 것처럼 일관되도록 보장할 수 있습니다. 이는 Google 내부에서 사용하는 전략이며, Bazel은 원격 캐시를 사용하도록 구성할 수 있습니다.
외부 종속 항목의 보안 및 안정성
서드 파티 소스의 아티팩트에 의존하는 것은 본질적으로 위험합니다. 서드 파티 소스 (예: 아티팩트 저장소)가 다운되면 외부 종속 항목을 다운로드할 수 없는 경우 전체 빌드가 중단될 수 있으므로 가용성 위험이 있습니다. 보안 위험도 있습니다. 공격자가 서드 파티 시스템을 해킹하면 공격자가 참조된 아티팩트를 자체 설계 중 하나로 바꿔서 임의의 코드를 빌드에 삽입할 수 있습니다. 사용하는 아티팩트를 개발자가 제어하는 서버에 미러링하고 빌드 시스템이 Maven Central과 같은 서드 파티 아티팩트 저장소에 액세스하지 못하도록 차단하여 두 가지 문제를 완화할 수 있습니다. 단, 이러한 미러를 유지하려면 노력과 리소스가 필요하므로 사용 여부는 프로젝트의 규모에 따라 달라지는 경우가 많습니다. 또한 소스 저장소에 각 서드 파티 아티팩트의 해시를 지정하도록 요구함으로써, 아티팩트가 조작되면 빌드가 실패하게 함으로써 최소한의 오버헤드로 보안 문제를 완전히 방지할 수 있습니다. 이 문제를 완전히 회피하는 또 다른 대안은 프로젝트의 종속 항목을 벤더링하는 것입니다. 프로젝트는 종속 항목을 소스 또는 바이너리로 프로젝트의 소스 코드와 함께 소스 제어에 확인합니다. 이는 사실상 프로젝트의 모든 외부 종속 항목이 내부 종속 항목으로 변환됩니다. Google은 내부적으로 이 접근 방식을 사용하여 Google에서 참조된 모든 서드 파티 라이브러리를 Google 소스 트리 루트에 있는 third_party 디렉터리에 확인합니다. 그러나 이는 Google의 소스 제어 시스템이 매우 큰 모노레포를 처리하도록 맞춤 빌드되었기 때문에 Google에서만 효과가 있으므로, 벤더링은 모든 조직에 옵션으로 적합하지 않을 수 있습니다.