Trang này được dịch bởi Cloud Translation API.

API JSON của Blogger: Mẹo tăng hiệu suất

Lưu ý quan trọng: Chúng tôi sẽ ngừng hỗ trợ API JSON phiên bản 2.0 kể từ ngày 30 tháng 9 năm 2024. Để đảm bảo chức năng không bị gián đoạn, hãy cập nhật các ứng dụng chạy API JSON phiên bản 2.0 lên phiên bản API mới nhất. Để dùng phiên bản mới nhất, hãy sử dụng các đường liên kết trong thanh điều hướng bên trái.

Tài liệu này trình bày một số kỹ thuật bạn có thể sử dụng để cải thiện hiệu suất của ứng dụng. Trong một số trường hợp, chúng tôi sử dụng ví dụ từ các API khác hoặc API chung để minh hoạ các ý tưởng được trình bày. Tuy nhiên, các khái niệm tương tự có thể áp dụng cho API Blogger.

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 chức năng nén gzip. Mặc dù việc này yêu cầu thêm thời gian của CPU để giải nén kết quả, nhưng việc đánh đổi chi phí mạng thường rất đáng để thực hiện.

Để nhận được phản hồi được mã hoá bằng gzip, bạn phải thực hiện 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ề các tiêu đề HTTP được định dạng đúng để bật chức 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ỉ gửi và nhận phần dữ liệu mà bạn quan tâm. Việc này cho phép ứng dụng 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ờ đó ứng dụng có thể dùng các tài nguyên như mạng, CPU và bộ nhớ một cách hiệu quả hơn.

Có hai loại yêu cầu một phần:

Phản hồi một phần: Một yêu cầu mà bạn chỉ định các trường cần đưa vào phản hồi (sử dụng tham số yêu cầu fields).
Patch (Bản vá): Yêu cầu cập nhật mà bạn chỉ gửi các trường bạn muốn thay đổi (sử dụng động từ HTTP PATCH).

Bạn có thể xem thêm thông tin chi tiết về cách thực hiện yêu cầu một phần trong các phần sau.

Câu trả lời một phần

Theo mặc định, máy chủ gửi lại bản trình bày đầy đủ của tài nguyên sau khi xử lý các yêu cầu. Để có hiệu suất tốt hơn, bạn có thể yêu cầu máy chủ chỉ gửi các trường 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 trả về. Bạn có thể 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.

Xin lưu ý rằng tham số fields chỉ ảnh hưởng đến dữ liệu phản hồi chứ không ảnh hưởng đến dữ liệu mà bạn cần gửi (nếu có). Để giảm lượng dữ liệu bạn gửi khi sửa đổi tài nguyên, hãy sử dụng yêu cầu bản vá.

Ví dụ:

Ví dụ sau đây cho thấy việc sử dụng tham số fields với API "Bản minh hoạ" chung (giả tưởng).

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

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

Phản hồi đầy đủ đối với tài nguyên: Dữ liệu tài nguyên đầy đủ bao gồm các trường sau cùng với nhiều trường khác đã bị loại bỏ vì lý do 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 chính 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 nêu trên, máy chủ 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 items được rút gọn chỉ bao gồm thông tin đặc điểm về tiêu đề HTML và độ dài trong mỗi mục.

200 OK

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

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à đối tượng mẹ bao quanh các trường đó.

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

Bản tóm tắt về 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. Dưới đây là cú pháp được hỗ trợ và các ví dụ khác được cung cấp trong phần sau.

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

