Các phương pháp hay nhất khi sử dụng Dịch vụ web API Chỉ dẫn

Các dịch vụ web của Nền tảng Google Maps là một tập hợp các giao diện HTTP với các dịch vụ của Google cung cấp dữ liệu địa lý cho các ứng dụng bản đồ của bạn.

Hướng dẫn này mô tả một số phương pháp phổ biến hữu ích để thiết lập yêu cầu dịch vụ web và xử lý phản hồi dịch vụ. Tham khảo hướng dẫn dành cho nhà phát triển để xem tài liệu đầy đủ về API hướng dẫn.

Dịch vụ web là gì?

Các dịch vụ web của Nền tảng Google Maps là một giao diện để yêu cầu dữ liệu API Maps từ các dịch vụ bên ngoài và sử dụng dữ liệu trong các ứng dụng Maps của bạn. Các dịch vụ này được thiết kế để dùng cùng với bản đồ, theo Giới hạn cấp phép trong Điều khoản dịch vụ của Nền tảng Google Maps.

Các dịch vụ web của API Maps sử dụng yêu cầu HTTP(S) cho những URL cụ thể, truyền tham số URL và/hoặc dữ liệu POST ở định dạng JSON làm đối số cho dịch vụ. Nhìn chung, các dịch vụ này trả về dữ liệu trong nội dung phản hồi dưới dạng JSON hoặc XML để phân tích cú pháp và/hoặc xử lý dữ liệu cho ứng dụng của bạn.

Thông thường, một yêu cầu API hướng dẫn thường có dạng sau:

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

trong đó output cho biết định dạng phản hồi (thường là json hoặc xml).

Lưu ý: Tất cả ứng dụng API hướng dẫn đều yêu cầu xác thực. Xem thêm thông tin về thông tin xác thực.

Truy cập SSL/TLS

HTTPS là yêu cầu bắt buộc đối với tất cả các yêu cầu trên Nền tảng Google Maps sử dụng khoá API hoặc chứa dữ liệu người dùng. Những yêu cầu được thực hiện qua HTTP chứa dữ liệu nhạy cảm có thể bị từ chối.

Tạo URL hợp lệ

Có thể bạn cho rằng một URL "hợp lệ" là điều hiển nhiên, nhưng điều đó không đúng. Ví dụ: URL được nhập trong thanh địa chỉ trong trình duyệt có thể chứa các ký tự đặc biệt (ví dụ: "上海+中國"); trình duyệt cần dịch nội bộ các ký tự đó sang một kiểu mã hoá khác trước khi truyền. Tương tự như vậy, mọi mã tạo hoặc chấp nhận dữ liệu đầu vào UTF-8 có thể coi URL có ký tự UTF-8 là "hợp lệ", nhưng cũng cần phải dịch các ký tự đó trước khi gửi đến máy chủ web. Quá trình này gọi là mã hoá URL hoặc mã hoá phần trăm.

Các ký tự đặc biệt

Chúng tôi cần dịch các ký tự đặc biệt vì tất cả URL đều phải tuân thủ cú pháp được chỉ định trong thông số kỹ thuật Mã nhận dạng tài nguyên đồng nhất (URI). Trên thực tế, điều này có nghĩa là URL chỉ được chứa một tập hợp con ký tự ASCII đặc biệt: ký hiệu chữ và số quen thuộc và một số ký tự dành riêng để dùng làm ký tự điều khiển trong URL. Bảng này tóm tắt các ký tự sau:

Khi tạo một URL hợp lệ, bạn phải đảm bảo rằng URL đó chỉ chứa các ký tự hiển thị trong bảng. Việc tạo một URL để sử dụng tập hợp ký tự này thường dẫn đến 2 vấn đề, một là bị bỏ sót và một là bị thay thế:

• Các ký tự bạn muốn xử lý tồn tại ngoài nhóm ở trên. Ví dụ: bạn cần mã hoá các ký tự bằng tiếng nước ngoài như 上海+中國 bằng các ký tự trên. Theo quy ước phổ biến, dấu cách (không được phép trong URL) cũng thường được biểu thị bằng ký tự dấu cộng '+'.
• Các ký tự tồn tại trong tập hợp nêu trên dưới dạng ký tự dành riêng, nhưng cần được sử dụng theo nghĩa đen. Ví dụ: ? được dùng trong các URL để cho biết điểm bắt đầu của chuỗi truy vấn; nếu muốn dùng chuỗi "? và Chuỗi ẩn số", bạn cần mã hoá ký tự '?'.

