Flutter应用框架组件插件app_framework_component的使用

应用框架组件

MyCS应用框架组件实现了一些核心的基础类，为构建以下内容提供了框架：

• 应用程序功能
• 管理状态和服务
• 处理通知

功能框架

以下序列图概述了一个功能的生命周期。

sequenceDiagram
    App Main->>FeatureRegistry: FeatureRegistry.intialize(&configLoaderFn)
    
    rect rgb(112,128,144)

    note right of App Main: 功能注册和初始化
    activate App Main
        rect rgb(80,128,144)
        loop for each feature
            create participant Feature
            App Main->>Feature: feature=Feature()
            Note right of Feature: 这是一个实现了Feature类的实现，它实现了功能的范围、状态和UI钩子的锚点。
            App Main->>FeatureRegistry: register(feature)
            activate FeatureRegistry
            FeatureRegistry->>FeatureRegistry: config=load feature configuration
            FeatureRegistry->>Feature: initialize(config, registered features)
            activate Feature
                create participant Service
                Feature->>Service: add Service to Feature.blocs property
                Note right of Service: 这是一个实现了Service类的实现，该类实现了功能使用的BloC功能。
                Feature-->>FeatureRegistry: 
            deactivate Feature
            FeatureRegistry->>FeatureRegistry: add feature to list of registered features
            FeatureRegistry-->>App Main: 
            deactivate FeatureRegistry
            end
        end
    deactivate App Main

    note right of App Main: 为构建上下文设置本地化
    activate App Main
        rect rgb(80,128,144)        
        App Main->>FeatureRegistry: updateLocalizations(context)
        activate FeatureRegistry
        loop for each feature
            FeatureRegistry->>Feature: blocs
            loop for each bloc that is a Service
                FeatureRegistry->>Service: updateLocalizations(context)
            end
        end
        FeatureRegistry-->>App Main: 
        deactivate FeatureRegistry
        end
    deactivate App Main

    end

    rect rgb(112,128,144)
    note right of App Main: 功能UX
    activate App Main
        create participant FeatureContainer
        App Main->>FeatureContainer: feature=FeatureContainer()
        Note right of FeatureContainer: 这是一个实现了FeatureContainer小部件的实现，它为功能实现UI钩子。它查询功能以获取可以渲染到容器中的锚点。
        rect rgb(80,128,144)        
            activate FeatureContainer
            Note left of FeatureContainer: initState()
                FeatureContainer->>FeatureRegistry: anchors = getAnchors(hookName)
                activate FeatureRegistry
                loop for each feature
                    FeatureRegistry->>Feature: anchors
                    FeatureRegistry->>FeatureRegistry: enumerate each anchor that matches the hookName                
                end
                FeatureRegistry-->>FeatureContainer: anchors for hookName
                deactivate FeatureRegistry
            deactivate FeatureContainer
        end
        
        rect rgb(80,128,144)
            activate FeatureContainer
            Note left of FeatureContainer: build(context)
            Note left of FeatureContainer: FeatureContainer实现的小部件的build覆盖应该在其UI中添加功能锚点。
                FeatureContainer->>FeatureContainer: build(container, anchors)                
            deactivate FeatureContainer
        end
    deactivate App Main
    end

开始使用

安装

将插件作为依赖项添加到您的Flutter应用程序的pubspec.yaml文件中。

dependencies:
  .
  .
  app_framework_component: ^0.0.25
  .
  .

实现一个功能

在您的项目中创建一个实现Feature类的功能。例如：

import 'package:app_framework_component/app_framework_component.dart';

class MyFeature extends Feature {
  [@override](/user/override)
  void initialize(Map<String, dynamic> config, List<Feature> registeredFeatures) {
    // 初始化配置和已注册的功能
    super.initialize(config, registeredFeatures);
    // 添加服务
    addBloc(MyService());
  }

  [@override](/user/override)
  void build(BuildContext context, List<Anchor> anchors) {
    // 构建UI并添加锚点
    // 这里可以添加具体的功能UI实现
  }
}

class MyService extends Service {
  // 实现服务的具体逻辑
}

集成功能

在主应用中注册和集成功能。例如：

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

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: FeatureRegistry(
        child: FeatureContainer(),
        initializers: [
          (context) => MyFeature().initialize(null, []),
        ],
      ),
    );
  }
}