Flutter资源生成插件resources_generator的使用

特性

通过assets/文件夹生成一个资源类，类似于Android中的R类。

配置

此生成器支持生成通用的assets文件夹和按口味（flavors）划分的assets文件夹。

没有口味时

assets文件夹的必要结构：

<your-project>
├── <assets-folder>/
   ├── images/ (用于图片)
   ├── vectors/ (用于矢量图或SVG)
   ├── translations/ (用于本地化)
   ├── fonts/ (用于字体)
   ├── scripts/ (用于Shell脚本)
   ├── configs/ (用于JSON配置)
   ├── raws/ (用于原始文件)
├── lib/
├── pubspec.yaml

有口味时

assets文件夹的必要结构：

<your-project>
├── <assets-folder>/
   ├── all/ （所有口味通用）
      ├── images/ (用于图片)
      ├── vectors/ (用于矢量图或SVG)
      ├── translations/ (用于本地化)
      ├── fonts/ (用于字体)
      ├── scripts/ (用于Shell脚本)
      ├── configs/ (用于JSON配置)
      ├── raws/ (用于原始文件)
   ├── <flavor-0>
      ├── ... （与all/相同）
   ├── <flavor-1>
      ├── ... （与all/相同）
   ├── <flavor-2>
      ├── ... （与all/相同）
   ├── ...
├── lib/
├── pubspec.yaml

使用方法

激活生成器执行文件：

dart pub global activate resources_generator

进入项目根目录：

cd <your-project>

执行生成器：

dart pub global run resources_generator:generate -i <assets-folder> -o <output-folder> -p <optional-package> -f

自动监控资产变化并生成：

dart pub global run resources_generator:monitor -i <assets-folder> -o <output-folder> -p <optional-package> -f

参数说明：

• -i 或 --input：可选，输入的资产文件夹，默认为assets。
• -o 或 --output：可选，输出文件夹，默认为lib/resources。
• -p 或 --package：可选，包名，如果资产在模块中而不是应用中。
• -f 或 --with-flavor：可选，将资源类生成到口味中。

注意事项

字体生成

生成字体时，字体文件名必须遵循以下格式：<family>-<attr-1>-<attr-2>.ttf，其中attrs表示字体样式和粗细。这些属性是可选的。
示例：

Roboto.ttf, Roboto-Italic.ttf, Roboto-Italic-w600.ttf

颜色生成

生成颜色时，所有以colors为前缀的JSON文件都会被处理。根据此类文件的数量，生成器会生成合适的资源文件。
示例：

单个文件（单变体颜色）：

├── <assets-folder>/
   ├── colors/
      ├── colors.json

多个文件（多变体颜色）：

├── <assets-folder>/
   ├── colors/
      ├── colors_dark.json
      ├── colors_light.json

完整示例

项目结构

my_project/
├── assets/
   ├── images/
      ├── logo.png
      ├── background.jpg
   ├── fonts/
      ├── Roboto-Regular.ttf
      ├── Roboto-Bold.ttf
   ├── colors/
      ├── colors.json
├── lib/
├── pubspec.yaml

生成命令

dart pub global run resources_generator:generate -i assets -o lib/resources

生成后的资源类示例（lib/resources/assets.dart）：

class Assets {
  // 图片
  static const String imageLogo = 'assets/images/logo.png';
  static const String imageBackground = 'assets/images/background.jpg';

  // 字体
  static const String fontRobotoRegular = 'assets/fonts/Roboto-Regular.ttf';
  static const String fontRobotoBold = 'assets/fonts/Roboto-Bold.ttf';

  // 颜色
  static const Map<String, dynamic> colors = {
    "primary": "#000000",
    "secondary": "#FFFFFF",
  };
}