종속 항목 관리

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

이전 페이지를 살펴보면 한 가지 테마가 반복해서 반복됩니다. 자체 코드를 관리하는 것은 매우 간단하지만 종속 항목을 관리하는 것이 훨씬 더 어렵습니다. 모든 종속 항목이 있습니다. 작업에 종속 항목이 있을 때도 있고(예: '출시를 완료로 표시하기 전에 문서 푸시'), 아티팩트에 종속 항목이 있는 경우도 있습니다(예: '코드를 빌드하려면 최신 버전의 컴퓨터 비전 라이브러리가 있어야 함'). 경우에 따라 코드베이스의 다른 부분에 내부 종속 항목이 있거나 코드 또는 타사 팀에서 외부 종속 항목을 소유하는 경우도 있습니다. 하지만 어떤 경우든 '이 작업을 수행하기 전에 필요한 것'은 빌드 시스템 설계에서 반복적으로 반복되며 종속 항목 관리는 빌드 시스템의 가장 기본적인 작업일 수 있습니다.

모듈 및 종속 항목 처리

Bazel과 같은 아티팩트 기반 빌드 시스템을 사용하는 프로젝트는 모듈 세트로 나뉘며 모듈은 BUILD 파일을 통해 서로의 종속 항목을 표현합니다. 이러한 모듈과 종속 항목을 올바르게 구성하면 빌드 시스템의 성능과 유지 관리 작업에 큰 영향을 미칠 수 있습니다.

세분화된 모듈 및 1:1:1 규칙 사용

아티팩트 기반 빌드를 구조화할 때 가장 먼저 떠오르는 질문은 개별 모듈이 얼마나 많은 기능을 포함해야 하는지 결정하는 것입니다. Bazel에서 모듈java_library 또는 go_binary과 같은 빌드 가능한 단위를 지정하는 대상으로 표시됩니다. 극단적으로 한 가지는 루트에 BUILD 파일을 넣고 해당 프로젝트의 모든 소스 파일을 재귀적으로 훑어보는 방식으로 전체 모듈을 단일 모듈에 포함할 수 있습니다. 다른 극단적인 경우 거의 모든 소스 파일을 자체 모듈로 만들어 각 파일에 종속되는 모든 파일을 BUILD 파일에 나열하도록 할 수 있습니다.

대부분의 프로젝트는 이러한 극단적인 수준에 해당하며, 성능과 유지관리 가능성 사이에서 절충해야 합니다. 전체 프로젝트에 단일 모듈을 사용하면 외부 종속 항목을 추가하는 경우를 제외하고 BUILD 파일을 터치할 필요가 없지만 빌드 시스템이 항상 전체 프로젝트를 한 번에 빌드해야 한다는 의미입니다. 즉, 빌드의 일부를 동시에 로드하거나 배포할 수 없으며 이미 빌드된 부분도 캐시할 수 없습니다. 파일당 모듈 한 개는 반대입니다. 빌드 시스템은 빌드의 캐싱 및 예약 단계에서 최대한의 유연성을 발휘하지만, 어느 파일이 어떤 파일을 참조할지 변경할 때마다 엔지니어는 종속 항목 목록을 유지관리하는 데 더 많은 노력을 기울여야 합니다.

정확한 세부사항은 언어 (경우에 따라 종종 다를 수 있음)에 따라 다르지만, Google에서는 일반적으로 작업 기반 빌드 시스템에 작성하는 모듈보다 훨씬 작은 모듈을 선호하는 경향이 있습니다. Google의 일반적인 프로덕션 바이너리는 종종 수만 개의 타겟에 따라 달라지며, 보통 규모의 팀도 코드베이스 내에서 수백 개의 타겟을 소유할 수 있습니다. 패키징과 같은 강력한 기본 제공 개념이 있는 자바와 같은 언어의 경우 각 디렉터리에는 일반적으로 단일 패키지, 대상 및 BUILD 파일이 포함됩니다. Bazel을 기반으로 하는 또 다른 빌드 시스템인 Pants는 이를 1:1:1 규칙이라고 합니다. 패키징 규칙이 약한 언어는 BUILD 파일당 여러 타겟을 정의하는 경우가 많습니다.

더 작은 빌드 타겟의 이점은 대규모로 빌드되기 시작하며, 더 빠르게 분산되는 빌드로 이어지고, 빌드 빈도는 낮아지기 때문입니다. 테스트에서 그림이 입력된 후에는 이점이 훨씬 더 강력해집니다. 즉, 빌드 시스템이 특정 변경사항의 영향을 받을 수 있는 제한된 일부 테스트만 실행하는 것에 대해 훨씬 더 스마트할 수 있게 되기 때문입니다. Google은 더 작은 타겟을 사용할 때 체계적인 이점이 있다고 믿기 때문에 개발자의 부담을 방지하기 위해 BUILD 파일을 자동으로 관리하는 도구에 투자함으로써 단점을 완화하기 시작했습니다.

buildifier, buildozer 등의 일부 도구는 buildtools 디렉터리의 Bazel에서 사용할 수 있습니다.

모듈 공개 상태 최소화

Bazel 및 기타 빌드 시스템을 사용하면 각 대상이 공개 상태를 지정할 수 있습니다. 가시성은 종속되는 종속 항목을 결정하는 속성입니다. 비공개 대상은 자체 BUILD 파일 내에서만 참조할 수 있습니다. 타겟은 명시적으로 정의된 BUILD 파일 목록의 대상에 관한 광범위한 가시성을 부여할 수 있으며, 공개 가시성의 경우에는 작업공간의 모든 대상에 더 넓은 가시성을 부여할 수도 있습니다.

대부분의 프로그래밍 언어와 마찬가지로 가시성을 최대한 최소화하는 것이 좋습니다. 일반적으로 Google의 팀은 타겟이 Google의 모든 팀에서 사용할 수 있는 널리 사용되는 라이브러리를 나타내는 경우에만 타겟을 공개로 설정합니다. 코드를 사용하기 전에 다른 팀원과 협력해야 하는 팀은 타겟의 공개 상태로 고객 타겟의 허용 목록을 유지합니다. 각 팀의 내부 구현 대상은 팀이 소유한 디렉터리로만 제한되며 대부분의 BUILD 파일에는 비공개가 아닌 타겟이 하나만 있습니다.

종속 항목 관리

모듈이 서로를 참조할 수 있어야 합니다. 코드베이스를 세분화된 모듈로 분할할 때의 단점은 모듈 간의 종속 항목을 관리해야 한다는 것입니다 (도구가 이를 자동화하는 데 도움이 될 수 있음). 이러한 종속 항목을 표현하면 일반적으로 BUILD 파일에 있는 콘텐츠의 대부분이 됩니다.

내부 종속 항목

세분화된 프로젝트에서 세분화된 대규모 프로젝트에서 대부분의 종속 항목은 내부에 있을 가능성이 높습니다. 즉, 동일한 소스 저장소에 정의되고 빌드된 다른 대상에 기반합니다. 내부 종속 항목은 빌드를 실행하는 동안 사전 빌드된 아티팩트로 다운로드되지 않고 소스에서 빌드된다는 점에서 외부 종속 항목과 다릅니다. 또한, 내부 종속 항목에는 '버전'이라는 개념이 없습니다. 즉, 대상 및 모든 내부 종속 항목이 항상 저장소에서 동일한 커밋/버전으로 빌드됩니다. 내부 종속 항목과 관련하여 신중하게 처리해야 하는 한 가지 문제는 전이 종속 항목을 처리하는 방법입니다 (그림 1). 타겟 A가 타겟 B에 종속되고, 이 라이브러리는 공통 라이브러리 타겟 C에 종속된다고 가정해 보겠습니다. 타겟 A는 타겟 C에 정의된 클래스를 사용할 수 있어야 하나요?

전이 종속 항목

