특성

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

이 페이지에서는 다양한 요소 사용의 기본사항과 이점을 설명하고 간단한 예시와 고급 예를 제공합니다.

다양한 측면에서는 빌드 종속 항목 그래프를 추가 정보와 작업으로 보강할 수 있습니다. 다음과 같은 측면이 유용할 수 있는 몇 가지 일반적인 시나리오입니다.

  • Bazel을 통합하는 IDE는 여러 측면을 사용하여 프로젝트에 대한 정보를 수집할 수 있습니다.
  • 코드 생성 도구는 대상과 상관없이 입력에서 실행하는 측면을 활용할 수 있습니다. 예를 들어 BUILD 파일은 protobuf 라이브러리 정의의 계층 구조를 지정할 수 있고 언어별 규칙은 요소를 사용하여 특정 언어의 protobuf 지원 코드를 생성하는 작업을 연결할 수 있습니다.

가로세로 기본사항

BUILD 파일은 프로젝트의 소스 코드에 대한 설명을 제공합니다. 프로젝트에 포함된 소스 파일, 이러한 파일에서 빌드해야 하는 아티팩트(대상), 이러한 파일 간의 종속 항목 등입니다. Bazel은 이 정보를 사용하여 빌드를 실행합니다. 즉, 아티팩트 (예: 실행 중인 컴파일러 또는 링커)를 생성하는 데 필요한 작업 세트를 알아내고 작업을 실행합니다. Bazel은 대상 간에 종속 항목 그래프를 구성하고 이 그래프를 방문하여 이러한 작업을 수집합니다.

다음 BUILD 파일을 살펴보세요.

java_library(name = 'W', ...)
java_library(name = 'Y', deps = [':W'], ...)
java_library(name = 'Z', deps = [':W'], ...)
java_library(name = 'Q', ...)
java_library(name = 'T', deps = [':Q'], ...)
java_library(name = 'X', deps = [':Y',':Z'], runtime_deps = [':T'], ...)

BUILD 파일은 다음 그림과 같이 종속 항목 그래프를 정의합니다.

빌드 그래프

그림 1. BUILD 파일 종속 항목 그래프

Bazel은 위의 예시에 있는 모든 대상에 대해 해당 규칙(이 경우 'java_library')의 구현 함수를 호출하여 이 종속 항목 그래프를 분석합니다. 규칙 구현 함수는 아티팩트(예: .jar 파일)를 빌드하고 아티팩트의 위치 및 이름과 같은 정보를 제공업체에 있는 이러한 타겟의 역방향 종속 항목에 전달하는 작업을 생성합니다.

측면은 작업을 생성하고 제공자를 반환하는 구현 함수가 있다는 점에서 규칙과 유사합니다. 그러나 종속 항목 그래프를 기반으로 하는 방식으로 작동합니다. 측면에는 구현 및 전파되는 모든 속성 목록이 있습니다. 'deps'라는 속성을 따라 전파되는 측면 A를 생각해 보세요. 이 측면은 대상 X에 적용되어 가로세로 애플리케이션 노드 A(X)를 생성할 수 있습니다. 적용 중에 A 특성은 X가 'deps' 속성에서 참조하는 모든 타겟 (A의 전파 목록에 있는 모든 속성)에 반복적으로 적용됩니다.

따라서, 대상 A에 대상 A를 적용하는 단일 작업은 다음 그림에 표시된 타겟의 원래 종속 항목 그래프의 '섀도 그래프'를 생성합니다.

가로세로 그래프 빌드

그림 2. 여러 측면을 보여주는 그래프를 작성합니다.

섀도 처리된 유일한 가장자리는 전파 세트의 속성을 따르는 가장자리입니다. 따라서 이 예에서는 runtime_deps 가장자리가 섀도 처리되지 않습니다. 그런 다음 원본 그래프의 노드에서 규칙 구현이 호출되는 방식과 유사하게 그림자 그래프의 모든 노드에서 가로세로 구현 함수가 호출됩니다.

간단한 예시

이 예시에서는 규칙의 소스 파일 및 deps 속성이 있는 모든 종속 항목을 재귀적으로 인쇄하는 방법을 보여줍니다. 가로세로 구현, 가로세로 정의, Bazel 명령줄에서 가로세로를 호출하는 방법을 보여줍니다.

def _print_aspect_impl(target, ctx):
    # Make sure the rule has a srcs attribute.
    if hasattr(ctx.rule.attr, 'srcs'):
        # Iterate through the files that make up the sources and
        # print their paths.
        for src in ctx.rule.attr.srcs:
            for f in src.files.to_list():
                print(f.path)
    return []

print_aspect = aspect(
    implementation = _print_aspect_impl,
    attr_aspects = ['deps'],
)

예시를 각 부분으로 나눈 후 하나씩 살펴보겠습니다.

가로세로 정의

print_aspect = aspect(
    implementation = _print_aspect_impl,
    attr_aspects = ['deps'],
)

가로세로 정의는 규칙 정의와 비슷하며 aspect 함수를 사용하여 정의됩니다.

규칙과 마찬가지로 측면에는 구현 함수(이 경우 _print_aspect_impl)가 있습니다.

attr_aspects는 속성이 적용되는 규칙 속성 목록입니다. 이 경우 가로세로 규칙이 적용되는 규칙의 deps 속성을 따라 전파됩니다.

attr_aspects의 또 다른 일반적인 인수는 규칙의 모든 속성에 속성을 전파하는 ['*']입니다.

가로세로 구현

def _print_aspect_impl(target, ctx):
    # Make sure the rule has a srcs attribute.
    if hasattr(ctx.rule.attr, 'srcs'):
        # Iterate through the files that make up the sources and
        # print their paths.
        for src in ctx.rule.attr.srcs:
            for f in src.files.to_list():
                print(f.path)
    return []

가로세로 구현 함수는 규칙 구현 함수와 유사합니다. 제공업체를 반환하고 작업을 생성하고 다음 두 가지 인수를 취할 수 있습니다.

  • target: 가로세로 항목이 적용되는 타겟입니다.
  • ctx: 속성에 액세스하고 출력과 작업을 생성하는 데 사용할 수 있는 ctx 객체입니다.

구현 함수는 ctx.rule.attr를 통해 대상 규칙의 속성에 액세스할 수 있습니다. 이 객체는 적용되는 대상에서 제공되는 제공자를 확인할 수 있습니다 (target 인수 사용).

제공업체 목록을 반환하려면 여러 요소가 필요합니다. 이 예에서 가로세로 요소는 아무것도 제공하지 않으므로 빈 목록을 반환합니다.

명령줄을 사용하여 가로세로 요소 호출

가로세로 비율을 적용하는 가장 간단한 방법은 명령줄에서 --aspects 인수를 사용하는 것입니다. 위 측면이 print.bzl라는 파일에 정의되었다고 가정해 보겠습니다.

bazel build //MyExample:example --aspects print.bzl%print_aspect

print_aspect를 대상 exampledeps 속성을 통해 재귀적으로 액세스할 수 있는 모든 대상 규칙에 적용합니다.

--aspects 플래그는 <extension file label>%<aspect top-level name> 형식의 가로세로 사양을 가리키는 인수 한 개를 사용합니다.

고급 예시

다음 예에서는 대상의 파일을 계산하는 타겟 규칙의 측면을 사용하여 확장 프로그램을 기준으로 필터링할 수 있습니다. 제공자를 사용하여 값을 반환하는 방법, 매개변수를 사용하여 가로세로 구현에 인수를 전달하는 방법, 규칙에서 가로세로 비율을 호출하는 방법을 보여줍니다.

file_count.bzl 파일:

FileCountInfo = provider(
    fields = {
        'count' : 'number of files'
    }
)

def _file_count_aspect_impl(target, ctx):
    count = 0
    # Make sure the rule has a srcs attribute.
    if hasattr(ctx.rule.attr, 'srcs'):
        # Iterate through the sources counting files
        for src in ctx.rule.attr.srcs:
            for f in src.files.to_list():
                if ctx.attr.extension == '*' or ctx.attr.extension == f.extension:
                    count = count + 1
    # Get the counts from our dependencies.
    for dep in ctx.rule.attr.deps:
        count = count + dep[FileCountInfo].count
    return [FileCountInfo(count = count)]

file_count_aspect = aspect(
    implementation = _file_count_aspect_impl,
    attr_aspects = ['deps'],
    attrs = {
        'extension' : attr.string(values = ['*', 'h', 'cc']),
    }
)

def _file_count_rule_impl(ctx):
    for dep in ctx.attr.deps:
        print(dep[FileCountInfo].count)

file_count_rule = rule(
    implementation = _file_count_rule_impl,
    attrs = {
        'deps' : attr.label_list(aspects = [file_count_aspect]),
        'extension' : attr.string(default = '*'),
    },
)

BUILD.bazel 파일:

load('//:file_count.bzl', 'file_count_rule')

cc_library(
    name = 'lib',
    srcs = [
        'lib.h',
        'lib.cc',
    ],
)

cc_binary(
    name = 'app',
    srcs = [
        'app.h',
        'app.cc',
        'main.cc',
    ],
    deps = ['lib'],
)

file_count_rule(
    name = 'file_count',
    deps = ['app'],
    extension = 'h',
)

가로세로 정의

file_count_aspect = aspect(
    implementation = _file_count_aspect_impl,
    attr_aspects = ['deps'],
    attrs = {
        'extension' : attr.string(values = ['*', 'h', 'cc']),
    }
)

이 예는 가로세로 속성이 deps 속성을 통해 전파되는 방식을 보여줍니다.

attrs는 측면의 속성 집합을 정의합니다. 공개 가로세로 속성은 string 유형이며 매개변수라고 합니다. 매개변수에는 values 속성이 지정되어 있어야 합니다. 이 예시에는 '*', 'h' 또는 'cc'을 값으로 사용할 수 있는 extension라는 매개변수가 있습니다.

