이 페이지에서는 개발자가 Bazel에 익숙하며 Bazel의 기능을 최대한 활용할 수 있도록 프로젝트를 구성하는 방법에 대한 가이드라인과 조언을 제공합니다.
전반적인 목표는 다음과 같습니다.
- 세분화된 종속 항목을 사용하여 동시 로드 및 성과 증분을 허용하기 위해
- 종속 항목을 잘 캡슐화하기 위해
- 코드를 잘 구조화하고 테스트하기 쉽게 만들기 위해
- 이해하고 유지관리하기 쉬운 빌드 구성을 만들기 위해
이러한 가이드라인은 요구사항이 아니며, 모든 요구사항을 준수할 수 있는 프로젝트는 거의 없습니다. 린트의 man 페이지에는 '엄격한 검사를 통해 오류가 발생하지 않는 실제 프로그램을 생성하는 첫 번째 사람에게 특별한 보상이 제공됩니다.'라고 말합니다. 하지만 이러한 원칙을 최대한 많이 통합하면 프로젝트의 가독성이 높아지고 오류 발생 가능성이 줄어들며 프로젝트를 더 빠르게 빌드할 수 있습니다.
이 페이지에서는 이 RFC에 설명된 요구사항 수준을 사용합니다.
빌드 및 테스트 실행
프로젝트는 항상 안정적인 브랜치에서 bazel build //... 및 bazel test //...를 성공적으로 실행할 수 있어야 합니다. 필요하지만 특정 상황에서 빌드되지 않는 타겟 (예: 특정 빌드 플래그 필요, 특정 플랫폼에서 빌드하지 않음, 라이선스 계약 필요)은 최대한 구체적으로 태그를 지정해야 합니다 (예: 'requires-osx'). 이 태그 지정을 사용하면 타겟을 '수동' 태그보다 더 세분화하여 필터링할 수 있으며 BUILD 파일을 검사하여 타겟의 제한사항을 파악할 수 있습니다.
타사 종속 항목
서드 파티 종속 항목을 선언할 수 있습니다.
WORKSPACE파일에서 원격 저장소로 선언합니다.- 또는 작업공간 디렉터리 아래의
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 파일을 추가해야 한다는 신호입니다. 이 구조가 오래 존재할수록 순환 종속 항목이 의도치 않게 생성되고, 타겟의 범위가 증가하며, 점점 더 많은 수의 역 종속 항목이 업데이트되어야 합니다.