Ngoại lệ: Đối với phản hồi API sử dụng trình bao bọc "data", trong đó phản hồi được lồng trong đối tượng data trông giống như data: { ... }, đừng đưa "data" vào quy cách fields. Việc đưa đối tượng dữ liệu vào có thông số kỹ thuật của trường như data/a/b sẽ gây ra lỗi. Thay vào đó, 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 phụ cụ thể của các 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 từng phần tử trong mảng items. Bạn cũng có thể chỉ định một trường phụ, trong đó fields=items(id) tương đương với fields=items/id.
Sử dụng ký tự đại diện trong các lựa chọn trường, nếu cần.
Ví dụ: fields=items/pagemap/* chọn tất cả các đối tượng trong sơ đồ trang.

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

Những ví dụ dưới đây bao gồm nội dung mô tả về mức độ ảnh hưởng của giá trị tham số fields đến phản hồi.

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

Xác định các trường bạn muốn trả về hoặc chọn các trường.

Giá trị tham số yêu cầu fields là một 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 gốc của phản hồi. Do đó, nếu bạn đang thực hiện thao tác danh sách, phản hồi 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 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ả các trường trong mỗi phần tử, ngoại trừ các trường khác.
`etag,items`	Trả về cả trường `etag` và mọi phần tử trong mảng items.
`items/title`	Chỉ trả về trường `title` cho mọi 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 quanh. 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 đó cũng được chọn một cách rõ ràng.
`context/facets/label`	Chỉ trả về trường `label` cho mọi thành phần của mảng `facets`. 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 mọi đối tượng là con của `pagemap`.

Dưới đâ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 mọi đối tượng là con của `links`.

Chỉ yêu cầu các 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 một số trường cụ thể, thì máy chủ sẽ trả về toàn bộ các đố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ụ dưới đây.

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 từng phần tử trong mảng items.

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

Sau khi xử lý yêu cầu hợp lệ chứa tham 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 gặp lỗi hoặc không hợp lệ, máy chủ sẽ trả về một 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 đã xảy ra lỗi gì khi chọn trường (ví dụ: "Invalid field selection a/b").

Dưới đây là ví dụ về câu trả lời từng phần xuất hiện trong phần giới thiệu ở trên. Yêu cầu này sử dụng tham số fields để chỉ định những 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 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, mức tăng hiệu suất có thể đạt được với phản hồi một phần có thể không được nhận dạng.

Bản vá (cập nhật một phần)

Bạn cũng có thể tránh gửi dữ liệu không cần thiết khi sửa đổi tài nguyên. Để chỉ gửi dữ liệu đã cập nhật cho các trường cụ thể mà bạn muốn thay đổi, hãy sử dụng động từ HTTP PATCH. Ngữ nghĩa của bản vá được mô tả trong tài liệu này khác (và đơn giản hơn) so với phương thức triển khai bản cập nhật một phần GData cũ.

Ví dụ ngắn bên dưới cho thấy cách việc sử dụng bản vá giảm thiểu dữ liệu bạn cần gửi để thực hiện một cập nhật nhỏ.

Ví dụ:

Ví dụ này cho thấy một yêu cầu bản vá đơn giản chỉ cập nhật tiêu đề của một tài nguyên API "Bản minh hoạ" chung chung (giả tưởng). Tài nguyên này cũng có nhận xét, một nhóm đặc điểm, trạng thái và nhiều trường khác, nhưng yêu cầu này chỉ gửi trường title, vì đó là trường duy nhất được sửa đổi:

PATCH https://www.googleapis.com/demo/v1/324
Authorization: Bearer your_auth_token
Content-Type: application/json

{
  "title": "New title"
}

Phản hồi:

200 OK

{
  "title": "New title",
  "comment": "First comment.",
  "characteristics": {
    "length": "short",
    "accuracy": "high",
    "followers": ["Jo", "Will"],
  },
  "status": "active",
  ...
}

Máy chủ trả về một mã trạng thái 200 OK cùng với bản trình bày đầy đủ của tài nguyên đã cập nhật. Do chỉ có trường title được đưa vào yêu cầu bản vá nên đó là giá trị duy nhất khác với trước đây.

Lưu ý: Nếu sử dụng tham số phản hồi một phần fields kết hợp với bản vá, bạn có thể tăng hiệu quả của các yêu cầu cập nhật hơn nữa. Yêu cầu bản vá chỉ làm giảm kích thước của yêu cầu. Phản hồi một phần sẽ làm giảm kích thước của phản hồi. Vì vậy, để giảm lượng dữ liệu được gửi theo cả hai hướng, hãy sử dụng yêu cầu bản vá có tham số fields.

Ngữ nghĩa của yêu cầu bản vá

Phần nội dung của yêu cầu bản vá chỉ bao gồm các trường tài nguyên bạn muốn sửa đổi. Khi chỉ định một trường, bạn phải bao gồm mọi đối tượng mẹ bao bọc, giống như đối tượng mẹ bao quanh được trả về bằng phản hồi một phần. Dữ liệu đã sửa đổi mà bạn gửi sẽ được hợp nhất vào dữ liệu cho đối tượng mẹ, nếu có.

Thêm: Để thêm một trường chưa tồn tại, hãy chỉ định trường mới và giá trị của trường đó.
Sửa đổi: Để thay đổi giá trị của một trường hiện có, hãy chỉ định trường đó rồi đặt thành giá trị mới.
Xoá: Để xoá một trường, hãy chỉ định trường đó rồi đặt thành null. Ví dụ: "comment": null. Bạn cũng có thể xoá toàn bộ đối tượng (nếu đối tượng đó có thể thay đổi) bằng cách đặt đối tượng đó thành null. Nếu bạn đang dùng Thư viện ứng dụng API Java, hãy dùng Data.NULL_STRING; để biết thông tin chi tiết, hãy xem phần JSON rỗng.

Lưu ý về mảng: Yêu cầu vá chứa mảng sẽ thay thế mảng hiện có bằng mảng bạn cung cấp. Bạn không thể sửa đổi, thêm hoặc xoá các mặt hàng trong một mảng theo từng phần.

Sử dụng bản vá trong chu trình đọc-sửa đổi-ghi

Bạn nên bắt đầu bằng cách truy xuất một phần câu trả lời có dữ liệu mà bạn muốn sửa đổi. Điều này đặc biệt quan trọng đối với các tài nguyên sử dụng ETag, vì bạn phải cung cấp giá trị ETag hiện tại trong tiêu đề HTTP If-Match để cập nhật thành công tài nguyên này. Sau khi nhận được dữ liệu, bạn có thể sửa đổi các giá trị bạn muốn thay đổi và gửi lại bản trình bày một phần đã sửa đổi bằng yêu cầu vá. Dưới đây là một ví dụ giả định tài nguyên minh hoạ sử dụng ETag:

GET https://www.googleapis.com/demo/v1/324?fields=etag,title,comment,characteristics
Authorization: Bearer your_auth_token

Đây là câu trả lời một phần:

200 OK

{
  "etag": "ETagString"
  "title": "New title"
  "comment": "First comment.",
  "characteristics": {
    "length": "short",
    "level": "5",
    "followers": ["Jo", "Will"],
  }
}

Yêu cầu bản vá sau đây dựa trên phản hồi đó. Như thể hiện dưới đây, mã này cũng sử dụng tham số fields để giới hạn dữ liệu trả về trong phản hồi của bản vá:

PATCH https://www.googleapis.com/demo/v1/324?fields=etag,title,comment,characteristics
Authorization: Bearer your_auth_token
Content-Type: application/json
If-Match: "ETagString"

{
  "etag": "ETagString"
  "title": "",                  /* Clear the value of the title by setting it to the empty string. */
  "comment": null,              /* Delete the comment by replacing its value with null. */
  "characteristics": {
    "length": "short",
    "level": "10",              /* Modify the level value. */
    "followers": ["Jo", "Liz"], /* Replace the followers array to delete Will and add Liz. */
    "accuracy": "high"          /* Add a new characteristic. */
  },
}

