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

راهنمای مقایسه‌ی ساختاری JSON

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

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

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

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

گام‌به‌گام

  1. دو نسخه را بچسبانید

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

  2. جدول تفاوت را بخوانید

    هر ردیف مسیر مقدار را به شکل /کلید/شماره، نوع تغییر و مقدار پیش و پس از آن را نشان می‌دهد. با خاموش کردن «فقط تفاوت‌ها» بخش‌های بدون تغییر هم نمایش داده می‌شوند.

  3. گزینه‌های مقایسه را تنظیم کنید

    اگر ترتیب عنصرهای آرایه برایتان مهم نیست «نادیده گرفتن ترتیب آرایه» را روشن کنید. «رشته‌ی عددی مثل عدد» مقدار "5" را با 5 برابر می‌داند و «فیلد شناسه‌ی عنصرهای آرایه» مثلاً id را برای جفت کردن عنصرها به کار می‌برد.

  4. Patch را بردارید

    JSON Patch ساخته‌شده را کپی کنید تا همین تغییرها را در جای دیگر اعمال کنید.

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

  • تغییر مقدار و افزودن کلید

    سن عوض شده، یک برچسب و یک کلید تازه آمده؛ کلید name که تغییری نکرده در جدول تفاوت نمی‌آید.

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

    نتیجه: ۱ تغییر در /age و ۲ افزوده در /tags/1 و /city

  • آرایه‌ی جابه‌جاشده با نادیده گرفتن ترتیب

    دو عنصر فقط جایشان عوض شده است؛ با روشن بودن نادیده گرفتن ترتیب، دو نسخه برابر شمرده می‌شوند.

    [{"id":1,"n":"a"},{"id":2,"n":"b"}]

    نتیجه: دو نسخه از نظر ساختار و مقدار یکسان‌اند.

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

  • مقایسه‌ی متنی JSON قالب‌بندی‌شده با JSON فشرده: این ابزار به فاصله‌ها و ترتیب کلیدها کاری ندارد، پس لازم نیست پیش از مقایسه آن‌ها را هم‌شکل کنید.
  • روشن کردن نادیده گرفتن ترتیب برای فهرستی که ترتیبش معنا دارد: در فهرست مرحله‌ها یا رتبه‌بندی، جابه‌جایی خودش یک تغییر است و نباید پنهان شود.
  • گذاشتن JSON با توضیح یا ویرگول پایانی: JSON استاندارد این‌ها را نمی‌پذیرد و خطای «JSON معتبر نیست» می‌گیرید. ابتدا آن‌ها را بردارید.
  • نادیده گرفتن تفاوت "5" و 5: برای بسیاری از برنامه‌ها نوع داده مهم است. «رشته‌ی عددی مثل عدد» را فقط وقتی روشن کنید که مطمئنید فرقی نمی‌کند.

مسیرهای JSON Pointer

مسیرهایی مثل /tags/1 با قاعده‌ی JSON Pointer نوشته می‌شوند: هر بخش پس از / یا نام کلید است یا شماره‌ی عنصر آرایه که از صفر شروع می‌شود. پس /tags/1 یعنی دومین عنصر آرایه‌ی tags.

JSON Patch از همین مسیرها استفاده می‌کند و هر تغییر را با یک عمل مثل add، remove یا replace توصیف می‌کند. بسیاری از کتابخانه‌ها و APIها این قالب را مستقیم می‌پذیرند.

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

ترتیب کلیدها اثر دارد؟
خیر. جابه‌جایی کلیدهای یک شیء هیچ‌وقت تفاوت حساب نمی‌شود. ترتیب عنصرهای آرایه به‌طور پیش‌فرض اثر دارد، مگر گزینه‌ی «نادیده گرفتن ترتیب آرایه» را روشن کنید.
فیلد شناسه برای چیست؟
اگر عنصرهای آرایه شیء هستند و فیلدی مثل id دارند، نام آن را بنویسید تا عنصرها با شناسه با هم تطبیق داده شوند و جابه‌جایی به‌جای حذف و افزودن نشان داده شود.
JSON Patch چطور استفاده می‌شود؟
خروجی طبق RFC 6902 است و اگر روی نسخه‌ی قبل اعمال شود به نسخه‌ی جدید می‌رسد. هنگام فعال بودن گزینه‌های مرتب‌سازی یا تبدیل رشته‌ی عددی، Patch نسبت به همان نسخه‌ی نرمال‌شده است.

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