권장사항

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

이 페이지에서는 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 파일을 그 하위 디렉터리에 추가해야 한다는 기호입니다. 이 구조가 길수록 순환 종속 항목이 의도치 않게 생성될 가능성이 높아지고 대상의 범위가 크립팅되며 증가하는 종속 항목 수를 업데이트해야 합니다.