چاپ زیبای JSON چیست؟
چاپ زیبای JSON، دادههای فشرده و سختخوان را به یک فرمت تورفته و چندخطی تبدیل میکند. در حالی که ماشینها بدون مشکل JSON تکخطی را پردازش میکنند، انسانها برای درک سریع دادههای پیچیده به ساختار بصری و تورفتگی منظم نیاز دارند.
After · json
Before · json
{
"user": "alice",
"role": "admin",
"permissions": [
"read",
"write"
],
"active": true,
"lastLogin": 1717200000
}{"user":"alice","role":"admin","permissions":["read","write"],"active":true,"lastLogin":1717200000}چرا JSON را زیبا چاپ کنیم؟
JSON خام دریافتی از APIها، پایگاههای داده و فایلهای لاگ اغلب برای صرفهجویی در پهنای باند فشرده میشود. چاپ زیبا ساختار قابلخواندن توسط انسان را بازمیگرداند — ساختاری که برای دیباگ، بررسی و درک دادهها به آن نیاز دارید.
🔍
دیباگ سریعتر
فیلدهای گمشده، مقادیر اشتباه و خطاهای ساختاری را در چند ثانیه شناسایی کنید، نه با تجزیه کاراکتر به کاراکتر یک دیوار متن.
👥
بررسی کد تمیزتر
بررسی تغییرات پیکربندی JSON در Pull Requestها با تورفتگی مناسب بسیار آسانتر است — بررسیکنندگان میتوانند روی آنچه تغییر کرده تمرکز کنند.
🔌
بررسی API
هنگام کاوش یک API جدید، پاسخهای زیباشده به شما امکان میدهند مدل داده و ساختار تودرتو را بدون نیاز به خواندن متن فشرده درک کنید.
📝
مستندسازی و اشتراکگذاری
JSON زیباشده آماده است تا در مستندات، ویکیها، تیکتها و Slack کپی شود، بدون اینکه کسی مجبور باشد آن را ذهناً تفسیر کند.
انتخاب تورفتگی
هر دو ۲ و ۴ فاصله گزینههای رایجی هستند. انتخاب درست معمولاً به راهنمای سبک تیم یا ترجیح شخصی بستگی دارد.
۲ فاصله
محبوبترین انتخاب در جوامع JavaScript و JSON. فایلها را فشرده نگه میدارد و در عین حال خوانا است. توسط npm، ESLint و اکثر راهنماهای سبک JS استفاده میشود.
۴ فاصله
رایج در پروژههای Python، Java و C#. فضای بصری بیشتری فراهم میکند و اغلب برای ساختارهای عمیقاً تودرتو ترجیح داده میشود.
موارد استفاده رایج
دیباگ پاسخهای API
یک پاسخ خام API را وارد کنید و فوراً ساختار کامل داده، آبجکتهای تودرتو و محتوای آرایهها را در قالبی خوانا مشاهده کنید.
خواندن فایلهای پیکربندی
پیکربندی ذخیرهشده در JSON فشرده پس از زیباسازی بهراحتی قابل خواندن و ویرایش است.
تحلیل لاگ
لاگهای ساختاریافته اغلب حاوی پیلودهای JSON هستند. زیباسازی ورودیهای لاگ جداگانه، تحلیل علت ریشه را بسیار سریعتر میکند.
مستندات توسعهدهنده
مثالهای JSON تورفته و واضح در مستندات API خود ارائه دهید تا توسعهدهندگان بلافاصله شکل درخواست و پاسخ را درک کنند.
کاوش داده
هنگام کار با یک مجموعه داده ناآشنا، زیباسازی اسکیمای کامل — فیلدها، انواع و ساختار تودرتو — را بدون نیاز به خواندن مستندات نمایان میکند.
آزمون و QA
مقایسه JSON مورد انتظار در برابر JSON واقعی در خرابیهای تست با تورفتگی یکسان و ساختار خط به خط بسیار آسانتر است.
چاپ زیبا در ترمینال
همیشه به ابزار مرورگر نیاز ندارید. این دستورات مستقیماً JSON را در ترمینال شما زیبا چاپ میکنند، بدون نیاز به نصب چیزی فراتر از ابزارهایی که احتمالاً قبلاً دارید.
Python
echo '{"a":1}' | python3 -m json.toolNode.js
node -e "console.log(JSON.stringify(JSON.parse(require('fs').readFileSync('/dev/stdin','utf8')),null,2))"CLI (jq)
cat data.json | jq .
curl + jq
curl -s https://api.example.com/data | jq .
سوالات متداول
چاپ زیبای JSON چیست؟
چاپ زیبای JSON (که فرمتبندی JSON یا زیباسازی JSON نیز نامیده میشود) JSON فشرده را به یک قالب خوانا با تورفتگی یکسان و شکست سطر تبدیل میکند. ساختارهای تودرتو، آرایهها و جفت کلید-مقدار را برای بررسی و دیباگ آسان میکند.
آیا چاپ زیبا دادهها را تغییر میدهد؟
خیر. فقط فضای خالی اضافه میشود — هیچ داده، کلید، مقدار یا ترتیبی تغییر نمیکند. یک فایل JSON زیباشده از نظر معنایی با نسخه اصلی یکسان است.
کدام بهتر است: ۲ فاصله یا ۴ فاصله؟
هیچکدام ذاتاً بهتر نیست. ۲ فاصله فشردهتر است و پیشفرض بسیاری از ابزارهای JavaScript است. ۴ فاصله جداسازی بصری بیشتری فراهم میکند. هر کدام را که راهنمای سبک تیمتان مشخص میکند استفاده کنید، یا اگر ترجیحی ندارید ۲ فاصله را انتخاب کنید.
آیا میتوانم JSON نامعتبر را زیبا چاپ کنم؟
خیر — ابتدا ورودی باید JSON معتبر باشد. اگر کاما انتهایی، تکنقلقولها یا کامنتها (JSONC/JSON5) دارید، قبل از زیباسازی آنها را به JSON استاندارد تبدیل کنید.
چطور JSON را در DevTools مرورگرم زیبا چاپ کنم؟
در Chrome/Firefox DevTools، دکمه {} را در پایین هر پانل پاسخ شبکه کلیک کنید تا بهصورت خودکار فرمتبندی شود. همچنین میتوانید JSON.stringify(obj, null, 2) را در کنسول اجرا کنید تا هر آبجکت JavaScript را بهصورت خوانا چاپ کنید.