SQL見るだけクエリ#064 PHPでAPIを連携する際に、エラー処理やタイムアウトの設定などをする方法。

SQL見るだけクエリ。PHPでAPIを連携する際に、エラー処理やタイムアウトの設定などをする方法。

この記事を読むと（約5分）
PHPでAPIを連携する際に、エラー処理やタイムアウトの設定などをする方法がイメージできます。

PHPでAPI連携を行う際のエラー処理やタイムアウトの設定について、参考になる方法をお伝えします。

エラー処理については、
APIの戻り値をjson形式にする場合、json_encode関数を使って配列やオブジェクトをjsonに変換しますが、この関数は変換に失敗した場合にfalseを返します。そのため、falseを返した場合にはjson_last_error関数でエラーの原因を調べて、適切なエラーメッセージを返すようにします。

タイムアウトの設定については、
APIの呼び出しにSoapClientクラスを使う場合、コンストラクタのオプションでconnection_timeoutを指定することで、サーバーとの接続が確立されるまでの待ち時間を制限することができます。しかし、これはレスポンスが遅いサービスのタイムアウトを定義することはできません。レスポンスが返ってくるまでの待ち時間を制限するには、php.iniかini_set関数でdefault_socket_timeoutを変更する必要があります。

また、PHPの処理自体にもタイムアウト時間が設定されており、これを超えると処理が中断されます。このタイムアウト時間は、php.iniのmax_execution_timeで設定できますが、これはすべてのPHPプログラムに影響します。特定のプログラムだけタイムアウト時間を変更したい場合は、set_time_limit関数を使って、プログラムの実行開始時にタイムアウト時間を指定することができます。

参考コードは以下の通りです。

// タイムアウト時間を120秒に設定
set_time_limit(120);

// SoapClientのオプションで接続タイムアウトを10秒に設定
$client = new SoapClient("http://example.com/api?wsdl", array("connection_timeout" => 10));

// レスポンスタイムアウトを15秒に設定
ini_set("default_socket_timeout", 15);

// APIの呼び出し
$result = $client->someMethod();

// 戻り値をjsonに変換
$json = json_encode($result);

// 変換に失敗した場合
if ($json === false) {
  // エラーの原因を取得
  $error = json_last_error();
  // エラーメッセージを作成
  switch ($error) {
    case JSON_ERROR_NONE:
      $message = "エラーはありません";
      break;
    case JSON_ERROR_DEPTH:
      $message = "スタックの深さの最大値を超えました";
      break;
    case JSON_ERROR_STATE_MISMATCH:
      $message = "JSONの形式が無効です";
      break;
    case JSON_ERROR_CTRL_CHAR:
      $message = "制御文字エラーが発生しました";
      break;
    case JSON_ERROR_SYNTAX:
      $message = "JSONの構文エラーが発生しました";
      break;
    case JSON_ERROR_UTF8:
      $message = "不正なUTF-8文字が含まれています";
      break;
    default:
      $message = "不明なエラーが発生しました";
      break;
  }
  // エラーメッセージをjsonに変換
  $json = json_encode(array("error" => $message));
}

// jsonを出力
echo $json;

このコードを実行すると、APIから返ってきた結果をjson形式で出力します。もしAPIの呼び出しに失敗したり、jsonの変換に失敗したりした場合は、エラーメッセージを含むjsonを出力します。例えば、以下のような出力になります。

{"name":"Alice","age":20,"gender":"female"}
{"error":"JSONの構文エラーが発生しました"}