讲师中心 微信公众号
AI工具推荐 视频效率加速

Workerman 5.2.3如何封装统一响应返回类

千明酱_4080

千明酱_4080

发布时间:2026-10-23 15:13:11

|

705人浏览过

|

来源于php中文网

原创

Workerman 5.2.3 无内置统一响应类,但可基于 Http\Response 封装 ApiResponse 静态类,支持 success/error 等方法返回标准 JSON 响应,自动设 content-type、状态码及 header,兼顾 RESTful 规范与扩展性。

workerman 5.2.3如何封装统一响应返回类

Workerman 5.2.3 本身不内置“统一响应类”,但你可以基于 Workerman\Protocols\Http\Response 快速封装一个符合项目规范的响应工具,兼顾 RESTful API 常见需求:状态码、JSON 格式、可选数据/消息/错误码、Header 控制。

设计一个基础统一响应类

核心目标是减少重复构造 Response 对象的代码,统一 content-type、编码、结构格式。推荐使用静态方法封装,避免对象生命周期问题(Workerman 回调中不建议依赖实例方法):

  • 返回标准 JSON 结构,如 {"code": 0, "msg": "success", "data": {...}}
  • 默认状态码为 200,错误时可覆盖为 4xx/5xx
  • 自动设置 Content-Type: application/json; charset=utf-8
  • 支持额外 header(如 X-Request-ID)和可选 cookie

示例代码:ApiResponse 类

注意:需确保已引入 Workerman 的 Response 类

use Workerman\Protocols\Http\Response;

class ApiResponse
{
    public static function success($data = null, $msg = 'success', $code = 0, $headers = [], $cookies = [])
    {
        $body = json_encode([
            'code' => $code,
            'msg'  => $msg,
            'data' => $data,
        ], JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES);

        $response = new Response(200, array_merge([
            'Content-Type' => 'application/json; charset=utf-8',
        ], $headers), $body);

        foreach ($cookies as $name => $value) {
            $response->cookie($name, $value);
        }

        return $response;
    }

    public static function error($msg = 'error', $code = -1, $httpCode = 400, $data = null, $headers = [])
    {
        $body = json_encode([
            'code' => $code,
            'msg'  => $msg,
            'data' => $data,
        ], JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES);

        $response = new Response($httpCode, array_merge([
            'Content-Type' => 'application/json; charset=utf-8',
        ], $headers), $body);

        return $response;
    }

    // 快捷 404、500 等常用状态
    public static function notFound($msg = 'not found') {
        return self::error($msg, 404, 404);
    }

    public static function serverError($msg = 'internal error') {
        return self::error($msg, 500, 500);
    }
}

在 onMessage 中使用

直接调用静态方法,传入连接对象即可发送:

$worker->onMessage = function ($connection, $request) {
    if ($request->method() === 'GET' && $request->path() === '/api/user') {
        $user = ['id' => 123, 'name' => '张三'];
        $connection->send(ApiResponse::success($user));
    } elseif ($request->method() === 'POST' && $request->path() === '/api/login') {
        $params = $request->post();
        if (empty($params['username'])) {
            $connection->send(ApiResponse::error('用户名不能为空', 1001, 400));
            return;
        }
        $connection->send(ApiResponse::success(['token' => 'xxx'], '登录成功'));
    } else {
        $connection->send(ApiResponse::notFound());
    }
};

进阶建议

若需更灵活控制(如全局异常捕获、日志埋点、响应耗时头),可在封装类中加入:

  • 记录请求 ID 和响应时间,通过 $response->header('X-Response-Time', ...)
  • 对敏感字段(如 password)做自动过滤(在 success() 中预处理 $data)
  • 结合 PSR-3 日志接口,在 error 方法中触发错误日志
  • 多进程环境下慎用 static 属性存状态,所有逻辑保持无状态

热门AI工具

更多
SkildArt
SkildArt Hot

SkildArt是一款AI文本写作工具,一站式 AI 视觉创作平台。

立刻MV
立刻MV Hot

立刻MV是一款AI文本写作工具,AI 音乐视频(MV)创作工具。

