Cải thiện hiệu suất

Nén bằng gzip

Một cách dễ dàng và thuận tiện để giảm băng thông cần thiết cho mỗi yêu cầu là bật tính năng nén gzip. Mặc dù việc này đòi hỏi thêm thời gian CPU để giải nén kết quả, nhưng việc đánh đổi với chi phí mạng thường rất đáng giá.

Để nhận được phản hồi được mã hoá gzip, bạn phải làm hai việc: Đặt tiêu đề Accept-Encoding và sửa đổi tác nhân người dùng để chứa chuỗi gzip. Dưới đây là ví dụ về tiêu đề HTTP được tạo đúng cách để bật tính năng nén gzip:

Accept-Encoding: gzip
User-Agent: my program (gzip)

Làm việc với một phần tài nguyên

Một cách khác để cải thiện hiệu suất của lệnh gọi API là chỉ yêu cầu phần dữ liệu mà bạn quan tâm. Điều này giúp ứng dụng của bạn tránh chuyển, phân tích cú pháp và lưu trữ các trường không cần thiết, nhờ đó có thể sử dụng tài nguyên (bao gồm cả mạng, CPU và bộ nhớ) hiệu quả hơn.

Phản hồi một phần

Theo mặc định, máy chủ sẽ gửi lại toàn bộ nội dung đại diện của một tài nguyên sau khi xử lý các yêu cầu. Để đạt được hiệu suất cao hơn, bạn có thể yêu cầu máy chủ chỉ gửi các trường mà bạn thực sự cần và nhận phản hồi một phần.

Để yêu cầu phản hồi một phần, hãy sử dụng tham số yêu cầu fields để chỉ định các trường mà bạn muốn được trả về. Bạn có thể sử dụng tham số này với bất kỳ yêu cầu nào trả về dữ liệu phản hồi.

Ví dụ:

Ví dụ sau đây cho thấy cách sử dụng tham số fields với API "Demo" chung (hư cấu).

Yêu cầu đơn giản: Yêu cầu GET HTTP này bỏ qua tham số fields và trả về tài nguyên đầy đủ.

https://www.googleapis.com/demo/v1

Phản hồi đầy đủ về tài nguyên: Dữ liệu tài nguyên đầy đủ bao gồm các trường sau đây, cùng với nhiều trường khác đã bị bỏ qua để đảm bảo tính ngắn gọn.

{
  "kind": "demo",
  ...
  "items": [
  {
    "title": "First title",
    "comment": "First comment.",
    "characteristics": {
      "length": "short",
      "accuracy": "high",
      "followers": ["Jo", "Will"],
    },
    "status": "active",
    ...
  },
  {
    "title": "Second title",
    "comment": "Second comment.",
    "characteristics": {
      "length": "long",
      "accuracy": "medium"
      "followers": [ ],
    },
    "status": "pending",
    ...
  },
  ...
  ]
}

Yêu cầu phản hồi một phần: Yêu cầu sau đây cho cùng một tài nguyên này sử dụng tham số fields để giảm đáng kể lượng dữ liệu được trả về.

https://www.googleapis.com/demo/v1?fields=kind,items(title,characteristics/length)

Phản hồi một phần: Để phản hồi yêu cầu ở trên, máy chủ sẽ gửi lại một phản hồi chỉ chứa thông tin về loại cùng với một mảng mục rút gọn chỉ bao gồm thông tin đặc trưng về tiêu đề và độ dài HTML trong mỗi mục.

200 OK

{
  "kind": "demo",
  "items": [{
    "title": "First title",
    "characteristics": {
      "length": "short"
    }
  }, {
    "title": "Second title",
    "characteristics": {
      "length": "long"
    }
  },
  ...
  ]
}

Xin lưu ý rằng phản hồi là một đối tượng JSON chỉ bao gồm các trường đã chọn và các đối tượng mẹ bao bọc chúng.

Tiếp theo là thông tin chi tiết về cách định dạng thông số fields, sau đó là thông tin chi tiết hơn về nội dung chính xác được trả về trong phản hồi.

Tóm tắt cú pháp tham số trường

Định dạng của giá trị tham số yêu cầu fields dựa trên cú pháp XPath. Cú pháp được hỗ trợ được tóm tắt bên dưới và các ví dụ bổ sung được cung cấp trong phần sau.

• Sử dụng danh sách được phân tách bằng dấu phẩy để chọn nhiều trường.
• Sử dụng a/b để chọn trường b lồng trong trường a; sử dụng a/b/c để chọn trường c lồng trong b.
  

  Trường hợp ngoại lệ: Đối với các phản hồi API sử dụng trình bao bọc "dữ liệu", trong đó phản hồi được lồng trong đối tượng data trông giống như data: { ... }, đừng đưa "data" vào thông số kỹ thuật fields. Việc đưa đối tượng dữ liệu có thông số kỹ thuật về trường như data/a/b vào sẽ gây ra lỗi. Thay vào đó, bạn chỉ cần sử dụng thông số kỹ thuật fields như a/b.

