Kiểm tra JSON

JSON thực sự cấm những gì

Ngữ pháp JSON được thiết kế cố ý rất nhỏ gọn, và gần như mọi lỗi kiểm tra đều thuộc số ít những thứ người ta mượn từ JavaScript mà JSON không bao giờ chấp nhận. Dấu phẩy thừa sau phần tử cuối cùng. Dấu nháy đơn thay vì nháy kép. Key không có dấu ngoặc kép. Comment — JSON không có, và chưa bao giờ có. NaN và Infinity, là số hợp lệ trong JavaScript nhưng không hợp lệ trong JSON. Và ký tự byte order mark ở đầu file, vô hình trong mọi trình soạn thảo, mà một số công cụ Windows thêm vào khi lưu dạng UTF-8, khiến một tài liệu hoàn toàn đúng bị lỗi ngay ở ký tự đầu tiên.

Có hai thứ hợp lệ nhưng vẫn gây rắc rối cho bạn, và đó là lý do “hợp lệ” không đồng nghĩa với “đúng”. Key trùng lặp không bị cấm trong đặc tả — và mỗi trình phân tích xử lý chúng một kiểu, phần lớn lấy key cuối cùng, nên một tài liệu có key lặp lại vẫn hợp lệ ở đây nhưng mang nghĩa khác nhau trong các ngôn ngữ khác nhau. Và số không có giới hạn độ chính xác xác định trong JSON, trong khi hầu hết trình phân tích đọc chúng dưới dạng số thực dấu phẩy động: một số nguyên vượt quá khoảng chín triệu tỷ sẽ bị làm tròn âm thầm, và đó là lý do các ID lớn thường được lưu dưới dạng chuỗi.

Thứ bạn nhận lại là chính xác dòng, cột và ký tự nơi việc phân tích dừng lại, thường hữu ích hơn bản thân thông báo lỗi. Trình phân tích báo điểm mà tài liệu không còn hợp lý nữa, không phải nơi lỗi được tạo ra — thiếu dấu đóng ngoặc nhọn sẽ được báo ở cuối file, và thiếu dấu phẩy được báo ở token ngay sau nó. Thói quen nhìn ngay trước vị trí được báo là thứ tiết kiệm thời gian nhất.

Đúng cú pháp không đồng nghĩa với đúng nội dung, và sự khác biệt này quan trọng. Công cụ này xác nhận cú pháp phân tích được. Tài liệu có chứa các trường API của bạn yêu cầu không, một giá trị có nằm trong phạm vi không, một ngày có thực sự là ngày không — không điều nào trong số đó là câu hỏi về JSON. Đó là kiểm tra theo schema, cần có schema, và một tài liệu có thể hoàn hảo ở đây nhưng bị từ chối ngay lập tức bởi dịch vụ bạn gửi đến.

Khi bạn cần công cụ khác

Để kiểm tra tài liệu theo schema thay vì theo ngữ pháp, JSON Schema là tiêu chuẩn và ajv là bản triển khai nhanh nhất — nó sẽ cho bạn biết một trường bắt buộc bị thiếu hay một giá trị nằm ngoài phạm vi, vốn thường là câu hỏi bạn thực sự có. check-jsonschema chạy các kiểm tra tương tự từ dòng lệnh và trong CI.

Với mọi việc trên dòng lệnh, jq là công cụ nên có: jq empty file.json kiểm tra và không in ra gì khi thành công, đúng như một script cần, còn jq . thì định dạng. Với file quá lớn để giữ trong bộ nhớ, jq --stream và ijson của Python phân tích từng phần, điều mà không trang nào tải toàn bộ tài liệu làm được.