0

0

Yii2 中处理 JSON POST 请求:配置与实践

霞舞

霞舞

发布时间:2025-07-23 15:20:29

|

706人浏览过

|

来源于php中文网

原创

Yii2 中处理 JSON POST 请求:配置与实践

本文深入探讨了 Yii2 应用在接收 application/json 类型 POST 请求时数据为空的问题,并提供了详细的解决方案。通过配置 yii\web\Request::$parsers,Yii2 能够正确解析 JSON 请求体,确保后端能顺利获取前端发送的 JSON 数据。文章涵盖了前端 JavaScript 发送 JSON 的示例及后端 PHP 处理逻辑。

理解 JSON POST 请求与 Yii2 的默认行为

在 web 开发中,前端通常通过 post 请求向后端发送数据。常见的 content-type 有 application/x-www-form-urlencoded 和 multipart/form-data。web 服务器(如 apache, nginx)默认会将这两种类型的请求体解析,并将数据填充到 php 的 $_post 全局变量中。因此,yii2 框架默认也是从 $_post 中读取 post 参数。

然而,当前端使用 fetch 或 XMLHttpRequest 发送 Content-Type: application/json 类型的请求时,请求体中的 JSON 数据不会被 Web 服务器自动解析并填充到 $_POST 变量中。这意味着,即使请求成功发送到后端,Yii2 尝试通过 Yii::$app->request->post('paramName') 获取参数时,也会因为 $_POST 为空而得到 null 值。

解决方案:配置 Yii2 请求解析器

为了让 Yii2 能够正确解析 application/json 类型的请求体,你需要将 JSON 解析器添加到 yii\web\Request::$parsers 属性中。这通常在你的应用程序配置文件(例如 config/web.php 或 config/main.php)中完成。

在 components 数组中找到 request 组件的配置,并添加 parsers 属性:

// config/web.php 或 config/main.php

'components' => [
    'request' => [
        // !!! insert a secret key in the following (if it is empty) - this is required by cookie validation
        'cookieValidationKey' => 'your-secret-key', // 请替换为你的密钥
        'parsers' => [
            'application/json' => 'yii\web\JsonParser',
        ],
        // ... 其他请求组件配置
    ],
    // ... 其他组件配置
]

通过上述配置,当 Yii2 接收到 Content-Type 为 application/json 的请求时,它会自动使用 yii\web\JsonParser 来解析请求体,并将解析后的数据填充到 Yii::$app->request->post() 方法可访问的内部数据结构中。

前端 JavaScript 发送 JSON 请求示例

前端使用 fetch API 发送 JSON 数据的示例代码如下。请注意 headers 中 Content-Type: application/json 的设置,以及 body 中使用 JSON.stringify() 将 JavaScript 对象转换为 JSON 字符串。

Narration Box
Narration Box

Narration Box是一种语音生成服务,用户可以创建画外音、旁白、有声读物、音频页面、播客等

下载
let csrfToken = document.querySelector("meta[name='csrf-token']").content;
let csrfParam = document.querySelector("meta[name='csrf-param']").content;

// 假设 e.id 和 this.state.ChangeName 是需要发送的数据
const dataToSend = {
    'id': e.id,
    'name': this.state.ChangeName
};

fetch("http://site.se/react/save-babysitter", {
    method: "POST",
    headers: {
        "Content-Type": "application/json", // 关键:指定内容类型为 JSON
        "Accept": "application/json",
        // Yii2 CSRF 令牌,确保请求安全
        [csrfParam]: csrfToken, // 使用中括号语法,因为 csrfParam 是变量
        "X-CSRF-Token": csrfToken // 兼容性考虑,通常 Yii2 会检查其中一个
    },
    body: JSON.stringify(dataToSend) // 将 JavaScript 对象转换为 JSON 字符串
})
.then(response => {
    // 检查响应状态码,如果不是 2xx,则抛出错误
    if (!response.ok) {
        throw new Error(`HTTP error! status: ${response.status}`);
    }
    return response.json(); // 解析 JSON 响应
})
.then((data) => {
    console.log("Success:", data);
})
.catch((error) => {
    console.error("Error:", error);
});

