flutter_gen_runner如何使用

我在使用flutter_gen_runner时遇到了一些问题，不太清楚具体该如何配置和使用。能否详细说明一下它的安装步骤、基本配置方法以及常见的使用场景？另外，如果出现代码生成失败的情况，应该如何排查和解决？希望有经验的朋友能分享一下实际项目中的使用技巧和注意事项。

2 回复

FlutterGen Runner 用于自动生成资源文件代码。使用步骤：

  1. 安装依赖：在 pubspec.yaml 添加 flutter_gen_runner 和 build_runner。
  2. 配置 flutter_gen 参数（可选）。
  3. 运行命令：flutter packages pub run build_runner build 生成代码。
  4. 在代码中直接使用生成的资源类，如 Assets.images.logo。

更多关于flutter_gen_runner如何使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html


Flutter Gen Runner 是配合 flutter_gen 库使用的代码生成工具，用于自动生成资源（如图片、字体、颜色等）的类型安全访问代码。

安装步骤

  1. 添加依赖
dev_dependencies:
  flutter_gen_runner: ^5.4.0
  build_runner: ^2.4.0
  flutter_gen: ^5.4.0
  1. 配置 flutter_gen（在 pubspec.yaml 中）
flutter_gen:
  output: lib/gen/ # 生成代码的输出目录
  integrations:
    - flutter_svg: true # 如果需要 SVG 支持

使用方法

  1. 运行代码生成
# 一次性生成
flutter packages pub run build_runner build

# 监听模式（文件变化时自动重新生成）
flutter packages pub run build_runner watch

# 清理并重新生成
flutter packages pub run build_runner clean
  1. 使用生成的代码
import 'gen/assets.gen.dart';

// 访问图片
Image.asset(Assets.images.logo.path);

// 访问 SVG
SvgPicture(Assets.svg.icons.chat);

// 访问字体
Text(
  'Hello',
  style: TextStyle(
    fontFamily: Assets.fonts.roboto.regular,
  ),
);

主要特性

  • 类型安全：编译时检查资源是否存在
  • 自动完成：IDE 支持自动补全
  • 空安全：完全支持 null safety
  • 多资源类型：支持图片、字体、SVG、JSON 等

确保在运行前已正确配置 pubspec.yaml 中的资源路径，并执行 flutter pub get。

回到顶部