PHP 8.6实现JSON-RPC接口,正确区分请求、通知和批量结果

浅强君_3383

浅强君_3383

2026-11-22

305人浏览

原创

php 8.6实现json-rpc 2.0接口,关键是保留json对象与数组的区别,并区分有id的请求和没有id的通知。通知不返回结果,批量请求只返回需要响应的项;空批次则是invalid request。下面给出只提供ping方法的http示例。

官方文档:4 Request object

官方文档:4 Request object

按协议建立响应函数

将下面内容保存为public/rpc.php。这里使用stdClass识别JSON对象,限制请求体大小和批次数量;业务方法用固定分发表,不把method当作任意PHP函数执行。

<?php function errorResult(int $code, string $message, mixed $id = null): array {
    return ['jsonrpc'=>'2.0','error'=>['code'=>$code,'message'=>$message],'id'=>$id];
}
function dispatch(mixed $r): ?array {
    if (!$r instanceof stdClass) return errorResult(-32600, 'Invalid Request');
    $hasId = property_exists($r, 'id');
    $id = $hasId ? $r->id : null;
    if (($r->jsonrpc ?? null) !== '2.0' || !is_string($r->method ?? null)
        || ($hasId && !is_int($id) && !is_string($id) && $id !== null)
        || (property_exists($r, 'params') && !is_array($r->params) && !$r->params instanceof stdClass)) {
        return errorResult(-32600, 'Invalid Request');
    }
    $reply = match ($r->method) {
        'ping' => property_exists($r,'params') && (array)$r->params !== []
            ? errorResult(-32602,'Invalid params',$id)
            : ['jsonrpc'=>'2.0','result'=>'pong','id'=>$id],
        default => errorResult(-32601,'Method not found',$id)
    };
    return $hasId ? $reply : null;
}
header('Content-Type: application/json; charset=utf-8');
if ($_SERVER['REQUEST_METHOD'] !== 'POST') {
    http_response_code(405); header('Allow: POST'); exit;
}
$raw = file_get_contents('php://input', false, null, 0, 1048577);
if ($raw === false || strlen($raw)>1048576) { http_response_code(413); exit; }
try {
    $input = json_decode($raw, false, 64, JSON_THROW_ON_ERROR);
} catch (JsonException $e) {
    echo json_encode(errorResult(-32700,'Parse error')); exit;
}
if (is_array($input)) {
    if ($input === []) $output = errorResult(-32600,'Invalid Request');
    elseif (count($input)>100) { http_response_code(413); exit; }
    else {
        $output = [];
        foreach ($input as $request) {
            $response = dispatch($request);
            if ($response !== null) $output[] = $response;
        }
        if ($output === []) { http_response_code(204); exit; }
    }
} else $output = dispatch($input);
if ($output === null) { http_response_code(204); exit; }
echo json_encode($output, JSON_THROW_ON_ERROR | JSON_UNESCAPED_UNICODE);

官方文档:6 Batch

官方文档:6 Batch

分别验证请求、通知与批量调用

启动本地开发服务器后,依次提交以下请求体。第一项返回id为1的pong;第二项没有id,返回HTTP 204;混合批次只返回带id的那一项。

{"jsonrpc":"2.0","method":"ping","id":1}
{"jsonrpc":"2.0","method":"ping"}
[{"jsonrpc":"2.0","method":"ping"},{"jsonrpc":"2.0","method":"ping","id":"a"}]

不要把无效对象当成通知

缺少id的有效请求是通知,但缺少jsonrpc或method类型错误的对象仍是Invalid Request。id:null虽然允许,规范并不推荐使用;不要用empty(id)判断是否有响应,否则0和空字符串会被误判。批次返回顺序也不应被客户端当成关联依据,应按id匹配。

Exa JS Web Search SDK 用于 AI 应用程序
Exa JS Web Search SDK 用于 AI 应用程序

exa-js 是 Exa 官方 JavaScript 软件开发工具包,Exa 是一个为 AI 工作流构建的网络搜索 API。它为代理提供了一种具体的方式来搜索网络、检索页面内容,并从代码中生成有来源的答案,而不是手动拼接原始 HTTP 调用。

下载

增加业务方法时保留错误边界

实际方法应逐个校验命名参数或位置参数,并将可预期的参数错误映射为-32602,未预期异常映射为-32603且不返回堆栈。身份验证、限流和写操作幂等性属于应用层,不能因为采用JSON-RPC就省略。

php免费学习视频:立即使用
踏上前端学习之旅,开启通往精通之路!从前端基础到项目实战,循序渐进,一步一个脚印,迈向巅峰!

相关文章

PHP速学教程(入门到精通)
PHP速学教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

php js json php 8.6

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

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

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

2023.09.01

13444

6

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

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

2023.10.11

7681

5

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

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

2023.10.11

2295

5

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

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

2023.10.23

4848

4

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

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

2023.10.23

5574

6

html怎么上传
html怎么上传

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

2023.11.03

4391

9

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

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

2023.11.09

6357

8

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

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

2023.11.13

5022

8

sprintf函数用法详解
sprintf函数用法详解

sprintf函数的用法:1、格式化字符串;2、指定输出宽度和精度;3、返回值。更多关于sprintf函数用法详解的内容,大家可以阅读下面的文章。

2023.11.27

12662

4

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
墨刀帮助中心
墨刀帮助中心

共0课时 | 0人学习

MyEclipse学习中心
MyEclipse学习中心

共0课时 | 0人学习