[flutter] 플러터 build_runner를 사용하여 코드 생성하기

플러터 앱을 개발하는 동안 코드 생성을 자동화하고 관련 파일을 생성하기 위해 build_runner를 사용할 수 있습니다. build_runner를 활용하여 코드를 자동으로 생성 및 업데이트하면 개발자는 반복적이고 지루한 작업을 피하고 더욱 효율적으로 작업할 수 있습니다.

1. build_runner란?

build_runner는 플러터와 다트 프로젝트에서 코드 생성을 위한 도구입니다. 이를 통해 소스 코드에 대한 분석을 수행하고, 생성된 결과물을 출력할 수 있습니다.

2. build_runner 사용 방법

먼저, build_runner 를 프로젝트에 추가합니다.

flutter pub add build_runner --dev

그 다음, build_runner를 사용하여 코드를 생성하고자 하는 파일과 클래스에 주석을 추가합니다. 주석은 어떤 코드를 생성해야 하는지 명시하는 역할을 합니다. 아래의 예시를 확인해보세요.

import 'package:json_serializable/json_serializable.dart';

part 'example.g.dart';

@JsonSerializable()
class Example {
  final String name;
  final int age;

  Example(this.name, this.age);

  factory Example.fromJson(Map<String, dynamic> json) => _$ExampleFromJson(json);
  Map<String, dynamic> toJson() => _$ExampleToJson(this);
}

이후, 명령어를 통해 코드를 생성합니다.

flutter pub run build_runner build

3. 소스 코드 분석 및 결과물 확인

build_runner는 주석이 달린 소스 코드를 분석하고, 결과물을 생성합니다. 예를 들어 위의 예시에서는 example.g.dart 파일이 생성됩니다. 이 파일은 toJsonfromJson을 포함한 코드가 자동으로 생성된 결과물입니다.

이제, build_runner를 사용하여 플러터 앱 개발 과정에서 코드를 자동으로 생성하고 관리하는 방법에 대해 알아보았습니다. 이를 통해 코드의 일관성을 유지하고 개발 생산성을 향상시킬 수 있습니다.

더 많은 내용을 알고 싶다면 아래의 레퍼런스를 확인해보세요.