לבקשת המשיכה היו 240 שורות שהשתנו ונגעתי בדיוק בשני ערכים. זה היה הרגע שבו נהייתי רציני לגבי מיון מפתחות JSON. חבר לצוות הפעיל קובץ תצורה דרך מעצב שסידר מחדש את המפתחות שלו, ערכתי שניים מהערכים האלה ביד, וההבדל שהתקבל היה קיר בלתי קריא של אדום וירוק שבו 238 מהשורות היו מפתחות שפשוט זזו. המבקר שלי, מובן, ביקש ממני לעשות זאת מחדש. השינויים האמיתיים היו בלתי נראים בתוך הרעש.
אני מפעיל [Toolz.dev] (/ וגם בונה פרויקטים של Laravel ו-WordPress, מה שאומר שאני גר בפנים package.json, composer.json, tsconfig.json, קטלוגים תרגום, ועוד מאה קבצי JSON שמתחייבים לבקרת גרסאות קובץ JSON עם סדר מפתחות בלתי צפוי הוא מס קטן וחוזר על כל אחד מאלה מיון מפתחות לסדר אלפביתי יציב הוא התיקון, וזה אחד מאותם שינויים שנראים קוסמטיים עד הפעם הראשונה שהוא חוסך לך סקירת קוד מבוזבזת מדריך זה מכסה מתי למיין מפתחות JSON, מתי לא לעשות ואיך לעשות זאת מבלי לשבור דבר.
TL;DR: סדרן JSON מסדר מחדש אובייקט' מקשי s לסדר אלפביתי ומסדר מחדש את התוצאה סדר מפתחות אינו משנה את המשמעות של JSON, מכיוון שאובייקטים אינם מסודרים לפי תקן JSON, אך סדר עקבי הופך קבצים לקריאה ומייצר הבדלי בקרת גרסאות נקיים המציגים רק ערכים שהשתנו מיין באופן רקורסיבי כדי להגיע לאובייקטים מקוננים, שמור על סדר מערך כברירת מחדל מכיוון שמערכים מסודרים, ובחר בפלט עולה או יורד, יפה או ממוזער סדרן JSON פועל כולו בדפדפן שלך.
מה זה סדרן JSON?
סדרן JSON לוקח אובייקט JSON ומסדר מחדש את המפתחות שלו לסדר אלפביתי, ואז כותב את האובייקט בחזרה החוצה הערכים לא נגעו רק הרצף שבו מופיעים המפתחות משתנה, וזה בטוח כי RFC 8259 מגדיר אובייקט כאוסף לא מסודר: סידור מחדש של מפתחות לא יכול לשנות את משמעות המסמך. כך {"name":"toolz","author":"Liton"} הופך {"author":"Liton","name":"toolz"}. כברירת מחדל המיון הוא רקורסיבי, מה שאומר שגם המפתחות בתוך כל אובייקט מקונן ממוינים, עד לרמה העמוקה ביותר.
זו כל הפעולה, והפשטות שלה היא הנקודה אתה לא משנה נתונים, מאמת סכימה או ממיר פורמט אתה כופה סדר צפוי על משהו שהיה לו שרירותי כל תועלת אחרת, קריאות, השוואה, הבדלים נקיים, זורם מאותו סדר יחיד צפוי.
האם מקשי המיון משנה את משמעות ה-JSON שלי?
לא, וזו העובדה שהופכת את המיון לבטוח בתקן JSON, ECMA-404, אובייקט מוגדר כאוסף לא מסודר של זוגות שמות וערכים המפרט מפורש שהסדר של אותם זוגות אינו משמעותי כל מנתח תואם קורא {"a":1,"b":2} ו {"b":2,"a":1} כמו בדיוק אותם נתונים. When התוכנית שלך עושה config.timeout או data["name"], הוא מחפש את המפתח בשמו; אף פעם לא אכפת לו איפה באובייקט המפתח הזה נכתב.
יש אזהרה אחת שכדאי לציין בבירור, כי מישהו תמיד שואל מספר זעיר של מערכות משתמשות לרעה באובייקטי JSON כאילו הוזמנו, תוך הסתמכות על סדר הכנסה לתצוגה או עיבוד. זהו שימוש לרעה בפורמט ולא במאפיין שלו, אבל אם אתה מזין מערכת שאינך שולט בה, בדוק לפני שאתה מבצע קובץ ממוין לצינור שאינך יכול לבדוק. עבור הרוב המכריע של JSON בעולם האמיתי, קבצי תצורה, מטענים של API, קבצי נעילה, קטלוגים של תרגום, מפתחות מיון הם שינוי מצגת גרידא עם אפס השפעה על המשמעות.
מערכים הם המקרה ההפוך, וההבחנה חשובה מערך JSON מסודר בהגדרה, והסדר שלו נושא משמעות לעיתים קרובות: רצף של שלבים, רשימה מדורגת, קבוצה של קואורדינטות שבהן מיקום אחד הוא קו אורך ומיקום שני הוא קו רוחב סידור מחדש של מערך יכול לשנות בשקט את מה שהנתונים אומרים לכן הכלי הזה משמר סדר מערך כברירת מחדל וממיין מערכים רק כאשר אתה מבקש זאת במפורש, וגם אז רק עבור מערכים שכל האלמנטים שלהם הם מחרוזות או כל המספרים.
למה שאמיין מפתחות JSON?
הסיבה לכותרת היא הבדלים נקיים, והיא זו ששינתה את אופן העבודה שלי כלים לבקרת גרסאות משווים קבצים שורה אחר שורה כאשר שני קבצים המייצגים את אותם נתונים כותבים את המפתחות שלהם בסדרים שונים, ההבדל מלא במקשים שזזו ולא בערכים שהשתנו אמצו כלל שכל קובץ JSON כתוב עם מפתחות ממוינים, והבעיה נעלמת: שתי גרסאות של הקובץ נבדלות רק כאשר ערך שונה בפועל, כך שסוקר רואה את השינוי האמיתי באופן מיידי זו בדיוק הסיבה מדוע לינטרים ומעצבים רבים מציעים אפשרות של מפתחות מיון, ומדוע כלים כמו jq שלח דגל מפתחות מיון.
הסיבה השנייה היא קריאות אנושית. כאשר אתה סורק קובץ תצורה גדול ומחפש הגדרה ספציפית, סדר אלפביתי אומר לך היכן לחפש. אתה לא קורא את כל הקובץ; אתה קופץ בערך למקום שבו המפתח צריך להיות, כמו שהיית עושה במילון. על קובץ עם שמונים מקשים, זה ההבדל בין חיפוש של שתי שניות לסריקה מלאה.
הסיבה השלישית היא השוואה בין קבצים אם לפרויקט שלך יש עשרה קבצי JSON שכולם צריכים לחלוק מבנה משותף, מיון כולם באותו אופן הופך את זה לטריוויאלי לגלגל העין בין אם חסר מפתח או שיש לו מפתח נוסף. הבדלים מסתדרים זה ליד זה במקום להסתתר בעמדות שונות.
הסיבה הרביעית היא קנוניזציה זרימות עבודה מסוימות זקוקות לייצוג יציב ודטרמיניסטי של ערך JSON, למשל כדי ל-hash אותו, לשמור אותו במטמון או להשוות שני מטענים לשוויון ללא קשר לאופן שבו הם הוסדרו בסידרה מיון מפתחות הוא צעד אחד לקראת צורה קנונית, אם כי JSON קנוני מלא מנרמל גם עיצוב רווח לבן ומספרים.
כיצד אוכל להשתמש ב-JSON Sorter?
הדבק את ה-JSON שלך בתיבת הקלט ב- סדרן JSON, או לטעון את המדגם כדי לראות את הצורה של הפלט הקלט חייב להיות חוקי JSON.אם זה לא, הכלי מדווח על שגיאת הניתוח עם המיקום שלו כדי שתוכל לתקן פסיק תועה או סוגר לא סגור לפני המיון.
לאחר מכן בחר כיצד המיון פועל. בחר עולה, שהוא A עד Z, או יורד עבור Z עד A. החלט אם לקפל את המקרה, שפועל כברירת מחדל כך Name, name, ו NAME שבו יחד במקום להיות מופרדים מכיוון שאותיות גדולות ממיינות לפני אותיות קטנות בסדר תווים גולמי בחרו אם לרדת לאובייקטים מקוננים, שכמעט תמיד תרצו, או למיין רק את הרמה העליונה אם אתם רוצים גם מערכים של מחרוזות או מספרים מסודרים, הפעל מיון מערך; מערכים מעורבים ומערכים של אובייקטים תמיד נשארים כפי שהם.
לבסוף, בחר את סגנון הפלט שלך. Pretty-print with two-space, four-space, or tab intentation for a readable file you will commit, or minify to a single line for the minest payload for storage or transport.Run the sort, then copy the result or download it.The key count tells you how many keys were reordered, which is a quick sanity check that the tool saw the structure you expected.
עולה, יורד, רקורסיבי: אילו הגדרות אני רוצה?
רוב הזמן ברירות המחדל הן מה שאתה רוצה: עולה, רקורסיבי, חסר רישיות, מודפס יפה עם שני רווחים. זה מייצר את הקובץ הקריא והידידותי למפרע שמניע מיון מלכתחילה. ההגדרות האחרות קיימות עבור מצבים ספציפיים, והטבלה למטה היא איך אני מחליט.
| הגדרה | ברירת מחדל | מתי לשנות את זה |
|---|---|---|
| להזמין | עולה (א' עד ת') | ירידה היא נדירה; שימושי כאשר אתה רוצה את המפתחות העדכניים ביותר או בעלי העדיפות הגבוהה ביותר, בשם למיין אחרון, בחלק העליון |
| רקורסיבי | על | כבה רק כאשר ברצונך לסדר מחדש קטעים ברמה העליונה אך שמור את הסדר המכוון ביד בתוך כל אחד מהם |
| התעלם ממקרה | על | כבה כאשר אתה צריך סדר קפדני של נקודת קוד, למשל כדי להתאים לכלי אחר שממיין באופן רגיש למקרה |
| מיון מערכים | כבוי | הפעל עבור מערכים שהם באמת סטים לא מסודרים, כמו רשימה של תגים או ערכים מותרים |
| הדפס יפה | על | כבה כדי למזער להובלה או אחסון |
ההגדרה האחת שאנשים משתמשים בה לרעה היא מיון מערך הפעל אותה רק כאשר אתה בטוח שמערך מייצג קבוצה לא מסודרת רשימה של תגים, קבוצה של סיומות קבצים מותרות או שקית של דגלי תכונה בטוחה למיון רשימה של שלבי צינור, טבלת מסלולים או כל דבר שבו המיקום מרמז על רצף אינו. כאשר יש ספק, השאר מערכים לבד, כי הכלי ' ברירת המחדל של שמירת הסדר לעולם לא יכולה להשחית את הנתונים שלך, בעוד שמיון המערך השגוי יכול בשקט.
איך זה מתאים לכלי JSON אחרים?
המיון הוא בדרך כלל שלב אחד בשרשרת קטנה. כאשר JSON מגיע ממוזער ובלתי קריא מ-API, אני מריץ אותו דרך ה- פורמט JSON קודם להכניס ולאמת את זה, ואז למיין את המפתחות כדי שיהיה ניתן לסריקה כשאני מכין מטען להובלה לאחר המיון, ה מיניפר JSON מפשיט אותו בחזרה לשורה בודדת, ומכיוון שהמפתחות כבר ממוינים, שני מטענים ממוזערים המייצגים את אותם נתונים יוצאים זהים בתים-עבור-בתים, וזה שימושי לאחסון במטמון ולהשוואה.
לעבודה מבנית ולא להצגה, ה משטח JSON הופך אובייקטים מקוננים למפתחות מנוקדים ובחזרה, מה שמשתלב באופן טבעי עם מיון כאשר אתה מתקוטט, הגדר למשתני סביבה. וכאשר אתה צריך את הנתונים בפורמט אחר לחלוטין, ה ממיר JSON ל-YAML האם התחנה הבאה; מיון מפתחות לפני ההמרה נותן לך גם קובץ YAML עם סדר שדה צפוי וקריא. אם אתה רוצה את התמונה הגדולה יותר של איך אלה משתלבים זה בזה, פרסתי את ההגדרה המלאה שלי ב- מדריך ערכת כלים למפתחי אינטרנט, והמכניקה העמוקה יותר של עיצוב חיה ב מדריך לפורמט JSON.
דוגמה אמיתית: אילוף package.json diff
תן לי לעבור על המצב המדויק שהתחיל את המאמר הזה, כי זה מראה למה בחירות ההגדרה חשובות. היה לי א package.json איפה ה dependencies בלוק נכתב לפי סדר ההתקנה, בערך בסדר שבו נוספו חבילות במשך שנתיים. חבר צוות חדש הפעיל את העורך 's format-on-save, שמיין את מפתחות התלות, וביצע זאת לצד שינוי אמיתי: חבטת חבילה אחת מגרסה 4 לגרסה 5.
ההבדל היה אסון נראה היה שכל תלות מתחת לזו שנתקלה זזה, כי המיון שינה את עמדותיו, אז המבקר ראה שלושים שורות שהשתנו למה שהיה שדרוג בשורה אחת התיקון לא היה להתווכח על מי העורך צדק התיקון היה למיין את הקובץ פעם אחת, לבצע את המיון הזה כשינוי נפרד משלו עם הודעה כמו "מיון package.json keys," ואז לגרום לגרסה להתנגש על גבי הסדר היציב כעת. לאחר מכן, כל שינוי תלות עתידי יצר הבדל נקי של שורה אחת או שתי שורות, מכיוון שהקובץ כבר היה בסדר שכולם ' הכלים רצו להכניס אותו.
זה הדפוס שאני עוקב אחריו כעת עבור כל JSON שחי בבקרת גרסאות מיין אותו פעם אחת בהתחייבות ייעודית, ואז שמור אותו מסודר. ה סדרן JSON עם ברירות המחדל שלו, עולה ורקורסיבית, מייצר בדיוק את הסדר ש-Prettier's מיון אפשרות ו jq --sort-keys לייצר, כך הקובץ נשאר יציב לא משנה איזה כלי חבר צוות במקרה לרוץ הדבר היחיד שאני בודק ראשון הוא מערכים: package.json אין מערכים משמעותיים לדאוג לגביהם, אבל קובץ עם מערך מסודר כמו רשימה של שלבי בנייה צריך מיון מערך שהופסק, וזו ברירת המחדל, כך שהרצף ישרוד.
אילו כלים ופורמטים ממיינים מפתחות JSON?
מיון מפתחות JSON הוא צורך נפוץ מספיק כדי שהוא יופיע ברחבי המערכת האקולוגית, וזה סימן טוב שהתרגול הוא צליל ולא מוזרות אישית. מעבד שורת הפקודה jq יש א --sort-keys דגל, כתוב לעתים קרובות -S, שממיין את המפתחות של כל אובייקט בפלט שלו מעצב הקוד Prettier יכול למיין מפתחות ב-JSON דרך התצורה שלו. linters רבים מציעים כלל מפתחות מיון המסמן אובייקטים לא ממוינים בקוד מקור. ספריות סטנדרטיות בשפה חושפות את אותה יכולת, למשל Python's json.dumps מקבל א sort_keys=True ארגומנט שמייצר פלט קנוני וממוין.
מה שמוסיף סדרן מבוסס דפדפן הוא המקרה המהיר, ללא הגדרה, כאשר יש לך כתם של JSON מתגובת API, שורת יומן או הודעת Slack, ואתה רק רוצה לקרוא אותו בסדר שפוי עכשיו, פתיחת דף והדבקה מהירה יותר מחיווט מעצב או נפילה למעטפת. זו אותה סיבה שקיים מעצב הדבקה וסע לצד תוספי עורך: הכלי עונה על הצורך האד-הוק שהצינור המוגדר אינו מכסה.
האם JSON שלי פרטי?
כן ה-JSON מנותח, ממוין, ומסודר מחדש כולו בדפדפן שלך באמצעות JavaScript שום דבר לא מועלה לשרת, נרשם או מאוחסן בכל מקום זה לא פרט מינורי עבור JSON ספציפית, כי JSON הוא המקום שבו חיים סודות: תגובות API הנושאות אסימונים, קבצי תצורה עם מחרוזות חיבור, מטענים המכילים רשומות של לקוחות הדבקת כל זה לתוך כלי ששולח אותו לשרת היא סיכון אמיתי, וזה בדיוק הסיכון שהכלי הזה בנוי להימנע ממנו.
אתה יכול לאמת את הטענה באותה דרך שהייתי עושה זאת פתח את לשונית הרשת בדפדפן שלך' כלי מפתחים של s וצפה בה בזמן שאתה ממיין; שום בקשה לא עוזבת את הדף או התנתק מהאינטרנט והמשיך למיין, כי ברגע שהדף נטען, הכלי עובד ללא חיבור כלל עיבוד בצד הלקוח הוא ברירת המחדל לכל מה שאני בונה, ואם אכפת לך מהטיעון הרחב יותר עבורו, ה מדריך פרטיות נתונים עושה את המקרה במלואו.
שאלות נפוצות
מה זה אומר למיין מפתחות JSON?
מיון מפתחות JSON מסדר מחדש את צמדי השם-ערך של אובייקט לסדר אלפביתי מבלי לשנות ערכים כלשהם האובייקט {"name":"toolz","author":"Liton"} הופך ל-{"author":"Liton","name":"toolz"}. רק סדר המפתחות משתנה, כך שהנתונים שהמסמך מייצג נשארים זהים לחלוטין.
האם מקשי המיון משנה את משמעות ה-JSON שלי?
לֹא . בתקן JSON, ECMA-404, אובייקט הוא קבוצה לא מסודרת של זוגות שם-ערך, כך שסדר מחדש של המפתחות שלו לא משנה את משמעותו. כל מנתח תואם קורא את הגרסאות הממוינות והלא ממוינות כמו אותם נתונים. הסדר חשוב רק לקריאות האדם ולהפקת הבדלים יציבים.
האם גם אובייקטים מקוננים ממוינים?
כן, כברירת מחדל. מיון רקורסיבי מופעל, כך שהמפתחות של כל אובייקט בתוך המסמך ממוינים, בכל רמת קינון. אתה יכול לכבות את הרקורסיה כדי למיין רק את המקשים ברמה העליונה ולהשאיר אובייקטים מקוננים בסדר המקורי שלהם.
האם המסדר מסדר מחדש מערכים?
לא כברירת מחדל. מערכים מסודרים לפי הגדרה, וסדרם מחדש יכול לשנות משמעות, כך שהכלי שומר על סדר המערך. ישנה אפשרות למיין מערכים שכל האלמנטים שלהם הם כל המחרוזות או כל המספרים כאשר אתה רוצה שיסדרו אותם; מערכים המשלבים סוגים או מכילים אובייקטים נשארים תמיד כפי שהם.
למה שאמיין מפתחות JSON?
הסיבה הנפוצה ביותר היא הבדלים יציבים: כאשר כל קובץ כותב את המפתחות שלו באותו סדר אלפביתי, הבדלי בקרת גרסאות מדגישים רק את הערכים שהשתנו ולא את המקשים שעברו. המיון גם הופך קבצי תצורה גדולים ותגובות API להרבה יותר קלות לסריקה ולהשוות לפי עין.
כיצד פועל מיון לא רגיש לאותיות רישיות?
עם מיון לא רגיש לאותיות רישיות, מקשים מושווים כאילו אותיות קטנות, אז שם, שם ושם מקובצים זה ליד זה במקום להיות מופרדים מכיוון שאותיות רישיות ממיין לפני אותיות קטנות בסדר גולמי. כבה אותו כדי למיין בקפדנות לפי נקודת קוד תו.
האם אני יכול לצמצם את ה-JSON הממוין?
כן. בחר פלט ממוזער כדי לקבל את ה-JSON הממוין בשורה אחת ללא רווח לבן נוסף, שהוא הצורה הקטנה ביותר לאחסון או הובלה. עבור קובץ קריא, בחר פלט יפה עם שני רווחים, ארבעה רווחים או הזחה של כרטיסיות במקום זאת.
האם ה-JSON שלי מועלה במקום כלשהו?
לֹא . ה-JSON מנותח וממוין לפי JavaScript בדפדפן שלך ולעולם אינו משודר, נרשם או מאוחסן. אתה יכול לאמת זאת על ידי צפייה בכרטיסייה רשת בזמן המיון, או על ידי מעבר לא מקוון, הכלי ממשיך לעבוד ללא חיבור.
נכתב על ידי Liton, בונה של [Toolz.dev] (/. אני בונה כלי מפתחים מבוססי דפדפן וכותב על עבודה עם JSON, Laravel והאינטרנט.
