Flutter资源生成插件assets_generator_by_zpdl的使用

Flutter资源生成插件assets_generator_by_zpdl的使用

概述

assets_generator_by_zpdl 插件提供了用于处理资源的 Dart 构建系统构建器。该插件通过识别 assets_annotation_by_zpdl 包中定义的注解来生成代码，并根据 pubspec.yaml 文件中的资源进行生成。

安装

在 pubspec.yaml 文件中添加以下依赖项：

dependencies:
  assets_annotation_by_zpdl: ^1.3.0

dev_dependencies:
  assets_generator_by_zpdl: ^1.3.0
  build_runner: <latest>

然后运行 flutter packages pub get 命令以安装这些依赖项。

使用方法

1. 创建一个带有 [@AssetsAnnotation](/user/AssetsAnnotation) 的类

import 'package:assets_annotation_by_zpdl/assets_annotation_by_zpdl.dart';

part 'assets.g.dart';

[@AssetsAnnotation](/user/AssetsAnnotation).camelCase(version: '1.0.0')
class Assets {
  const Assets();
}

上述代码创建了一个名为 Assets 的类，并用 [@AssetsAnnotation](/user/AssetsAnnotation).camelCase 注解来指示使用驼峰命名法。version 参数用于版本控制。

2. 生成你的资源

运行以下命令以生成 lib/assets.g.dart 文件：

flutter packages pub run build_runner build

这将根据 pubspec.yaml 中定义的资源生成对应的 Dart 类。

3. 使用你的资源

const assets = Assets();

print(assets.image.image);
print(assets.animation.animation);

注解值

注解支持以下几种命名方式：

1. isCamelCase：首字母小写，其余单词首字母大写。
2. isSnakeCase：每个单词之间用下划线连接。
3. version：用于更新版本。

示例代码

以下是一个完整的示例代码，展示了如何使用 assets_generator_by_zpdl 插件：

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

part 'main.g.dart';

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

/// 原始命名
[@AssetsAnnotation](/user/AssetsAnnotation)(version: '1.0.0')
class Assets {
  const Assets();
}

const assets = Assets();

/// 驼峰命名
[@AssetsAnnotation](/user/AssetsAnnotation).camelCase(version: '1.0.0')
class AssetsCamel {
  const AssetsCamel();
}

const assetsCamel = AssetsCamel();

/// 蛇形命名
[@AssetsAnnotation](/user/AssetsAnnotation).snakeCase(version: '1.0.0')
class AssetsSnake {
  const AssetsSnake();
}

const assetsSnake = AssetsSnake();

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  // 这是你的应用的根部件
  [@override](/user/override)
  Widget build(BuildContext context) {
    return const MaterialApp(
      title: 'assets generator by zpdl Demo',
      home: MyHomePage(),
    );
  }
}

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

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(title: const Text('Assets generator',)),
      body: ListView(
        children: [
          _buildListTile(
              assets.image.uog____61___264____32__1____920,
              assetsCamel.image.og61264321920,
              assetsSnake.image.og____61___264____32__1____920),
          _buildListTile(
              assets.image.camelAlbum.iconCalendarJpg,
              assetsCamel.image.camelAlbum.iconCalendarJpg,
              assetsSnake.image.camel_album.icon_calendar_jpg),
          _buildListTile(
              assets.image.snake_guide.snake_guide,
              assetsCamel.image.snakeGuide.snakeGuide,
              assetsSnake.image.snake_guide.snake_guide),
          _buildListTile(
              assets.camelGuide,
              assetsCamel.camelGuide,
              assetsSnake.camel_guide),
        ],
      ),
    );
  }

  Widget _buildListTile(String assets, String assetsCamel, String assetsSnake) {
    return ListTile(
      title: Text(assets),
      subtitle: Text('$assetsCamel\n$assetsSnake'),
      leading: Image.asset(assets),
    );
  }
}