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

编辑推荐精选

Vora

Vora

免费创建高清无水印Sora视频

Vora是一个免费创建高清无水印Sora视频的AI工具

Refly.AI

Refly.AI

最适合小白的AI自动化工作流平台

无需编码,轻松生成可复用、可变现的AI自动化工作流

酷表ChatExcel

酷表ChatExcel

大模型驱动的Excel数据处理工具

基于大模型交互的表格处理系统,允许用户通过对话方式完成数据整理和可视化分析。系统采用机器学习算法解析用户指令,自动执行排序、公式计算和数据透视等操作,支持多种文件格式导入导出。数据处理响应速度保持在0.8秒以内,支持超过100万行数据的即时分析。

AI工具酷表ChatExcelAI智能客服AI营销产品使用教程
TRAE编程

TRAE编程

AI辅助编程,代码自动修复

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

AI工具TraeAI IDE协作生产力转型热门
AIWritePaper论文写作

AIWritePaper论文写作

AI论文写作指导平台

AIWritePaper论文写作是一站式AI论文写作辅助工具,简化了选题、文献检索至论文撰写的整个过程。通过简单设定,平台可快速生成高质量论文大纲和全文,配合图表、参考文献等一应俱全,同时提供开题报告和答辩PPT等增值服务,保障数据安全,有效提升写作效率和论文质量。

AI辅助写作AI工具AI论文工具论文写作智能生成大纲数据安全AI助手热门
博思AIPPT

博思AIPPT

AI一键生成PPT,就用博思AIPPT!

博思AIPPT,新一代的AI生成PPT平台,支持智能生成PPT、AI美化PPT、文本&链接生成PPT、导入Word/PDF/Markdown文档生成PPT等,内置海量精美PPT模板,涵盖商务、教育、科技等不同风格,同时针对每个页面提供多种版式,一键自适应切换,完美适配各种办公场景。

AI办公办公工具AI工具博思AIPPTAI生成PPT智能排版海量精品模板AI创作热门
潮际好麦

潮际好麦

AI赋能电商视觉革命,一站式智能商拍平台

潮际好麦深耕服装行业,是国内AI试衣效果最好的软件。使用先进AIGC能力为电商卖家批量提供优质的、低成本的商拍图。合作品牌有Shein、Lazada、安踏、百丽等65个国内外头部品牌,以及国内10万+淘宝、天猫、京东等主流平台的品牌商家,为卖家节省将近85%的出图成本,提升约3倍出图效率,让品牌能够快速上架。

iTerms

iTerms

企业专属的AI法律顾问

iTerms是法大大集团旗下法律子品牌,基于最先进的大语言模型(LLM)、专业的法律知识库和强大的智能体架构,帮助企业扫清合规障碍,筑牢风控防线,成为您企业专属的AI法律顾问。

SimilarWeb流量提升

SimilarWeb流量提升

稳定高效的流量提升解决方案,助力品牌曝光

稳定高效的流量提升解决方案,助力品牌曝光

Sora2视频免费生成

Sora2视频免费生成

最新版Sora2模型免费使用,一键生成无水印视频

最新版Sora2模型免费使用,一键生成无水印视频

下拉加载更多