安装

Finch 是一个基于 Dart 的服务端 Web 框架。本页介绍安装的前提条件和步骤。

前提条件

• Dart SDK — Finch 需要 Dart 3.x 或更高版本。从 dart.dev/get-dart 下载。
• 一个终端和文本编辑器（推荐使用带有 Dart 扩展的 VS Code）。

安装 Finch CLI

Finch CLI 提供项目脚手架、构建、服务和迁移命令。

dart pub global activate finch

激活后，验证安装是否成功：

finch --version

创建新项目

finch create

不带任何参数运行时，finch create 会以交互方式询问项目名称以及是否使用 Docker。其余选项都有合理的默认值：项目会创建在以项目名命名的目录中，模板默认为 simple，除非你通过 -t/--template 覆盖它。若要完全跳过交互提示：

finch create -n my_app -p ./my_app -t example -d

运行 finch templates 可列出可用于 -t 的官方模板（实时从 GitHub 获取）。example 模板与本文档中使用的示例项目一致，包含 MongoDB、MySQL、SQLite、WebSocket、i18n、表单和 API 文档等示例；simple 则是一个最小化的起始模板。如果你没有传入 -d/--docker 并且在 Docker 提示中回答否，生成项目中的 Dockerfile、.dockerignore 和 docker-compose.yaml 会被自动删除。

运行新项目

cd my_app
dart pub get
finch serve

finch serve 会启动带有文件监视器的开发服务器——widget 和语言文件的变更会被自动识别，无需重启。关于 serve（开发环境）与编译后的二进制文件（生产环境）之间的区别，请参阅 Running an Application。

将 Finch 添加到现有项目

dart pub add finch

然后运行：

dart pub get

你仍需手动编写 lib/app.dart 的相关设置以及路由函数——由于 dart pub add 只会添加依赖，而不会生成 finch create 所创建的脚手架，具体的最小化结构请参阅 Running an Application。

更新 Finch

finch -u

更新全局激活的 finch CLI 本身（相当于再次运行 dart pub global activate finch）。若要升级项目内的 finch 软件包依赖，请改用标准的 Dart 工具：dart pub upgrade finch。

下一步

查看 Finch CLI 了解所有可用命令，或直接跳转到 Configuration 来设置您的第一个应用程序。