Perl -- 使用 JSON::RPC::Client 时出现“不是 HASH 引用”错误

Posted 2023-02-16

【中文标题】Perl -- 使用 JSON::RPC::Client 时出现“不是 HASH 引用”错误

【英文标题】：Perl -- 'Not a HASH reference' error when using JSON::RPC::Client

【发布时间】：2011-08-03 15:39:36

【问题描述】：

我是 Perl 的新手。 我有一个在 http://localhost:19000 运行的 JSON-RPC 服务器，我需要调用 checkEmail() 方法。

use JSON::RPC::Client;

my $client = new JSON::RPC::Client;
my $url    = 'http://localhost:19000';

my $callobj =  
    method  => 'checkEmail',
    params  => [ '[e-mail]' ],
;

my $res = $client->call($url, $callobj);

if($res) 
     if ($res->is_error) 
         print "Error : ", $res->error_message;
        
     else 
         print $res->result;
        
  
  else 
     print $client->status_line;
  

当我尝试启动它时，它会显示以下信息：

perl ./check_ac.pl
Not a HASH reference at /usr/local/share/perl/5.10.1/JSON/RPC/Client.pm line 193.

UPD：

完整的堆栈跟踪：

perl -MCarp::Always ./check_ac.pl
Not a HASH reference at /usr/local/share/perl/5.10.1/JSON/RPC/Client.pm line 193
        JSON::RPC::ReturnObject::new('JSON::RPC::ReturnObject', 'HTTP::Response=HASH(0x9938d48)', 'JSON=SCALAR(0x96f1518)') called at /usr/local/share/perl/5.10.1/JSON/RPC/Client.pm line 118
        JSON::RPC::Client::call('JSON::RPC::Client=HASH(0x944a818)', 'http://localhost:19000', 'HASH(0x96f1578)') called at ./check_ac.pl line 11

【问题讨论】：

使用perl -MCarp::Always ./check_ac.pl 获得完整的堆栈跟踪，并更好地了解代码中的问题所在。

它说“找不到 Carp/Always.pm”。我尝试使用 MCarp::Always 安装它，但找不到

尝试安装 Carp::Always，而不是 MCarp::Always。 -M 仅表示命令行中的“使用”。

【参考方案1】：

这个错误意味着你的 JSON-RPC 服务器实际上不是一个，因为它不满足requirement 7.3。当JSON::RPC::Client 假设 JSON-RPC 服务返回的文档是格式正确的（即 JSON 对象）时触发该错误，而这种假设结果是错误的。向JSON::RPC::Client 的作者报告错误将是请求更好的错误消息的适当方式。

我会通过找出导致JSON::RPC::Client 阻塞的服务器返回的内容来解决此类问题。不幸的是，JRC 未能提供足够的挂钩点来发现这一点，所以你必须有点棘手。

我不喜欢编辑外部库，因此我建议使用扩展和覆盖方法来检测 JSON-RPC 服务器的流量。像这样的东西（check_ac.pl）：

use Data::Dumper qw();

package JSON::RPC::InstrumentedClient;
use base 'JSON::RPC::Client';

# This would be better done with Module::Install, but I'm limiting dependencies today.
sub _get 
    my ($self, @args) = @_;

    return $self->_dump_response($self->SUPER::_get(@args));


sub _post 
    my ($self, @args) = @_;

    return $self->_dump_response($self->SUPER::_post(@args));


sub _dump_response 
    my ($self, $response) = @_;

    warn Data::Dumper::Dump([$response->decoded_content], [qw(content)]);
    return $response;


package main;

my $client = JSON::RPC::InstrumentedClient->new();
my $url    = 'http://localhost:19000';

... # rest of check_ac.pl

这包含了对JSON::RPC::Client 在内部进行的_get 和_post 的调用，以便您检查Web 服务器在响应我们发出的请求时实际所说的内容。上述代码转储页面的文本内容；在您的情况下，这可能不是正确的事情，如果遇到错误会爆炸。它只是一个调试辅助，帮助您从客户端代码端找出服务器出了什么问题。

我想，现在的警告已经足够了。祝你好运。

【参考方案2】：

这似乎是method new of JSON::RPC::ReturnObject 中的一个错误。

sub new 
    my ($class, $obj, $json) = @_;
    my $content = ( $json || JSON->new->utf8 )->decode( $obj->content );

    #...
# line 193
    $content->error ? $self->is_success(0) : $self->is_success(1);
    #...

$content 的值将是从JSON::decode() 调用返回的值。但是查看文档，JSON->decode() 似乎返回了一个标量，它可以是一个数字、一个字符串、一个数组引用、或一个哈希引用。

不幸的是，JSON::RPC::ReturnObject->new() 在尝试将其作为 hashref 访问之前并没有检查 JSON->decode() 返回的类型。鉴于您的错误，我将继续并假设它在您的情况下得到的结果是不是之一。 :-)

我不知道是否有办法强制从您的代码中进行修复。我建议联系author 并让他知道这个问题，和/或filing a bug。

【讨论】：

JSON::RPC::Client 通过假设返回值是 hashref 而表现正确；这是协议的要求。对于这个问题，当然，更好的错误消息会更好。

但正如我所指出的，JSON::decode() 仍然可以返回其他类型的标量。 JSON perldoc 明确指出就是这种情况。错误是JSON::RPC::ReturnObject 不应该假设它会总是 在$content 中获得一个 hashref，除非它为创建它而调用的方法已保证它将始终提供。正如您所说，似乎还有另一个错误潜伏在某个地方（即 - 为什么 不是 在应该返回的时候返回了 hashref？），但是“不是 HASH 引用”错误是由于 ReturnObject 的 ctor 验证不足造成的。

是的，关于 JRC 是否有责任在与不是 JSON-RPC 服务器的东西交互时提供良好的错误消息（事实上，我读过JRC 来源中至少有一条评论暗示作者本人不确定该走哪条路）。但我也不认为指出这一事实本身就足够有帮助。

很公平。我绝对专注于 Perl 方面，而不是 JSON/RPC 方面。你的回答可能会让他更接近他需要去的地方。