이 페이지에서는 개발자가 Bazel에 익숙하며 Bazel의 기능을 최대한 활용할 수 있도록 프로젝트를 구성하는 방법에 대한 가이드라인과 조언을 제공합니다.
전체 목표는 다음과 같습니다.
- 세분화된 종속 항목을 사용하여 병렬 처리와 증분성을 허용합니다.
- 종속 항목을 잘 캡슐화하기 위해
- 코드를 잘 구조화하고 테스트 가능하게 만들기 위해
- 이해하고 유지관리하기 쉬운 빌드 구성을 만들기 위해
이 가이드라인은 요구사항이 아닙니다. 모든 프로젝트가 이를 준수할 수는 없습니다. 린트의 man 페이지에 따르면 '엄격한 검사로 오류를 전혀 발생시키지 않는 실제 프로그램을 처음으로 작성한 사람에게는 특별한 보상이 제공됩니다.' 그러나 이러한 원칙을 최대한 많이 통합하면 프로젝트의 가독성이 높아지고 오류 발생 가능성이 줄어들며 프로젝트를 더 빠르게 빌드할 수 있습니다.
이 페이지에서는 이 RFC에 설명된 요구사항 수준을 사용합니다.
빌드 및 테스트 실행
프로젝트는 항상 안정적인 브랜치에서 bazel build //... 및 bazel test //...를 실행할 수 있어야 합니다. 필요한 타겟이지만 특정 상황에서 빌드되지 않는 타겟 (예: 특정 빌드 플래그 필요, 특정 플랫폼에서 빌드되지 않음, 라이선스 계약 필요)은 최대한 구체적으로 태그를 지정해야 합니다 (예: 'requires-osx'). 이렇게 태그를 지정하면 '수동' 태그보다 더 세분화된 수준에서 타겟을 필터링할 수 있으며 BUILD 파일을 검사하는 사용자가 타겟의 제한사항을 파악할 수 있습니다.
타사 종속 항목
서드 파티 종속 항목을 선언할 수 있습니다.
MODULE.bazel파일에서 원격 저장소로 선언합니다.- 또는 작업공간 디렉터리의
third_party/디렉터리에 배치합니다.
바이너리에 따라 다름
가능하면 모든 것을 소스에서 빌드해야 합니다. 일반적으로 이는 라이브러리 some-library.so에 종속되는 대신 BUILD 파일을 만들고 소스에서 some-library.so를 빌드한 다음 해당 타겟에 종속된다는 것을 의미합니다.
항상 소스에서 빌드하면 호환되지 않는 플래그나 다른 아키텍처로 빌드된 라이브러리를 사용하지 않습니다. 또한 노출 범위, 정적 분석 또는 동적 분석과 같이 소스에서만 작동하는 일부 특성도 있습니다.
버전 관리
가능하면 헤드에서 모든 코드를 빌드하는 것이 좋습니다. 버전을 사용해야 하는 경우 타겟 이름에 버전을 포함하지 마세요 (예: //guava-20.0이 아닌 //guava). 이렇게 이름을 지정하면 라이브러리를 더 쉽게 업데이트할 수 있습니다 (타겟 하나만 업데이트하면 됨). 다이아몬드 종속 항목 문제에 대해서도 더 탄력적입니다. 한 라이브러리가 guava-19.0에 종속되고 다른 라이브러리가 guava-20.0에 종속되는 경우 두 가지 버전에 종속하려는 라이브러리가 생성될 수 있습니다.
두 타겟을 하나의 guava 라이브러리로 가리키는 혼동을 야기하는 별칭을 만든 경우 BUILD 파일이 혼동을 야기합니다.
.bazelrc 파일 사용
프로젝트별 옵션의 경우 workspace/.bazelrc의 구성 파일을 사용하세요(bazelrc 형식 참고).
소스 제어에 체크인하지 않으려는 프로젝트의 사용자별 옵션을 지원하려면 다음 줄을 포함합니다.
try-import %workspace%/user.bazelrc
(또는 다른 파일 이름)을 workspace/.bazelrc에 추가하고 user.bazelrc을 .gitignore에 추가합니다.
패키지
빌드 가능한 파일이 포함된 모든 디렉터리는 패키지여야 합니다. BUILD 파일이 하위 디렉터리의 파일 (예: srcs = ["a/b/C.java"])을 참조하는 경우 BUILD 파일을 해당 하위 디렉터리에 추가해야 한다는 신호입니다. 이 구조가 존재하는 시간이 길어질수록 의도치 않게 순환 종속 항목이 생성되고 타겟의 범위가 확장되며 점점 더 많은 역종속 항목을 업데이트해야 합니다.