پرش به محتوای اصلی

راهنمای قالب‌بندی و اعتبارسنجی JSON

زمان مطالعه: ۳ دقیقه

این ابزار چیست؟

پاسخ بیشتر سرویس‌های وب به‌صورت JSON می‌رسد و معمولاً در یک خط فشرده است؛ خواندن آن برای آدم دشوار است و یک کامای جاافتاده یا اضافه کل داده را از کار می‌اندازد. این ابزار متن JSON را مرتب می‌کند، فشرده می‌کند، کلیدهایش را الفبایی می‌چیند و اگر خطایی باشد، سطر و ستون دقیق و توضیح فارسی آن را نشان می‌دهد.

برنامه‌نویس‌ها، تحلیل‌گر داده‌ها و هر کسی که فایل پیکربندی یا پاسخ API را بازبینی می‌کند از آن سود می‌برد. پردازش کاملاً در مرورگر انجام می‌شود و متن شما به هیچ سرویسی فرستاده نمی‌شود.

گام‌به‌گام

  1. JSON را بچسبانید

    متن را در کادر سمت راست بچسبانید یا با «بارگذاری فایل» یک فایل با پسوند json بیاورید؛ حداکثر حجم ۲ مگابایت است.

  2. تورفتگی را انتخاب کنید

    بین دو فاصله، چهار فاصله و تب (Tab) یکی را برگزینید؛ خروجی بلافاصله با همین انتخاب ساخته می‌شود.

  3. گزینه‌های اضافه را روشن کنید

    «مرتب‌سازی کلیدها» ترتیب کلیدها را الفبایی می‌کند و «خروجی فشرده» همه‌ی فاصله‌های اضافی را حذف می‌کند.

  4. خطا را بخوانید

    اگر JSON معتبر نباشد، زیر خروجی شماره‌ی سطر و ستون، دلیل خطا و خط مشکل‌دار با یک علامت زیر نویسه‌ی خراب نشان داده می‌شود.

  5. نتیجه را بردارید

    خروجی را کپی یا به‌صورت فایل data.json دانلود کنید، یا برای دیدن ساختار آن به نمای «درخت» بروید.

نمونه‌های کاربردی

  • فشرده‌کردن یک شیء چندخطی

    فاصله‌ها و خط‌های اضافه حذف می‌شود و متن فارسی همان‌طور که هست می‌ماند. گزینه‌ی «خروجی فشرده» خودکار روشن می‌شود.

    {
      "name": "علی",
      "tags": ["a", "b"],
      "age": 30
    }

    نتیجه: {"name":"علی","tags":["a","b"],"age":30}

  • پیداکردن کامای اضافه

    کامای پیش از آکولاد بستن در JSON مجاز نیست؛ ابزار جای دقیق آن را می‌گوید.

    {
      "name": "علی",
      "age": 30,
    }

    نتیجه: خطا در سطر ۴، ستون ۱: کامای اضافه پیش از «}».

  • مرتب‌کردن کلیدهای تودرتو

    کلیدها در همه‌ی سطح‌ها الفبایی می‌شوند؛ برای مقایسه‌ی دو فایل با ابزار تفاوت‌یاب بسیار کاربردی است.

    {"b":2,"a":{"d":1,"c":2}}

    نتیجه: {"a":{"c":2,"d":1},"b":2}

اشتباه‌های رایج

  • نقل‌قول تکی در JSON پذیرفته نمی‌شود؛ رشته‌ها و کلیدها باید با نقل‌قول دوتایی نوشته شوند، حتی اگر در جاوااسکریپت تکی کار کند.
  • کلیدی که بدون نقل‌قول نوشته شده یا کامای انتهای آخرین عضو، دو خطای رایج در نمونه‌هایی است که از کد جاوااسکریپت کپی شده‌اند.
  • عددهای صحیح بسیار بزرگ، مثلاً شناسه‌های بیش از ۱۶ رقم، در جاوااسکریپت گرد می‌شوند؛ این گونه مقدارها را در JSON به‌صورت رشته بنویسید.
  • اگر کل متن یک رشته‌ی escape‌شده است (با \n و \" فراوان)، به‌جای تلاش دستی از «بازکردن رشته» استفاده کنید؛ عکس این کار را «تبدیل به رشته» انجام می‌دهد.

JSON دقیقاً چه چیزی را مجاز می‌داند؟

JSON فقط شش نوع مقدار دارد: شیء، آرایه، رشته، عدد، درست و نادرست، و تهی. هر رشته و هر کلید باید با نقل‌قول دوتایی بیاید، توضیح (comment) وجود ندارد و بعد از آخرین عضو هیچ کامایی نباید بگذارید. بسیاری از خطاهای روزمره از همین سه قاعده می‌آید؛ چون ویرایشگرها و زبان‌های برنامه‌نویسی در ظاهر سخت‌گیری کمتری دارند.

فرمت JSON عمداً ساده است تا همه‌ی زبان‌ها بتوانند آن را بخوانند، اما همین سادگی یعنی تاریخ، عدد بزرگ و داده‌ی دودویی نوع ویژه‌ای ندارند. معمولاً تاریخ را به‌صورت رشته‌ی ISO و داده‌ی دودویی را به‌صورت رشته‌ی base64 می‌نویسند.

چه وقت فشرده و چه وقت مرتب؟

فشرده‌سازی زمانی مفید است که JSON را می‌فرستید یا ذخیره می‌کنید و هر بایت اهمیت دارد؛ مثلاً در بدنه‌ی درخواست یا یک متغیر محیطی. برای خواندن و بازبینی همیشه نسخه‌ی با تورفتگی بهتر است.

مرتب‌سازی کلیدها وقتی ارزش دارد که می‌خواهید دو خروجی از دو زمان یا دو سرور را مقایسه کنید. ترتیب کلیدها در JSON معنایی ندارد، پس مرتب‌کردن محتوا را عوض نمی‌کند اما تفاوت‌های ساختگی را از بین می‌برد. توجه کنید که ترتیب عضوهای آرایه معنادار است و مرتب نمی‌شود.

پرسش‌های متداول

خطای JSON چطور نشان داده می‌شود؟
شماره‌ی سطر و ستون، دلیل خطا به فارسی و خط مشکل‌دار همراه با یک علامت زیر ستون نمایش داده می‌شود؛ مثلاً کامای اضافه، نقل‌قول تکی یا کلید بدون نقل‌قول.
متن فارسی در خروجی escape می‌شود؟
خیر. نویسه‌های فارسی همان‌طور که هستند می‌مانند و به شکل \u06xx در نمی‌آیند. اگر می‌خواهید escape شوند از ابزار «Escape و Unescape» استفاده کنید.
برای عددهای خیلی بزرگ دقت حفظ می‌شود؟
خیر؛ عددهای صحیح بزرگ‌تر از ۹٬۰۰۷٬۱۹۹٬۲۵۴٬۷۴۰٬۹۹۱ مانند جاوااسکریپت گرد می‌شوند. این‌گونه مقدارها را به‌صورت رشته در JSON بنویسید.

ابزارهای مرتبط