设置 API 调用的重试机制是处理请求失败的常见策略之一。通过在请求失败时自动重试,可以提高调用的成功率,尤其是在面对网络波动、服务短暂不可用等问题时。以下是几种常见的重试机制实现方法,包括简单的固定间隔重试、指数退避算法,以及使用第三方库实现更复杂的重试逻辑。
一、简单的固定间隔重试
1. 基本逻辑
在请求失败时,等待固定的时间后再次尝试,最多重试指定的次数。
2. 示例代码(PHP)
php
<?php
function get_jd_product_detail_with_retry($app_key, $app_secret, $sku_id, $max_retries = 3, $retry_interval = 2) {
$attempt = 0;
while ($attempt < $max_retries) {
$response_data = get_jd_product_detail($app_key, $app_secret, $sku_id);
if ($response_data && $response_data['code'] == '0') {
return $response_data;
} else {
echo "尝试 {$attempt + 1} 失败,将在 {$retry_interval} 秒后重试...\n";
sleep($retry_interval);
}
$attempt++;
}
throw new Exception("API 调用失败,已达到最大重试次数");
}
function get_jd_product_detail($app_key, $app_secret, $sku_id) {
$timestamp = date('Y-m-d H:i:s');
$params = [
'method' => 'jd.item.get',
'app_key' => $app_key,
'timestamp' => $timestamp,
'v' => '2.0',
'sku' => $sku_id,
'sign_method' => 'md5',
];
$params['sign'] = generate_signature($app_key, $app_secret, $timestamp, $params);
$client = new \GuzzleHttp\Client();
$response = $client->request('GET', 'https://api.jd.com/routerjson', [
'query' => $params,
]);
return json_decode($response->getBody(), true);
}
function generate_signature($app_key, $app_secret, $timestamp, $params) {
ksort($params);
$sign_str = $app_key . $timestamp . $app_secret;
foreach ($params as $key => $value) {
$sign_str .= $key . $value;
}
return md5($sign_str);
}
$app_key = 'your_app_key'; // 替换为你的 App Key
$app_secret = 'your_app_secret'; // 替换为你的 App Secret
$sku_id = '123456'; // 替换为商品的 SKU ID
try {
$response_data = get_jd_product_detail_with_retry($app_key, $app_secret, $sku_id);
print_r($response_data);
} catch (Exception $e) {
echo "错误: " . $e->getMessage() . "\n";
}
?>
二、指数退避算法
1. 基本逻辑
在请求失败时,等待的时间逐渐增加,通常是指数级增长。例如,第一次等待 1 秒,第二次等待 2 秒,第三次等待 4 秒等。
2. 示例代码(PHP)
php
<?php
function get_jd_product_detail_with_exponential_backoff($app_key, $app_secret, $sku_id, $max_retries = 3) {
$attempt = 0;
$retry_interval = 1; // 初始等待时间
while ($attempt < $max_retries) {
$response_data = get_jd_product_detail($app_key, $app_secret, $sku_id);
if ($response_data && $response_data['code'] == '0') {
return $response_data;
} else {
echo "尝试 {$attempt + 1} 失败,将在 {$retry_interval} 秒后重试...\n";
sleep($retry_interval);
$retry_interval *= 2; // 指数退避
}
$attempt++;
}
throw new Exception("API 调用失败,已达到最大重试次数");
}
function get_jd_product_detail($app_key, $app_secret, $sku_id) {
$timestamp = date('Y-m-d H:i:s');
$params = [
'method' => 'jd.item.get',
'app_key' => $app_key,
'timestamp' => $timestamp,
'v' => '2.0',
'sku' => $sku_id,
'sign_method' => 'md5',
];
$params['sign'] = generate_signature($app_key, $app_secret, $timestamp, $params);
$client = new \GuzzleHttp\Client();
$response = $client->request('GET', 'https://api.jd.com/routerjson', [
'query' => $params,
]);
return json_decode($response->getBody(), true);
}
function generate_signature($app_key, $app_secret, $timestamp, $params) {
ksort($params);
$sign_str = $app_key . $timestamp . $app_secret;
foreach ($params as $key => $value) {
$sign_str .= $key . $value;
}
return md5($sign_str);
}
$app_key = 'your_app_key'; // 替换为你的 App Key
$app_secret = 'your_app_secret'; // 替换为你的 App Secret
$sku_id = '123456'; // 替换为商品的 SKU ID
try {
$response_data = get_jd_product_detail_with_exponential_backoff($app_key, $app_secret, $sku_id);
print_r($response_data);
} catch (Exception $e) {
echo "错误: " . $e->getMessage() . "\n";
}
?>
三、使用第三方库
1. 使用 retrying
库
retrying
是一个 Python 库,用于简化重试逻辑。虽然 PHP 没有类似的库,但可以参考其逻辑实现。
2. 示例代码(PHP)
php
<?php
require 'vendor/autoload.php';
use GuzzleHttp\Client;
function get_jd_product_detail($app_key, $app_secret, $sku_id) {
$timestamp = date('Y-m-d H:i:s');
$params = [
'method' => 'jd.item.get',
'app_key' => $app_key,
'timestamp' => $timestamp,
'v' => '2.0',
'sku' => $sku_id,
'sign_method' => 'md5',
];
$params['sign'] = generate_signature($app_key, $app_secret, $timestamp, $params);
$client = new Client();
$response = $client->request('GET', 'https://api.jd.com/routerjson', [
'query' => $params,
]);
return json_decode($response->getBody(), true);
}
function generate_signature($app_key, $app_secret, $timestamp, $params) {
ksort($params);
$sign_str = $app_key . $timestamp . $app_secret;
foreach ($params as $key => $value) {
$sign_str .= $key . $value;
}
return md5($sign_str);
}
function retry_if_request_fails($app_key, $app_secret, $sku_id, $max_retries = 3, $retry_interval = 2) {
$attempt = 0;
while ($attempt < $max_retries) {
try {
$response_data = get_jd_product_detail($app_key, $app_secret, $sku_id);
if ($response_data && $response_data['code'] == '0') {
return $response_data;
} else {
throw new Exception("API 调用失败,错误信息: " . $response_data['errorMessage']);
}
} catch (Exception $e) {
echo "尝试 {$attempt + 1} 失败,将在 {$retry_interval} 秒后重试...\n";
sleep($retry_interval);
}
$attempt++;
}
throw new Exception("API 调用失败,已达到最大重试次数");
}
$app_key = 'your_app_key'; // 替换为你的 App Key
$app_secret = 'your_app_secret'; // 替换为你的 App Secret
$sku_id = '123456'; // 替换为商品的 SKU ID
try {
$response_data = retry_if_request_fails($app_key, $app_secret, $sku_id);
print_r($response_data);
} catch (Exception $e) {
echo "错误: " . $e->getMessage() . "\n";
}
?>
四、注意事项
-
避免过度重试:
- 设置合理的最大重试次数和重试间隔时间,避免对服务器造成不必要的压力。
-
记录日志:
- 在每次重试时记录详细的日志信息,包括失败原因、重试次数等