Flutter资源文件生成插件sheepu_assets_generator的使用

sheepu_assets_generator

sheepu_assets_generator 是一个用于自动生成单个项目或多模块项目中资源文件配置（yaml）和常量的 Flutter 工具。

[]

语言支持：英语 | 简体中文

• sheepu_assets_generator
  • 使用
    • 环境
    • 激活sheepu_assets_generator
    • 命令
      • 帮助
      • 演示
      • 所有命令
    • Dart
      • 在项目中使用
      • 在模块中使用

使用

环境

你需要将 pub 的 bin 路径添加到系统的 PATH 中。

更多关于 pub global 的信息可以参考 官方文档。

激活 sheepu_assets_generator

运行以下命令来全局安装插件：

dart pub global activate sheepu_assets_generator

命令

帮助

查看帮助信息：

sheepu_agen -h

演示

运行一个简单的示例：

sheepu_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 是否保存参数到本地 如果仅运行 sheepu_agen 而不带任何参数，则会执行保存的参数 -o, --out 常量类的生成路径（默认值为 “lib”） -r, --rule 资源常量名称的命名规则 “lwu” (lowercase_with_underscores)：assets_images_xxx_jpg “uwu” (uppercase_with_underscores)：ASSETS_IMAGES_XXX_JPG “lcc” (lowerCamelCase)：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,
);

完整示例

假设你有一个 Flutter 项目，其结构如下：

project/
├── assets/
│   └── images/
│       ├── logo.png
│       └── background.jpg
├── lib/
│   └── main.dart
└── pubspec.yaml

1. 配置 pubspec.yaml

确保你的 pubspec.yaml 文件中正确配置了资源文件：

flutter:
  assets:
    - assets/images/logo.png
    - assets/images/background.jpg

2. 生成资源常量

运行以下命令生成资源常量：

sheepu_agen -p . -f assets/images -t f -r lcc -c MyAssets

这将生成一个名为 MyAssets 的类，其中包含以驼峰命名法命名的资源常量。

3. 使用生成的常量

在 main.dart 中使用生成的常量：

import 'package:project/lib/my_assets.dart';

void main() {
  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        body: Center(
          child: Column(
            mainAxisAlignment: MainAxisAlignment.center,
            children: [
              Image.asset(MyAssets.assetsImagesLogoPng),
              SizedBox(height: 20),
              Image.asset(MyAssets.assetsImagesBackgroundJpg),
            ],
          ),
        ),
      ),
    );
  }
}