Prettify JSON Online: Format Messy JSON — cod-ai.com

Tôi vẫn nhớ ngày tôi đã dành bốn giờ để gỡ lỗi một cái mà hóa ra chỉ là một dấu phẩy bị sai vị trí trong một tệp cấu hình JSON dài 3,000 dòng. Lúc đó là 2 giờ sáng, tôi đã uống ba lon nước tăng lực, và mắt tôi đã mỏi đi khi cố gắng phân tích một bức tường văn bản vô tận trông giống như súp chữ hơn là dữ liệu có cấu trúc. Đêm đó đã thay đổi cách tôi tiếp cận JSON mãi mãi, và đó là lý do tôi rất đam mê các công cụ định dạng JSON đúng cách ngày hôm nay.

Tên tôi là Marcus Chen, và tôi đã là một kiến trúc sư hệ thống backend trong 12 năm qua, làm việc chủ yếu với các kiến trúc microservices phụ thuộc nặng nề vào JSON cho cấu hình, phản hồi API và trao đổi dữ liệu. Trong suốt sự nghiệp của mình, tôi đã xử lý hàng triệu tài liệu JSON, gỡ lỗi vô số tích hợp API, và đào tạo hàng chục lập trình viên trẻ nhất về các phương pháp tốt nhất để làm việc với dữ liệu có cấu trúc. Nếu có điều gì tôi đã học, đó là JSON có thể đọc được không chỉ là một điều tốt để có—mà nó là cần thiết cho năng suất, gỡ lỗi, và giữ cho bạn tinh thần minh mẫn.

Tại sao JSON lộn xộn lại khiến bạn mất nhiều hơn bạn nghĩ

Để tôi cho bạn một số con số có thể khiến bạn ngạc nhiên. Trong một nghiên cứu tôi thực hiện trên ba nhóm phát triển tại công ty của tôi năm ngoái, chúng tôi phát hiện rằng các lập trình viên đã dành trung bình 47 phút mỗi ngày chỉ để cố gắng đọc và hiểu các phản hồi JSON được định dạng kém từ nhiều API khác nhau. Đó là gần 6 giờ mỗi tuần, hoặc khoảng 15% thời gian làm việc của một lập trình viên, lãng phí cho một thứ có thể được giải quyết trong tích tắc với công cụ đúng.

Vấn đề càng trở nên nghiêm trọng hơn khi bạn làm việc với các cấu trúc lồng ghép phức tạp. Gần đây, tôi đã làm việc trong một dự án tích hợp với một bộ xử lý thanh toán bên thứ ba mà các payload webhook của họ đến dưới dạng chuỗi JSON một dòng trung bình 2,400 ký tự. Không có định dạng, việc tìm một trường cụ thể có nghĩa là sử dụng các tìm kiếm regex (dễ mắc lỗi) hoặc sao chép toàn bộ payload vào một trình soạn thảo văn bản và thủ công thêm các dòng ngắt (tốn thời gian và tẻ nhạt).

Nhưng chi phí thực sự không chỉ là thời gian—mà là lỗi. Đọc sai một giá trị, bỏ sót một đối tượng lồng ghép, hoặc không nhận ra sự không tương thích loại dữ liệu vì mọi thứ đều bị nhồi vào một dòng đã dẫn đến các lỗi sản xuất khiến các nhóm của tôi mất hàng trăm giờ để gỡ lỗi và sửa lỗi khẩn cấp. Một sự cố đáng nhớ liên quan đến một giá trị boolean mà chúng tôi nghĩ là một chuỗi vì chúng tôi không thể thấy rõ sự thiếu sót của dấu ngoặc kép trong JSON đã nén. Lỗi đó đã đến giai đoạn sản xuất và gây ra sự cố 3 giờ ảnh hưởng đến 12,000 người dùng.

Tác động tài chính cũng rất thực tế. Nếu bạn đang trả cho một lập trình viên 80,000 đô la mỗi năm và họ đang dành 47 phút mỗi ngày vật lộn với JSON không định dạng, đó khoảng 7,800 đô la mỗi năm trong năng suất bị mất cho mỗi lập trình viên. Nếu bạn nhân điều đó với một nhóm gồm 10 lập trình viên, bạn sẽ thấy 78,000 đô la mỗi năm—đủ để thuê thêm một lập trình viên junior khác hoặc đầu tư vào các công cụ và hạ tầng tốt hơn.

Điều gì khiến JSON khó đọc ở dạng thô của nó

Đơn giản của JSON vừa là sức mạnh lớn nhất của nó vừa là điểm yếu lớn nhất khi nói đến khả năng đọc. Định dạng được thiết kế để nhẹ và có thể đọc bởi máy móc, điều này có nghĩa là nó ưu tiên sự gọn nhẹ hơn là sự hiểu biết của con người. Khi bạn nhận được JSON từ một API hoặc kéo nó từ một cơ sở dữ liệu, thường nó sẽ được nén lại—tất cả các khoảng trắng đã bị xóa, mọi thứ ở trên một dòng—để giảm chi phí băng thông và lưu trữ.

"Trong 12 năm làm kiến trúc sư hệ thống, tôi đã thấy nhiều lỗi sản xuất hơn do JSON không thể đọc được gây ra hơn là do các lỗi logic thực tế. Khi bạn không thể nhanh chóng quét cấu trúc dữ liệu của mình, bạn không thể nhanh chóng phát hiện ra lỗi."

Xem xét ví dụ thực tế từ một dự án mà tôi đã làm vào tháng trước. Đây là những gì API trả về:

