Flutter插件objd_gen的使用方法

objd_gen

这个包包含由source_gen生成的代码生成器。通过注解，可以更简洁地编写Widgets、Files、Packs和Projects。

Flutter插件objd_gen的安装

在你的pubspec.yaml文件中添加这个包作为开发依赖：

dev_dependencies:
  build_runner: 
  objd_gen: ^0.0.2

生成器会在与你注解文件相邻的位置创建新的dart类和函数。为了使它们可用，你需要使用part语句导入它们：

import 'package:objd/core.dart';

part '[your_filename].g.dart';

在编写完所有的Widgets后，你可以运行以下命令来生成相关的类和函数：

pub run build_runner build

如果你想在保存时自动重新生成，可以运行：

pub run build_runner watch

Widget

使用@Wdg注解可以使编写Widget变得更加简单。你可以给它一个带有所需参数的函数，该函数返回一个新的Widget，然后生成器会根据这个函数生成相应的Widget类。

例如：

@Wdg
Widget helloWorld() => Log('Hello World!');

运行build_runner后，会生成一个名为HelloWorld的新Widget（继承自函数名），因此建议使用小写函数名。

参数也可以像预期的那样工作，并且如果你需要，还可以访问到Widget的上下文：

@Wdg
Widget helloName(String name, {String lastname = '', required Context context}) =>
  For.of([
    Comment('This was generated by HelloName on version ${context.version}'),
    Log('Hello $name $lastname!'),
  ]);

这将转换为如下方式的Widget，你可以在项目中的任何地方使用它：

class HelloName extends Widget {
  final String name;
  final String lastname;

  HelloName(
    this.name, {
    this.lastname = '',
  });

  @override
  Widget generate(Context context) => helloName(
        name,
        lastname: lastname,
        context: context,
      );
}

File

使用@Func()注解可以简化编写Minecraft函数的过程。只需在应该包含在函数中的Widget变量上添加@Func()注解即可：

@Func()
final Widget load = HelloWorld();

这将读取变量名load并生成一个名为LoadFile的新变量，其中包含File Widget：

final File LoadFile = File(
  '/load',
  child: load,
);

在@Func()的括号内，你可以提供各种参数来自定义文件生成：

示例：

@Func(
  name: 'main',
  path: 'folder',
  execute: false,
  create: true,
)
final Widget main_widget = Comment('main file');

Pack

@Pck()注解的工作方式类似于@Func()。你可以注解一个File列表变量，并生成一个表示这个Pack的Widget。

如果你不提供命名空间，它将选择你的变量名。

示例：

@Pck(name: 'namespace', main: 'main', load: 'load')
final List<File> myPack = [
  LoadFile,
  MainFile,
];

这将生成这样的Widget：

class NamespacePack extends Widget {
  @override
  Widget generate(Context context) => Pack(
        name: 'namespace',
        files: myPack,
        load: File('load', create: false),
        main: File('main', create: false),
      );
}

Project

最后，创建一个数据包需要一个@Prj。这可以自动生成一个主函数，包含所有必要的部分，以便实际生成所有的包和文件。

我们仍然需要注解一个Widget变量，它是我们的Widget树的根：

@Prj(
  name: 'My awesome Datapack',
  target: './datapacks/',
  version: 17,
  description: 'A simple dp for demonstrating annotations',
)
final myProject = NamespacePack();

这将在g.dart中生成如下内容：

void main([List<String> args = const []]) => createProject(
      Project(
        name: 'My awesome Datapack',
        target: './datapacks/',
        version: 17,
        description: 'A simple dp for demonstrating annotations',
        generate: myProject,
      ),
      args,
    );