Flutter资源生成插件assets_generator的使用

assets_generator 是一个用于自动生成Flutter项目中的资源配置（yaml）和常量的工具。它支持单个项目和多模块项目。

使用方法

环境准备

你需要将 pub 的二进制文件路径添加到系统的环境变量中。

你可以参考 pub global 获取更多详细信息。

激活 assets_generator

dart pub global activate assets_generator

命令行用法

帮助

agen -h

示例

agen -t d -s -r lwu

所有命令

-h, --[no-]help 帮助信息 -p, --path Flutter项目的根路径 (默认为 “.”) -f, --folder 资源的根文件夹 (默认为 “assets”) -w, --[no-]watch 是否继续监控资源的变化 (默认为开启) -t, --type 在 pubspec.yaml 中的类型 “d” 表示目录 “- assets/images/” “f” 表示文件 “- assets/images/xxx.jpg” (默认为 “d”) -s, --[no-]save 是否保存参数到本地 如果运行 agen 时没有参数，将执行本地保存的参数 -o, --out 常量类的输出路径 (默认为 “lib”) -r, --rule 资源常量名称的规则 “lwu”(小写下划线) : “assets_images_xxx_jpg” “uwu”(大写下划线) : “ASSETS_IMAGES_XXX_JPG” “lcc”(驼峰命名) : “assetsImagesXxxJpg” (默认为 “lwu”) -c, --class 常量类的名称 (默认为 “Assets”) –const-ignore 忽略某些常量的正则表达式

### Dart 代码示例

#### 在项目中使用

```dart
Image.asset(Assets.assets_images_xxx_jpg);

在模块中使用

Image.asset(
  Assets.assets_images_xxx_jpg,
  package: Assets.package,
);

示例项目

以下是一个完整的示例项目，展示了如何使用 assets_generator 生成资源常量并在项目中使用它们。

main.dart

import 'package:flutter/material.dart';
import 'assets.dart';

void main() => runApp(const MyApp());

class MyApp extends StatelessWidget {
  const MyApp({Key? key}) : super(key: key);

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: const MyHomePage(title: 'Flutter Demo Home Page'),
    );
  }
}

class MyHomePage extends StatefulWidget {
  const MyHomePage({Key? key, required this.title}) : super(key: key);

  final String title;

  [@override](/user/override)
  State<MyHomePage> createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  int _counter = 0;

  void _incrementCounter() {
    setState(() {
      _counter++;
    });
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text(widget.title),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            const Text(
              'You have pushed the button this many times:',
            ),
            Text(
              '$_counter',
            ),
            Image.asset(Assets.assets_images_flutter_candies_logo_png),
          ],
        ),
      ),
      floatingActionButton: FloatingActionButton(
        onPressed: _incrementCounter,
        tooltip: 'Increment',
        child: const Icon(Icons.add),
      ),
    );
  }
}

assets.dart

假设你已经使用 assets_generator 生成了 assets.dart 文件，内容可能如下：

class Assets {
  static const String assets_images_flutter_candies_logo_png = 'assets/images/flutter_candies_logo.png';
  static const String package = 'your_package_name';
}

通过以上步骤，你可以轻松地在Flutter项目中管理和使用资源文件。希望这些信息对你有所帮助！