쿼리 빠른 시작

문제 신고 소스 보기 Nightly · 8.3 · 8.2 · 8.1 · 8.0 · 7.6

이 튜토리얼에서는 미리 만들어진 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 내부에 main 메서드가 포함되어 있으며 이를 실행하여 카페 메뉴를 출력할 수 있습니다. 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

종속 항목 찾기

러너가 실행되는 데 사용하는 타겟은 무엇인가요?

파일 시스템을 탐색하지 않고 프로젝트의 구조를 자세히 살펴보고 싶다고 가정해 보겠습니다 (대규모 프로젝트에서는 불가능할 수 있음). Cafe Bazel은 어떤 규칙을 사용하나요?

이 예와 같이 러너의 타겟이 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

참고: --noimplicit_deps 플래그를 추가하면 목록을 간소화하기 위해 구성과 잠재적 도구 모음이 삭제됩니다. 이 플래그를 생략하면 Bazel이 BUILD 파일에 지정되지 않은 암시적 종속 항목을 반환하여 출력이 어수선해집니다.

대부분의 경우 쿼리 함수 deps()를 사용하여 특정 타겟의 개별 출력 종속 항목을 확인합니다.

종속 항목 그래프 시각화 (선택사항)

참고: 이 섹션에서는 Graphviz를 사용하므로 Graphviz를 다운로드하여 따라 하세요.

이 섹션에서는 특정 쿼리의 종속 항목 경로를 시각화하는 방법을 설명합니다. 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 성분을 수정하려고 합니다. 카페 바젤에 문제가 발생하지 않도록 cheese에 의존하는 요리를 확인해야 합니다.

주의: ingredients은 자체 패키지이므로 //package:target 형식으로 타겟 cheese에 다른 이름 지정 규칙을 사용해야 합니다. 타겟 또는 라벨 참조에 대해 자세히 알아보세요.

특정 타겟/패키지에 종속된 타겟을 확인하려면 rdeps(universe_scope, target)를 사용하면 됩니다. rdeps() 쿼리 함수는 관련 디렉터리인 universe_scope와 target 등 두 개 이상의 인수를 사용합니다. Bazel은 제공된 universe_scope 내에서 타겟의 역 종속 항목을 검색합니다. rdeps() 연산자는 선택사항인 세 번째 인수를 허용합니다. 이는 검색 깊이의 상한을 지정하는 정수 리터럴입니다.

도움말: 프로젝트의 전체 범위 내에서 검색하려면 universe_scope을 //...로 설정하세요.

전체 프로젝트 '//…' 범위 내에서 타겟 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 Cafe에 들어옵니다. 이름 외에는 알려진 바가 없습니다. 다행히도 주문이 'customers' BUILD 파일에 태그되어 있습니다. 이 태그에 액세스하려면 어떻게 해야 하나요?

개발자는 테스트 목적으로 Bazel 타겟에 다양한 식별자를 태그할 수 있습니다. 예를 들어 테스트의 태그는 디버그 및 출시 프로세스에서 테스트의 역할을 주석으로 달 수 있습니다. 특히 런타임 주석 기능이 없는 C++ 및 Python 테스트의 경우에 유용합니다. 태그와 크기 요소를 사용하면 코드베이스의 체크인 정책을 기반으로 테스트 모음을 유연하게 어셈블할 수 있습니다.

이 예에서 태그는 메뉴 항목을 나타내는 pizza 또는 macAndCheese 중 하나입니다. 이 명령어는 특정 패키지 내에서 식별자와 일치하는 태그가 있는 타겟을 쿼리합니다.

bazel query 'attr(tags, "pizza", //src/main/java/com/example/customers/...)'

이 쿼리는 'customers' 패키지에서 태그가 'pizza'인 모든 타겟을 반환합니다.

테스트

이 질문을 사용하여 Jenny가 주문하고 싶어 하는 내용을 파악합니다.

답변

마카로니 앤 치즈

새 종속 항목 추가

카페 바젤의 메뉴가 확대되었습니다. 이제 고객이 스무디를 주문할 수 있습니다. 이 특정 스무디는 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 {

}

그런 다음 Smoothie.java를 적절한 디렉터리(dishes)에 추가합니다.

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' 파일을 포함하여 각 새 재료에 대해 새 Java 라이브러리를 만듭니다. 업데이트된 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에 대해 생성된 Java 파일이 '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",
    ],
)

마지막으로 스무디를 셰프의 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 파일 작성에 관한 자세한 내용은 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' 타겟 간의 관계를 살펴보고 두 함수의 차이점을 알아보세요. 한 타겟에서 다른 타겟으로 이동하는 방법은 여러 가지가 있습니다.

• Chef → MacAndCheese → Cheese
• Chef → Pizza → Cheese

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를 사용하여 이 그래프를 시각화하면 관계를 더 명확하게 이해할 수 있습니다.

테스트

Cafe Bazel의 고객이 레스토랑에 대한 첫 번째 리뷰를 남겼습니다. 리뷰에 리뷰 작성자의 신원, 언급된 요리 등 일부 세부정보가 누락되었습니다. 다행히 Bazel을 사용하면 이 정보에 액세스할 수 있습니다. reviews 패키지에는 미스터리 고객의 리뷰를 출력하는 프로그램이 포함되어 있습니다. 다음 명령어를 사용하여 빌드하고 실행합니다.

bazel build //src/main/java/com/example/reviews:review

bazel-bin/src/main/java/com/example/reviews/review

Bazel 쿼리만 사용하여 리뷰를 작성한 사람과 설명된 요리를 파악하세요.

힌트

태그와 종속 항목에서 유용한 정보를 확인합니다.

답변

이 리뷰는 피자를 설명하고 있으며 Amir가 리뷰어입니다. bazel query --noimplicit\_deps 'deps(//src/main/java/com/example/reviews:review)'를 사용하여 이 규칙에 어떤 종속 항목이 있는지 살펴보면 이 명령어의 결과에 Amir가 검토자로 표시됩니다. 다음으로 검토자가 Amir임을 알고 있으므로 쿼리 함수를 사용하여 Amir가 `BUILD` 파일에 어떤 태그를 가지고 있는지 확인하여 어떤 요리가 있는지 확인할 수 있습니다. 이 명령어는 아미르가 피자를 주문한 유일한 고객이자 리뷰어임을 출력하여 답을 제공합니다.bazel query 'attr(tags, "pizza", //src/main/java/com/example/customers/...)'

요약

축하합니다. 이제 여러 기본 쿼리를 실행했으며 자체 프로젝트에서 이를 사용해 볼 수 있습니다. 쿼리 언어 구문에 대해 자세히 알아보려면 쿼리 참조 페이지를 참고하세요. 더 고급 쿼리를 원하시나요? 쿼리 가이드에는 이 가이드에서 다루는 것보다 더 많은 사용 사례가 자세히 나와 있습니다.