注意事项:

  • CSRF 令牌: 在发送 POST 请求时,为了防止跨站请求伪造 (CSRF) 攻击,Yii2 默认会检查 CSRF 令牌。前端需要从页面中获取 CSRF 令牌并将其作为请求头或请求体参数发送。上述代码示例中,令牌通过 csrf-param 和 X-CSRF-Token 头部发送。
  • 错误处理: 在 fetch 的 then 链中添加 response.ok 检查和 catch 块,可以更好地处理网络错误和服务器响应错误。

后端 PHP 控制器处理逻辑

在配置了 JsonParser 之后,Yii2 的 request 组件就能够正确解析 JSON 请求体了。你现在可以通过 Yii::$app->request->post() 方法像获取普通表单数据一样获取 JSON 数据中的参数。

request;

        // 设置响应格式为 JSON
        Yii::$app->response->format = Response::FORMAT_JSON;

        // 获取解析后的 JSON 数据
        // 如果前端发送的是 {"id": 123, "name": "Test"}
        $id = $request->post('id');
        $name = $request->post('name');

        // 也可以获取所有 POST 参数为一个数组
        // $postData = $request->post(); 

        // 生产环境中,通常需要对接收到的数据进行验证和处理
        if (empty($id) || empty($name)) {
            return [
                'status' => 'error',
                'message' => 'ID 或 Name 不能为空。',
            ];
        }

        // 假设这里进行数据保存或其他业务逻辑
        // 例如:$model = new Babysitter(['id' => $id, 'name' => $name]); $model->save();

        // 返回成功响应
        return [
            'status' => 'success',
            'message' => '数据接收成功!',
            'received_id' => $id,
            'received_name' => $name,
            // 可以在这里返回更多处理结果
        ];
    }
}

重要提示:

  • CSRF 验证: 如果你的控制器或单个 action 开启了 CSRF 验证(Yii2 默认开启),请确保前端正确发送了 CSRF 令牌。如果前端无法发送令牌或你确定不需要 CSRF 保护(例如,对于仅供内部 API 调用的接口),你可以在控制器中设置 $enableCsrfValidation = false; 或在 action 中通过行为配置禁用。但请务必了解禁用 CSRF 验证可能带来的安全风险。
  • getRawBody(): 如果你需要获取原始的 JSON 字符串而不是解析后的数据,可以使用 Yii::$app->request->getRawBody() 方法。这在某些需要手动解析或记录原始请求体的场景中非常有用。
  • 响应格式: 在 Yii2 中,为了返回 JSON 格式的响应,建议设置 Yii::$app->response->format = \yii\web\Response::FORMAT_JSON;,然后直接返回一个 PHP 数组或对象,Yii2 会自动将其编码为 JSON 字符串。

总结

通过在 Yii2 应用程序的 request 组件中配置 yii\web\JsonParser,我们可以轻松地解决后端无法接收 application/json 类型 POST 请求数据的问题。这一配置使得 Yii2 能够无缝地处理前端发送的 JSON 数据,极大地简化了前后端数据交互的复杂性。在实际开发中,除了正确配置解析器,还应注意 CSRF 保护、数据验证和规范的错误处理,以构建健壮和安全的 Web 应用程序。

相关专题

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

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

1977

2023.09.01

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

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

1295

2023.10.11

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

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

1204

2023.10.11

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

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

948

2023.10.23

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

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

1400

2023.10.23

html怎么上传
html怎么上传

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

1229

2023.11.03

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

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

1439

2023.11.09

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

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

1303

2023.11.13

php源码安装教程大全
php源码安装教程大全

本专题整合了php源码安装教程,阅读专题下面的文章了解更多详细内容。

7

2025.12.31

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
RunnerGo从入门到精通
RunnerGo从入门到精通

共22课时 | 1.7万人学习

尚学堂Mahout视频教程
尚学堂Mahout视频教程

共18课时 | 3.2万人学习

Linux优化视频教程
Linux优化视频教程

共14课时 | 3.1万人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号