使用 Directions API 网络服务的最佳做法

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

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

什么是网络服务？

Google Maps Platform 网络服务是一个接口，用于从外部服务请求 Maps API 数据，以及在地图应用中使用这些数据。这些服务旨在根据 Google Maps Platform 服务条款中的许可限制与地图结合使用。

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

典型的 Directions API 请求通常采用以下格式：

https://maps.googleapis.com/maps/api/directions/output?parameters

其中，output 表示响应格式（通常为 json 或 xml）。

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

SSL/TLS 访问

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

构建有效网址

您可能认为“有效”网址不言自明，但实际并非如此。例如，在浏览器地址栏中输入的网址可能包含特殊字符（例如 "上海+中國"）；浏览器需要先在内部将这些字符转换为其他编码，然后再进行传输。同样，任何生成或接受 UTF-8 输入的代码都可能会将包含 UTF-8 字符的网址视为“有效”，但同样需要先转换这些字符，然后再将其发送给网络服务器。该过程称为网址编码或百分号编码。

特殊字符

我们之所以需要转换特殊字符，是因为所有网址都需要符合统一资源标识符 (URI) 规范所规定的语法。实际上，这意味着网址必须只包含一个特殊的 ASCII 字符子集：大家熟悉的字母数字符号以及一些在网址内用作控制字符的预留字符。下表汇总了这些字符：

构建有效网址时，您必须确保网址只包含“有效网址字符汇总”表格中显示的那些字符。让网址按照上述字符集使用字符通常会带来两个问题，一个是遗漏问题，一个是替换问题：

• 您要处理的字符未包含在上述字符集内。举例来说，非英语字符（例如 上海+中國）需要使用上述字符进行编码。按照常见惯例，空格（网址内不允许使用空格）通常也使用加号字符 '+' 表示。
• 字符在上述字符集内存在且属于预留字符，但需要按原义使用。例如，? 在网址内用于表示查询字符串的开头；如果您想要使用字符串“? and the Mysterions”，则需要对 '?' 字符进行编码。

所有要进行网址编码的字符都会使用一个 '%' 字符和一个与其 UTF-8 字符对应的双字符十六进制值进行编码。例如，UTF-8 中的 上海+中國 在进行网址编码后将变为 %E4%B8%8A%E6%B5%B7%2B%E4%B8%AD%E5%9C%8B。字符串 ? and the Mysterians 在进行网址编码后将变为 %3F+and+the+Mysterians 或 %3F%20and%20the%20Mysterians。

需要编码的常见字符

以下是一些必须进行编码的常见字符：

转换您通过用户输入获取的网址有时颇为棘手。例如，用户可能会输入“5th&Main St.”这样的地址。一般而言，您应该根据网址的组成部分来构建网址，将所有用户输入都视为原义字符。

此外，对于所有 Google Maps Platform 网络服务 API 和静态网络 API，网址最多可包含 16384 个字符。对于大多数服务，很少出现接近这一字符数限制的情况。但请注意，某些服务具有的若干参数可能会导致网址较长。

合理使用 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 调用同步到分钟的开头（即使在不同设备之间），也不是在一段时间内均匀分布。如果一个设计不佳的应用这样做，则会在每分钟开始时产生正常水平的六十倍的流量峰值。

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

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

处理响应

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

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

您使用的解析方案取决于您是在 XML 还是 JSON 中返回输出。JSON 响应已采用 JavaScript 对象的形式，因此可在客户端上的 JavaScript 本身中进行处理。 应使用 XML 处理器和 XML 查询语言处理 XML 响应，以处理 XML 格式的元素。我们在以下示例中使用了 XPath，因为它在 XML 处理库中通常受支持。

使用 XPath 处理 XML

XML 是一种用于数据交换的相对成熟的结构化信息格式。虽然 XML 不像 JSON 那样轻量化，但确实提供更多语言支持和更强大的工具。例如，用于在 Java 中处理 XML 的代码内置在 javax.xml 软件包中。

处理 XML 响应时，您应该使用适当的查询语言在 XML 文档中选择节点，而不是假设元素位于 XML 标记内的绝对位置。XPath 是一种语言语法，用于以唯一方式描述 XML 文档中的节点和元素。通过 XPath 表达式，您可以标识 XML 响应文档中的特定内容。

XPath 表达式

对 XPath 有一定了解对于开发强大的解析方案会大有帮助。本部分将重点介绍如何使用 XPath 对 XML 文档中的元素进行寻址，让您能够对多个元素寻址并构建复杂的查询。

XPath 使用表达式选择 XML 文档中的元素，并使用与目录路径所用语法类似的语法。 这些表达式可标识 XML 文档树中的元素，该树是类似于 DOM 的层次结构树。一般来说，XPath 表达式是贪心的，这意味着它们将匹配与提供的条件匹配的所有节点。

我们将使用以下抽象 XML 来说明我们的示例：

<WebServiceResponse>
 <status>OK</status>
 <result>
  <type>sample</type>
  <name>Sample XML</name>
  <location>
   <lat>37.4217550</lat>
   <lng>-122.0846330</lng>
  </location>
 </result>
 <result>
  <message>The secret message</message>
 </result>
</WebServiceResponse>

表达式中的节点选择

XPath 选择会选择节点。根节点包含整个文档。您可以使用特殊表达式“/”选择此节点。请注意，根节点不是 XML 文档的顶级节点；实际上，它位于此顶级元素之上一个级别，并且包含该元素。

