內容

build_runner 套件提供用於產生檔案的通用指令,包括測試產生的檔案或同時提供原始碼和產生的檔案。此頁面說明如何使用 build_runner。若要了解如何將 build_runner 與特定套件搭配使用,請參閱該套件的文件。

build_runner 指令與 建置器 搭配使用,這些套件使用 Dart 建置系統 從輸入檔案產生輸出檔案。例如,json_serializablebuilt_value_generator 套件定義會產生 Dart 程式碼的建置器。

儘管 Dart 建置系統是反射 (效能有問題) 和巨集 (Dart 編譯器不支援) 的良好替代方案,但它不只可以讀取和寫入 Dart 程式碼。例如,sass_builder 套件實作一個建置器,可以從 .scss.sass 檔案產生 .css 檔案。

設定 build_runner

#

要使用 build_runner,請在應用程式的 pubspec 中新增一個對 build_runner開發依賴關係

yaml
dev_dependencies:
  # ···
  build_runner: ^2.4.8
  build_test: ^2.2.2

依賴 build_test 是選用的;如果您要測試程式碼,請執行此動作。

pubspec.yaml 變更後,請像往常一樣執行 dart pub getdart pub upgrade

$ dart pub get

使用內建指令

#

以下是使用 build_runner build 指令的範例

$ # From a directory that contains a pubspec.yaml file:
$ dart run build_runner build

build_runner 套件包含下列指令

build
執行一次性建置。
serve
執行開發伺服器。您可以使用 webdev serve, 而不是直接使用此指令,它有方便的預設行為。
test
執行 測試
watch
啟動一個建置伺服器,監控輸入檔案的編輯。透過執行增量重建來回應變更。

更多資訊

#

如果您正在處理特定網頁的程式碼,請參閱 webdev 頁面

有關使用 build_runner 的詳細資訊,請參閱下列內容