Guzzlehttp - 如何从 Guzzle 6 获取响应的正文？

Posted 2023-02-19

【中文标题】Guzzlehttp - 如何从 Guzzle 6 获取响应的正文？

【英文标题】：Guzzlehttp - How get the body of a response from Guzzle 6?

【发布时间】：2015-08-13 11:31:00

【问题描述】：

我正在尝试围绕我公司正在开发的 api 编写一个包装器。它很安静，并且使用 Postman，我可以使用用户名和密码作为 POST 数据向http://subdomain.dev.myapi.com/api/v1/auth/ 之类的端点发送发布请求，然后我会得到一个令牌。一切都按预期工作。现在，当我尝试从 php 中执行相同操作时，我会返回一个 GuzzleHttp\Psr7\Response 对象，但似乎无法像使用 Postman 请求那样在其中的任何地方找到令牌。

相关代码如下：

$client = new Client(['base_uri' => 'http://companysub.dev.myapi.com/']);
$response = $client->post('api/v1/auth/', [
    'form_params' => [
        'username' => $user,
        'password' => $password
    ]
]);

var_dump($response); //or $resonse->getBody(), etc...

上面代码的输出看起来像（警告，传入的文本墙）：

object(guzzlehttp\psr7\response)#36 (6) 
  ["reasonphrase":"guzzlehttp\psr7\response":private]=>
  string(2) "ok"
  ["statuscode":"guzzlehttp\psr7\response":private]=>
  int(200)
  ["headers":"guzzlehttp\psr7\response":private]=>
  array(9) 
    ["connection"]=>
    array(1) 
      [0]=>
      string(10) "keep-alive"
    
    ["server"]=>
    array(1) 
      [0]=>
      string(15) "gunicorn/19.3.0"
    
    ["date"]=>
    array(1) 
      [0]=>
      string(29) "sat, 30 may 2015 17:22:41 gmt"
    
    ["transfer-encoding"]=>
    array(1) 
      [0]=>
      string(7) "chunked"
    
    ["content-type"]=>
    array(1) 
      [0]=>
      string(16) "application/json"
    
    ["allow"]=>
    array(1) 
      [0]=>
      string(13) "post, options"
    
    ["x-frame-options"]=>
    array(1) 
      [0]=>
      string(10) "sameorigin"
    
    ["vary"]=>
    array(1) 
      [0]=>
      string(12) "cookie, host"
    
    ["via"]=>
    array(1) 
      [0]=>
      string(9) "1.1 vegur"
    
  
  ["headerlines":"guzzlehttp\psr7\response":private]=>
  array(9) 
    ["connection"]=>
    array(1) 
      [0]=>
      string(10) "keep-alive"
    
    ["server"]=>
    array(1) 
      [0]=>
      string(15) "gunicorn/19.3.0"
    
    ["date"]=>
    array(1) 
      [0]=>
      string(29) "sat, 30 may 2015 17:22:41 gmt"
    
    ["transfer-encoding"]=>
    array(1) 
      [0]=>
      string(7) "chunked"
    
    ["content-type"]=>
    array(1) 
      [0]=>
      string(16) "application/json"
    
    ["allow"]=>
    array(1) 
      [0]=>
      string(13) "post, options"
    
    ["x-frame-options"]=>
    array(1) 
      [0]=>
      string(10) "sameorigin"
    
    ["vary"]=>
    array(1) 
      [0]=>
      string(12) "cookie, host"
    
    ["via"]=>
    array(1) 
      [0]=>
      string(9) "1.1 vegur"
    
  
  ["protocol":"guzzlehttp\psr7\response":private]=>
  string(3) "1.1"
  ["stream":"guzzlehttp\psr7\response":private]=>
  object(guzzlehttp\psr7\stream)#27 (7) 
    ["stream":"guzzlehttp\psr7\stream":private]=>
    resource(40) of type (stream)
    ["size":"guzzlehttp\psr7\stream":private]=>
    null
    ["seekable":"guzzlehttp\psr7\stream":private]=>
    bool(true)
    ["readable":"guzzlehttp\psr7\stream":private]=>
    bool(true)
    ["writable":"guzzlehttp\psr7\stream":private]=>
    bool(true)
    ["uri":"guzzlehttp\psr7\stream":private]=>
    string(10) "php://temp"
    ["custommetadata":"guzzlehttp\psr7\stream":private]=>
    array(0) 
    
  

