Flutter插件smartbok的安装与使用

smartbok

Dart 注解处理器，用于减少样板代码。深受 Project Lombok 的启发。

安装

在 pubspec.yaml 文件中添加 smartbok 作为开发依赖项。

dev_dependencies:
  smartbok:

运行生成器：

dart run build_runner build
flutter packages pub run build_runner build
// 或者实时监听
flutter packages pub run build_runner watch

使用

CopyWith

为带有注解的类生成扩展，并生成一个 $copyWith 方法。

示例代码

源文件 (model.dart)

// 引入 smartbok 注解
import 'package:smartbok/smartbok.dart';

// 定义模型类并添加 @CopyWith 注解
@CopyWith
class Model {
    // 最终字段
    final String text;
    final num number;
    // 可变字段
    String someText;

    // 构造函数
    Model(this.text, {this.number});
}

生成文件 (model.g.dart)

运行生成器后会自动生成以下代码：

// 扩展类，包含 $copyWith 方法
extension ModelCopyWithExtension on Model {
  // 定义 $copyWith 方法
  Model $copyWith({
    String? text, 
    num? number, 
    String? someText
  }) {
    // 创建新的 Model 实例
    final model = Model(
      text ?? this.text, // 如果传入了 text，则使用传入值，否则使用原始值
      number: number ?? this.number // 如果传入了 number，则使用传入值，否则使用原始值
    );
    // 更新可变字段
    model.someText = someText ?? this.someText;
    return model; // 返回新的实例
  }
}

完整示例 Demo

以下是一个完整的 Flutter 示例，展示如何使用 smartbok 的 CopyWith 功能。

示例代码

主文件 (main.dart)

import 'package:flutter/material.dart';
import 'model.dart'; // 导入定义的 Model 类
import 'model.g.dart'; // 导入生成的扩展类

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

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(title: Text('Smartbok Example')),
        body: Center(
          child: EditableModel(),
        ),
      ),
    );
  }
}

class EditableModel extends StatefulWidget {
  @override
  _EditableModelState createState() => _EditableModelState();
}

class _EditableModelState extends State<EditableModel> {
  // 初始化 Model 实例
  Model model = Model('Hello', number: 42);

  // 更新模型状态的方法
  void updateModel() {
    setState(() {
      // 使用 $copyWith 方法创建新实例并更新字段
      model = model.$copyWith(
        text: 'World',
        number: 99,
        someText: 'Updated Field',
      );
    });
  }

  @override
  Widget build(BuildContext context) {
    return Column(
      mainAxisAlignment: MainAxisAlignment.center,
      children: [
        Text('Current Model: $model'),
        ElevatedButton(
          onPressed: updateModel,
          child: Text('Update Model'),
        ),
      ],
    );
  }
}

生成文件 (model.g.dart)

如上所述，通过运行生成器会生成以下代码：

extension ModelCopyWithExtension on Model {
  Model $copyWith({
    String? text, 
    num? number, 
    String? someText
  }) {
    final model = Model(
      text ?? this.text,
      number: number ?? this.number
    );
    model.someText = someText ?? this.someText;
    return model;
  }
}