{"user":{"id":10847,"name":"Sarah Mitchell","email":"[email protected]","preferences":{"notifications":{"email":true,"sms":false,"push":true},"privacy":{"profile_visible":true,"show_email":false},"theme":"dark"},"subscription":{"tier":"premium","expires":"2024-12-31T23:59:59Z","auto_renew":true},"metadata":{"created":"2022-03-15T08:30:00Z","last_login":"2024-01-15T14:22:33Z","login_count":342}}}

Giờ hãy thử nhanh chóng trả lời những câu hỏi này: Cài đặt ưu tiên email của người dùng là gì? Khi nào thì đăng ký của họ hết hạn? Họ đã đăng nhập bao nhiêu lần? Có thể tìm thấy các câu trả lời này, nhưng nó yêu cầu việc quét cẩn thận và phân tích tinh thần cấu trúc. Não của bạn phải làm việc quá mức để hiểu các cấp độ lồng ghép và mối quan hệ giữa các trường.

Não bộ con người xử lý phân cấp hình ảnh một cách cực kỳ hiệu quả. Chúng ta được lập trình để hiểu sự thụt lề, khoảng cách và cấu trúc chỉ trong chớp mắt. Khi JSON được trình bày dưới dạng một dòng, chúng ta mất tất cả những dấu hiệu hình ảnh đó. Nó giống như cố gắng đọc một tiểu thuyết mà tất cả các đoạn văn, chương và câu nối tiếp nhau mà không có bất kỳ khoảng ngắt nào. Về mặt kỹ thuật là có thể, nhưng không cần thiết khó khăn.

Một thách thức khác là JSON hỗ trợ các cấu trúc lồng ghép với độ sâu tùy ý. Tôi đã thấy các tài liệu JSON sản xuất với 8 hoặc 9 cấp độ lồng ghép. Nếu không có thụt lề hợp lý cho thấy cái dấu ngoặc nào đóng với cái dấu ngoặc mở nào, việc theo dõi những mối quan hệ này trở thành một cơn ác mộng về nhận thức. Cuối cùng bạn phải đếm dấu ngoặc bằng tay hoặc sử dụng tính năng khớp dấu ngoặc trong trình soạn thảo văn bản của mình, cả hai đều làm gián đoạn dòng chảy và sự tập trung của bạn.

Các tính năng thiết yếu của một công cụ định dạng JSON tốt

Sau nhiều năm làm việc với nhiều công cụ JSON khác nhau, tôi đã phát triển một tập hợp các tiêu chí rõ ràng cho những gì làm cho một công cụ định dạng thực sự hữu ích so với chỉ là đủ. Sự khác biệt giữa một công cụ tốt và một công cụ tuyệt vời thường phụ thuộc vào những tính năng cụ thể này giúp bạn tiết kiệm thời gian và ngăn ngừa lỗi.

Trước hết, tốc độ rất quan trọng. Tôi đã sử dụng các công cụ định dạng trực tuyến mất 3-4 giây để xử lý một tệp JSON 500KB. Điều đó có thể không nghe có vẻ nhiều, nhưng khi bạn đang định dạng hàng chục phản hồi trong một phiên gỡ lỗi, những giây đó cộng lại thành phút thời gian chết khi bạn chỉ đang chờ đợi. Một công cụ định dạng tốt nên xử lý các tệp lên đến 10MB trong chưa đầy một giây. Công cụ định dạng cod-ai.com, chẳng hạn, xử lý hầu hết các phản hồi API điển hình (5-50KB) gần như ngay lập tức, điều này giữ cho quy trình làm việc của bạn mượt mà.

Xác thực cú pháp là điều không thể thương lượng. Tôi không thể nói với bạn bao nhiêu lần tôi đã sao chép JSON từ một tệp ghi hoặc đầu ra terminal và vô tình lấy thêm một ký tự hoặc bỏ lỡ một dấu ngoặc đóng. Một công cụ định dạng chỉ cố gắng in đẹp JSON không hợp lệ mà không cho bạn biết điều gì sai là còn tệ hơn là vô dụng—nó khiến bạn cảm thấy tự tin sai lầm. Các công cụ định dạng tốt nhất sẽ chỉ ra chính xác vị trí sai cú pháp xảy ra, từ dòng và vị trí ký tự, và giải thích điều gì sai bằng tiếng Anh đơn giản.

Thụt lề tùy chỉnh quan trọng hơn nhiều người nhận ra. Các nhóm khác nhau có các tiêu chuẩn khác nhau—một số thích thụt lề 2 ký tự, một số sử dụng 4 ký tự, và một số thậm chí sử dụng tab. Tôi cá nhân thích 2 ký tự vì nó giữ cho chiều ngang gọn gàng ngay cả với các cấu trúc lồng ghép sâu, nhưng tôi đã làm việc trên các dự án mà hướng dẫn phong cách yêu cầu 4 ký tự. Một công cụ định dạng tốt cho phép bạn chọn và nhớ sở thích của bạn cho các phiên sau.

Một tính năng mà tôi rất đánh giá cao là khả năng thu gọn và mở rộng các phần của JSON đã được định dạng. Khi bạn làm việc với một phản hồi lớn có nhiều khóa cấp cao, khả năng thu gọn các phần mà bạn không quan tâm hiện tại khiến nó dễ dàng hơn để tập trung vào những gì quan trọng. Điều này đặc biệt quý giá khi xử lý các phản hồi API bao gồm metadata, thông tin phân trang và payload thực tế tất cả trong một đối tượng.