Các phương pháp hay nhất khi sử dụng dịch vụ web API ma trận từ xa

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 tớ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 và xử lý phản hồi của dịch vụ web. Tham khảo hướng dẫn dành cho nhà phát triển để xem tài liệu đầy đủ về API ma trận khoảng cách.

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. Những dịch vụ này được thiết kế để sử dụng cùng với bản đồ, theo Hạn chế về giấy 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) đến các 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 sẽ trả về dữ liệu trong nội dung phản hồi dưới dạng JSON hoặc XML để ứng dụng của bạn phân tích cú pháp và/hoặc xử lý.

Thông thường, yêu cầu API ma trận khoảng cách thường có dạng sau:

https://maps.googleapis.com/maps/api/distancematrix/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ả các ứng dụng API ma trận khoảng cách đều yêu cầu xác thực. Tìm hiểu thêm thông tin về thông tin xác thực.

Truy cập SSL/TLS

HTTPS là 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. Các yêu cầu được thực hiện qua HTTP có chứa dữ liệu nhạy cảm có thể bị từ chối.

Tạo URL hợp lệ

Bạn có thể cho rằng URL "hợp lệ" là tự hiển nhiên, nhưng điều này không đúng. Ví dụ: một URL được nhập vào 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 chế độ mã hoá khác trước khi truyền. Cũng giống như mã thông báo, mọi mã tạo hoặc chấp nhận dữ liệu đầu vào UTF-8 đều có thể coi các 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ỉ phải chứa một tập con các ký tự ASCII đặc biệt: các 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:

Tóm tắt các ký tự URL hợp lệ
Đặtký tựViệc sử dụng URL
Chữ và số 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 Chuỗi văn bản, cách sử dụng lược đồ (http), cổng (8080), v.v.
Không dành riêng - _ . ~ Chuỗi văn bản
Đã đặt trước ! * ' ( ) ; : @ & = + $ , / ? % # [ ] Ký tự điều khiển và/hoặc Chuỗi văn bản

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ự xuất hiện trong bảng Tóm tắt các ký tự URL hợp lệ. Việc cấu thành một URL để sử dụng bộ ký tự này thường sẽ dẫn đến hai vấn đề, một là bỏ sót và một là bị thay thế:

  • Các ký tự mà bạn muốn xử lý nằm ngoài nhóm trên. Ví dụ: các ký tự bằng tiếng nước ngoài như 上海+中國 cần được mã hoá bằng các ký tự trên. Theo quy ước phổ biến, dấu cách (không được cho phép trong URL) thường được biểu thị bằng ký tự dấu cộng '+'.
  • Các ký tự nằm trong tập hợp 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 phần đầu của chuỗi truy vấn; nếu muốn sử dụng chuỗi "? và Mysterions", bạn cần mã hoá ký tự '?'.

Tất cả các ký tự được 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 thành %E4%B8%8A%E6%B5%B7%2B%E4%B8%AD%E5%9C%8B. Chuỗi ? and the Mysterians sẽ được mã hoá URL dưới dạng %3F+and+the+Mysterians hoặc %3F%20and%20the%20Mysterians.

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

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

Ký tự không an toàn Giá trị được mã hoá
Không gian %20
" %22
< %3C
> %3E
# %23
% %25
| %7C

Đôi khi, việc chuyển đổi URL mà bạn nhận được từ hoạt động đầu vào của người dùng sẽ rất khó khăn. 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 nó, 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, các URL cũng được giới hạn ở 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ụ, giới hạn ký tự này hiếm khi được áp dụng. Tuy nhiên, xin lưu ý rằng một số dịch vụ có một số tham số có thể dẫn đến URL dài.

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

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

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 lỗi 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 kết nối TCP có thể bị lỗi ở đâu đó giữa ứng dụng 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 trong khi yêu cầu ban đầu không thành công. Tuy nhiên, điều quan trọng là bạn không nên gửi yêu cầu lặp đi lặp lại đế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 và Google, gây ra sự cố cho nhiều bên.