• Sử dụng bộ chọn phụ để yêu cầu một tập hợp các trường con cụ thể của mảng hoặc đối tượng bằng cách đặt biểu thức trong dấu ngoặc đơn "( )".

  Ví dụ: fields=items(id,author/email) chỉ trả về mã mặt hàng và email của tác giả cho mỗi phần tử trong mảng items. Bạn cũng có thể chỉ định một trường con duy nhất, trong đó fields=items(id) tương đương với fields=items/id.

• Sử dụng ký tự đại diện trong lựa chọn trường, nếu cần.

  Ví dụ: fields=items/pagemap/* chọn tất cả đối tượng trong một bản đồ trang.

Các ví dụ khác về cách sử dụng thông số trường

Các ví dụ bên dưới bao gồm nội dung mô tả về cách giá trị tham số fields ảnh hưởng đến phản hồi.

Lưu ý: Giống như tất cả giá trị tham số truy vấn, giá trị tham số fields phải được mã hoá URL. Để dễ đọc hơn, các ví dụ trong tài liệu này sẽ bỏ qua quá trình mã hoá.

Xác định các trường mà bạn muốn trả về hoặc thực hiện lựa chọn trường.

Giá trị tham số yêu cầu fields là danh sách các trường được phân tách bằng dấu phẩy, và mỗi trường được chỉ định tương ứng với thư mục gốc của phản hồi. Do đó, nếu bạn đang thực hiện thao tác danh sách, thì phản hồi sẽ là một tập hợp và thường bao gồm một mảng tài nguyên. Nếu bạn đang thực hiện một thao tác trả về một tài nguyên duy nhất, thì các trường sẽ được chỉ định tương ứng với tài nguyên đó. Nếu trường bạn chọn là (hoặc là một phần của) một mảng, thì máy chủ sẽ trả về phần đã chọn của tất cả các phần tử trong mảng.

Dưới đây là một số ví dụ ở cấp bộ sưu tập:

Ví dụ	Hiệu quả
items	Trả về tất cả phần tử trong mảng items, bao gồm tất cả trường trong mỗi phần tử, nhưng không có trường nào khác.
etag,items	Trả về cả trường etag và tất cả phần tử trong mảng items.
items/title	Chỉ trả về trường title cho tất cả các phần tử trong mảng items. Bất cứ khi nào một trường lồng nhau được trả về, phản hồi sẽ bao gồm các đối tượng mẹ bao bọc. Các trường mẹ không bao gồm bất kỳ trường con nào khác trừ phi các trường con đó cũng được chọn rõ ràng.
context/facets/label	Chỉ trả về trường label cho tất cả các thành phần của mảng facets, chính mảng này được lồng trong đối tượng context.
items/pagemap/*/title	Đối với mỗi phần tử trong mảng items, chỉ trả về trường title (nếu có) của tất cả đối tượng là con của pagemap.

Sau đây là một số ví dụ ở cấp tài nguyên:

Ví dụ	Hiệu quả
title	Trả về trường title của tài nguyên được yêu cầu.
author/uri	Trả về trường phụ uri của đối tượng author trong tài nguyên được yêu cầu.
links/*/href	Trả về trường href của tất cả đối tượng là con của links.

Chỉ yêu cầu một phần của các trường cụ thể bằng cách sử dụng lựa chọn phụ.

Theo mặc định, nếu yêu cầu của bạn chỉ định các trường cụ thể, máy chủ sẽ trả về toàn bộ đối tượng hoặc phần tử mảng. Bạn có thể chỉ định một phản hồi chỉ bao gồm một số trường phụ nhất định. Bạn thực hiện việc này bằng cách sử dụng cú pháp lựa chọn phụ "( )", như trong ví dụ bên dưới.

Ví dụ:	Hiệu quả
items(title,author/uri)	Chỉ trả về các giá trị của title và uri của tác giả cho mỗi phần tử trong mảng items.

Xử lý phản hồi một phần

Sau khi xử lý một yêu cầu hợp lệ có chứa thông số truy vấn fields, máy chủ sẽ gửi lại mã trạng thái HTTP 200 OK cùng với dữ liệu được yêu cầu. Nếu tham số truy vấn fields có lỗi hoặc không hợp lệ, máy chủ sẽ trả về mã trạng thái HTTP 400 Bad Request cùng với thông báo lỗi cho người dùng biết lỗi xảy ra với lựa chọn trường của họ (ví dụ: "Invalid field selection a/b").

Dưới đây là ví dụ về một phần nội dung phản hồi trong phần giới thiệu ở trên. Yêu cầu sử dụng tham số fields để chỉ định các trường cần trả về.

https://www.googleapis.com/demo/v1?fields=kind,items(title,characteristics/length)

Phản hồi một phần sẽ có dạng như sau:

200 OK

{
  "kind": "demo",
  "items": [{
    "title": "First title",
    "characteristics": {
      "length": "short"
    }
  }, {
    "title": "Second title",
    "characteristics": {
      "length": "long"
    }
  },
  ...
  ]
}

Lưu ý: Đối với các API hỗ trợ tham số truy vấn để phân trang dữ liệu (ví dụ: maxResults và nextPageToken), hãy sử dụng các tham số đó để giảm kết quả của mỗi truy vấn xuống kích thước có thể quản lý. Nếu không, bạn có thể không nhận được mức tăng hiệu suất có thể có với phản hồi một phần.