API函数调用过程全解析：从新手入门到生产实践

1次阅读

共计 1932 个字符，预计需要花费 5 分钟才能阅读完成。

API（Application Programming Interface）是现代软件开发中不可或缺的组成部分。简单来说，API 就是两个软件组件之间的约定，定义了它们如何相互通信。在 Web 开发中，API 通常指的是 HTTP API，它基于客户端 - 服务器模型工作。

HTTP 请求 / 响应模型
客户端发送一个 HTTP 请求到服务器
服务器处理请求并返回 HTTP 响应
客户端接收并处理响应
典型 API 调用流程
构造请求（URL、方法、头、体）
建立网络连接
发送请求数据
等待服务器响应
接收响应数据
解析和处理响应

新手在 API 调用过程中经常会遇到以下几个问题：

超时处理不当
未设置超时导致线程长时间阻塞
网络不稳定时系统资源被耗尽
错误码解析缺失
只处理 200 成功状态码
忽略 4xx/5xx 错误码的处理
重试机制不完善
简单的无限重试
没有退避策略导致服务器过载

import requests
from requests.adapters import HTTPAdapter
from urllib3.util.retry import Retry

# 带超时和重试的 API 调用
def call_api_with_retry(url, params=None, max_retries=3, backoff_factor=1):
    session = requests.Session()

    # 配置重试策略
    retry = Retry(
        total=max_retries,
        backoff_factor=backoff_factor,
        status_forcelist=[500, 502, 503, 504]
    )

    # 配置适配器
    adapter = HTTPAdapter(max_retries=retry)
    session.mount('http://', adapter)
    session.mount('https://', adapter)

    try:
        # 带超时的请求
        response = session.get(url, params=params, timeout=(3.05, 27))
        response.raise_for_status()  # 检查 HTTP 错误
        return response.json()
    except requests.exceptions.RequestException as e:
        print(f"API 调用失败: {e}")
        return None

import okhttp3.*;
import java.io.IOException;
import java.util.concurrent.TimeUnit;

public class ApiClient {
    private final OkHttpClient client;

    public ApiClient() {this.client = new OkHttpClient.Builder()
            .connectTimeout(3, TimeUnit.SECONDS)
            .readTimeout(30, TimeUnit.SECONDS)
            .writeTimeout(30, TimeUnit.SECONDS)
            .retryOnConnectionFailure(true)
            .build();}

    public String callApiWithRetry(String url) throws IOException {Request request = new Request.Builder()
            .url(url)
            .build();

        try (Response response = client.newCall(request).execute()) {if (!response.isSuccessful()) {throw new IOException("Unexpected code" + response.code());
            }
            return response.body().string();
        }
    }
}