Tất cả các ký tự cần mã hoá URL đều được mã hoá bằng ký tự '%' và một giá trị hex gồm hai ký tự tương ứng với ký tự UTF-8. Ví dụ: 上海+中國 trong UTF-8 sẽ được mã hoá URL dưới dạng %E4%B8%8A%E6%B5%B7%2B%E4%B8%AD%E5%9C%8B. Chuỗi ? and the Mysterians sẽ được mã hoá URL thành %3F+and+the+Mysterians hoặc %3F%20and%20the%20Mysterians.

Các ký tự phổ biến cần mã hoá

Một số ký tự phổ biến phải được mã hoá là:

Đôi khi, việc chuyển đổi một URL mà bạn nhận được từ hoạt động đầu vào của người dùng đôi khi khá phức tạp. Ví dụ: người dùng có thể nhập địa chỉ là "5th&Main St." Nhìn chung, bạn nên tạo URL từ các phần của URL đó, coi mọi hoạt động đầu vào của người dùng là các ký tự cố định.

Ngoài ra, URL chỉ được có tối đa 16384 ký tự đối với tất cả các dịch vụ web và API web tĩnh trên Nền tảng Google Maps. Đối với hầu hết các dịch vụ, hiếm khi đạt đến giới hạn ký tự này. Tuy nhiên, hãy lưu ý rằng một số dịch vụ nhất định có một số tham số có thể dẫn đến URL dài.

Sử dụng lịch sự các API của Google

Các ứng dụng API được thiết kế kém có thể khiến cả Internet và máy chủ của Google phải tải nhiều hơn mức cần thiết. Phần này trình bày một số phương pháp hay nhất dành cho các ứng dụng khách sử dụng API. Khi làm theo các phương pháp hay nhất này, bạn có thể tránh việc ứng dụng của mình bị chặn do vô tình sử dụng API sai cách.

Thuật toán thời gian đợi luỹ thừa

Trong một số ít trường hợp, có thể xảy ra sự cố khi phân phát yêu cầu của bạn; bạn có thể nhận được mã phản hồi HTTP 4XX hoặc 5XX hoặc đơn giản là kết nối TCP không thành công ở đâu đó giữa ứng dụng khách và máy chủ của Google. Thông thường, bạn nên thử lại yêu cầu vì yêu cầu tiếp theo có thể thành công khi yêu cầu ban đầu không thành công. Tuy nhiên, bạn không nên chỉ lặp đi lặp lại các yêu cầu đến máy chủ của Google. Hành vi lặp lại này có thể làm quá tải mạng giữa ứng dụng của bạn và Google, gây ra sự cố cho nhiều bên.

Cách tốt hơn là thử lại với độ trễ tăng dần giữa các lần thử. Thông thường, độ trễ được tăng lên bằng một hệ số nhân với mỗi lần thử, một phương pháp được gọi là Thời gian đợi luỹ thừa.

Ví dụ: hãy xem xét một ứng dụng muốn gửi yêu cầu này đến API Múi giờ:

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

Ví dụ sau đây trong Python cho thấy cách tạo yêu cầu bằng thuật toán thời gian đợi luỹ thừa:

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}")

Bạn cũng nên lưu ý rằng không có mã thử lại nào cao hơn trong chuỗi lệnh gọi ứng dụng dẫn đến các yêu cầu lặp lại liên tiếp nhanh chóng.

Yêu cầu đã đồng bộ hoá

Số lượng lớn các yêu cầu được đồng bộ hoá với các API của Google có thể trông giống như một cuộc tấn công Từ chối dịch vụ phân tán (DDoS) nhằm vào cơ sở hạ tầng của Google và được xử lý tương ứng. Để tránh tình trạng này, bạn phải đảm bảo rằng các yêu cầu API không được đồng bộ hoá giữa các ứng dụng.

Ví dụ: hãy xem xét một ứng dụng hiển thị thời gian theo múi giờ hiện tại. Ứng dụng này có thể sẽ đặt chuông báo trong hệ điều hành ứng dụng khi đánh thức chuông báo vào đầu phút để có thể cập nhật thời gian hiển thị. Ứng dụng không được thực hiện bất kỳ lệnh gọi API nào trong quá trình xử lý liên kết với chuông báo đó.

Việc thực hiện lệnh gọi API để phản hồi một chuông báo cố định sẽ không tốt vì việc này dẫn đến việc các lệnh gọi API được đồng bộ hoá vào thời điểm bắt đầu phút, ngay cả giữa các thiết bị khác nhau, thay vì được phân phối đồng đều theo thời gian. Một ứng dụng được thiết kế kém làm việc này sẽ tạo ra mức tăng đột biến về lưu lượng truy cập ở mức bình thường 60 lần khi bắt đầu mỗi phút.

