Hướng Dẫn Truy Vấn JSONPath: Cách Tìm Kiếm Dữ Liệu JSON

JSON đã trở thành ngôn ngữ chung của web. API trả về JSON, file cấu hình sử dụng JSON, cơ sở dữ liệu lưu trữ tài liệu JSON. Nhưng khi cấu trúc JSON trở nên lớn hơn và lồng sâu hơn, việc tìm giá trị cụ thể ngày càng khó khăn. Đây là lúc JSONPath xuất hiện. JSONPath là ngôn ngữ truy vấn cho phép bạn sử dụng biểu thức đường dẫn ngắn gọn để điều hướng và trích xuất dữ liệu từ tài liệu JSON, giống như XPath làm với XML. Hướng dẫn này bao gồm mọi thứ từ cú pháp cơ bản đến lọc nâng cao với các ví dụ thực tế bạn có thể áp dụng ngay.

JSONPath Là Gì?

JSONPath là ngôn ngữ truy vấn JSON, ban đầu được Stefan Goessner đề xuất năm 2007. Nó cung cấp cú pháp gọn để chọn nút từ tài liệu JSON, tương tự như CSS selector định vị phần tử HTML hoặc biểu thức XPath định vị nút XML. Thay vì viết vòng lặp và logic điều kiện để duyệt cấu trúc JSON, bạn chỉ cần viết một biểu thức mô tả đường dẫn đến dữ liệu mong muốn.

Biểu thức JSONPath bắt đầu từ nút gốc của tài liệu JSON và điều hướng qua các đối tượng và mảng đến giá trị mong muốn. Ngôn ngữ này hỗ trợ wildcard, recursive descent, array slicing và biểu thức lọc, đủ mạnh cho hầu hết nhu cầu trích xuất dữ liệu.

Tài Liệu JSON Mẫu

Trong hướng dẫn này, chúng tôi sẽ sử dụng tài liệu JSON sau làm ví dụ làm việc. Đây là ví dụ kinh điển từ đề xuất JSONPath gốc với dữ liệu bổ sung:

{
  "store": {
    "book": [
      {
        "category": "reference",
        "author": "Nigel Rees",
        "title": "Sayings of the Century",
        "price": 8.95
      },
      {
        "category": "fiction",
        "author": "Evelyn Waugh",
        "title": "Sword of Honour",
        "price": 12.99
      },
      {
        "category": "fiction",
        "author": "Herman Melville",
        "title": "Moby Dick",
        "isbn": "0-553-21311-3",
        "price": 8.99
      },
      {
        "category": "fiction",
        "author": "J.R.R. Tolkien",
        "title": "The Lord of the Rings",
        "isbn": "0-395-19395-8",
        "price": 22.99
      }
    ],
    "bicycle": {
      "color": "red",
      "price": 19.95
    }
  }
}

Tham Khảo Cú Pháp JSONPath

JSONPath sử dụng một bộ toán tử nhỏ kết hợp để tạo thành truy vấn mạnh mẽ. Đây là tham khảo cú pháp đầy đủ:

Biểu Thức JSONPath Cơ Bản

Truy Cập Nút Gốc và Con Trực Tiếp

Ký hiệu đô la $ đại diện cho nút gốc của tài liệu JSON. Từ đó, bạn sử dụng ký hiệu dấu chấm để truy cập thuộc tính đối tượng và ký hiệu dấu ngoặc để truy cập chỉ mục mảng.

Ký Hiệu Dấu Ngoặc

Ký hiệu dấu ngoặc là thay thế cho ký hiệu dấu chấm khi tên thuộc tính chứa ký tự đặc biệt, khoảng trắng hoặc bắt đầu bằng số:

$.store['book'][0]['title']
$['store']['bicycle']['color']

Ký hiệu dấu ngoặc và ký hiệu dấu chấm có thể hoán đổi cho thuộc tính đối tượng. Tuy nhiên, khi tên thuộc tính là động hoặc chứa ký tự không hợp lệ trong ký hiệu dấu chấm, phải sử dụng ký hiệu dấu ngoặc.

Toán Tử Wildcard

Toán tử wildcard * khớp với tất cả phần tử trong mảng hoặc tất cả thuộc tính trong đối tượng. Nó cực kỳ hữu ích để trích xuất tất cả giá trị ở một cấp mà không cần biết khóa hoặc chỉ mục cụ thể.

Recursive Descent: Toán Tử Dấu Chấm Đôi

