使用PHP Slim框架获取POST请求数据失败该如何解决？

问题描述 #

使用PHP的Slim Framework开发CRUD接口，通过Postman做接口测试。此前已经通过GET方法实现了单条/全部数据的查询功能，在开发新增数据的POST接口时遇到参数获取失败的问题：

1. 参考教程使用的$request->getParam('paramName')方法在当前环境不存在
2. 尝试使用$request->getParsedBody()、$request->getBody()获取请求参数，返回值均为空
   出问题的接口代码如下：

$app->post('/users/add', function (Request $request, Response $response, array $args) {
    $data = $request->getParsedBody();
    $username = $data['username'];
    $passhash = $data['passhash'];
    $email = $data['email'];

    $sql = "INSERT INTO user (username, passhash, email) VALUE (:username, :passhash, :email)";

    try {
        $db = new DB();
        $conn = $db->connect();

        $stmt = $conn->prepare($sql);

        $stmt->bindParam(':username', $username);
        $stmt->bindParam(':passhash', $passhash);
        $stmt->bindParam(':email', $email);

        $result = $stmt->execute();

        $db = null;
        $response->getBody()->write(json_encode($result));
        return $response
            ->withHeader('content-type', 'application/json')
            ->withStatus(200);
    } catch (PDOException $e) {
        $error = array (
            "message" => $e->getMessage()
        );

        $response->getBody()->write(json_encode($error));
        return $response
            ->withHeader('content-type', 'application/json')
            ->withStatus(500);
    }
});

解决方案 #

核心问题原因 #

Slim 4及以上版本已经移除了getParam方法，且默认不开启请求体自动解析中间件，所以直接调用getParsedBody会返回空值，按以下步骤排查即可：

• 步骤1：开启请求体解析中间件
  在初始化$app实例的代码后，手动注册请求体解析中间件：

  $app->addBodyParsingMiddleware();
  

  该中间件会自动解析application/x-www-form-urlencoded、multipart/form-data、application/json三种格式的请求体，解析后的参数可以直接通过$request->getParsedBody()拿到数组格式的结果。
• 步骤2：校验Postman配置
  • 如果提交表单格式参数，在Postman的Body栏选择x-www-form-urlencoded或者form-data即可，不要手动修改Headers栏的Content-Type值，Postman会自动匹配正确的请求头
  • 如果提交JSON格式参数，在Body栏选择raw，格式选JSON，Headers栏会自动生成Content-Type: application/json配置，不要手动删除或修改
• 步骤3：增加代码容错处理
  对获取到的请求参数做判空兜底，避免参数缺失时抛出数组下标不存在的PHP警告：

  // 优先取解析后的请求体，为空时兜底为空数组
  $data = $request->getParsedBody() ?? [];
  $username = $data['username'] ?? '';
  $passhash = $data['passhash'] ?? '';
  $email = $data['email'] ?? '';
  

• 调试技巧
  如果配置完成后仍获取不到参数，可以用原生方法打印原始请求体，确认请求参数是否正常发送到后端：

  var_dump(file_get_contents('php://input'));
  exit;
  

内容的提问来源于stack exchange，提问作者Tyomnat