使用 Directions API（旧版）网络服务的最佳实践

Google Maps Platform Web 服务是一组 HTTP 接口，可用于访问 Google 服务，从而为您的地图应用提供地理位置数据。

本指南介绍了一些有助于设置 Web 服务请求和处理服务响应的常见做法。如需查看 Directions API（旧版）的完整文档，请参阅开发者指南。

什么是网络服务？

Google Maps Platform Web 服务是一种接口，用于从外部服务请求地图 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 字符子集：大家熟悉的字母数字符号以及一些在网址内用作控制字符的预留字符。下表汇总了这些字符：

有效网址字符汇总
字符集字符在网址中的用法
字母数字 a b c d e f g h i j k l m n o p q r s t u v w x y z A B C D E F G H I J K L M N O P Q R S T U V W X Y Z 0 1 2 3 4 5 6 7 8 9 文本字符串、在 scheme 中使用 (http)、端口 (8080) 等
非预留字符 - _ . ~ 文本字符串
预留字符 ! * ' ( ) ; : @ & = + $ , / ? % # [ ] 控制字符和/或文本字符串

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

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

需要编码的常见字符

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

不安全的字符 编码后的值
空格 %20
" %22
< %3C
> %3E
# %23
% %25
| %7C

转换您通过用户输入获取的网址有时颇为棘手。例如，用户可能会输入“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 调用与分钟开始时间同步（即使在不同设备之间亦是如此），而非在一段时间内均匀分布。若应用未经合理设计，则此操作会导致在每分钟开始时产生正常水平 60 倍的流量高峰。

相较之下，我们可以采用一种较好的设计，即将第二个闹钟设为随机选择的时间。 当第二个闹钟触发时，应用会调用所需的任何 API 并存储结果。当应用想要在分钟开始时更新其显示时间时，它会使用先前存储的结果，而非再次调用该 API。借助此方法，API 调用即可在一段时间内均匀分布。此外，当显示时间更新时，这类 API 调用操作并不会导致延迟呈现内容。

除了分钟开始时间，您还应注意不要设置其他常见同步时间，如小时开始时间和每天开始时间（午夜）。

处理响应

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

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

您使用的解析方案取决于您是以 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> 元素。一般来说，您无需担心上下文，因为您通常会通过单个表达式处理 Web 服务结果。

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

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

表达式类型
根节点
XPath 表达式：“/”
选择： 
    <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 表达式：“/WebServiceResponse/result”
选择： 
    <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>
带通配符的路径
XPath 表达式：“/WebServiceResponse//location”
选择： 
    <location>
     <lat>37.4217550</lat>
     <lng>-122.0846330</lng>
    </location>
带谓词的路径
XPath 表达式：“/WebServiceResponse/result[2]/message”
选择： 
    <message>The secret message</message>
第一个 result 的所有直接子级
XPath 表达式：“/WebServiceResponse/result[1]/*”
选择： 
     <type>sample</type>
     <name>Sample XML</name>
     <location>
      <lat>37.4217550</lat>
      <lng>-122.0846330</lng>
     </location>
type 文本为“sample”的 result 的 name。
XPath 表达式：“/WebServiceResponse/result[type/text()='sample']/name”
选择： 
    Sample XML

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

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

表达式中的文本选择

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

表达式类型
所有文本节点（包括空格）
XPath 表达式：“//text()”
选择： 
    sample
    Sample XML

    37.4217550
    -122.0846330
    The secret message
文本选择
XPath 表达式：“/WebServiceRequest/result[2]/message/text()”
选择： 
    The secret message
上下文相关选择
XPath 表达式：“/WebServiceRequest/result[type/text() = 'sample']/name/text()”
选择： 
    Sample XML

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

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

在 Java 中评估 XPath

Java 广泛支持解析 XML 和在 javax.xml.xpath.* 软件包中使用 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");
    }
  }
}