build_runner를 사용한 코드 생성

JSON 분석처럼 반복적인 상용구 코드가 있습니다. 코드 생성은 주석을 바탕으로 이 코드를 대신 작성해 주므로 정확하고 빠르게 작업할 수 있습니다. ⚙️

build_runner는 프로젝트에서 코드 생성기를 실행하는 Dart 도구입니다. 소스 파일을 읽고 주석을 찾아 새 파일을 생성합니다.

앱을 빌드할 때만 실행되고 앱과 함께 배포되지 않으므로 pubspec.yaml의 dev_dependencies 아래에 build_runner를 추가합니다.

생성기는 형제 파일에 내용을 작성합니다. 관례에 따라 이름이 .g.dart로 끝나는 part 지시문으로 이 파일을 연결합니다.

build 명령으로 한 번 생성하도록 실행합니다. 이 명령은 코드를 검사하고 모든 .g.dart 파일을 만들거나 최신 상태로 갱신합니다.

개발 중에는 저장할 때마다 watch 모드가 자동으로 다시 생성합니다. 수동으로 다시 실행하지 않아도 생성 파일을 동기화된 상태로 유지합니다.

출력이 오래된 파일과 충돌하면 --delete-conflicting-outputs를 추가합니다. 오래된 생성 파일을 삭제하여 새 빌드가 성공하도록 합니다.

생성기는 annotate한 선언에만 동작합니다. 이 주석은 빌더에게 처리할 class와 생성할 코드를 알려 줍니다.

모든 .g.dart 파일을 read-only로 취급하세요. 다음 빌드에서 수정 내용이 덮어써지므로 소스와 주석을 대신 편집해야 합니다.

팀에서는 생성 파일을 커밋하거나 .gitignore에 추가한 뒤 CI에서 다시 빌드하는 방식을 선택합니다. 어느 쪽이든 하나의 정책을 정하고 일관되게 유지하세요.

json_serializable과 freezed처럼 많은 패키지가 build_runner에 연결됩니다. 이들은 하나의 builder 파이프라인을 공유하므로 명령 하나로 모두 실행할 수 있습니다.

모든 파일 저장 시 코드를 다시 생성하는 명령은 무엇인가요?

build_runner는 주석을 생성된 .g.dart 파일로 변환합니다. dev_dependencies에 추가하고 build 또는 watch를 실행한 뒤, 출력 파일은 절대 수정하지 마세요. 🎉