Toán tử dấu chấm đôi .. là một trong những tính năng mạnh nhất của JSONPath. Nó tìm kiếm khóa được chỉ định ở mọi cấp của cây JSON, không chỉ con trực tiếp. Hãy nghĩ về nó như tìm kiếm sâu trên toàn bộ tài liệu.

Toán tử recursive descent đặc biệt hữu ích khi bạn không biết đường dẫn chính xác đến dữ liệu mong muốn, hoặc khi cùng một khóa xuất hiện ở nhiều cấp lồng nhau. Ví dụ, nếu phản hồi API chứa trường id ở nhiều cấp lồng khác nhau, $..id sẽ thu thập tất cả id.

Array Slicing

Array slicing cho phép bạn chọn một phạm vi phần tử từ mảng. Cú pháp [start:end] chọn phần tử từ chỉ mục bắt đầu đến (nhưng không bao gồm) chỉ mục kết thúc. Hỗ trợ cả chỉ mục dương và âm.

Lưu ý rằng hành vi slicing có thể khác biệt nhẹ giữa các triển khai JSONPath. Cú pháp trên tuân theo quy ước được sử dụng bởi hầu hết thư viện phổ biến và tiêu chuẩn IETF RFC 9535.

Biểu Thức Lọc

Biểu thức lọc là nơi JSONPath thực sự trở nên mạnh mẽ. Chúng cho phép bạn chọn phần tử dựa trên điều kiện thay vì vị trí. Cú pháp lọc sử dụng [?(condition)], trong đó condition được đánh giá cho từng phần tử.

Toán Tử So Sánh

JSONPath hỗ trợ các toán tử so sánh sau trong biểu thức lọc:

Ví Dụ Lọc Thực Tế

Sử dụng tài liệu mẫu của chúng tôi, đây là các biểu thức lọc thực tế và kết quả của chúng:

Find all books cheaper than $10:

< 10)]

Trả về sách "Sayings of the Century" ($8.95) và "Moby Dick" ($8.99).

Find all fiction books:

$.store.book[?(@.category == "fiction")]

Trả về ba cuốn sách: "Sword of Honour", "Moby Dick" và "The Lord of the Rings".

Find books with an ISBN:

$.store.book[?(@.isbn)]

Trả về sách có thuộc tính isbn: "Moby Dick" và "The Lord of the Rings". Điều này là do bộ lọc kiểm tra sự tồn tại của thuộc tính.

Find the most expensive book:

$.store.book[?(@.price > 20)]

Trả về "The Lord of the Rings" ($22.99).

Toán Tử Logic Trong Bộ Lọc

Bạn có thể kết hợp điều kiện bằng toán tử logic:

< 10 && @.category == "fiction")]
$.store.book[?(@.price > 15 || @.category == "reference")]

Biểu thức đầu tiên tìm sách tiểu thuyết dưới $10 (chỉ "Moby Dick"). Biểu thức thứ hai tìm sách trên $15 hoặc thuộc danh mục tham khảo (trả về "Sayings of the Century" và "The Lord of the Rings").

JSONPath và XPath

JSONPath được mô hình hóa rõ ràng theo XPath, và hai ngôn ngữ chia sẻ nhiều điểm tương đồng về khái niệm. Nếu bạn quen với xử lý XML, hiểu mối quan hệ này sẽ hữu ích.

Sự khác biệt chính là XPath hoạt động trên mô hình cây phong phú với phần tử, thuộc tính, nút văn bản, không gian tên và chỉ thị xử lý. JSONPath hoạt động trên mô hình đơn giản hơn với đối tượng (ánh xạ khóa-giá trị) và mảng (danh sách có thứ tự). Sự đơn giản này làm cho JSONPath dễ học hơn nhưng kém biểu cảm hơn XPath cho các truy vấn phức tạp.

JSONPath Trong Thực Tế

Kiểm Thử API

JSONPath không thể thiếu cho kiểm thử API. Khi bạn gửi yêu cầu đến API và nhận phản hồi JSON lớn, JSONPath cho phép bạn xác nhận giá trị cụ thể mà không cần điều hướng thủ công toàn bộ cấu trúc. Hầu hết công cụ kiểm thử API hỗ trợ JSONPath nguyên bản.

Ví dụ, trong kiểm thử bạn có thể xác minh giá của cuốn sách đầu tiên dưới $10:

// Using a JSONPath assertion in testing
response.jsonPath().get("store.book[0].price").should(equals(8.95));

// Find all books by a specific author
response.jsonPath().get("store.book[?(@.author == 'Herman Melville')].title");
// Returns: ["Moby Dick"]