Máy chủ phản hồi bằng mã trạng thái HTTP 200 OK và đại diện một phần của tài nguyên đã cập nhật:

200 OK

{
  "etag": "newETagString"
  "title": "",                 /* Title is cleared; deleted comment field is missing. */
  "characteristics": {
    "length": "short",
    "level": "10",             /* Value is updated.*/
    "followers": ["Jo" "Liz"], /* New follower Liz is present; deleted Will is missing. */
    "accuracy": "high"         /* New characteristic is present. */
  }
}

Trực tiếp tạo yêu cầu bản vá

Đối với một số yêu cầu bản vá, bạn cần dựa trên dữ liệu mà bạn truy xuất trước đó. Ví dụ: nếu bạn muốn thêm một mặt hàng vào một mảng và không muốn mất bất kỳ phần tử mảng hiện có nào, trước tiên, bạn phải lấy dữ liệu hiện có. Tương tự, nếu một API sử dụng ETag, bạn cần gửi giá trị ETag trước đó cùng với yêu cầu của mình để cập nhật thành công tài nguyên.

Lưu ý: Bạn có thể sử dụng tiêu đề HTTP "If-Match: *" để buộc thực hiện một bản vá khi ETag đang sử dụng. Nếu làm như vậy, thì bạn không cần đọc trước khi ghi.