Thay vào đó, bạn nên đặt chuông báo thứ hai theo thời gian được chọn ngẫu nhiên. Khi chuông báo thứ hai này kích hoạt, ứng dụng sẽ gọi bất kỳ API nào mà ứng dụng cần và lưu trữ kết quả. Khi muốn cập nhật màn hình ngay từ đầu phút, ứng dụng sẽ sử dụng các kết quả đã lưu trữ trước đó thay vì gọi lại API. Với phương pháp này, các lệnh gọi API được trải đều theo thời gian. Ngoài ra, các lệnh gọi API không trì hoãn quá trình kết xuất khi màn hình đang được cập nhật.

Ngoài thời điểm bắt đầu phút, các thời gian đồng bộ hoá phổ biến khác mà bạn không nên cẩn thận nhắm mục tiêu là vào đầu một giờ và bắt đầu mỗi ngày vào lúc nửa đêm.

Đang xử lý câu trả lời

Phần này thảo luận cách trích xuất các giá trị này một cách linh động từ phản hồi của dịch vụ web.

Các dịch vụ web của Google Maps cung cấp câu trả lời dễ hiểu, nhưng không thân thiện với người dùng. Khi thực hiện một truy vấn, thay vì hiển thị một tập dữ liệu, bạn nên trích xuất một vài giá trị cụ thể. Thông thường, bạn sẽ muốn phân tích cú pháp các phản hồi từ dịch vụ web và chỉ trích xuất những giá trị mà bạn quan tâm.

Giao thức phân tích cú pháp mà bạn sử dụng phụ thuộc vào việc bạn trả về kết quả ở định dạng XML hay JSON. Phản hồi JSON vốn đã ở dạng đối tượng JavaScript, có thể được xử lý ngay trong JavaScript trên ứng dụng. Phản hồi XML phải được xử lý bằng trình xử lý XML và ngôn ngữ truy vấn XML để xử lý các phần tử trong định dạng XML. Chúng tôi sử dụng XPath trong các ví dụ sau vì tên này thường được hỗ trợ trong các thư viện xử lý XML.

Xử lý XML bằng q

XML là một định dạng thông tin có cấu trúc tương đối hoàn thiện, dùng để trao đổi dữ liệu. Mặc dù không nhẹ như JSON, nhưng XML hỗ trợ nhiều ngôn ngữ hơn và cung cấp các công cụ mạnh mẽ hơn. Ví dụ: mã để xử lý XML trong Java được tích hợp vào các gói javax.xml.

Khi xử lý các phản hồi XML, bạn nên sử dụng ngôn ngữ truy vấn thích hợp để chọn các nút trong tài liệu XML, thay vì giả định các phần tử nằm ở vị trí tuyệt đối trong mã đánh dấu XML. XPath là cú pháp ngôn ngữ dùng để mô tả duy nhất các nút và phần tử trong một tài liệu XML. Biểu thức giám sát cho phép bạn xác định nội dung cụ thể trong tài liệu phản hồi XML.

Biểu thức Tên

Một số kiến thức quen thuộc với vai trò sẽ giúp bạn phát triển một lược đồ phân tích cú pháp mạnh mẽ. Phần này sẽ tập trung vào cách định địa chỉ của các phần tử trong tài liệu XML bằng Wi-Fi, cho phép bạn giải quyết nhiều phần tử và tạo các truy vấn phức tạp.

NETWORK sử dụng biểu thức để chọn các phần tử trong tài liệu XML, sử dụng cú pháp tương tự như cú pháp dùng cho đường dẫn thư mục. Các biểu thức này xác định các phần tử trong cây tài liệu XML. Cây này là một cây phân cấp tương tự như cây DOM. Nhìn chung, biểu thức vai trò kiểm soát quá mức, cho biết rằng chúng sẽ khớp với tất cả các nút phù hợp với tiêu chí đã cung cấp.

Chúng tôi sẽ sử dụng XML trừu tượng sau để minh hoạ các ví dụ:

<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>

Lựa chọn nút trong biểu thức

Chọn nút trong các mục lựa chọn Nhà cung cấp thông tin. Nút gốc bao gồm toàn bộ tài liệu. Bạn chọn nút này bằng cách sử dụng biểu thức đặc biệt "/". Lưu ý rằng nút gốc không phải là nút cấp cao nhất của tài liệu XML; trên thực tế, nút này nằm trên một cấp phía trên phần tử cấp cao nhất này và bao gồm nút đó.

Các nút phần tử đại diện cho các phần tử khác nhau trong cây tài liệu XML. Ví dụ: phần tử <WebServiceResponse> đại diện cho phần tử cấp cao nhất được trả về trong dịch vụ mẫu ở trên của chúng tôi. Bạn chọn các nút riêng lẻ thông qua đường dẫn tuyệt đối hoặc tương đối, được biểu thị bằng sự hiện diện hoặc không có ký tự "/" ở đầu.