元素节点表示 XML 文档树中的各种元素。例如，<WebServiceResponse> 元素表示上述示例服务中返回的顶级元素。您可以通过绝对路径或相对路径（由是否存在前导“/”字符来指示）选择单个节点。

• 绝对路径：“/WebServiceResponse/result”表达式选择属于 <WebServiceResponse> 节点子节点的所有 <result> 节点。（请注意，这两个元素都是根节点“/”的子项。）
• 当前上下文的相对路径：表达式“result”将与当前上下文中的所有 <result> 元素匹配。一般而言，您不必担心上下文，因为您通常是通过单个表达式处理网络服务结果。

这两种表达式都可以通过添加用双斜杠（“//”）表示的通配符路径进行扩充。此通配符表示中间路径中可能匹配零个或多个元素。例如，XPath 表达式“//formatted_address”将匹配当前文档中具有该名称的所有节点。表达式 //viewport//lat 将匹配所有可跟踪 <viewport> 为父元素的 <lat> 元素。

默认情况下，XPath 表达式将与所有元素相匹配。您可以提供一个用方括号 ([]) 括起来的谓词，将表达式限制为仅匹配特定元素。例如，XPath 表达式“/GeocodeResponse/result[2]”始终会返回第二个结果。

    <WebServiceResponse>
     <status>OK</status>
     <result>
      <type>sample</type>
      <name>Sample XML</name>
      <location>
       <lat>37.4217550</lat>
       <lng>-122.0846330</lng>
      </location>
     </result>
     <result>
      <message>The secret message</message>
     </result>
    </WebServiceResponse>
    

    <result>
     <type>sample</type>
     <name>Sample XML</name>
     <location>
      <lat>37.4217550</lat>
      <lng>-122.0846330</lng>
     </location>
    </result>
    <result>
     <message>The secret message</message>
    </result>
    

    <location>
     <lat>37.4217550</lat>
     <lng>-122.0846330</lng>
    </location>
    

    <message>The secret message</message>
    

     <type>sample</type>
     <name>Sample XML</name>
     <location>
      <lat>37.4217550</lat>
      <lng>-122.0846330</lng>
     </location>
    

    Sample XML
    

请务必注意，选择元素时，您购买的是节点，而不仅仅是这些对象中的文本。通常，您需要遍历所有匹配的节点并提取文本。您也可以直接匹配文本节点；请参阅下文的文本节点 。

请注意，XPath 也支持属性节点；不过，所有 Google 地图网络服务提供的元素都不带属性，因此无需匹配属性。

表达式中的文本选择

XML 文档中的文本通过“文本节点”运算符在 XPath 表达式中指定。运算符“text()”表示从指定节点提取文本。例如，XPath 表达式“//formatted_address/text()”将返回 <formatted_address> 元素中的所有文本。

    sample
    Sample XML

    37.4217550
    -122.0846330
    The secret message
    

    The secret message
    

    Sample XML
    

或者，您也可以对表达式求值并返回一组节点，然后遍历该“节点集”，从每个节点中提取文本。我们在下例中便使用了这个方法。

如需详细了解 XPath，请参阅 XPath W3C 规范。

在 Java 中评估 XPath

Java 在 javax.xml.xpath.* 软件包中为解析 XML 和使用 XPath 表达式提供了广泛支持。因此，本部分中的示例代码使用 Java 来说明如何处理 XML 并解析来自 XML 服务响应的数据。

如需在 Java 代码中使用 XPath，您首先需要实例化 XPathFactory 的实例，并对该工厂调用 newXPath() 以创建 XPath 对象。然后，此对象可以使用 evaluate() 方法处理传递的 XML 和 XPath 表达式。

评估 XPath 表达式时，请务必遍历可能返回的任何可能的“节点集”。由于这些结果在 Java 代码中以 DOM 节点的形式返回，因此您应捕获 NodeList 对象中的如此多个值，并遍历该对象，以便从这些节点中提取任何文本或值。

以下代码说明了如何创建 XPath 对象，为其分配 XML 和 XPath 表达式，并评估该表达式以输出相关内容。

import org.xml.sax.InputSource;
import org.w3c.dom.*;
import javax.xml.xpath.*;
import java.io.*;

public class SimpleParser {

  public static void main(String[] args) throws IOException {

	XPathFactory factory = XPathFactory.newInstance();

    XPath xpath = factory.newXPath();

    try {
      System.out.print("Web Service Parser 1.0\n");

      // In practice, you'd retrieve your XML via an HTTP request.
      // Here we simply access an existing file.
      File xmlFile = new File("XML_FILE");

      // The xpath evaluator requires the XML be in the format of an InputSource
	  InputSource inputXml = new InputSource(new FileInputStream(xmlFile));

      // Because the evaluator may return multiple entries, we specify that the expression
      // return a NODESET and place the result in a NodeList.
      NodeList nodes = (NodeList) xpath.evaluate("XPATH_EXPRESSION", inputXml, XPathConstants.NODESET);

      // We can then iterate over the NodeList and extract the content via getTextContent().
      // NOTE: this will only return text for element nodes at the returned context.
      for (int i = 0, n = nodes.getLength(); i < n; i++) {
        String nodeString = nodes.item(i).getTextContent();
        System.out.print(nodeString);
        System.out.print("\n");
      }
    } catch (XPathExpressionException ex) {
	  System.out.print("XPath Error");
    } catch (FileNotFoundException ex) {
      System.out.print("File Error");
    }
  }
}