Flutter合同属性管理插件contract_prop的使用

contract_prop

contract_prop 是一个用于小部件属性依赖注入（Dependency Injection, DI）的插件，通过继承范围提供覆盖合同。

开始使用

添加包到项目中

在你的 Flutter 项目中添加 contract_prop 包：

flutter pub add contract_prop

实现 ContractInterface

为你的合同实现 ContractInterface。例如：

class LabelContract with ContractInterface {
  final String name;

  // 默认构造函数
  LabelContract({this.name = 'foo bar'});

  // 定义合同属性
  ContractProp<String> get label => ContractProp<String>(contract: (_) => name);
}

创建小部件并包装 ContractPropBuilder

创建一个小部件，并用 ContractPropBuilder 包装它：

class ContractText extends StatelessWidget {
  final String? text;

  const ContractText({Key? key, this.text}) : super(key: key);

  [@override](/user/override)
  Widget build(BuildContext context) {
    return ContractPropBuilder<LabelContract>(
      // 提供默认合同实例
      contract: LabelContract(),
      builder: (_, contract) => Text(
        text ?? contract.label.value(context) ?? '', // 获取合同属性值
      ),
    );
  }
}

覆盖合同

在应用中覆盖合同。例如：

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

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      builder: (_, child) {
        return ContractScope(
          // 提供覆盖的合同实例
          contracts: [
            LabelContract(name: 'Hello world'),
          ],
          child: child!,
        );
      },
      home: const Scaffold(body: Center(child: DemoPage())),
    );
  }
}

自定义合同

你可以扩展默认合同以实现自定义行为。例如：

class CustomLabelContract extends LabelContract {
  [@override](/user/override)
  ContractProp<String> get label => ContractProp<String>(contract: (_) => 'custom');
}

然后在 ContractScope 中使用自定义合同：

ContractScope(
  contracts: [
    CustomLabelContract(),
  ],
  child: child!,
)

示例代码

以下是完整的示例代码：

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

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

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

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      builder: (_, child) {
        return ContractScope(
          contracts: [
            LabelContract(name: 'Hello world'), // 覆盖默认合同
          ],
          child: child!,
        );
      },
      home: const Scaffold(body: Center(child: DemoPage())),
    );
  }
}

class ContractText extends StatelessWidget {
  final String? text;

  const ContractText({Key? key, this.text}) : super(key: key);

  [@override](/user/override)
  Widget build(BuildContext context) {
    return ContractPropBuilder<LabelContract>(
      contract: LabelContract(), // 提供默认合同实例
      builder: (_, contract) => Text(
        text ?? contract.label.value(context) ?? '', // 获取合同属性值
      ),
    );
  }
}

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

  [@override](/user/override)
  Widget build(BuildContext context) {
    return const ContractText();
  }
}

// 定义合同接口
class LabelContract with ContractInterface {
  final String name;

  LabelContract({this.name = 'foo bar'});

  ContractProp<String> get label => ContractProp<String>(contract: (_) => name);
}

// 自定义合同
class CustomLabelContract extends LabelContract {
  [@override](/user/override)
  ContractProp<String> get label => ContractProp<String>(contract: (_) => 'custom');
}

更多关于Flutter合同属性管理插件contract_prop的使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html

sinazl 1楼•6 天前

更多关于Flutter合同属性管理插件contract_prop的使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html

contract_prop 是一个用于管理合同属性的 Flutter 插件。它可以帮助开发者在 Flutter 应用中轻松地管理和操作合同相关的属性。以下是如何使用 contract_prop 插件的基本步骤：

1. 添加依赖

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

dependencies:
  flutter:
    sdk: flutter
  contract_prop: ^1.0.0  # 请使用最新版本

然后运行 flutter pub get 来获取依赖。

2. 导入插件

在你的 Dart 文件中导入 contract_prop 插件：

import 'package:contract_prop/contract_prop.dart';

3. 初始化插件

在使用插件之前，通常需要对其进行初始化。你可以在 main.dart 文件中进行初始化：

void main() async {
  WidgetsFlutterBinding.ensureInitialized();
  await ContractProp.initialize();
  runApp(MyApp());
}

4. 使用插件

contract_prop 插件提供了多种方法来管理合同属性。以下是一些常见的使用示例：

添加合同属性

await ContractProp.addProperty(
  contractId: '12345',
  propertyName: 'price',
  propertyValue: '1000',
);

获取合同属性

String? price = await ContractProp.getProperty(
  contractId: '12345',
  propertyName: 'price',
);
print('Price: $price');

更新合同属性

await ContractProp.updateProperty(
  contractId: '12345',
  propertyName: 'price',
  newValue: '1500',
);

删除合同属性

await ContractProp.deleteProperty(
  contractId: '12345',
  propertyName: 'price',
);

获取所有合同属性

Map<String, String> properties = await ContractProp.getAllProperties(
  contractId: '12345',
);
print('Properties: $properties');

5. 处理错误

在使用插件时，可能会遇到一些错误。你可以使用 try-catch 块来捕获并处理这些错误：

try {
  await ContractProp.addProperty(
    contractId: '12345',
    propertyName: 'price',
    propertyValue: '1000',
  );
} catch (e) {
  print('Error: $e');
}

6. 示例应用

以下是一个简单的示例应用，展示了如何使用 contract_prop 插件：

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

void main() async {
  WidgetsFlutterBinding.ensureInitialized();
  await ContractProp.initialize();
  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: Text('Contract Prop Example'),
        ),
        body: Center(
          child: Column(
            mainAxisAlignment: MainAxisAlignment.center,
            children: [
              ElevatedButton(
                onPressed: () async {
                  await ContractProp.addProperty(
                    contractId: '12345',
                    propertyName: 'price',
                    propertyValue: '1000',
                  );
                  print('Property added');
                },
                child: Text('Add Property'),
              ),
              ElevatedButton(
                onPressed: () async {
                  String? price = await ContractProp.getProperty(
                    contractId: '12345',
                    propertyName: 'price',
                  );
                  print('Price: $price');
                },
                child: Text('Get Property'),
              ),
              ElevatedButton(
                onPressed: () async {
                  await ContractProp.updateProperty(
                    contractId: '12345',
                    propertyName: 'price',
                    newValue: '1500',
                  );
                  print('Property updated');
                },
                child: Text('Update Property'),
              ),
              ElevatedButton(
                onPressed: () async {
                  await ContractProp.deleteProperty(
                    contractId: '12345',
                    propertyName: 'price',
                  );
                  print('Property deleted');
                },
                child: Text('Delete Property'),
              ),
              ElevatedButton(
                onPressed: () async {
                  Map<String, String> properties = await ContractProp.getAllProperties(
                    contractId: '12345',
                  );
                  print('Properties: $properties');
                },
                child: Text('Get All Properties'),
              ),
            ],
          ),
        ),
      ),
    );
  }
}