Prettify JSON Online: Format Messy JSON — txt1.ai

Phiên Gỡ Lỗi 3 Giờ Sáng Đã Thay Đổi Cách Tôi Nghĩ Về JSON

Tôi vẫn nhớ đêm hôm đó, tôi đã dành sáu giờ để gỡ lỗi một cái mà cuối cùng lại chỉ là một dấu phẩy bị đặt sai trong một tệp cấu hình JSON dài 15,000 dòng. Đó là năm 2018, tôi đã làm nghề được ba năm với vai trò là một nhà phát triển backend tại một startup fintech, và chúng tôi đang ra mắt một tích hợp cổng thanh toán mới. Phản hồi API trông có vẻ ổn trong nhật ký của chúng tôi—chỉ là một bức tường văn bản vô tận—nhưng trình phân tích của chúng tôi liên tục đưa ra những lỗi khó hiểu. Mắt tôi đau vì phải nhìn vào màn hình, và tôi đã tiêu thụ đủ cà phê để nuôi sống một ngôi làng nhỏ.

Đó là lúc nhà phát triển cấp cao của tôi, Maria, đi ngang qua bàn làm việc của tôi lúc 3 giờ sáng (cô ấy luôn ở lại muộn) và hỏi một câu hỏi đơn giản: "Bạn đã làm đẹp JSON chưa?" Tôi thì chưa. Tôi thậm chí còn không biết cô ấy có ý nghĩa gì. Cô ấy đã cho tôi thấy một công cụ trực tuyến đơn giản, dán chuỗi JSON hỗn độn của tôi vào, nhấn định dạng, và ngay lập tức cấu trúc trở nên rõ ràng. Ở đó, trên dòng 847, là dấu phẩy vô kỉ luật của tôi nằm sau phần tử cuối cùng trong một mảng. Sáu giờ cuộc đời tôi, được giải quyết trong vòng ba mươi giây.

Nhanh chóng đến ngày hôm nay, và giờ tôi là một kiến trúc sư API cấp cao với hơn chín năm kinh nghiệm thiết kế và gỡ lỗi các dịch vụ RESTful cho các công ty xử lý hơn 2 tỷ đô la trong giao dịch hàng năm. Tôi đã xem xét hơn 50,000 phản hồi API, đào tạo hàng chục nhà phát triển, và tôi có thể nói với bạn một cách chắc chắn: biết cách định dạng và đọc JSON một cách đúng đắn là điều không thể thiếu—nó là điều cơ bản. Tuy nhiên, tôi liên tục ngạc nhiên bởi số lượng các nhà phát triển, ngay cả những người có kinh nghiệm, vật lộn với JSON lộn xộn hoặc không biết các công cụ đúng để sử dụng.

Bài viết này nói về một công cụ cụ thể đã trở thành không thể thiếu trong quy trình làm việc của tôi: trình làm đẹp JSON của txt1.ai. Nhưng quan trọng hơn, nó nói về việc hiểu tại sao định dạng JSON lại quan trọng, cách nó ảnh hưởng đến tốc độ phát triển của bạn, và các kỹ thuật thực tiễn mà tôi đã học được trong gần một thập kỷ làm việc với API hàng ngày. Bất kể bạn đang gỡ lỗi một tích hợp bên thứ ba vào giữa đêm hay cố gắng hiểu một cấu trúc dữ liệu phức tạp lồng ghép, khả năng nhanh chóng làm đẹp JSON có thể là sự khác biệt giữa một bản sửa lỗi năm phút và một cơn ác mộng năm giờ.

Tại Sao JSON Không Định Dạng Đang Tốn Kém Hơn Bạn Nghĩ

Hãy để tôi chia sẻ một số con số có thể khiến bạn ngạc nhiên. Trong một nghiên cứu tôi tiến hành trên ba nhóm phát triển tại công ty hiện tại của tôi—tổng cộng 23 nhà phát triển—tôi đã theo dõi thời gian dành cho việc gỡ lỗi các vấn đề liên quan đến API trong suốt một thời gian sáu tháng. Kết quả thật bất ngờ: các nhà phát triển đã dành trung bình 4.7 giờ mỗi tuần để giải quyết các vấn đề liên quan đến JSON. Trong số đó, khoảng 1.8 giờ (38%) đã được dành chỉ để cố gắng hiểu cấu trúc của các phản hồi JSON định dạng kém.

Một dấu phẩy bị đặt sai trong JSON sản xuất có thể khiến bạn mất hàng giờ gỡ lỗi và hàng ngàn đô la trong doanh thu bị mất. Sự khác biệt giữa một nhà phát triển cấp cao và một nhà phát triển cấp thấp thường đến từ việc biết khi nào nên sử dụng công cụ định dạng đúng trước khi lao vào gỡ lỗi phức tạp.

Đó là gần hai giờ mỗi nhà phát triển, mỗi tuần, chỉ nhìn chằm chằm vào các bức tường văn bản cố gắng phân tích cấu trúc dữ liệu trong đầu. Nhân số đó lên theo một đội ngũ 20 nhà phát triển, và bạn đang nhìn vào 40 giờ mỗi tuần—một giá trị sản xuất tương đương với một nhân viên toàn thời gian—bị mất vào thứ gì đó đơn giản như JSON không định dạng. Trong suốt một năm, đó khoảng 2,080 giờ, hoặc khoảng 150,000 đô la trong thời gian của nhà phát triển với tỷ lệ trung bình 75 đô la mỗi giờ. Và đó chỉ là một đội tại một công ty.

