Flutter代码生成插件tenon_generator的使用

tenon_generator 是一个用于生成 Flutter 代码的插件。它通常与 tenon_annotation 配合使用，通过注解来生成所需的代码。以下是一个完整的示例，展示如何使用 tenon_generator。

使用步骤

1. 添加依赖

首先，在 pubspec.yaml 文件中添加 tenon_annotation 和 tenon_generator 作为依赖项：

dependencies:
  tenon_annotation: ^1.0.0

dev_dependencies:
  tenon_generator: ^1.0.0
  build_runner: ^2.0.0

然后运行以下命令以安装依赖：

flutter pub get

2. 创建注解类

接下来，创建一个带有注解的类。例如，我们定义一个简单的 User 类，并使用 @Generate 注解来生成相关的代码。

// lib/user.dart
import 'package:tenon_annotation/tenon_annotation.dart';

part 'user.g.dart'; // 这是生成的代码文件

@Generate()
class User {
  final String name;
  final int age;

  User({required this.name, required this.age});
}

3. 生成代码

在项目根目录下运行以下命令以生成代码：

flutter pub run build_runner build

生成的代码会出现在 user.g.dart 文件中。你可以查看生成的代码以了解它是如何工作的。

4. 使用生成的代码

现在可以在其他地方使用生成的代码。例如：

// lib/main.dart
import 'package:flutter/material.dart';
import 'user.dart';

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

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(title: Text('Tenon Generator Example')),
        body: Center(
          child: UserWidget(user: User(name: 'John Doe', age: 30)),
        ),
      ),
    );
  }
}

class UserWidget extends StatelessWidget {
  final User user;

  UserWidget({required this.user});

  @override
  Widget build(BuildContext context) {
    return Column(
      mainAxisAlignment: MainAxisAlignment.center,
      children: [
        Text('Name: ${user.name}'),
        Text('Age: ${user.age}'),
      ],
    );
  }
}

5. 运行应用

运行应用以查看效果：

flutter run

更多关于Flutter代码生成插件tenon_generator的使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html

itying888 1楼•8 天前作者

更多关于Flutter代码生成插件tenon_generator的使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html

tenon_generator 是一个用于 Flutter 的代码生成插件，它可以帮助开发者自动生成一些重复性的代码，从而提高开发效率。以下是如何使用 tenon_generator 的基本步骤：

1. 添加依赖

首先，你需要在 pubspec.yaml 文件中添加 tenon_generator 和 build_runner 的依赖。

dependencies:
  flutter:
    sdk: flutter
  tenon_annotation: ^1.0.0  # 如果有注解库的话

dev_dependencies:
  build_runner: ^2.1.0
  tenon_generator: ^1.0.0

2. 创建注解（可选）

如果你需要自定义注解，可以创建一个注解类。例如：

// lib/annotations/my_annotation.dart
class MyAnnotation {
  final String name;

  const MyAnnotation(this.name);
}

3. 创建生成器

接下来，你需要创建一个生成器类，这个类将负责生成代码。例如：

// lib/generators/my_generator.dart
import 'package:tenon_generator/tenon_generator.dart';
import 'package:source_gen/source_gen.dart';
import 'package:build/src/builder/build_step.dart';
import 'package:analyzer/dart/element/element.dart';

class MyGenerator extends GeneratorForAnnotation<MyAnnotation> {
  @override
  generateForAnnotatedElement(
      Element element, ConstantReader annotation, BuildStep buildStep) {
    final name = annotation.read('name').stringValue;
    return '''
// Generated code
class ${name}Generated {
  void sayHello() {
    print('Hello, $name!');
  }
}
''';
  }
}

4. 使用注解

在你的代码中使用注解，并标记需要生成代码的部分。例如：

// lib/main.dart
import 'package:flutter/material.dart';
import 'annotations/my_annotation.dart';

@MyAnnotation('MyClass')
class MyClass extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: Text('Tenon Generator Example'),
        ),
        body: Center(
          child: Text('Hello, World!'),
        ),
      ),
    );
  }
}

5. 运行代码生成器

使用 build_runner 来生成代码。在终端中运行以下命令：

flutter pub run build_runner build

6. 查看生成的代码

生成的代码通常会放在 lib 目录下的 .g.dart 文件中。例如，my_class.g.dart 文件可能包含以下内容：

// GENERATED CODE - DO NOT MODIFY BY HAND

// **************************************************************************
// MyGenerator
// **************************************************************************

// Generated code
class MyClassGenerated {
  void sayHello() {
    print('Hello, MyClass!');
  }
}

7. 使用生成的代码

你可以在你的代码中使用生成的类。例如：

void main() {
  final generated = MyClassGenerated();
  generated.sayHello();
}

8. 自动生成代码（可选）

如果你希望在每次保存文件时自动生成代码，可以使用以下命令：

flutter pub run build_runner watch