이 튜토리얼에서는 Bazel을 사용하여 사전 제작된 Bazel 프로젝트를 사용하여 코드의 종속 항목을 추적하는 방법을 다룹니다.
언어 및 --output
플래그 세부정보는 Bazel 쿼리 참조 및 Bazel cquery 참조 매뉴얼을 확인하세요. 명령줄에 bazel help query
또는 bazel help cquery
를 입력하여 IDE에서 도움을 받으세요.
목표
이 가이드에서는 프로젝트의 파일 종속 항목을 자세히 알아보는 데 사용할 수 있는 기본 쿼리 집합을 설명합니다. Bazel 및 BUILD
파일의 작동 방식에 관한 기본 지식이 있는 신규 Bazel 개발자를 대상으로 합니다.
기본 요건
아직 설치하지 않았다면 먼저 Bazel을 설치합니다. 이 튜토리얼에서는 Git을 소스 제어에 사용하므로 최상의 결과를 얻으려면 Git도 설치하세요.
종속 항목 그래프를 시각화하려면 Graphviz라는 도구를 사용합니다. 이 도구를 다운로드하여 따라해 보세요.
샘플 프로젝트 가져오기
다음으로 선택한 명령줄 도구에서 다음을 실행하여 Bazel의 예시 저장소에서 샘플 앱을 검색합니다.
git clone https://github.com/bazelbuild/examples.git
이 가이드의 샘플 프로젝트는 examples/query-quickstart
디렉터리에 있습니다.
시작하기
Bazel 쿼리란 무엇인가요?
쿼리는 BUILD
파일 간의 관계를 분석하고 결과 출력에서 유용한 정보를 검사하여 Bazel 코드베이스에 관해 알아보는 데 도움이 됩니다. 이 가이드에서는 몇 가지 기본 쿼리 함수를 미리 보지만 더 많은 옵션은 쿼리 가이드를 참조하세요. 쿼리를 사용하면 BUILD
파일을 수동으로 탐색하지 않고도 대규모 프로젝트의 종속 항목에 관해 알아볼 수 있습니다.
쿼리를 실행하려면 명령줄 터미널을 열고 다음을 입력합니다.
bazel query 'query_function'
시나리오
카페 바젤과 각 셰프 사이의 관계를 자세히 다루는 시나리오를 상상해 보세요. 피자와 맥 앤 치즈만 판매하는 카페입니다. 프로젝트가 어떻게 구성되어 있는지 아래에서 살펴보세요.
bazelqueryguide
├── BUILD
├── src
│ └── main
│ └── java
│ └── com
│ └── example
│ ├── customers
│ │ ├── Jenny.java
│ │ ├── Amir.java
│ │ └── BUILD
│ ├── dishes
│ │ ├── Pizza.java
│ │ ├── MacAndCheese.java
│ │ └── BUILD
│ ├── ingredients
│ │ ├── Cheese.java
│ │ ├── Tomatoes.java
│ │ ├── Dough.java
│ │ ├── Macaroni.java
│ │ └── BUILD
│ ├── restaurant
│ │ ├── Cafe.java
│ │ ├── Chef.java
│ │ └── BUILD
│ ├── reviews
│ │ ├── Review.java
│ │ └── BUILD
│ └── Runner.java
└── WORKSPACE
이 튜토리얼에서는 달리 지시가 없는 한 BUILD
파일에서 필요한 정보를 찾지 말고 쿼리 함수만 사용합니다.
프로젝트는 카페를 구성하는 다양한 패키지로 구성됩니다. restaurant
, ingredients
, dishes
, customers
, reviews
로 구분됩니다. 이러한 패키지의 규칙은 다양한 태그와 종속 항목으로 카페의 여러 구성요소를 정의합니다.
빌드 실행
이 프로젝트에는 카페의 메뉴를 출력하기 위해 실행할 수 있는 Runner.java
내부의 기본 메서드가 포함되어 있습니다. bazel build
명령어와 함께 Bazel을 사용하여 프로젝트를 빌드하고 :
를 사용하여 대상 이름이 runner
임을 알립니다. 대상을 참조하는 방법은 대상 이름을 참조하세요.
이 프로젝트를 빌드하려면 터미널에 다음 명령어를 붙여넣습니다.
bazel build :runner
빌드에 성공하면 출력은 다음과 같습니다.
INFO: Analyzed target //:runner (49 packages loaded, 784 targets configured).
INFO: Found 1 target...
Target //:runner up-to-date:
bazel-bin/runner.jar
bazel-bin/runner
INFO: Elapsed time: 16.593s, Critical Path: 4.32s
INFO: 23 processes: 4 internal, 10 darwin-sandbox, 9 worker.
INFO: Build completed successfully, 23 total actions
빌드가 완료되면 다음 명령어를 붙여넣어 애플리케이션을 실행합니다.
bazel-bin/runner
--------------------- MENU -------------------------
Pizza - Cheesy Delicious Goodness
Macaroni & Cheese - Kid-approved Dinner
----------------------------------------------------
그러면 간단한 설명과 함께 메뉴 항목 목록이 표시됩니다.
타겟 탐색
이 프로젝트는 자체 패키지에 재료와 요리를 나열합니다. 쿼리를 사용하여 패키지의 규칙을 보려면 bazel query package/…
명령어를 실행합니다.
이 경우 다음을 실행하여 카페의 재료와 요리를 살펴볼 수 있습니다.
bazel query //src/main/java/com/example/dishes/...
bazel query //src/main/java/com/example/ingredients/...
재료 패키지의 대상을 쿼리하면 출력이 다음과 같이 표시됩니다.
//src/main/java/com/example/ingredients:cheese
//src/main/java/com/example/ingredients:dough
//src/main/java/com/example/ingredients:macaroni
//src/main/java/com/example/ingredients:tomato
종속 항목 찾기
러너가 달리는 데 사용하는 타겟은 무엇인가요?
파일 시스템을 사용하지 않고 프로젝트 구조를 더 자세히 살펴보고 싶다고 가정해 보겠습니다 (대규모 프로젝트에서는 불가능할 수 있음). 카페 바젤이 사용하는 규칙은 무엇인가요?
이 예시와 같이 실행기 타겟이 runner
인 경우 다음 명령어를 실행하여 타겟의 기본 종속 항목을 검색합니다.
bazel query --noimplicit_deps "deps(target)"
bazel query --noimplicit_deps "deps(:runner)"
//:runner
//:src/main/java/com/example/Runner.java
//src/main/java/com/example/dishes:MacAndCheese.java
//src/main/java/com/example/dishes:Pizza.java
//src/main/java/com/example/dishes:macAndCheese
//src/main/java/com/example/dishes:pizza
//src/main/java/com/example/ingredients:Cheese.java
//src/main/java/com/example/ingredients:Dough.java
//src/main/java/com/example/ingredients:Macaroni.java
//src/main/java/com/example/ingredients:Tomato.java
//src/main/java/com/example/ingredients:cheese
//src/main/java/com/example/ingredients:dough
//src/main/java/com/example/ingredients:macaroni
//src/main/java/com/example/ingredients:tomato
//src/main/java/com/example/restaurant:Cafe.java
//src/main/java/com/example/restaurant:Chef.java
//src/main/java/com/example/restaurant:cafe
//src/main/java/com/example/restaurant:chef
대부분의 경우 deps()
쿼리 함수를 사용하여 특정 대상의 개별 출력 종속 항목을 확인합니다.
종속 항목 그래프 시각화 (선택사항)
이 섹션에서는 특정 쿼리의 종속 항목 경로를 시각화하는 방법을 설명합니다. Graphviz를 사용하면 평면화된 목록이 아닌 방향성 비순환 그래프 이미지로 경로를 확인할 수 있습니다. 다양한 --output
명령줄 옵션을 사용하여 Bazel 쿼리 그래프의 표시를 변경할 수 있습니다. 옵션은 화면출력 형식을 참조하세요.
먼저 원하는 쿼리를 실행하고 --noimplicit_deps
플래그를 추가하여 과도한 도구 종속 항목을 삭제합니다. 그런 다음 출력 플래그가 있는 쿼리를 따르고 그래프를 graph.in
라는 파일에 저장하여 그래프의 텍스트 표현을 만듭니다.
대상 :runner
의 모든 종속 항목을 검색하고 출력 형식을 그래프로 지정하려면 다음 안내를 따르세요.
bazel query --noimplicit_deps 'deps(:runner)' --output graph > graph.in
그러면 빌드 그래프의 텍스트 표현인 graph.in
라는 파일이 생성됩니다. Graphviz는 텍스트를 시각화로 처리하는 도구인 dot
를 사용하여 png를 만듭니다.
dot -Tpng < graph.in > graph.png
graph.png
를 열면 다음과 같이 표시됩니다. 이 가이드에서는 필수 경로 세부정보를 보다 명확하게 이해할 수 있도록 아래 그래프를 단순화했습니다.
이는 이 가이드 전체에서 다양한 쿼리 함수의 출력을 확인하려고 할 때 도움이 됩니다.
역방향 종속 항목 찾기
그 대신 다른 대상에서 사용하는 대상을 분석하려는 경우 쿼리를 사용하여 특정 규칙에 종속된 대상을 검사할 수 있습니다. 이를 '역 종속 항목'이라고 합니다. rdeps()
를 사용하면 익숙하지 않은 코드베이스에서 파일을 수정할 때 유용할 수 있으며 자신도 모르게 이 항목에 종속된 다른 파일이 손상되는 것을 방지할 수 있습니다.
예를 들어 cheese
재료를 수정할 수 있습니다. 카페 Bazel에 문제를 일으키지 않으려면 cheese
를 사용한 요리를 확인해야 합니다.
특정 타겟/패키지에 종속된 대상을 확인하려면 rdeps(universe_scope, target)
를 사용하면 됩니다. rdeps()
쿼리 함수는 최소 두 개의 인수, 즉 universe_scope
(관련 디렉터리)와 target
를 사용합니다. Bazel은 제공된 universe_scope
내에서 대상의 역 종속 항목을 검색합니다. rdeps()
연산자는 세 번째 인수(선택사항)를 허용합니다. 이 인수는 검색 깊이의 상한값을 지정하는 정수 리터럴입니다.
전체 프로젝트 '//...'의 범위 내에서 대상 cheese
의 역 종속 항목을 찾으려면 다음 명령어를 실행합니다.
bazel query "rdeps(universe_scope, target)"
ex) bazel query "rdeps(//... , //src/main/java/com/example/ingredients:cheese)"
//:runner
//src/main/java/com/example/dishes:macAndCheese
//src/main/java/com/example/dishes:pizza
//src/main/java/com/example/ingredients:cheese
//src/main/java/com/example/restaurant:cafe
//src/main/java/com/example/restaurant:chef
쿼리 반환 결과는 치즈가 피자와 macAndCheese 모두에 의존함을 보여줍니다. 정말 놀라운데요!
태그를 기준으로 대상 찾기
두 고객이 아미르와 제니라는 Bazel 카페에 들어갑니다. 이름 외에는 알려진 것이 없습니다. 다행히 'customers' BUILD
파일에 주문이 태그되어 있습니다. 이 태그에 어떻게 액세스할 수 있나요?
개발자는 종종 테스트 목적으로 Bazel 대상에 다양한 식별자로 태그를 지정할 수 있습니다. 예를 들어 테스트의 태그는 디버그 및 출시 프로세스에서 테스트의 역할에 주석을 달 수 있습니다. 런타임 주석 기능이 없는 C++ 및 Python 테스트의 경우 특히 그렇습니다. 태그 및 크기 요소를 사용하면 코드베이스의 체크인 정책에 따라 테스트 모음을 유연하게 조합할 수 있습니다.
이 예에서 태그는 메뉴 항목을 나타내는 pizza
또는 macAndCheese
중 하나입니다. 이 명령어는 특정 패키지 내에 식별자와 일치하는 태그가 있는 대상을 쿼리합니다.
bazel query 'attr(tags, "pizza", //src/main/java/com/example/customers/...)'
이 쿼리는 'pizza' 태그가 있는 'customers' 패키지의 모든 타겟을 반환합니다.
테스트
이 쿼리를 사용하여 제니가 주문하려고 하는 항목을 알아봅니다.
정답
맥앤치즈
새 종속 항목 추가
카페 바젤이 스무디를 주문할 수 있는 메뉴를 확대했습니다. 재료가 Strawberry
, Banana
인 스무디입니다.
먼저 스무디가 필요한 재료 Strawberry.java
와 Banana.java
를 추가합니다. 빈 Java 클래스를 추가합니다.
src/main/java/com/example/ingredients/Strawberry.java
package com.example.ingredients;
public class Strawberry {
}
src/main/java/com/example/ingredients/Banana.java
package com.example.ingredients;
public class Banana {
}
다음으로 적절한 디렉터리 dishes
에 Smoothie.java
를 추가합니다.
src/main/java/com/example/dishes/Smoothie.java
package com.example.dishes;
public class Smoothie {
public static final String DISH_NAME = "Smoothie";
public static final String DESCRIPTION = "Yummy and Refreshing";
}
마지막으로, 적절한 BUILD
파일에 이러한 파일을 규칙으로 추가합니다. 새 요소마다 이름, 공개 가시성, 새로 만든 'src' 파일을 포함하여 새 재료의 자바 라이브러리를 새로 만듭니다. 다음과 같이 업데이트된 BUILD
파일로 마무리해야 합니다.
src/main/java/com/example/ingredients/BUILD
java_library(
name = "cheese",
visibility = ["//visibility:public"],
srcs = ["Cheese.java"],
)
java_library(
name = "dough",
visibility = ["//visibility:public"],
srcs = ["Dough.java"],
)
java_library(
name = "macaroni",
visibility = ["//visibility:public"],
srcs = ["Macaroni.java"],
)
java_library(
name = "tomato",
visibility = ["//visibility:public"],
srcs = ["Tomato.java"],
)
java_library(
name = "strawberry",
visibility = ["//visibility:public"],
srcs = ["Strawberry.java"],
)
java_library(
name = "banana",
visibility = ["//visibility:public"],
srcs = ["Banana.java"],
)
요리의 BUILD
파일에서 Smoothie
에 대한 새 규칙을 추가하려고 합니다. 이렇게 하면 Smoothie
용으로 생성된 자바 파일과 스무디의 각 재료에 생성한 새로운 규칙이 'src' 파일로 포함됩니다.
src/main/java/com/example/dishes/BUILD
java_library(
name = "macAndCheese",
visibility = ["//visibility:public"],
srcs = ["MacAndCheese.java"],
deps = [
"//src/main/java/com/example/ingredients:cheese",
"//src/main/java/com/example/ingredients:macaroni",
],
)
java_library(
name = "pizza",
visibility = ["//visibility:public"],
srcs = ["Pizza.java"],
deps = [
"//src/main/java/com/example/ingredients:cheese",
"//src/main/java/com/example/ingredients:dough",
"//src/main/java/com/example/ingredients:tomato",
],
)
java_library(
name = "smoothie",
visibility = ["//visibility:public"],
srcs = ["Smoothie.java"],
deps = [
"//src/main/java/com/example/ingredients:strawberry",
"//src/main/java/com/example/ingredients:banana",
],
)
마지막으로 Chef의 BUILD
파일에 스무디를 종속 항목으로 포함하려고 합니다.
src/main/java/com/example/restaurant/BUILD
java\_library(
name = "chef",
visibility = ["//visibility:public"],
srcs = [
"Chef.java",
],
deps = [
"//src/main/java/com/example/dishes:macAndCheese",
"//src/main/java/com/example/dishes:pizza",
"//src/main/java/com/example/dishes:smoothie",
],
)
java\_library(
name = "cafe",
visibility = ["//visibility:public"],
srcs = [
"Cafe.java",
],
deps = [
":chef",
],
)
cafe
를 다시 빌드하여 오류가 없는지 확인합니다. 빌드가 완료되었다면 축하합니다. '카페'의 새로운 종속 항목을 추가했습니다. 그렇지 않은 경우 철자 오류 및 패키지 이름 지정에 유의하세요. BUILD
파일 작성에 대한 자세한 내용은 빌드 스타일 가이드를 참고하세요.
이제 Smoothie
를 추가하여 새 종속 항목 그래프를 시각화하여 이전 종속 항목과 비교합니다. 명확성을 위해 그래프 입력의 이름을 graph2.in
및 graph2.png
로 지정합니다.
bazel query --noimplicit_deps 'deps(:runner)' --output graph > graph2.in
dot -Tpng < graph2.in > graph2.png
graph2.png
를 보면 Smoothie
가 다른 요리와 공유한 종속 항목은 없지만 Chef
가 사용하는 또 다른 대상임을 알 수 있습니다.
somepath() 및 allpaths()
한 패키지가 다른 패키지에 종속된 이유를 쿼리하려면 어떻게 해야 할까요? 둘 사이의 종속 항목 경로를 표시하면 답변을 얻을 수 있습니다.
somepath()
및 allpaths()
, 두 가지 함수를 사용하여 종속 항목 경로를 찾을 수 있습니다. 시작 타겟 S와 끝점 E가 주어졌을 때 somepath(S,E)
를 사용하여 S와 E 사이의 경로를 찾습니다.
'Chef'와 'Cheese' 타겟 간의 관계를 살펴보고 두 함수의 차이점을 살펴봅니다. 한 타겟에서 다른 타겟으로 이동할 수 있는 다양한 경로가 있습니다.
- 셰프 → MacAndCheese → 치즈
- 요리사 → 피자 → 치즈
somepath()
는 두 옵션 중 하나의 경로를 제공하는 반면 'allpaths()'는 가능한 모든 경로를 출력합니다.
Cafe Bazel을 예로 들어 다음을 실행합니다.
bazel query "somepath(//src/main/java/com/example/restaurant/..., //src/main/java/com/example/ingredients:cheese)"
//src/main/java/com/example/restaurant:cafe
//src/main/java/com/example/restaurant:chef
//src/main/java/com/example/dishes:macAndCheese
//src/main/java/com/example/ingredients:cheese
출력은 Cafe → Chef → MacAndCheese → Cheese)의 첫 번째 경로를 따릅니다. 대신 allpaths()
를 사용하면 다음과 같은 결과를 얻게 됩니다.
bazel query "allpaths(//src/main/java/com/example/restaurant/..., //src/main/java/com/example/ingredients:cheese)"
//src/main/java/com/example/dishes:macAndCheese
//src/main/java/com/example/dishes:pizza
//src/main/java/com/example/ingredients:cheese
//src/main/java/com/example/restaurant:cafe
//src/main/java/com/example/restaurant:chef
allpaths()
의 출력은 종속 항목의 평면화된 목록이므로 읽기가 약간 더 어렵습니다. Graphviz를 사용하여 이 그래프를 시각화하면 관계를 더 명확하게 이해할 수 있습니다.
테스트
카페 바젤의 고객 중 한 명이 첫 번째 리뷰를 남겼습니다. 안타깝게도 리뷰에 리뷰 작성자의 신원 및 언급하는 요리와 같은 일부 세부정보가 누락되어 있습니다. 다행히 Bazel을 사용하여 이 정보에 액세스할 수 있습니다. reviews
패키지에는 미스터리 고객의 리뷰를 출력하는 프로그램이 포함되어 있습니다. 다음을 사용하여 빌드하고 실행합니다.
bazel build //src/main/java/com/example/reviews:review
bazel-bin/src/main/java/com/example/reviews/review
Bazel 검색어만 남기고, 누가 리뷰를 작성했고 어떤 요리를 설명했는지 알아내려고 노력하세요.
힌트
태그 및 종속 항목에서 유용한 정보를 확인합니다.
정답
이 리뷰에는 피자에 대한 설명이 포함되었으며 아미르는 리뷰 작성자였습니다. bazel query --noimplicit\_deps 'deps(//src/main/java/com/example/reviews:review)'
를 사용하여 이 규칙의 종속 항목을 살펴보면 이 명령어의 결과를 통해 아미르가 검토자임을 알 수 있습니다.
이제 검토자가 Amir임을 알고 있으므로 쿼리 함수를 사용하여 `BUILD` 파일에서 Amir에 어떤 태그가 있는지 찾아 어떤 요리가 있는지 확인할 수 있습니다.
bazel query 'attr(tags, "pizza", //src/main/java/com/example/customers/...)'
명령어는 Amir가 피자를 주문한 유일한 고객이며 답변을 제공하는 리뷰 작성자임을 출력합니다.
요약
수고하셨습니다 지금까지 여러 기본 쿼리를 실행했으며, 이러한 쿼리를 자체 프로젝트에서 사용해 볼 수 있습니다. 쿼리 언어 구문에 대한 자세한 내용은 쿼리 참조 페이지를 참조하세요. 고급 쿼리를 사용하고 싶으신가요? 쿼리 가이드에는 이 가이드에서 다루는 것보다 더 많은 사용 사례가 있는 심층 목록이 있습니다.