README

简介

Super Magic Module 是一个基于 Hyperf 框架的扩展包，专为 magic-service 设计的增强扩展模块。该模块采用领域驱动设计（DDD）架构，为应用程序提供了清晰的分层结构和丰富的功能组件。

Super Magic Module 需要结合 magic-service 一起使用，其核心功能是通过接管 magic-service 的消息事件，建立用户与超级麦吉智能体之间的信息传递通道。这种设计使得用户可以无缝地与智能体进行交互，从而获得更加智能化的服务体验。

作为一个桥接模块，Super Magic Module 不仅处理消息的传递，还负责转换数据格式、协调事件流程，以及提供必要的上下文信息，确保智能体能够准确理解用户意图并给出恰当的响应。

功能特性

基于 Hyperf 3.1 构建，完美适配现有 magic-service 架构
遵循领域驱动设计（DDD）架构，代码组织清晰，易于维护
提供资源共享功能，支持跨模块资源访问
作为消息通道，连接用户与超级麦吉智能体
支持事件监听与处理，实时响应用户请求
提供工作区管理，支持多话题、多任务处理
实现文件管理系统，支持智能体对文件的操作
符合 PSR 规范的代码组织，确保代码质量

系统架构

Super Magic Module 作为 magic-service 的扩展，在整个系统中扮演以下角色：

用户请求 → magic-service → Super Magic Module → 超级麦吉智能体
                 ↑                 |
                 └─────────────────┘
              响应返回

该模块通过以下方式与 magic-service 集成：

监听 magic-service 的消息事件
处理和转换消息格式
传递消息至超级麦吉智能体
接收并处理智能体的响应
将处理结果返回给 magic-service

安装

通过 Composer 安装：

composer require dtyq/super-magic-module

基本使用

配置

模块提供了 ConfigProvider 用于注册相关服务和功能。在 Hyperf 应用的 config/autoload 目录下配置：

<?php

return [
    // 加载 ConfigProvider
    \Dtyq\SuperMagic\ConfigProvider::class,
];

与 magic-service 集成

要将 Super Magic Module 与 magic-service 集成，需要在 magic-service 中依赖进行接管：

[
    'dependencies_priority' => [
        // 助理执行事件
        AgentExecuteInterface::class => SuperAgentMessageSubscriberV2::class,
        SuperAgentMessageInterface::class => SuperAgentMessage::class,
    ]
]

领域层使用

模块基于 DDD 架构设计，包含以下几个主要层次：

Domain（领域层）：包含业务逻辑和实体，如消息处理、工作区管理等核心功能
Application（应用层）：协调领域对象完成复杂的业务场景，如消息传递流程
Infrastructure（基础设施层）：提供技术支持，包括数据存储、外部服务调用等
Interfaces（接口层）：处理外部请求和响应，提供API接口

开发

目录结构

src/
├── Application/      # 应用层，处理业务流程
│   ├── Share/        # 资源共享服务
│   └── SuperAgent/   # 超级智能体服务
├── Domain/           # 领域层，包含核心业务逻辑
│   ├── Share/        # 资源共享领域模型
│   └── SuperAgent/   # 超级智能体领域模型
├── Infrastructure/   # 基础设施层，提供技术实现
│   ├── ExternalAPI/  # 外部API调用
│   └── Utils/        # 工具类
├── Interfaces/       # 接口层，处理外部交互
│   ├── Share/        # 资源共享接口
│   └── SuperAgent/   # 超级智能体接口
├── Listener/         # 事件监听器
└── ConfigProvider.php # 配置提供者

命令

该扩展包提供了一系列有用的命令：

# 代码风格修复
composer fix

# 代码静态分析
composer analyse

# 执行测试
composer test

# 启动 Hyperf 服务
composer start

消息流程

Super Magic Module 处理消息的基本流程如下：

用户在 magic-service 发送消息
magic-service 触发消息事件
Super Magic Module 监听到事件，提取消息内容
消息被转换为超级麦吉智能体可理解的格式
消息发送给超级麦吉智能体
智能体处理消息并生成响应
Super Magic Module 接收响应并转换格式
响应通过事件传递回 magic-service
用户收到智能体的回应

测试

执行测试：

composer test

贡献指南

Fork 该仓库
创建特性分支 (git checkout -b feature/amazing-feature)
提交更改 (git commit -m 'Add some amazing feature')
推送到分支 (git push origin feature/amazing-feature)
创建一个 Pull Request

作者

dtyq team - team@dtyq.com

许可证

该项目采用私有许可证 - 详情请参阅团队内部文档。

项目状态

该模块正在积极开发中，作为 magic-service 的增强组件，持续提供智能交互能力的升级。我们欢迎团队成员提供反馈和建议，共同完善这一关键模块。

dtyq / super-magic-module

Maintainers

Details