• Đường dẫn tuyệt đối: biểu thức "/WebServiceResponse/result" chọn tất cả các nút <result> là con của nút <WebServiceResponse>. (Xin lưu ý rằng cả hai phần tử này đều bắt nguồn từ nút gốc "/".)
• Đường dẫn tương đối trong ngữ cảnh hiện tại: biểu thức "result" sẽ khớp với mọi phần tử <result> trong ngữ cảnh hiện tại. Nhìn chung, bạn không cần phải lo lắng về ngữ cảnh, vì bạn thường xử lý kết quả dịch vụ web thông qua một biểu thức duy nhất.

Bạn có thể tăng cường một trong hai biểu thức này bằng cách thêm đường dẫn ký tự đại diện, biểu thị bằng dấu gạch chéo đôi ("//"). Ký tự đại diện này cho biết rằng không có hoặc nhiều phần tử có thể khớp trong đường dẫn xen kẽ. Chẳng hạn, biểu thức Wi-Fi "//formatted_address" sẽ khớp với tất cả các nút có tên đó trong tài liệu hiện tại. Biểu thức //viewport//lat khớp với tất cả các phần tử <lat> có thể theo dõi <viewport> dưới dạng phần tử mẹ.

Theo mặc định, biểu thức Wi-Fi khớp với tất cả các phần tử. Bạn có thể hạn chế biểu thức để khớp với một phần tử nhất định bằng cách cung cấp một predicate được đặt trong dấu ngoặc vuông ([]). Biểu thức Wi-Fi "/GeocodeResponse/result[2] luôn trả về kết quả thứ hai, chẳng hạn như vậy.

    <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
    

Điều quan trọng cần lưu ý là khi chọn các phần tử, bạn phải chọn các nút, chứ không chỉ văn bản trong các đối tượng đó. Nhìn chung, bạn nên lặp lại tất cả các nút đã khớp và trích xuất văn bản. Bạn cũng có thể so khớp trực tiếp các nút văn bản; xem phần Nút văn bản bên dưới.

Lưu ý rằng vai trò cũng hỗ trợ các nút thuộc tính. Tuy nhiên, tất cả các dịch vụ web của Google Maps đều phân phát các phần tử không có thuộc tính, vì vậy việc so khớp các thuộc tính là không cần thiết.

Chọn văn bản trong biểu thức

Văn bản trong tài liệu XML được chỉ định trong biểu thức vai trò thông qua toán tử nút văn bản. Toán tử này "text()" cho biết việc trích xuất văn bản từ nút đã chỉ định. Ví dụ: biểu thức diễn ra ng tên "//formatted_address/text()" sẽ trả về tất cả văn bản trong các phần tử <formatted_address>.

    sample
    Sample XML

    37.4217550
    -122.0846330
    The secret message
    

    The secret message
    

    Sample XML
    

Ngoài ra, bạn có thể đánh giá một biểu thức và trả về một tập hợp các nút, sau đó lặp lại "tập hợp nút" đó và trích xuất văn bản từ mỗi nút. Chúng tôi sử dụng phương pháp này trong ví dụ bên dưới.

Để biết thêm thông tin về, hãy tham khảo phần Thông số kỹ thuật của GAIA W3C.

Đánh giá XPath trong Java

Java có hỗ trợ rộng rãi cho việc phân tích cú pháp XML và sử dụng biểu thức Wi-Fi trong gói javax.xml.xpath.*. Vì lý do đó, mã mẫu trong phần này sử dụng Java để minh hoạ cách xử lý XML và phân tích cú pháp dữ liệu trong các phản hồi của dịch vụ XML.

Để sử dụng Wi-Fi trong mã Java, trước tiên, bạn cần tạo thực thể cho một thực thể của XPathFactory và gọi newXPath() trên nhà máy đó để tạo một đối tượng XPath . Sau đó, đối tượng này có thể xử lý các biểu thức XML và Wi-Fi đã truyền bằng phương thức evaluate().

Khi đánh giá biểu thức, hãy đảm bảo rằng bạn lặp lại mọi "nhóm nút" có thể được trả về. Vì các kết quả này được trả về dưới dạng các nút DOM trong mã Java, nên bạn nên thu thập nhiều giá trị như vậy trong một đối tượng NodeList và lặp lại qua đối tượng đó để trích xuất bất kỳ văn bản hoặc giá trị nào từ các nút đó.

Đoạn mã sau minh hoạ cách tạo một đối tượng XPath, gán XML và biểu thức vai trò này đồng thời đánh giá biểu thức để in nội dung có liên quan.

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");
    }
  }
}