Tuy nhiên, đối với các trường hợp khác, bạn có thể trực tiếp tạo yêu cầu bản vá mà không cần truy xuất dữ liệu hiện có trước. Ví dụ: bạn có thể dễ dàng thiết lập yêu cầu bản vá cập nhật một trường thành một giá trị mới hoặc thêm một trường mới. Dưới đây là ví dụ:

PATCH https://www.googleapis.com/demo/v1/324?fields=comment,characteristics
Authorization: Bearer your_auth_token
Content-Type: application/json

{
  "comment": "A new comment",
  "characteristics": {
    "volume": "loud",
    "accuracy": null
  }
}

Với yêu cầu này, nếu trường nhận xét đã có một giá trị, giá trị mới sẽ ghi đè giá trị đó; nếu không, giá trị được đặt thành giá trị mới. Tương tự, nếu có một đặc điểm âm lượng, thì giá trị của đặc điểm đó sẽ bị ghi đè. Nếu không có, thì giá trị đó sẽ được tạo. Trường chính xác (nếu được đặt) sẽ bị xoá.

Xử lý phản hồi cho bản vá

Sau khi xử lý yêu cầu bản vá hợp lệ, API sẽ trả về mã phản hồi HTTP 200 OK cùng với thông tin đầy đủ về tài nguyên đã sửa đổi. Nếu API được sử dụng ETag, máy chủ sẽ cập nhật các giá trị ETag khi xử lý thành công yêu cầu bản vá, giống như với PUT.

Yêu cầu bản vá sẽ trả về toàn bộ bản trình bày tài nguyên, trừ phi bạn sử dụng tham số fields để giảm lượng dữ liệu trả về.

Nếu yêu cầu bản vá dẫn đến trạng thái tài nguyên mới không hợp lệ về cú pháp hoặc về mặt ngữ nghĩa, máy chủ sẽ trả về mã trạng thái HTTP 400 Bad Request hoặc 422 Unprocessable Entity và trạng thái tài nguyên vẫn không thay đổi. Ví dụ: nếu bạn cố gắng xoá giá trị cho một trường bắt buộc, máy chủ sẽ trả về lỗi.

Ký hiệu thay thế khi động từ PATCH HTTP không được hỗ trợ

Nếu tường lửa của bạn không cho phép các yêu cầu HTTP PATCH, thì hãy thực hiện yêu cầu HTTP POST và đặt tiêu đề ghi đè thành PATCH, như thể hiện dưới đây:

POST https://www.googleapis.com/...
X-HTTP-Method-Override: PATCH
...

Sự khác biệt giữa bản vá và bản cập nhật

Trong thực tế, khi gửi dữ liệu cho một yêu cầu cập nhật sử dụng động từ HTTP PUT, bạn chỉ cần gửi các trường bắt buộc hoặc không bắt buộc; nếu bạn gửi giá trị cho các trường do máy chủ đặt thì các trường đó sẽ bị bỏ qua. Mặc dù đây có vẻ giống như một cách khác để cập nhật một phần, nhưng phương pháp này có một số hạn chế. Với các bản cập nhật sử dụng động từ HTTP PUT, yêu cầu sẽ không thành công nếu bạn không cung cấp các tham số bắt buộc. Đồng thời, yêu cầu sẽ xoá dữ liệu đã đặt trước đó nếu bạn không cung cấp các tham số không bắt buộc.

Vì lý do này, việc sử dụng bản vá sẽ an toàn hơn nhiều. Bạn chỉ cung cấp dữ liệu cho những trường bạn muốn thay đổi; những trường bạn bỏ qua sẽ không bị xoá. Ngoại lệ duy nhất đối với quy tắc này là xảy ra với các phần tử hoặc mảng lặp lại: Nếu bạn bỏ qua tất cả các phần tử hoặc mảng lặp lại, các phần tử hoặc mảng đó vẫn sẽ giữ nguyên; nếu bạn cung cấp bất kỳ phần tử hoặc mảng nào trong số đó, thì toàn bộ tập hợp sẽ được thay thế bằng tập hợp mà bạn cung cấp.