Một phương pháp hiệu quả hơn là thử lại và tăng độ trễ giữa các lần thử. Thông thường, độ trễ sẽ được tăng lên theo 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 Time Zone API (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ụ về Python sau đây cho thấy cách thực hiện 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 cẩn thận để không có thử lại mã 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 một cách nhanh chóng liên tiếp.

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

Một số lượng lớn các yêu cầu được đồng bộ hoá đối với API của Google có thể giống như một cuộc tấn công Từ chối dịch vụ phân tán (DDoS) đối với cơ sở hạ tầng của Google và được xử lý tương ứng. Để tránh điều này, bạn cần đả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 đánh thức ứng dụng vào đầu phút để 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 quan đến 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ì điều đó dẫn đến việc các lệnh gọi API được đồng bộ hoá với 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 khi thực hiện 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 60 lần mức bình thường vào đầ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, ứ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 cách tiếp cận này, các lệnh gọi API sẽ được trải đều theo thời gian. Ngoài ra, các lệnh gọi API không trì hoãn việc 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 điểm đồng bộ hoá phổ biến khác mà bạn không nên nhắm mục tiêu là đầu giờ và đầu ngày vào lúc nửa đêm.

Đang xử lý phản hồ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 hoạt 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 rất dễ hiểu, nhưng không hoàn toàn thân thiện với người dùng. Khi thực hiện truy vấn, thay vì hiển thị một tập hợp dữ liệu, bạn nên trích xuất một vài giá trị cụ thể. Nhìn chung, bạn nên phân tích cú pháp phản hồi qua dịch vụ web và chỉ trích xuất các giá trị mà bạn quan tâm.

Lược đồ phân tích cú pháp 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 đã ở dạng đối tượng JavaScript có thể được xử lý ngay trong chính JavaScript trên ứng dụng. Bạn phải xử lý phản hồi XML bằng cách sử dụng trình xử lý XML và ngôn ngữ truy vấn XML để xử lý các phần tử ở định dạng XML. Chúng tôi sử dụng XPath trong các ví dụ sau đây, vì bộ nhớ này thường được hỗ trợ trong các thư viện xử lý XML.

Xử lý XML bằng XPath

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 nhiều 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 một 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à một cú pháp ngôn ngữ để mô tả riêng biệt các nút và phần tử trong một tài liệu XML. Biểu thức XPath 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 XPath

Một số người dùng đã quen thuộc với XPath sẽ giúp bạn phát triển được 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 các phần tử trong tài liệu XML được xử lý bằng XPath, cho phép bạn giải quyết nhiều phần tử và xây dựng các truy vấn phức tạp.

XPath 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 các đườ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, là cây phân cấp tương tự như cây DOM. Nói chung, các biểu thức XPath có giá trị tham lam, cho biết rằng các biểu thức này sẽ khớp với tất cả các nút khớp với tiêu chí đã cung cấp.

Chúng tôi sẽ sử dụng XML trừu tượng sau đây để 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

Lựa chọn XPath sẽ chọn nút. Nút gốc bao gồm toàn bộ tài liệu. Bạn chọn nút này bằng biểu thức đặc biệt "/". Xin 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; thực ra nút này nằm phía 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 này.

Các nút phần tử đại diện cho nhiều phần tử trong cây tài liệu XML. Chẳng hạn, 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 từng nút riêng lẻ thông qua đường dẫn tuyệt đối hoặc tương đối, biểu thị bằng việc có hay 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à phần tử con của nút <WebServiceResponse>. (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 từ 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 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 thông qua việc thêm đường dẫn ký tự đại diện, được biểu thị bằng dấu gạch chéo đôi ("//"). Ký tự đại diện này cho biết không có hoặc nhiều phần tử có thể khớp trong đường dẫn xen kẽ. Ví dụ: biểu thức XPath "//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 sẽ khớp với tất cả các phần tử <lat> có thể theo dõi <viewport> là thành phần mẹ.

Theo mặc định, biểu thức XPath 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 XPath "/GeocodeResponse/result[2] luôn trả về kết quả thứ hai chẳng hạn.

Loại biểu cảm
Root node
Biểu thức XPath:  "/"
Lựa chọn:
    <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>
    
Đường dẫn tuyệt đối
Biểu thức XPath:  "/WebServiceResponse/result"
Lựa chọn:
    <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>
    
Đường dẫn có ký tự đại diện
Biểu thức XPath:  "/WebServiceResponse//location"
Lựa chọn:
    <location>
     <lat>37.4217550</lat>
     <lng>-122.0846330</lng>
    </location>
    
Đường dẫn có vị từ
Biểu thức XPath:  "/WebServiceResponse/result[2]/message"
Lựa chọn:
    <message>The secret message</message>
    
Tất cả thư mục con trực tiếp của result đầu tiên
Biểu thức XPath:  "/WebServiceResponse/result[1]/*"
Lựa chọn:
     <type>sample</type>
     <name>Sample XML</name>
     <location>
      <lat>37.4217550</lat>
      <lng>-122.0846330</lng>
     </location>
    
name của một result có văn bản type là "mẫu".
Biểu thức XPath:  "/WebServiceResponse/result[type/text()='sample']/name"
Lựa chọn:
    Sample XML
    

Điều quan trọng cần lưu ý là khi chọn các phần tử, bạn sẽ chọn các nút, chứ không chỉ văn bản trong các đối tượng đó. Nói 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.

Xin lưu ý rằng XPath 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.

Lựa 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 XPath thông qua toán tử nút văn bản. Toán tử "text()" này cho biết việc trích xuất văn bản từ nút đã chỉ định. Ví dụ: biểu thức XPath "//formatted_address/text()" sẽ trả về tất cả văn bản trong các phần tử <formatted_address>.

Loại biểu cảm
Tất cả các nút văn bản (bao gồm cả khoảng trắng)
Biểu thức XPath:  "//text()"
Lựa chọn:
    sample
    Sample XML

    37.4217550
    -122.0846330
    The secret message
    
Chọn văn bản
Biểu thức XPath:  "/WebServiceRequest/result[2]/message/text()"
Lựa chọn:
    The secret message
    
Lựa chọn nhạy cảm theo ngữ cảnh
Biểu thức XPath:  "/WebServiceRequest/result[type/text() = 'sample']/name/text()"
Lựa chọn:
    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" đó, 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ụ dưới đây.

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

Đánh giá XPath trong Java

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

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

Khi đánh giá biểu thức XPath, 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 nút DOM trong mã Java, 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 trên đố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 đó.

Mã sau minh hoạ cách tạo đối tượng XPath, gán đối tượng XML và biểu thức XPath, đồng thời đánh giá biểu thức để in nội dung 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");
    }
  }
}