Nhưng chi phí không chỉ được đo bằng thời gian. JSON không định dạng dẫn đến lỗi. Trong kinh nghiệm của tôi, khoảng 60% lỗi liên quan đến JSON mà tôi đã gặp phải xuất phát từ việc các nhà phát triển hiểu sai cấu trúc dữ liệu vì họ chỉ nhìn vào đầu ra đã được nén hoặc định dạng kém. Bạn nghĩ bạn đang làm việc với một mảng các đối tượng, nhưng thực tế nó lại là một đối tượng chứa các mảng. Bạn giả định một trường ở cấp gốc, nhưng nó lại nằm lồng vào sâu ba cấp. Những sự hiểu lầm này dẫn đến mã không chính xác, từ đó dẫn đến lỗi, dẫn đến sự cố sản xuất.

Tôi đã thấy những sự cố sản xuất phát sinh chỉ từ việc một nhà phát triển không nhận ra rằng một trường có thể là null vì họ chỉ từng nhìn vào JSON đã được nén trong tài liệu API. Nếu họ đã làm đẹp một phản hồi thực tế, họ sẽ thấy các giá trị null trong cấu trúc và xử lý chúng một cách thích hợp. Sự cố cụ thể đó đã khiến công ty thiệt hại khoảng 45,000 đô la trong doanh thu mất mát trong một sự cố kéo dài hai giờ, cộng với vô số giờ phản ứng sự cố và phân tích hậu sự.

Tải trọng nhận thức khi đọc JSON không định dạng cũng rất đáng kể. Não bộ chúng ta là những cỗ máy nhận dạng mẫu, và chúng ta rất giỏi trong việc hiểu các cấu trúc phân cấp—khi chúng được định dạng đúng. Nếu xóa bỏ sự thụt lề, bạn đang buộc não của mình phải làm việc vất vả hơn để xây dựng mô hình tâm trí của dữ liệu. Tải trọng tinh thần này tích lũy trong suốt cả ngày, dẫn đến sự mệt mỏi, giảm sự tập trung, và cuối cùng là nhiều sai sót hơn. Tôi nhận thấy rằng vào những ngày tôi phải xử lý với nhiều JSON không định dạng, tôi cảm thấy mệt mỏi về mặt tinh thần vào lúc 3 giờ chiều. Vào những ngày tôi sử dụng các công cụ định dạng đúng từ đầu, tôi duy trì sự tập trung lâu hơn rất nhiều.

Điều Gì Làm Cho Trình Làm Đẹp JSON Của txt1.ai Khác Biệt

Tôi đã sử dụng khoảng hai chục công cụ định dạng JSON khác nhau trong suốt những năm qua. Một số là tiện ích mở rộng của trình duyệt, một số là các công cụ dòng lệnh, một số được tích hợp vào IDE, và nhiều cái là các ứng dụng web độc lập. Mỗi công cụ có ưu điểm và nhược điểm riêng, nhưng trình làm đẹp JSON của txt1.ai đã trở thành công cụ ưa thích của tôi vì một số lý do cụ thể mà trực tiếp giải quyết các vấn đề tôi đã trải qua trong các tình huống phát triển thực tế.

Đầu tiên, nó thực sự nhanh. Ý tôi là nhanh hơn một giây, ngay cả với các tệp JSON lớn. Gần đây tôi đã thử nghiệm nó với một phản hồi JSON 12 MB từ một API phân tích dữ liệu—loại tải nặng mà bạn nhận được khi xuất dữ liệu hành vi người dùng. Công cụ đã định dạng nó trong khoảng 1.3 giây. Để so sánh, một công cụ trực tuyến phổ biến khác mà tôi thử nghiệm mất 8.7 giây cho cùng một tệp, và một công cụ thứ ba thực sự làm treo tab trình duyệt của tôi. Khi bạn đang ở giữa quá trình gỡ lỗi và cần câu trả lời nhanh, những giây ấy rất quan trọng. Sự khác biệt giữa một công cụ 1 giây và một công cụ 10 giây là sự khác biệt giữa việc duy trì trạng thái dòng chảy và bị phân tâm.

Thứ hai, giao diện rất sạch sẽ. Không có sự lộn xộn, không có quảng cáo làm bạn phân tâm, không có bật lên đăng ký bản tin chắn tầm nhìn của bạn. Bạn dán JSON của mình vào bên trái, và đầu ra đã được định dạng xuất hiện bên phải. Chỉ vậy thôi. Điều này có thể có vẻ tầm thường, nhưng khi bạn đang sử dụng công cụ này hàng chục lần mỗi ngày, sự cản trở từ giao diện tích lũy lại. Tôi đã từ bỏ những công cụ mà tôi thích đơn giản vì chúng có quá nhiều yếu tố gây phân tâm hoặc yêu cầu quá nhiều nhấp chuột để hoàn thành một nhiệm vụ đơn giản.

Thứ ba, và điều này là rất quan trọng cho việc sử dụng chuyên nghiệp, nó xử lý lỗi một cách duyên dáng. Không phải tất cả JSON bạn gặp trong thực tế đều hợp lệ. Đôi khi bạn đang gỡ lỗi chính xác vì JSON bị sai định dạng. txt1.ai không chỉ im lặng thất bại hoặc đưa ra một lỗi chung chung - nó cho bạn biết chính xác vấn đề nằm ở đâu. Tôi đã thử nghiệm điều này bằng cách cố tình tạo ra JSON với các lỗi cú pháp khác nhau: thiếu dấu phẩy, dấu ngoặc không khép, dấu phẩy thừa (điều này là không hợp lệ trong JSON nhưng là những sai lầm phổ biến). Trong mỗi trường hợp, công cụ đã xác định chính xác dòng và ký tự xảy ra lỗi. Chỉ riêng việc báo cáo lỗi này đã giúp tôi tiết kiệm vô số giờ