zhamao-framework

zhamao-framework

PHP开发的多功能聊天机器人与Web服务框架

炸毛框架是一个基于PHP的开发框架,专注于API服务和聊天机器人开发。框架支持WebSocket和HTTP协议,采用模块化和注解方式,便于功能开发。它提供插件系统、多机器人客户端支持和数据库连接池等特性,适用于构建聊天机器人和Web服务。框架的设计简洁高效,为开发者提供便捷和灵活的开发体验。

炸毛框架聊天机器人Web服务器PHP开发OneBotGithub开源项目
<div align="center"> <img src="https://cdn.jsdelivr.net/gh/zhamao-robot/zhamao-framework/resources/images/logo_trans.png" width = "150" height = "150" alt="炸毛框架"><br> <h2>炸毛框架</h2> 炸毛框架 (zhamao-framework) 是一个高性能的聊天机器人 + Web 服务器开发框架<br><br> <p align="center"> <a href="https://onebot.dev/"> <img src="https://img.shields.io/badge/OneBot-12-black?style=flat-square" alt="OneBot"> </a> <a href="https://github.com/zhamao-robot/zhamao-framework/actions"> <img src="https://img.shields.io/github/actions/workflow/status/zhamao-robot/zhamao-framework/test.yml?branch=v3-develop&label=Test&style=flat-square" alt="Integration Test"> </a> <a href="https://packagist.org/packages/zhamao/framework"> <img src="https://img.shields.io/packagist/dt/zhamao/framework?label=Downloads&style=flat-square" alt="下载数"> </a> <a href="https://github.com/zhamao-robot/zhamao-framework/releases"> <img src="https://img.shields.io/packagist/v/zhamao/framework?include_prereleases&label=Release&style=flat-square" alt="最新版本"> </a> <a href="https://github.com/zhamao-robot/zhamao-framework/blob/master/LICENSE"> <img src="https://img.shields.io/github/license/zhamao-robot/zhamao-framework?label=License&style=flat-square" alt="开源协议"> </a> <a href="https://github.com/zhamao-robot/zhamao-framework/search?q=TODO"> <img src="https://img.shields.io/github/search/zhamao-robot/zhamao-framework/TODO?label=TODO%20Counter&style=flat-square" alt="TODO"> </a> </p> </div>

开发者 QQ 群:670821194 点击加入群聊

如果有愿意一起开发框架本身的开发者,请提出 PR 或 Issue 参与开发!如果对框架本身的核心设计有更好的想法,可与作者成立开发组(目前仅 2 人),参与 OneBot V12 生态和框架本身的开发。

相关正在进行的版本任务见 Projects 一栏!

简介

炸毛框架使用 PHP 编写,主要面向 API 服务,聊天机器人,包含 Websocket、HTTP 等监听和请求库,用户代码采用模块化处理,使用注解可以方便地编写各类功能。

框架主要用途为 HTTP 服务器,机器人搭建框架。尤其对于聊天机器人消息处理较为方便和全面,提供了众多会话机制和内部调用机制,可以以各种方式设计你自己的插件。

#[\BotCommand('你好')] public function hello(\BotContext $ctx) { $ctx->reply("你好,我是炸毛!"); // 简单的命令式回复 } #[\Route('/index')] public function index() { return "<h1>hello!</h1>"; // 快速的 HTTP 服务开发 }

开始

框架目前支持 Linux、WSL、macOS、Windows 环境直接运行,其中 Linux、macOS 环境可直接使用下方一键安装脚本。

如果你想在其他环境安装部署,可使用 Docker 快速部署或手动安装环境后安装框架,详见文档。

# Linux、macOS 下一键检测 PHP 环境、安装框架 bash <(curl -fsSL https://zhamao.xin/v3.sh) # 启动框架 cd zhamao-v3 ./zhamao server

一键安装脚本还有可以自定义参数的方式,比如:

# 脚本默认会检测系统的PHP,如果想直接跳过检测,安装独立的PHP版本,则添加此环境变量 export ZM_NO_LOCAL_PHP="yes" # 脚本如果安装独立版本PHP,默认版本为8.1,如果想使用其他版本,则添加此环境变量指定版本 export ZM_DOWN_PHP_VERSION="8.2" # 脚本默认会将框架在当前目录下的 `zhamao-app` 目录进行安装,如果想使用其他目录,则添加此环境变量 export ZM_CUSTOM_DIR="my-custom-app" # 脚本默认会对本项目使用阿里云国内加速镜像,如果想使用packagist源,则添加此环境变量 export ZM_COMPOSER_PACKAGIST="yes" # 执行完前面的环境变量再执行一键安装脚本,就可以实现自定义参数! bash <(curl -fsSL https://zhamao.xin/v3.sh)

关于其他安装方式,请参阅 文档

文档

查看文档(国内自建):https://framework.zhamao.xin/

备用链接(国外托管):https://framework.zhamao.me/

特点

  • 原生支持多个机器人客户端同时连接
  • 灵活的注解事件绑定机制,可同时使用 Annotation 和原生 Attribute 注解
  • 完善的插件系统,可编写插件后打包或分发,供他人使用
  • 采用插件化编写,可自由搭配其他 Composer 组件,也可单文件面向过程编写
  • 支持模块打包、热加载,分享模块更方便
  • 常驻内存,全局缓存变量随处使用,提供多种缓存方案
  • 自带 MySQL、SQLite、Redis 等数据库连接池
  • 本身为 HTTP 服务器、WebSocket 服务器,可以构建属于自己的 HTTP API 接口
  • 可选自带 PHP 环境,无需手动编译安装,by crazywhalecc/static-php-cli

贡献和捐赠

如果你在使用过程中发现任何问题,可以提交 Issue 或自行 Fork 后修改并提交 Pull Request。

目前项目仅两人维护,耗费精力较大,所以非常欢迎对框架的贡献。

本项目为作者闲暇时间开发,如果觉得好用,不妨进行捐助~你的捐助会让我更加有动力完善插件,感谢你的支持!

我们会将捐赠的资金用于本项目驱动的炸毛机器人和框架文档的服务器开销上。捐赠列表

如果您不想直接参与框架的开发,也可以分享你编写的模块,帮助完善框架生态。

支付宝

支付宝二维码

关于

框架和 SDK 是 炸毛机器人 项目的核心框架开源部分。炸毛机器人是作者写的一个高性能机器人,曾获全国计算机设计大赛一等奖。

作者的炸毛机器人已从2018年初起稳定运行了五年,并且持续迭代。

可以提交 Issue加群(670821194) 进行疑难解答。

本项目在更新内容时,请及时关注 GitHub 动态,更新前请将自己的插件或项目代码做好备份。

项目框架采用 Apache-2.0 协议开源,在分发或重写修改等操作时需遵守协议。项目插件部分(除 src/Globalssrc/ZM 文件夹外的其他文件夹) 在非借鉴框架内代码时可不遵守 Apache-2.0 协议进行分发和修改(声明版权)。

注意:在你使用 mirai 等 AGPL-3.0 协议的机器人软件与框架连接时,使用本框架需要将你编写或修改的部分使用 AGPL-3.0 协议重新分发。

在贡献代码时,请保管好自己的全局配置文件中的敏感信息,请勿将带有个人信息的配置文件上传 GitHub 等网站。

感谢 JetBrains 为此开源项目提供 PhpStorm 开发工具支持:

<img src="https://resources.jetbrains.com/storage/products/company/brand/logos/PhpStorm.svg" width="300">

感谢开发者 @sunxyw 中为项目开发规范化提出的一些建议。

star

编辑推荐精选

讯飞智文

讯飞智文

一键生成PPT和Word,让学习生活更轻松

讯飞智文是一个利用 AI 技术的项目,能够帮助用户生成 PPT 以及各类文档。无论是商业领域的市场分析报告、年度目标制定,还是学生群体的职业生涯规划、实习避坑指南,亦或是活动策划、旅游攻略等内容,它都能提供支持,帮助用户精准表达,轻松呈现各种信息。

AI办公办公工具AI工具讯飞智文AI在线生成PPTAI撰写助手多语种文档生成AI自动配图热门
讯飞星火

讯飞星火