가로세로의 매개변수 값은 가로세로를 요청하는 규칙과 동일한 이름의 문자열 속성에서 가져옵니다. file_count_rule의 정의를 참고하세요. 매개변수가 있는 가로세로 매개변수는 매개변수를 정의하는 구문이 없으므로 명령줄을 통해 사용할 수 없습니다.

가로세로 유형에는 label 또는 label_list 유형의 비공개 속성도 허용됩니다. 비공개 라벨 속성은 측면으로 생성된 작업에 필요한 도구 또는 라이브러리의 종속 항목을 지정하는 데 사용할 수 있습니다. 이 예에 정의된 비공개 속성은 없지만 다음 코드 스니펫은 도구를 가로세로로 전달하는 방법을 보여줍니다.

...
    attrs = {
        '_protoc' : attr.label(
            default = Label('//tools:protoc'),
            executable = True,
            cfg = "exec"
        )
    }
...

가로세로 구현

FileCountInfo = provider(
    fields = {
        'count' : 'number of files'
    }
)

def _file_count_aspect_impl(target, ctx):
    count = 0
    # Make sure the rule has a srcs attribute.
    if hasattr(ctx.rule.attr, 'srcs'):
        # Iterate through the sources counting files
        for src in ctx.rule.attr.srcs:
            for f in src.files.to_list():
                if ctx.attr.extension == '*' or ctx.attr.extension == f.extension:
                    count = count + 1
    # Get the counts from our dependencies.
    for dep in ctx.rule.attr.deps:
        count = count + dep[FileCountInfo].count
    return [FileCountInfo(count = count)]

규칙 구현 함수와 마찬가지로 가로세로 구현 함수는 종속 항목에 액세스할 수 있는 제공업체 구조체를 반환합니다.

이 예에서 FileCountInfo는 필드 count가 하나인 제공자로 정의됩니다. fields 속성을 사용하여 제공자의 필드를 명시적으로 정의하는 것이 좋습니다.

가로세로 애플리케이션 A(X)의 제공자 집합은 타겟 X의 규칙 구현 및 가로세로 A의 구현에서 비롯된 제공자의 합집합입니다. 규칙 구현이 적용되는 제공자는 측면이 적용되기 전에 생성되고 고정되며 측면에서 수정할 수 없습니다. 타겟과 타겟에 적용되는 측면이 각각 동일한 유형의 제공자를 제공하는 경우 오류가 발생합니다. 단, OutputGroupInfo(규칙과 가로세로가 서로 다른 출력 그룹을 지정하는 한 병합됨)와 InstrumentedFilesInfo는 가로세로에서 가져옵니다. 즉, 가로세로 구현은 DefaultInfo를 반환할 수 없습니다.

매개변수와 비공개 속성은 ctx의 속성으로 전달됩니다. 이 예시에서는 extension 매개변수를 참조하고 계산할 파일을 결정합니다.

반환되는 제공자의 경우 attr_aspects 목록에서 가로세로가 전파되는 속성 값이 가로세로 애플리케이션의 적용 결과로 대체됩니다. 예를 들어 타겟 X의 D에 Y와 Z가 있으면 A(X)의 ctx.rule.attr.deps는 [A(Y), A(Z)]가 됩니다. 이 예에서 ctx.rule.attr.deps는 가로세로가 적용된 원래 타겟의 'Deps'에 가로세로 비율을 적용한 결과 객체입니다.

이 예에서 가로세로 요소는 타겟 종속 항목에서 FileCountInfo 제공자에 액세스하여 총 전환 파일 수를 누적합니다.

규칙에서 측면 호출

def _file_count_rule_impl(ctx):
    for dep in ctx.attr.deps:
        print(dep[FileCountInfo].count)

file_count_rule = rule(
    implementation = _file_count_rule_impl,
    attrs = {
        'deps' : attr.label_list(aspects = [file_count_aspect]),
        'extension' : attr.string(default = '*'),
    },
)

규칙 구현은 ctx.attr.deps을 통해 FileCountInfo에 액세스하는 방법을 보여줍니다.

규칙 정의는 매개변수 (extension)를 정의하고 기본값 (*)을 지정하는 방법을 보여줍니다. 기본값이 'cc', 'h' 또는 '*'가 아닌 경우 가로세로 정의의 매개변수에 적용된 제한으로 인해 오류가 발생합니다.

대상 규칙을 통해 측면 호출

load('//:file_count.bzl', 'file_count_rule')

cc_binary(
    name = 'app',
...
)

file_count_rule(
    name = 'file_count',
    deps = ['app'],
    extension = 'h',
)

규칙을 통해 extension 매개변수를 가로세로로 전달하는 방법을 보여줍니다. 규칙 구현에서 extension 매개변수가 기본값을 갖고 있으므로 extension은 선택적 매개변수로 간주됩니다.

file_count 대상이 빌드되면 가로세로 요소는 자체 평가되며 모든 타겟은 deps를 통해 반복적으로 액세스할 수 있습니다.