Flutter对象编辑标注插件obj_edit_annotation的使用

obj_edit_annotation 是一个用于 Flutter 的对象编辑标注插件，它允许开发者通过注解的方式对对象进行编辑和标注。这个插件通常用于在 Flutter 应用中实现对象的动态编辑功能，比如表单生成、对象属性编辑等。

安装

首先，你需要在 pubspec.yaml 文件中添加 obj_edit_annotation 插件的依赖：

dependencies:
  flutter:
    sdk: flutter
  obj_edit_annotation: ^latest_version

然后运行 flutter pub get 来安装依赖。

基本用法

1. 创建可编辑的对象类

   你需要创建一个类，并使用 [@ObjEdit](/user/ObjEdit) 注解来标记这个类，表示这个类的对象可以被编辑。

   import 'package:obj_edit_annotation/obj_edit_annotation.dart';
   
   [@ObjEdit](/user/ObjEdit)()
   class User {
     String name;
     int age;
     String email;
   
     User({required this.name, required this.age, required this.email});
   }
   

2. 生成编辑表单

   obj_edit_annotation 插件会自动生成一个用于编辑该对象的表单。你可以在代码中使用生成的表单来编辑对象的属性。

   import 'package:flutter/material.dart';
   import 'user.dart'; // 假设你的User类在user.dart文件中
   
   class UserEditScreen extends StatelessWidget {
     final User user;
   
     UserEditScreen({required this.user});
   
     @override
     Widget build(BuildContext context) {
       return Scaffold(
         appBar: AppBar(
           title: Text('Edit User'),
         ),
         body: Padding(
           padding: const EdgeInsets.all(16.0),
           child: UserEditForm(user: user),
         ),
       );
     }
   }
   

   在这个例子中，UserEditForm 是 obj_edit_annotation 插件自动生成的表单组件。

3. 处理表单提交

   你可以在表单提交时获取用户输入的数据，并更新对象。

   class UserEditScreen extends StatefulWidget {
     final User user;
   
     UserEditScreen({required this.user});
   
     @override
     _UserEditScreenState createState() => _UserEditScreenState();
   }
   
   class _UserEditScreenState extends State<UserEditScreen> {
     late User user;
   
     @override
     void initState() {
       super.initState();
       user = widget.user;
     }
   
     void _onFormSubmit(User editedUser) {
       setState(() {
         user = editedUser;
       });
       // 这里可以添加保存数据的逻辑
     }
   
     @override
     Widget build(BuildContext context) {
       return Scaffold(
         appBar: AppBar(
           title: Text('Edit User'),
         ),
         body: Padding(
           padding: const EdgeInsets.all(16.0),
           child: UserEditForm(
             user: user,
             onFormSubmit: _onFormSubmit,
           ),
         ),
       );
     }
   }
   

   在这个例子中，_onFormSubmit 方法会在表单提交时被调用，并接收编辑后的 User 对象。

自定义表单字段

你可以通过注解来自定义表单字段的显示方式和验证规则。

[@ObjEdit](/user/ObjEdit)()
class User {
  [@Field](/user/Field)(label: "Full Name", required: true)
  String name;

  [@Field](/user/Field)(label: "Age", validator: _validateAge)
  int age;

  [@Field](/user/Field)(label: "Email", inputType: InputType.email)
  String email;

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

  static String? _validateAge(int? value) {
    if (value == null || value < 0) {
      return 'Age must be a positive number';
    }
    return null;
  }
}