深度推理能力全新升级,全面对标OpenAI o1

科大讯飞的星火大模型,支持语言理解、知识问答和文本创作等多功能,适用于多种文件和业务场景,提升办公和日常生活的效率。讯飞星火是一个提供丰富智能服务的平台,涵盖科技资讯、图像创作、写作辅助、编程解答、科研文献解读等功能,能为不同需求的用户提供便捷高效的帮助,助力用户轻松获取信息、解决问题,满足多样化使用场景。

热门AI开发模型训练AI工具讯飞星火大模型智能问答内容创作多语种支持智慧生活
Spark-TTS

Spark-TTS

一种基于大语言模型的高效单流解耦语音令牌文本到语音合成模型

Spark-TTS 是一个基于 PyTorch 的开源文本到语音合成项目,由多个知名机构联合参与。该项目提供了高效的 LLM(大语言模型)驱动的语音合成方案,支持语音克隆和语音创建功能,可通过命令行界面(CLI)和 Web UI 两种方式使用。用户可以根据需求调整语音的性别、音高、速度等参数,生成高质量的语音。该项目适用于多种场景,如有声读物制作、智能语音助手开发等。

Trae

Trae

字节跳动发布的AI编程神器IDE

Trae是一种自适应的集成开发环境(IDE),通过自动化和多元协作改变开发流程。利用Trae,团队能够更快速、精确地编写和部署代码,从而提高编程效率和项目交付速度。Trae具备上下文感知和代码自动完成功能,是提升开发效率的理想工具。

AI工具TraeAI IDE协作生产力转型热门
咔片PPT

咔片PPT

AI助力,做PPT更简单!

咔片是一款轻量化在线演示设计工具,借助 AI 技术,实现从内容生成到智能设计的一站式 PPT 制作服务。支持多种文档格式导入生成 PPT,提供海量模板、智能美化、素材替换等功能,适用于销售、教师、学生等各类人群,能高效制作出高品质 PPT,满足不同场景演示需求。

讯飞绘文

讯飞绘文

选题、配图、成文,一站式创作,让内容运营更高效

讯飞绘文,一个AI集成平台,支持写作、选题、配图、排版和发布。高效生成适用于各类媒体的定制内容,加速品牌传播,提升内容营销效果。

热门AI辅助写作AI工具讯飞绘文内容运营AI创作个性化文章多平台分发AI助手
材料星

材料星

专业的AI公文写作平台,公文写作神器

AI 材料星,专业的 AI 公文写作辅助平台,为体制内工作人员提供高效的公文写作解决方案。拥有海量公文文库、9 大核心 AI 功能,支持 30 + 文稿类型生成,助力快速完成领导讲话、工作总结、述职报告等材料,提升办公效率,是体制打工人的得力写作神器。

openai-agents-python

openai-agents-python

OpenAI Agents SDK,助力开发者便捷使用 OpenAI 相关功能。

openai-agents-python 是 OpenAI 推出的一款强大 Python SDK,它为开发者提供了与 OpenAI 模型交互的高效工具,支持工具调用、结果处理、追踪等功能,涵盖多种应用场景,如研究助手、财务研究等,能显著提升开发效率,让开发者更轻松地利用 OpenAI 的技术优势。

Hunyuan3D-2

Hunyuan3D-2

高分辨率纹理 3D 资产生成

Hunyuan3D-2 是腾讯开发的用于 3D 资产生成的强大工具,支持从文本描述、单张图片或多视角图片生成 3D 模型,具备快速形状生成能力,可生成带纹理的高质量 3D 模型,适用于多个领域,为 3D 创作提供了高效解决方案。

3FS

3FS

一个具备存储、管理和客户端操作等多种功能的分布式文件系统相关项目。

3FS 是一个功能强大的分布式文件系统项目,涵盖了存储引擎、元数据管理、客户端工具等多个模块。它支持多种文件操作,如创建文件和目录、设置布局等,同时具备高效的事件循环、节点选择和协程池管理等特性。适用于需要大规模数据存储和管理的场景,能够提高系统的性能和可靠性,是分布式存储领域的优质解决方案。

下拉加载更多