使用 Geolocation API 网络服务的最佳实践

Google Maps Platform 网络服务是 Google 服务的一系列 HTTP 接口，可为您的地图应用提供地理数据。

本指南介绍了一些用于设置网络服务请求和处理服务响应的常见做法。如需查看 Geolocation API 的完整文档，请参阅开发者指南。

什么是网络服务？

Google Maps Platform 网络服务是一个接口，用于从外部服务请求 Maps API 数据以及在地图应用中使用这些数据。这些服务设计为与地图搭配使用，须遵守 Google Maps Platform 服务条款中的许可限制。

Maps API 网络服务使用发送到特定网址的 HTTP(S) 请求，将网址参数和/或 JSON 格式的 POST 数据作为参数传递给服务。通常，这些服务会在响应正文中以 JSON 格式返回数据，以供您的应用进行解析和/或处理。

使用 POST 将地理位置请求发送到以下网址：

https://www.googleapis.com/geolocation/v1/geolocate?key=YOUR_API_KEY

注意：所有 Geolocation API 应用都需要进行身份验证。详细了解身份验证凭据。

SSL/TLS 访问

所有使用 API 密钥或包含用户数据的 Google Maps Platform 请求都必须使用 HTTPS。通过 HTTP 发出的包含敏感数据的请求可能会被拒绝。

合理使用 Google API

设计不善的 API 客户端可能会给互联网和 Google 服务器带来超出需要的负载。本部分包含适用于 API 客户端的一些最佳做法。遵循这些最佳实践有助于避免您的应用因无意中滥用 API 而遭到屏蔽。

指数后退

在极少数情况下，您的请求可能会发生错误；您可能会收到 4XX 或 5XX HTTP 响应代码，或者 TCP 连接可能在您的客户端与 Google 服务器之间的某个地方发生故障。通常情况下，重试请求是值得的，因为如果初始请求失败，后续请求可能会成功。但是，重要的是不要只是简单地循环不断地向 Google 的服务器发出请求。这种循环行为可能会使客户端和 Google 之间的网络过载，从而给多方造成问题。

更好的方法是不断增加重试之间的延迟时间。通常，延迟时间会以乘法因数增加每次尝试，这种方法称为指数退避算法。

例如，假设某个应用希望向 Time Zone API 发出此请求：

https://maps.googleapis.com/maps/api/timezone/json?location=39.6034810,-119.6822510&timestamp=1331161200&key=YOUR_API_KEY

下面的 Python 示例显示了如何通过指数后退发起请求：

import json
import time
import urllib.error
import urllib.parse
import urllib.request

# The maps_key defined below isn't a valid Google Maps API key.
# You need to get your own API key.
# See https://developers.google.com/maps/documentation/timezone/get-api-key
API_KEY = "YOUR_KEY_HERE"
TIMEZONE_BASE_URL = "https://maps.googleapis.com/maps/api/timezone/json"


def timezone(lat, lng, timestamp):

    # Join the parts of the URL together into one string.
    params = urllib.parse.urlencode(
        {"location": f"{lat},{lng}", "timestamp": timestamp, "key": API_KEY,}
    )
    url = f"{TIMEZONE_BASE_URL}?{params}"

    current_delay = 0.1  # Set the initial retry delay to 100ms.
    max_delay = 5  # Set the maximum retry delay to 5 seconds.

    while True:
        try:
            # Get the API response.
            response = urllib.request.urlopen(url)
        except urllib.error.URLError:
            pass  # Fall through to the retry loop.
        else:
            # If we didn't get an IOError then parse the result.
            result = json.load(response)

            if result["status"] == "OK":
                return result["timeZoneId"]
            elif result["status"] != "UNKNOWN_ERROR":
                # Many API errors cannot be fixed by a retry, e.g. INVALID_REQUEST or
                # ZERO_RESULTS. There is no point retrying these requests.
                raise Exception(result["error_message"])

        if current_delay > max_delay:
            raise Exception("Too many retry attempts.")

        print("Waiting", current_delay, "seconds before retrying.")

        time.sleep(current_delay)
        current_delay *= 2  # Increase the delay each time we retry.


if __name__ == "__main__":
    tz = timezone(39.6034810, -119.6822510, 1331161200)
    print(f"Timezone: {tz}")

您还应注意，应用调用链中没有可导致快速连续重复请求的重试代码。

同步请求

向 Google API 发送大量同步请求可能会看似对 Google 基础架构发起分布式拒绝服务 (DDoS) 攻击，并据此进行处理。为避免出现这种情况，您应确保 API 请求不会在客户端之间同步。

例如，假设某个应用显示当前时区的时间。此应用可能会在客户端操作系统中设置闹钟，并在分钟开始时唤醒操作系统，以便更新显示的时间。在与该闹钟相关的处理过程中，应用不应进行任何 API 调用。

通过 API 调用来响应固定闹钟是不好的做法，因为这会导致 API 调用与分钟开始时同步（即使在不同设备之间），而不是随时间均匀分布。设计不合理的应用如果这样做，则会在每分钟开始时产生正常水平的 60 倍的流量峰值。

相比之下，一种可能的良好设计是将第二个闹钟设置为随机选择的时间。当第二个闹钟触发时，应用会调用所需的任何 API 并存储结果。当应用想要在分钟开始时更新其显示内容，它会使用之前存储的结果，而不是再次调用 API。使用此方法时，API 调用会在一段时间内均匀分布。此外，在更新屏幕时，API 调用不会延迟渲染。

除了分钟开始时间之外，您应注意不要设置的其他常用同步时间还包括小时开始和每天开始时间的午夜。

处理响应

此部分介绍如何以动态方式从 Web 服务响应中提取这些值。

Google 地图网络服务提供的响应易于理解，但并非完全易用。执行查询时，您可能希望提取一些特定值，而不是显示一组数据。一般来说，您需要解析来自网络服务的响应，并仅提取您感兴趣的值。

您使用的解析方案取决于您是否以 JSON 格式返回输出。JSON 响应已经采用 JavaScript 对象的形式，因此可在客户端上的 JavaScript 本身中进行处理。