Postman 的输出类似于：

    "data" : 
        "token" "fasdfasf-asfasdfasdf-sfasfasf"
    

很明显，我在使用 Guzzle 中的响应对象时遗漏了一些东西。 Guzzle 响应在请求中指示 200 状态代码，所以我不确定我需要做什么来检索返回的数据。

【问题讨论】：

$response->getBody()->getContents() 不起作用？

【参考方案1】：

Guzzle 实现了PSR-7。这意味着它默认将消息正文存储在使用 PHP 临时流的Stream 中。要检索所有数据，您可以使用强制转换运算符：

$contents = (string) $response->getBody();

你也可以这样做

$contents = $response->getBody()->getContents();

这两种方法的区别在于 getContents 返回剩余的内容，因此第二次调用不会返回任何内容，除非您使用 rewind 或 seek 查找流的位置。

$stream = $response->getBody();
$contents = $stream->getContents(); // returns all the contents
$contents = $stream->getContents(); // empty string
$stream->rewind(); // Seek to the beginning
$contents = $stream->getContents(); // returns all the contents

相反，使用 PHP 的字符串转换操作，它将从流中读取所有数据，从头到尾。

$contents = (string) $response->getBody(); // returns all the contents
$contents = (string) $response->getBody(); // returns all the contents

文档：http://docs.guzzlephp.org/en/latest/psr7.html#responses

【讨论】：

getContents 函数只出现在 Guzzle 6 文档的一小部分（在流部分），我错过了它。你让我免于大量搜索。

谢谢。令人难以置信的是，这在文档中并没有更清楚。甚至他们的官方文档 (docs.guzzlephp.org/en/latest) 也让调用 $res->getBody() 看起来像是返回了您通常期望的结果。

他们确实应该在官方文件中添加注释或通知之类的内容。我在这个问题上浪费了两天时间。

也可以使用json_decode。例如，将您的回复包装在 json_decode($response, true); 中，这将返回一个数组。

强烈建议您不要使用 (string) $response->getBody() 因为它实际上并没有检索所有数据。它检索默认值的长度，因此它可以截断实际值。 github.com/guzzle/guzzle/issues/1610

【参考方案2】：

如果期望返回 JSON，最简单的获取方法：

$data = json_decode($response->getBody()); // returns an object

// OR

$data = json_decode($response->getBody(), true); // returns an array

json_decode() 会自动将 body 投射到string，所以不需要调用getContents()。

【讨论】：

为什么这个答案没有得到更多关注？？？这正是我所需要的。谢谢@MaskimIvanov

这对我来说也是最简单最容易的事情。谢谢

这个简单的答案“解决”了眼前的问题，但它忽略了@Federkun 接受的答案的细微差别。这种“正常工作”的原因大部分时间是因为对json_decode 的调用隐式转换响应正文为字符串。话虽如此，值得理解接受的答案，因为字符串转换方法可能存在问题，并不总是检索所有数据，正如@Shardj 的评论中所强调的那样。

此方法有效，但静态分析时会出错

谢谢！！我只是错过了真正的关键字

【参考方案3】：

获取 JSON 格式的响应：

1.

$response = (string) $res->getBody();
$response =json_decode($response); // Using this you can access any key like below
$key_value = $response->key_name; //access key  

$response = json_decode($res->getBody(),true);
$key_value =   $response['key_name'];//access key