Loomy
Loomy Hot

一款AI工具,主要用于科大讯飞发布的桌面级 AI 助理,比 OpenClaw 更易用、更安全!,适合需要提升相关任务效率的用户。

VibeKnow
VibeKnow Hot

一款AI视频创作工具,主要用于全球首个AI知识视频创作平台,文档、文章、网页,一键生成视频,适合需要提升相关任务效率的用户。

超级简历WonderCV

一款AI办公效率工具,主要用于免费求职简历模版下载制作,应届生职场人必备简历制作神器,适合需要提升相关任务效率的用户。

切问学术

切问学术是一款AI论文写作工具,复旦大学NLP团队推出的AI学术智能体。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

相关专题

更多
php文件怎么打开
php文件怎么打开

打开php文件步骤:1、选择文本编辑器;2、在选择的文本编辑器中,创建一个新的文件,并将其保存为.php文件;3、在创建的PHP文件中,编写PHP代码;4、要在本地计算机上运行PHP文件,需要设置一个服务器环境;5、安装服务器环境后,需要将PHP文件放入服务器目录中;6、一旦将PHP文件放入服务器目录中,就可以通过浏览器来运行它。

11464

2023.09.01

php怎么取出数组的前几个元素
php怎么取出数组的前几个元素

取出php数组的前几个元素的方法有使用array_slice()函数、使用array_splice()函数、使用循环遍历、使用array_slice()函数和array_values()函数等。本专题为大家提供php数组相关的文章、下载、课程内容,供大家免费下载体验。

6621

2023.10.11

php反序列化失败怎么办
php反序列化失败怎么办

php反序列化失败的解决办法检查序列化数据。检查类定义、检查错误日志、更新PHP版本和应用安全措施等。本专题为大家提供php反序列化相关的文章、下载、课程内容,供大家免费下载体验。

2175

2023.10.11

php怎么连接mssql数据库
php怎么连接mssql数据库

连接方法:1、通过mssql_系列函数;2、通过sqlsrv_系列函数;3、通过odbc方式连接;4、通过PDO方式;5、通过COM方式连接。想了解php怎么连接mssql数据库的详细内容,可以访问下面的文章。

4188

2023.10.23

php连接mssql数据库的方法
php连接mssql数据库的方法

php连接mssql数据库的方法有使用PHP的MSSQL扩展、使用PDO等。想了解更多php连接mssql数据库相关内容,可以阅读本专题下面的文章。

4914

2023.10.23

html怎么上传
html怎么上传

html通过使用HTML表单、JavaScript和PHP上传。更多关于html的问题详细请看本专题下面的文章。php中文网欢迎大家前来学习。

3851

2023.11.03

PHP出现乱码怎么解决
PHP出现乱码怎么解决

PHP出现乱码可以通过修改PHP文件头部的字符编码设置、检查PHP文件的编码格式、检查数据库连接设置和检查HTML页面的字符编码设置来解决。更多关于php乱码的问题详情请看本专题下面的文章。php中文网欢迎大家前来学习。

5557

2023.11.09

php文件怎么在手机上打开
php文件怎么在手机上打开

php文件在手机上打开需要在手机上搭建一个能够运行php的服务器环境,并将php文件上传到服务器上。再在手机上的浏览器中输入服务器的IP地址或域名,加上php文件的路径,即可打开php文件并查看其内容。更多关于php相关问题,详情请看本专题下面的文章。php中文网欢迎大家前来学习。

4342

2023.11.13

Gradle插件开发入门教程
Gradle插件开发入门教程

本专题介绍Gradle插件开发的基本流程,涵盖插件类编写、自定义任务注册、扩展参数设计和插件应用方法,帮助你理解插件如何组织构建逻辑,减少多个项目之间的重复配置。

60

2026.10.22

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
第六期_前端基础
第六期_前端基础

共107课时 | 23.9万人学习

Webman中文手册
Webman中文手册

共0课时 | 0人学习

Workerman官方手册
Workerman官方手册

共0课时 | 0人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn