이전 페이지를 살펴보면 한 가지 주제가 계속 반복됩니다. 자체 코드는 상당히 간단하지만 종속 항목을 관리하는 것은 더 어려워집니다 온갖 종류의 종속 항목이 있습니다. 작업에 종속되지 않도록 해야 합니다 (예: '버전을 온전히 처리되어야 하고 때로는 아티팩트에 종속된 경우 (예: 최신 버전의 컴퓨터 비전 라이브러리를 설치해야 함'). 때로는 코드베이스의 다른 부분에 내부 종속 항목이 있습니다. 다른 팀이 소유한 코드나 데이터에 외부 종속 항목이 있는 경우가 있습니다. 이러한 권한을 부여할 수 있습니다. 그러나 어쨌든 "나는 '필요할 것 같아서'라는 생각은 '이거 먹고 싶은데?'라는 생각이 종속 항목 관리는 아마도 가장 중요한 부분일 겁니다 빌드 시스템의 기본적인 작업을 담당합니다
모듈 및 종속 항목 처리
Bazel과 같은 아티팩트 기반 빌드 시스템을 사용하는 프로젝트는 모듈 집합으로 분할되며, 모듈은 BUILD 파일을 통해 서로의 종속 항목을 표현합니다. 이러한 모듈과 종속 항목을 적절하게 구성하면 빌드 시스템의 성능과 유지관리에 드는 작업량에 큰 영향을 미칠 수 있습니다.
세분화된 모듈과 1:1:1 규칙 사용
아티팩트 기반 빌드를 구성할 때 가장 먼저 발생하는 질문은 개별 모듈이 포함해야 하는 기능의 양을 결정하는 것입니다. Bazel에서
모듈은 다음과 같이 빌드 가능한 단위를 지정하는 대상으로 표현됩니다.
java_library 또는 go_binary입니다. 한쪽 극단에서는 BUILD 파일 하나를 루트에 배치하고 해당 프로젝트의 모든 소스 파일을 재귀적으로 모아 globbing하여 전체 프로젝트를 단일 모듈에 포함할 수 있습니다. 반대로 거의 모든 소스 파일을 자체 모듈로 만들 수 있으므로 각 파일은 종속되는 다른 모든 파일을 BUILD 파일에 나열해야 합니다.
대부분의 프로젝트는 이러한 극단 사이 어딘가에 있으며, 선택 시 성능과 유지보수성 간의 절충이 필요합니다. 전체 프로젝트에 단일 모듈을 사용하면 외부 종속 항목을 추가할 때를 제외하고 BUILD 파일을 건드릴 필요가 없을 수도 있지만, 빌드 시스템은 항상 전체 프로젝트를 한 번에 빌드해야 합니다. 즉, 빌드의 일부를 병렬화하거나 배포할 수 없으며 이미 빌드된 부분을 캐시할 수도 없습니다. 파일당 모듈 하나는 그 반대입니다. 빌드 시스템은 빌드 단계의 캐싱 및 예약에 최대한의 유연성을 제공하지만 엔지니어는 어떤 파일이 어떤 파일을 참조하는지 변경할 때마다 종속 항목 목록을 유지하는 데 더 많은 노력을 기울여야 합니다.
정확한 세부사항은 언어마다 다르며 언어 내에서도 다를 수 있지만 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가 타겟 B에 종속되어 있다고 가정해 보겠습니다 공통 라이브러리 타겟 C에 종속됩니다. 타겟 A가 타겟 C에 정의된 클래스를 사용할 수 있어야 하나요?
그림 1. 전이 종속 항목
기본 도구에 관한 한, 여기에는 아무런 문제가 없습니다. 둘 다 B와 C는 빌드될 때 대상 A에 링크되므로 C는 A에 알려져 있습니다. Bazel은 수년 동안 이것을 허용했지만, Google이 성장함에 따라 문제가 관찰되기 시작했습니다 B가 리팩터링되어 더 이상 C에 의존해야 했습니다. C에 대한 B의 종속 항목이 삭제되면 A 및 B의 종속 항목을 통해 C를 사용한 타겟이 중단됩니다. 효과적으로, 표적의 종속 항목이 공개 계약의 일부가 되어 변경할 수 있습니다. 즉, 시간이 지남에 따라 종속 항목이 누적되고 Google 점차 느려지기 시작했습니다
Google은 결국 '엄격한 전이적' 종속 항목 모드'를 참조하세요. 이 모드에서 Bazel은 대상이 참조하지 않고 기호를 참조할 수 있으며, 그러면 자동으로 삽입하는데 사용할 수 있는 셸 명령과 종속됩니다. 이 변경사항을 Google의 전체 코드베이스와 수백만 개의 빌드 대상을 리팩터링하여 수년간의 노력이 필요했지만 그만한 가치가 있었습니다. 이제 타겟에 불필요한 종속 항목이 적으므로 빌드 속도가 훨씬 빨라졌으며 엔지니어는 종속 항목에 종속된 타겟이 손상되는 것을 걱정하지 않고 필요하지 않은 종속 항목을 삭제할 수 있습니다.
평소와 같이 엄격한 전이 종속 항목을 적용하면 절충점이 있습니다. 자주 사용되는 라이브러리를 부수적으로 가져오는 대신 여러 위치에 명시적으로 나열해야 하므로 빌드 파일이 더 장황해지고 엔지니어가 BUILD 파일에 종속 항목을 추가하는 데 더 많은 노력을 기울여야 했습니다. 이후 Google은 누락된 많은 종속 항목을 자동으로 감지하고 개발자 개입 없이 BUILD 파일에 추가하여 이러한 수고를 덜어주는 도구를 개발했습니다. 하지만 이러한 도구가 없어도 코드베이스가 확장될 때는 그만한 가치가 있는 것으로 확인되었습니다. BUILD 파일에 종속 항목을 명시적으로 추가하는 것은 일회성 비용이지만 암시적 전이 종속 항목을 처리하면 빌드 타겟이 존재하는 한 지속적인 문제가 발생할 수 있습니다. Bazel은 기본적으로 Java 코드에 엄격한 전이 종속 항목을 적용합니다.
외부 종속 항목
종속 항목이 내부가 아닌 경우 외부 종속 항목이어야 합니다. 외부 종속 항목은 빌드 시스템 외부에서 빌드되고 저장된 아티팩트에 있는 종속 항목입니다. 이 아티팩트 저장소에서 직접 가져와서 소스 기반 빌드가 아닌 있는 그대로 사용됩니다. 외부 종속 항목과 내부 종속 항목의 가장 큰 차이점 중 하나는 외부 종속 항목에는 버전이 있고 이러한 버전은 프로젝트의 소스 코드와 별개로 존재한다는 것입니다.
종속 항목 자동 관리와 수동 종속 항목 관리 비교
빌드 시스템에서 외부 종속 항목의 버전을 관리할 수 있음
선택할 수 있습니다 수동으로 관리하는 경우 buildfile은
아티팩트 저장소에서 다운로드하려는 버전을 명시적으로 나열한 것입니다.
종종 다음과 같이 의미론적 버전 문자열을 사용합니다.
1.1.4 형식으로 입력하세요. 자동으로 관리되는 경우 소스 파일은
빌드 시스템이 항상 최신 버전을 다운로드합니다. 예를 들어 Gradle에서는 종속 항목 버전을 '1.+'로 선언하여 주 버전이 1이면 종속 항목의 부 버전 또는 패치 버전이 허용된다고 지정할 수 있습니다.
자동 관리 종속 항목은 소규모 프로젝트에는 편리할 수 있지만, 일반적으로 규모가 상당하거나 두 명 이상의 엔지니어가 작업하는 프로젝트에서는 재앙이 될 수 있습니다. 자동으로 관리되는 종속 항목의 문제는 버전이 업데이트되는 시점을 제어할 수 없다는 점입니다. 외부 서드파티가 수익을 창출하는 것을 방지할 수 있는 방법은 없습니다. 의미론적 버전 관리를 사용한다고 주장하는 경우에도) 어떤 날은 잘 작동하다가 다음 날엔 고장날 수 있으며 변경된 것을 쉽게 감지할 수 있는 방법이 없습니다. 작동 상태로 롤백할 수 있습니다 빌드가 중단되지 않더라도 추적할 수 없는 미묘한 동작이나 성능 변화가 있을 수 있습니다.
반면에 수동으로 관리하는 종속 항목에는 소스를 변경해야 하므로 쉽게 검색 및 롤백될 수 있으며 이전 버전의 저장소를 확인하여 이전 종속 항목으로 빌드합니다. Bazel에서는 모든 종속 항목의 버전을 수동으로 지정해야 합니다. 짝수 중간 규모라면 수동 버전 관리의 오버헤드는 충분히 그만한 가치가 있습니다. 안정성이 떨어질 수 있습니다
단일 버전 규칙
라이브러리의 여러 버전은 일반적으로 서로 다른 아티팩트로 표시되므로 이론적으로 동일한 외부 종속 항목의 여러 버전을 빌드 시스템에서 서로 다른 이름으로 모두 선언할 수 없는 이유는 없습니다. 이렇게 하면 각 대상은 원하는 종속 항목 버전을 선택할 수 있습니다. 있습니다. 이것은 실제로 많은 문제를 일으키므로 Google은 엄격한 단일 버전 규칙 코드베이스에 있는 모든 서드 파티 종속 항목에 적용됩니다.
여러 버전을 허용할 때 발생하는 가장 큰 문제는 다이아몬드 종속 항목임 있습니다. 타겟 A가 타겟 B 및 외부 라이브러리의 v1에 종속된다고 가정해 보겠습니다. 타겟 B가 나중에 리팩터링되어 동일한 v2의 종속 항목을 추가하는 경우 외부 라이브러리, 이제 타겟 A가 2에 암시적으로 의존하므로 타겟 A가 중단됩니다. 여러 버전을 생성할 수 있습니다 사실, 페이지에 태그를 추가하는 것은 대상에서 여러 버전이 있는 서드 파티 라이브러리로의 새로운 종속 항목 왜냐하면 해당 타겟의 사용자가 이미 다른 목표에 있습니다. 단일 버전 규칙을 따르다 보면 이러한 충돌이 대상은 서드 파티 라이브러리, 기존 종속 항목에 대한 종속 항목을 추가합니다. 이미 같은 버전을 사용하고 있기 때문에 행복하게 공존할 수 있습니다
전이 외부 종속 항목
외부 종속 항목의 전이 종속 항목을 처리하는 것은 특히 어려울 수 있습니다. Maven Central과 같은 많은 아티팩트 저장소에서는 아티팩트가 저장소의 다른 아티팩트의 특정 버전에 대한 종속 항목을 지정할 수 있습니다. Maven 또는 Gradle과 같은 빌드 도구는 기본적으로 각 전이 종속 항목을 재귀적으로 다운로드하는 경우가 많습니다. 즉, 프로젝트에 단일 종속 항목을 추가하면 총 수십 개의 아티팩트가 다운로드될 수 있습니다.
이는 매우 편리합니다. 새 라이브러리에 종속 항목을 추가할 때 라이브러리의 전이 종속 항목을 각각 추적해야 하는 큰 어려움이 있습니다. 모두 수동으로 추가할 수 있습니다 하지만 큰 단점도 있습니다. 동일한 서드 파티 라이브러리의 서로 다른 버전에 종속될 수 있습니다. 전략은 반드시 단일 버전 규칙을 위반하고 다이아몬드로 이끄는 것입니다. 종속 항목 문제일 수 있습니다. 타겟이 같은 종속 항목의 다른 버전이 있다면 어떤 버전을 사용하게 될지 get입니다. 즉, 외부 종속 항목을 업데이트하면 새 버전이 새 버전을 가져오기 시작하면 코드베이스 전체에서 충돌 버전을 해결해야 하기 때문입니다
따라서 Bazel은 전이 종속 항목을 자동으로 다운로드하지 않습니다.
안타깝게도 만병통치약은 없습니다. Bazel의 대안은
해당 저장소의 모든 외부 저장소가 나열된
종속 항목 및 해당 종속 항목에 사용되는 명시적 버전을
저장소 다행히 Bazel은 코드를 자동으로 생성할 수 있는
Maven 집합의 전이 종속 항목이 포함된 파일을 생성합니다.
아티팩트를 생성합니다. 이 도구를 한 번 실행하여 프로젝트의 초기 WORKSPACE 파일을 생성할 수 있으며, 그런 다음 이 파일을 수동으로 업데이트하여 각 종속 항목의 버전을 조정할 수 있습니다.
여기서도 편의성과 확장성 중에서 선택해야 합니다. 소규모 프로젝트는 전이 종속 항목 자체를 관리하는 데 신경 쓰지 않는 것이 좋으며 자동 전이 종속 항목을 사용해도 됩니다. 이 전략은 조직과 코드베이스가 커지고 충돌과 예상치 못한 결과가 점점 더 자주 발생함에 따라 점점 매력적이지 않게 됩니다. 대규모의 경우 종속 항목을 수동으로 관리하는 비용은 자동 종속 항목 관리로 인한 문제를 처리하는 비용보다 훨씬 적습니다.
외부 종속 항목을 사용하여 빌드 결과 캐싱
외부 종속 항목은 대체로 서드 파티에서 제공합니다. 안정화된 버전의 라이브러리를 제공할 수 있습니다. 다소 유용함 조직은 또한 자체 코드 중 일부를 사용하여 다른 코드 조각이 이 아티팩트를 서드 파티가 아닌 더 효율적입니다 이렇게 하면 이론적으로 아티팩트가 생성된 경우 빌드 속도를 높일 수 빌드는 느리지만 다운로드도 빠릅니다
그러나 이는 많은 오버헤드와 복잡성을 초래합니다. 각 아티팩트를 빌드하고 최신 상태로 유지해야 하며, 클라이언트는 최신 버전으로 업데이트합니다. 또한 디버깅이 훨씬 더 어려워집니다. 시스템의 나머지 부분이 빌드될 수 있는 더 이상 소스 트리의 일관된 뷰가 없습니다.
빌드하는 데 시간이 오래 걸리는 아티팩트 문제를 해결하는 더 좋은 방법은 원격 캐싱을 지원하는 빌드 시스템을 사용해야 합니다. 이러한 빌드 시스템은 모든 빌드의 결과 아티팩트를 엔지니어 간에 공유되는 위치에 저장하므로 개발자가 다른 사람이 최근에 빌드한 아티팩트를 사용하는 경우 빌드 시스템은 빌드하는 대신 자동으로 다운로드합니다. 이렇게 하면 아티팩트에 직접 종속되도록 하면서 빌드가 항상 동일한 소스에서 빌드된 것처럼 일관성이 있어야 합니다. 이는 Google에서 내부적으로 사용하는 전략이며 Bazel은 원격 캐시를 사용하도록 구성할 수 있습니다.
외부 종속 항목의 보안 및 안정성
서드 파티 소스의 아티팩트에 의존하는 것은 본질적으로 위험합니다. 여기에는
가용성 위험은 여전히 제3자 소스 (아티팩트 저장소 등)가
다운로드할 수 없는 경우에는 전체 빌드가 중단될 수도 있기 때문입니다.
외부 종속 항목이
포함되어 있습니다 또한 보안 위험이 있습니다. 서드 파티 시스템이
공격자가 이미 참조된 링크를 교체하여
임의의 코드를 주입할 수 있도록 하기 위해
넣으세요. 이 두 가지 문제는 개발자가 생성한 아티팩트를 미러링하여
제어하는 서버에 종속되며 빌드 시스템의 액세스를 차단하여
Maven Central과 같은 서드 파티 아티팩트 저장소에 적합합니다 단점은
이러한 미러는 유지관리에 노력과 리소스가 필요하므로
프로젝트의 규모에 따라 달라질 수 있습니다 또한 보안 문제는
각 객체의 해시를 요구하여 약간의 오버헤드로 완전히 방지할 수 있습니다.
소스 저장소에 지정된 서드 파티 아티팩트로 인해 빌드가
오류가 발생할 수 있습니다 이 문제를 완전히 우회하는 또 다른 방법은 프로젝트의 종속 항목을 공급업체에 제공하는 것입니다. 프로젝트가 종속 항목을 제공하는 경우 프로젝트의 소스 코드와 함께 소스 또는 바이너리로 소스 제어에 체크인합니다. 즉, 프로젝트의 모든 외부 종속 항목이 내부 종속 항목으로 변환됩니다. Google은 이 접근 방식을 내부적으로 사용하여 Google 전반에서 참조되는 모든 서드 파티 라이브러리를 Google 소스 트리의 루트에 있는 third_party 디렉터리로 확인합니다. 하지만 이는 Google의 소스 제어 시스템이 매우 큰 모노레포를 처리하도록 맞춤 빌드되었기 때문에 Google에서만 작동하므로 모든 조직에 공급업체를 이용하는 것이 적합하지 않을 수 있습니다.