그림 1. 전이 종속 항목

기본 도구에서는 문제가 없습니다. 빌드될 때 B와 C 모두 대상 A에 연결되므로 C에 정의된 모든 기호는 A로 알려져 있습니다. Bazel은 이를 수년간 허용해 왔지만 Google이 성장함에 따라 문제가 발생하기 시작했습니다. B가 더 이상 C에 종속될 필요가 없도록 리팩터링되었다고 가정해 보겠습니다. 그런 다음 B에 대한 C의 종속 항목이 삭제되면 A와 B의 종속 항목을 통해 C를 사용한 다른 대상이 중단됩니다. 실제로 타겟의 종속 항목은 공개 계약의 일부가 되어 안전하게 변경할 수 없습니다. 즉, 종속 항목이 시간이 지나면서 누적되어 Google에서 빌드 속도가 느려지기 시작했습니다.

Google은 Bazel에 '엄격한 전이 종속 모드'를 도입함으로써 이 문제를 해결했습니다. 이 모드에서 Bazel은 대상이 기호에 직접 의존하지 않고 기호를 참조하려고 하는지 여부를 확인한 경우 실패하는 경우 및 종속 항목을 자동으로 삽입하는 데 사용할 수 있는 셸 명령어와 함께 실패합니다. 이 변경사항을 Google의 전체 코드베이스에 적용하고 수백만 개의 빌드 타겟 중 하나를 리팩터링하여 종속 항목을 명시적으로 나열하는 것은 수년에 걸쳐 노력했지만 그만한 가치가 있었습니다. 이제 대상에 불필요한 종속 항목이 적기 때문에 빌드가 훨씬 빨라지고 엔지니어는 종속 항목에 종속되는 대상에 대한 걱정 없이 필요하지 않은 종속 항목을 삭제할 수 있습니다.

평소와 같이 엄격한 전이 종속 항목을 시행하면 절충해야 했습니다. 이제 자주 사용되는 라이브러리를 부수적으로 가져오기보다는 여러 위치에 명시적으로 나열해야 하고 엔지니어가 BUILD 파일에 종속 항목을 추가하는 데 더 많은 노력이 필요했기 때문입니다. 이후 Google은 누락된 많은 종속 항목을 자동으로 감지하고 개발자의 개입 없이 BUILD 파일에 추가하여 이러한 수고를 덜어주는 도구를 개발했습니다. 그러나 이러한 도구가 없더라도 코드베이스가 확장됨에 따라 절충할 만한 가치가 있는 것으로 확인되었습니다. BUILD 파일에 종속 항목을 명시적으로 추가하는 것은 일회성 비용이지만 빌드 대상이 있는 한 암시적 전이 종속 항목을 처리하면 지속적인 문제가 발생할 수 있습니다. Bazel은 기본적으로 자바 코드에 엄격한 전이 종속 항목을 적용합니다.

외부 종속 항목

종속 항목이 내부가 아닌 경우 종속 항목이어야 합니다. 외부 종속 항목은 빌드 시스템 외부에서 빌드되어 저장된 아티팩트의 종속 항목입니다. 종속 항목은 일반적으로 아티팩트 저장소 (인터넷을 통해 액세스)에서 직접 가져오며 소스에서 빌드되지 않고 그대로 사용합니다. 외부 종속 항목과 내부 종속 항목 간의 가장 큰 차이점 중 하나는 외부 종속 항목에는 버전이 있고 이러한 버전은 프로젝트의 소스 코드와는 독립적으로 존재한다는 점입니다.

자동 종속 항목과 수동 종속 항목 관리 비교

빌드 시스템에서 외부 종속 항목 버전을 수동 또는 자동으로 관리하도록 허용할 수 있습니다. 빌드 파일에서는 수동으로 관리할 때 아티팩트 저장소에서 다운로드할 버전을 명시적으로 나열합니다. 주로 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에서만 작동하므로 벤더링이 모든 조직에 적합한 옵션은 아닙니다.