Chuyển Đổi Dữ Liệu

Khi tích hợp hệ thống sử dụng định dạng dữ liệu khác nhau, JSONPath giúp trích xuất và chuyển đổi trường cụ thể. Bạn có thể trích xuất giá trị từ một cấu trúc JSON và ánh xạ sang cấu trúc khác mà không cần viết code duyệt phức tạp.

Quản Lý Cấu Hình

File cấu hình phức tạp thường chứa JSON lồng sâu. JSONPath cho phép bạn truy vấn giá trị cấu hình cụ thể mà không cần tải và phân tích toàn bộ cấu trúc. Các công cụ như jq sử dụng cú pháp giống JSONPath để xử lý JSON trong pipeline dòng lệnh.

Giám Sát và Cảnh Báo

Trong hệ thống quan sát, truy vấn JSONPath có thể trích xuất metric từ log định dạng JSON và phản hồi API. Bạn có thể thiết lập cảnh báo kích hoạt khi truy vấn JSONPath trả về giá trị vượt ngưỡng.

Triển Khai JSONPath

JSONPath có sẵn trong hầu hết mọi ngôn ngữ lập trình. Đây là các thư viện phổ biến nhất:

Ví Dụ JavaScript

< 10)]',
  json: data
});
// Returns books with price < 10

Python Example

from jsonpath_ng import parse

data = { /* our sample JSON */ }

# Find all authors
author_expr = parse('$..author')
authors = [match.value for match in author_expr.find(data)]
# ["Nigel Rees", "Evelyn Waugh", "Herman Melville", "J.R.R. Tolkien"]

# Find cheap books
cheap_expr = parse('$.store.book[?(@.price < 10)]')
cheap_books = [match.value for match in cheap_expr.find(data)]

Common Pitfalls and Tips

• Zero-based vs one-based indexing: JSONPath uses zero-based indexing (the first element is [0]), while XPath uses one-based indexing (the first element is [1]). This is a common source of off-by-one errors.
• Implementation differences: Before the IETF standard (RFC 9535), JSONPath implementations varied in their handling of edge cases like empty results, null values, and filter syntax. Always test your expressions with the specific library you are using.
• Filter performance: Recursive descent with filters ($..book[?(@.price < 10)]) can be slow on large documents because it must traverse the entire tree. For performance-critical applications, use more specific paths when possible.
• Case sensitivity: JSONPath is case-sensitive. $.Store will not match $.store. This is consistent with JSON's case-sensitive nature.
• Chỉ mục zero-based và one-based: JSONPath sử dụng chỉ mục zero-based (phần tử đầu tiên là [0]), trong khi XPath sử dụng chỉ mục one-based (phần tử đầu tiên là [1]). Đây là nguồn lỗi off-by-one phổ biến.
• Khác biệt triển khai: Trước tiêu chuẩn IETF (RFC 9535), các triển khai JSONPath khác nhau trong việc xử lý các trường hợp biên như kết quả rỗng, giá trị null và cú pháp lọc. Luôn kiểm tra biểu thức với thư viện cụ thể của bạn.

Cạm Bẫy và Mẹo Phổ Biến

Năm 2024, IETF đã công bố RFC 9535, chính thức chuẩn hóa JSONPath. Đặc tả này giải quyết nhiều điểm không rõ ràng và không nhất quán tồn tại giữa các triển khai. Các khía cạnh chính của tiêu chuẩn bao gồm:

• < 10)]) có thể chậm trên tài liệu lớn vì nó phải duyệt toàn bộ cây. Đối với ứng dụng quan trọng về hiệu suất, sử dụng đường dẫn cụ thể hơn khi có thể.
• Phân biệt chữ hoa chữ thường: JSONPath phân biệt chữ hoa chữ thường. $.Store sẽ không khớp với $.store. Điều này nhất quán với bản chất phân biệt chữ hoa chữ thường của JSON.
• Thoát ký tự đặc biệt: Nếu tên khóa chứa dấu chấm hoặc dấu ngoặc, phải sử dụng ký hiệu dấu ngoặc có trích dẫn: $['key.with.dots'] thay vì $.key.with.dots.
• Không có duyệt ngược lên cha: Không giống XPath, JSONPath không thể điều hướng đến nút cha. Không có tương đương với .. (trục cha) của XPath. Dấu .. trong JSONPath có nghĩa là recursive descent, không phải cha.

Nếu bạn đang bắt đầu dự án mới, ưu tiên thư viện triển khai RFC 9535 để có khả năng tương thích tối đa và hành vi có thể dự đoán.