שנה: 2017

Plan/Execution Segregation

כאשר אנו כותבים תוכנה שאמורה לשרת תהליכים עסקיים מסוימים, חשוב מאוד שמבנה (“מודל”) התוכנה יתאם למודל העסקי.

מדוע? כי דרישות חדשות יגיעו מתוך המודל העסקי.
אם התרגום בין המודל העסקי למודל התוכנה הוא ישיר – יהיה קל לתרגם את הדרישות לשינוי בתוכנה.
אם המיפוי מסובך – נצטרך “לכופף” שוב את המיפוי, מה שעלול לגרום להסתבכות, פיצ’ר שקשה יותר לממש, וחוב טכני שילך ויתפח.

כל זה מוכר לרוב הקוראים, אני מקווה. אני חוזר על התובנה (החשובה) הזו שוב ושוב.

בפוסט הזה אתמקד בבעיית מידול נפוצה, כזו שיכולה להסתיים במידול ישיר ופשוט, או מידול סבוך שקשה לתחזק.

איך זה מתחיל?

ההתחלה המודעת של הסיפור היא, בד”כ – כבר לאחר כברת-דרך.

לצורך הפוסט בחרתי בדוגמה של מערכת לניהול משלוחים בסופרמרקט. כולנו לקוחות של סופרמרקט כזה או אחר – ולכן מכירים את הדומיין בצורה לא-רעה.

המערכת שלנו היא מערכת לניהול משלוחים בסופרמרקט. הלקוח מזמין רשימה של פריטים ומקבל אותם במשלוח לביתו תוך 24 שעות מרגע ההזמנה. החיוב נעשה רק לאחר שהמשלוח הגיע ללקוח.

מידלנו את ההזמנה כאובייקט Order, המכיל רשימה של אובייקטי ListItem.

ListItem הוא “Pattern” נפוץ ושימושי למקרים כאלו.

מכיוון שהעלות של פריט (Item) היא תכונה המשתנה לאורך הזמן (temporal) זו תהיה טעות להצביע מההזמנה ישירות לפריט. מחיר הפריט השתנה לאחר שנה? גם מחיר ההזמנה השתנה, לא משנה שהיא כבר הסתיימה.

במקום זאת, אנו מעתיקים ברגע ההזמנה את הפריטים לאובייקט בשם LineItem שתפקידו לספק snapshot רלוונטי לרגע ההזמנה. לא נרצה שהעלאה או הפחתה של מחיר בפרק הזמן בין ההזמנה למשלוח יחול על הלקוח. בכלל, כסף הוא נושא רגיש אצל לקוחות. חשוב לדייק ולהיות צפויים בכל מה שקשור אליו.

עד כאן – טוב ויפה!

הבעיה מתחילה (לכאורה) כמה חודשים לאחר ההשקה:

נציגי שירות הלקוחות מתלוננים על תלונות חוזרות ונשנות של לקוחות שקשה לטפל בהן: כאשר חסרים פריטים ו/או לקוח מסרב לקבל פריט מסוים במשלוח (החברה מאפשר ללקוח לעשות זאת. סוג של החזרה) – לפעמים יש בלבול בסכומים שצריך לשלם / לזכות את הלקוח – וקשה להבין מה הסכום הנכון שצריך להיות. במיוחד – קשה להסביר את זה ללקוח.

נציגי שירות הלקוחות  מבקשים שהחיוב של לקוח יתבצע שבוע אחרי הקניה, אחרי שכל העניינים הוסדרו, במקרים מסוימים – אולי שבועיים. אולי הם מבקשים UI עשיר יותר שיעזור להם לסדר את הבלבול. 
מצד שני יש גם את מנכ”ל הכספים שכמובן מתנגד. הוא תוהה בקול רם “ממתי הפכנו לבנק שנותן הלוואות ללקוחות?”, והוא גם הביע חשש שלפיתוח יהיה קשה לממש כזאת יכולת – וחשוב שהפיתוח יושקע בפיצ’רים שמכניסים עוד רווחים לחברה.

דרישות כמו הנ”ל מריחות כמו בקשות ל”פיצ’ר פירוס” (Pyrrhic Feature) – פיצ’ר שלא באמת יפתור את בעיה, אלא רק יקבע ויחמיר אותה. על פיצ’ר כזה נאמר: “עוד פיצ’ר כזה – ואבדנו”.

אנחנו ניגשים לקוד (או ל Database) ומתחילים להזיז את הקוד לכיוון פתרון. עוד תנאי פה, ועוד בדיקה שם – אבל הקוד הולך ומסתבך. מי היה מאמין שמערכת של סופרמרקט היא נושא כ”כ מסובך?!

כאשר המודל שלנו “עקום” או “לא מתאים” טבעי שיצוצו בעיות. הניסיון לפתור אותן ב”פיצ’פוצ’ים” עלול להתארך  – וגם מקבע את המצב הבעייתי.
לאחר כל אותם “פיצ’פוצ’ים” שאיכשהו הצליחו – מי יעז לבצע Refacotring משמעותי באותו קוד?!

איך זה באמת התחיל? (סיפור ה Prequel)

הבעיה הנ”ל בעצם התחילה במידול האובייקטים הבסיסי. כמה שגרתי.

כשהתחלנו לתכנן את המערכת זיהינו אובייקט “הזמנה” ואובייקט “משלוח.”
דיי מהר – הבנו שהאובייקטים בעצם זהים. הסכמה ב Database היא זהה לחלוטין. המשלוח הוא ההזמנה, וההזמנה היא המשלוח.

למה לתחזק נתונים כפולים ב Database? למה סתם לשכפל קוד? הרי אומנו “לחפש ולהשמיד” כל כפילות קוד אפשרית.

הבעיה העקרונית במצב הזה הוא ששני אובייקטים שנראים אותו הדבר כרגע – לא בהכרח יראו אותו הדבר בהמשך הדרך.

אני ארשה לעצמי להתחיל בדוגמה מגוחכת:

זה בוודאי דבר שלא נעשה, וגם עם עשינו – קל מאוד לתקן.

ככל שהדוגמה יותר מורכבת, יותר קשה להבחין בטעות. למשל:

באמת נראים אותו הדבר. דיי סביר שנאמר לעצמו “מה זו כפילות הקוד הזו?!” – ונאחד את האובייקטים.

השאלה המהותית היא: האם האובייקטים במקרה זהים כרגע, או האם הם באמת מייצגים את אותו הדבר לטווח ארוך?

בכלל, האם “הזמנה” ו”משלוח” הם באמת אותו הדבר?

הנה כמה דוגמאות מדוע הם לא אותו הדבר (וטיעוני-נגד נפוצים):

פריטים (lineitems) שקיימים בהזמנה עשויים לא להיות במלאי – ולכן לא להיכלל במשלוח.

  • “אין בעיה! נמחק אותם מהרשימה”


ייתכן ופריט שונה נשלח מזה שהוזמן. טעות במשלוח.

  • “נחזיר. מה זה משנה אם הייתה טעות משלוח, או שהלקוח לא רצה בפריט מסיבה אחרת?”


אולי המשלוח יתבצע למקום אחר מאשר מה שהוזמן במקור? (“כן, אדוני השליח! אני לא בבית. תביא את זה בבקשה לחמתי או לשכן”).

  • “נעדכן את הכתובת. זה קל!”.


התנהגות המערכת לגבי החזרת פריטים במשלוח, וביטול פריטים בהזמנה היא כנראה שונה.

  • “השאלה בקוד: (if(deliveryTimeStamp != null תספק את ההבחנה, מה הבעיה? טודו-בום, הכל בסדר!”.

למשלוח יש סטטוס-מעקב (state) שונה מזה של הזמנה: “המשלוח יצא”, “המשלוח נמסר”, “המשלוח התקבל” מול: “הזמנה התקבלה” / “הזמנה בוטלה”.

  • “אין בעיה לייצר לאובייקט state רחב, הכולל את כל המצבים. טודו-בם? טודו-בום!”.
לכאורה ההבדלים שאני מציג הם לא גדולים: ניתן להוסיף כמה שדות לאובייקט המאוחד, ולהתגבר על כל הבעיות שהצגתי.

הכל בסדר שם?

שלוש בעיות

בעצם בהחלטה לאחד את האובייקטים הקונספטואליים – לאובייקט יחיד בקוד, יש כמה תופעות לוואי לא טובות.

הבעיה קצרת הטווח הנובעת מהאיחוד היא לרוב שיותר קוד (גם הקוד המטפל במשלוח וגם זה המטפל בהזמנה) צריך להכיר state (אובייקט, סך נתונים) עשיר יותר ולהתמודד איתו.
Smell נפוץ הוא משפטי if בקוד המנסים לבדל בין הזמנה ומשלוח ← ולהתנהג בצורה אחרת.
התוצאה היא קוד יותר מסובך, שקשה יותר לתחזק.במקום לפצל את הקוד ליחידות קטנות יותר שלכל אחת אחריות קטנה (“divide and conquer“) – יצרנו ערמת קוד גדולה יותר להתמודד איתה (“unite and endure“).

בעיית הטווח הבינוני: חוסר בהיסטוריה

מכיוון שיש אובייקט אחד – שדות מחליפים ערך במהלך ה processing, ואנו מאבדים ערכים קודמים שאולי רלוונטיים.
מה קורה כאשר רוצים לטפל במצבים מורכבים (ביטולים, החזרות, וכו’)? – כאשר אין לנו היסטוריה לגשת אליה (“מה הייתה בדיוק ההזמנה?”), אנחנו לרוב נוטים לייצר “שבבי היסטוריה” ע”פ הצורך הרגעי – ולהדביק אותם על האובייקט המאוחד. פיצ’פוצ’ים.Smells נפוצים לבעיה הזו הם:

  • יש לנו כל מיני שדות שמנסים לחפות על חוסר בהיסטוריה AmountIfDelivered, או cancellationDate ביחד עם realCancellationDate.
  • יש לנו audit (לוג או טבלה) – דרכו אנו מנסים לדבג תקלות, ובעצם ליצור “היסטוריה חלופית”.
    בני אדם (מפתחים, support) יכולים לקרוא את הלוג – אך קשה מאוד לקוד שרוצה לבצע פעולה להסתמך עליו (כי הוא לא well-structured והפורמט עלול להשתנות לאורך הזמן).
  • אנו מוסיפים טבלאות ייחודיות ל BI – כי הם זקוקים להבנת ההיסטוריה, שאנחנו לא מסוגלים לספק להם עם נתוני הליבה שלנו (core data, לא של אפל).
במקרים הללו הקוד גולש, תחת הלחצים לתקן עוד ועוד באגים ולטפל במקרי קצה שלא דמיינו בתחילת הפיתוח – ל”קוד Job Security”, כזה שרק מי שכתב – יכול באמת להבין ולשנות. שינוי משמעותי – לרוב כרוך ב rewrite של כל המנגנון.האם לארגון שלנו יש מספיק משאבים ל re-writes הללו?

בעיית הטווח הארוך
בטווח הארוך יכולה להיגרם בעיה אפילו קשה יותר: הקשר 1:1 בין שני האובייקטים המקוריים, הזמנה ומשלוח – עומד להישבר. הארגון רוצה לפתח פיצ’ר אסטרטגי שקל לבטא מבחינה עסקית – אך סיוט לממש בקוד.
דוגמאות מעולם הסופרמרקט:
  • נאפשר ללקוח ליצור כמה הזמנות בזו אחר זו – ונשלח אתן במשלוח אחד.
  • נאפשר לשכנים לאחד משלוחים – בכדי לחסוך בעלות המשלוח.
  • נאפשר לבצע הזמנה אחת, כאשר פריטים יישלחו בקבוצות ע”פ הזמינות שלהן.
אלו תסריטי “יום הדין”: לאנשי הביזנס קל לתאר את השינוי המתבקש (ולכן זה לא נשמע להם כ”כ מסובך לקבל את זה) – אבל המפתחים לא יכולים לממש אותו ללא Refactoring מאסיבי או כתיבת הקוד מחדש.

Plan Execution Segregation

לכן:

  • נסו לזהות אובייקטים דומים אך שונים בשלבים המוקדמים של הפיתוח. הפרידו בין אובייקטים המתארים “תוכנית” לאובייקטים המתארים “ביצוע”.
  • הרשו לעצמכם לשכפל נתונים ואף מעט קוד, ולהתיר על כנם שני אובייקטים שונים – גם אם בשלב הראשון ההבדל בין האובייקטים אינו ברור.
כמובן שיש סיכון שכלל ה Plan/Execution Segregation יוביל אתכם לשכפול קוד מיותר. שלעולם לא יצוצו דרישות שיצדיקו החזקה של שני אובייקטים דומים.

אבל, חשבו לרגע מה הסיכון? הוא לא כ”כ גדול: נניח שיש אובייקט “הזמנה” שבשלב מסוים משוכפל (בבסיס הנתונים / בזיכרון) לאובייקט “משלוח” והטיפול עובר אליו. האם המערכת תהיה קשה הרבה יותר לתחזוקה?

הרגילו אותנו יותר מידי באינטנסיביות “לחפש ולהשמיד” כפילויות של קוד. ברוב המקרים זה יהיה סיכון קטן עם סיכויים טובים להשתלם (ואף להשתלם מאוד) בעתיד.
היכולת לבצע בקלות השוואה בין “תוכנית” ל”ביצוע”, בין הזמנה למשלוח שבוצע בפועל – על כל השדות, וגם להיסטוריה רחוקה, להחזיק בסיסי קוד קטנים יותר, ובמיוחד: לשנות את הקשר ביניהם מ1:1 ל n:1 (או אולי n:n) – הם יתרונות שיכולים להיות מאוד משמעותיים למערכת בטווח הארוך.

ביצוע שינוי שכזה בשלב מאוחר – הוא פעולה יקרה יותר בסדרי גודל מהשלבים הראשונים, ולכן משתלם בד”כ לקחת את הסיכון.
איך מזהים שזה המצב? יש שני כללי-אצבע פשוטים:
  • אם ברמת הביזנס יש הבחנה בין 2 המונחים, למשל אנשים הביזנס כן מדברים על הזמנה וגם על משלוח (זה לא “אותו הדבר” מבחינתם), זהו חיזוק לכך שכדאי לבצע הפרדה.
  • ככל שהאובייקט המדובר קרוב יותר לליבת העסק (דוגמה קלאסית: הזמנה), כך הסבירות שלא תוכלו לבצע שינויים במידול ללא מאמץ ניכר – גדלים, ולכן כדאי יותר לבצע את ההפרדה.
    • באובייקטים שוליים יחסית – סביר יותר שתוכלו לבצע שינויים בהמשך הדרך מבלי לזעזע את המערכת.
כאשר מבצעים הפרדה בין Plan ל Execution חשוב שתהיה דרך לקשר בין האובייקטים. בד”כ יהיה על אובייקט הביצוע (Execution Object) רפרנס (id?) לאובייקט התוכנית (Plan Object).
עוד המלצות נלוות:מה השלב שבו הופכים Plan ל Execution? האם זה מועד הביצוע? זמן קבוע לפניו (למשל: חצי שעה לפני)?

  • כלל נפוץ הוא לעשות זאת על בסיס Resource Allocation: לרוב execution לא יוכל להתבצע ללא הקצאה של משאבים. כאשר המשאב הוקצה (ונרשם) – יש סיכוי טוב שתרצו לעשות את המעבר. למשל:
    • Order של מונית הופך ל Ride כאשר הוקצה נהג. זה יכול לקרות מיד (ואז הלקוח ממתין עוד כמה דקות להגעת המונית) או אולי כמה שעות לפני הנסיעה – כאשר זו הזמנה לנסיעה עתידית.
  • כאשר אין משאב ברור, המעבר לרוב יקרה ברגע תחילת הביצוע. למשל: PaymentPlan הופך ל Payment , ברגע בו התחלתי לבצע את התשלום.
    • תשלום אגב יכול לארוך שניות, דקות, ואף שבועות: קיבלנו reject מסולק אחד, ואנו פונים לסולק אחר, אין מספיק כסף בחשבון כרגע וננסה “לנדנד” עד שיהיה, כרטיס אשראי בוטל – אך עדיין רוצים “לרדוף” אחרי התשלום, וכו’.
תיאור ה Execution כהצלחה (SUCCESS) או כשלון (FAIL) לעתים רבות אינו מספיק:
כאשר הביצוע מורכב מכמה פעולות ו/או כמה שלבים:

  • יש פעולות שלא הורצו בכלל – כי הן תלויות בפעולה אחרת. האם הן הצלחה, או כישלון?
  • יש פעולות שמתמשכות לאורך זמן, ולמרות שהמשכנו מהן הלאה – עדיין לא ברור אם הצליחו. למשל: המשלוח הסתיים – אבל רק מחר בבוקר נקבל טלפון שחבילה לא הגיעה ללקוח.
  • אולי קרו כמה כישלונות, כמה לקוחות קיבלו פריטים לא נכונים. האם יש הבדל בין בעיה אחת לשלושה?
  • פתרון נפוץ הוא לחשב את ה state בצורה דינאמית:
    • הרבה פעמים נוח להחזיר רשימה של בעיות, במקום סיכומם כערך יחיד. יש צרכנים של הפונקציה שיספרו רק אם מספר הבעיות גדול מאפס (או ()errors.isEmpty), ויש כאלו שיכנסו יותר לפרטים.
    • לעתים שווה גם לציין פעולות pending או suspension – שעדיין לא התבצעו, ולכן לא ברור מה המצב שלהן. יש הבדל גדול בין “0 תקלות משלוח!” לבין “0 תקלות משלוח, אבל 6 חבילות עדיין לא סופקו”.
    • השם pending מרמז יותר על פעולות שמתבצעות כסדרן אך לא הסתיימו, ו suspension על פעולות שהתעכבו / הסתבכו – אך עדיין לא ברור אם יצליחו לתקן ולסיים אותן בהצלחה.
      • אם יש suspensions – לרוב כדאי לקבוע גם deadline שהופך אותן לכישלון. לא נרצה להיות ב state לא ברור לאורך זמן.
לעתים יש טעם לשמור את ה Plan לשימוש חוזר. למשל: לקוח בונה רשימה של פריטים אותם הוא מזמין כל שבוע. 
  • האם זה שכפול פשוט של Plan או אובייקט אחר? תלוי במקרה – אבל אל תשללו את האופציה שמדובר באובייקט דומה אך אחר. אובייקט כזה נקרא גם Protocol (נוהל החוזר על עצמו, מונח מקובל בשירותי-בריאות). השם מעט מוזר לפריטים אהובים מהסופרמרקט, אך יותר הגיוני אם מדובר בצורת תשלום שחוזרת על עצמה, נניח PaymentPlan מול PaymentProtocol.

סיכום

מזמן רציתי לכתוב על Analysis Patterns, כלומר Patterns של מידול מערכת.
אני מוצא אותם מאוד שימושים ומעניינים. בעבר, בעידן המפלים והדינוזאורים, היה מקובל לבצע מידול לפני התכנון המערכת הטכני – ולשלב הזה קראו Analysis. היום אנו מבצעים מידול כחלק מהתכן הטכני של המערכת, וגם תוך כדי ריצה, וגם בדיעבד – ולכן השם Analysis Pattern קצת לא מתאים. הייתי קורא להם Modeling Patterns.

שיהיה בהצלחה!

קוטלין (Kotlin) למפתחי ג’אווה ותיקים – חלק ז’: הספריה הסטנדרטית, וכתיבת קוד אלגנטי

אם עקבתם עד עכשיו אחר הסדרה, כנראה שיש לכם ידע משמעותי כבר בקוטלין – אבל יהיה עליכם עדיין קשה להבין קוד קיים בקוטלין בגלל חוסר אחד עיקרי: הפונקציות של הספריה הסטנדרטית – שנעשה בהן שימוש רב.

Scope Functions

נתחיל בפונקציות ה”חדשות” ביותר למפתחי ג’אווה – או כך לפחות נדמה לי: ה scope functions.
הדמיון הרב ביניהן – הוא דיי מבלבל!

נפתח בהגדרות:

הטבלה כאן כ reference – ולא כדי לנסות ולשנן.

את הפונקציה ()with, אני מניח שכולם מכירים. אני זוכר אותה עוד מימי Object Pascal…

הפונקציה ה”כמעט-תאומה” שלה היא apply:

  1. כפי שאתם רואים הן דיי דומות: משתמשים בהן כאשר רוצים לבצע שורת פעולות על ביטוי מורכב (או סתם משתנה עם שם ארוך), כאשר:
    1. ב with שולחים את הביטוי כפרמטר.
    2. ב apply – כ extension function על הביטוי.
  2. יש גם הבדל בערכי ההחזרה:
    1. הביטוי של with יחזיר את ערך (כלומר: ה evaluation) של הבלוק.
    2. הביטוי של apply יחזיר את האובייקט עליו הופעלה apply.
  3. זה כל ההבדל? בשביל זה יצרו שתי פונקציות כ”כ דומות?
    האם apply היא פשוט עבור עצלנים שלא מסוגלים לעשות extract variable?!
  4. ובכן… דווקא ערך ההחזרה הוא החשוב – המאפשר ב apply לשרשר את הפעולה. זה מתאים לשרשרת פעולות שכבר אין לכם “ביד” את ה reference לאובייקט המדובר – ואז apply מאפשרת את המשך השרשור.
הפונקציה הבאה שנפגוש, ()run – עשויה להישמע קצת מוזרה: היא רק מריצה בלוק.
את הבלוק שתתנו לה – היא תריץ.
מה הטעם בכזו פונקציה? למה היא שימושית?!
טוב… הדוגמה הראשונה באמת מעוררת השתוממות.
הדוגמה השניה – מסבירה את העניין:
כאשר אתם מריצים את run – אתם יוצרים scope חדש/נוסף להרצה.
אם אתם רוצים להימנע מלכלוך ה scope שלכם, למשל במשתנה temp – הפונקציה run תאפשר לכם לעשות זאת בצורה אלגנטית. שימוש ב run מצהיר בצורה מפורשת: “temp קיים רק עבור הפעולה הקצרה הבאה – ואינו רלוונטי להמשך הקוד”
זה עובד עבור הדוגמה הקטנה הזו – אבל יכול לעבוד גם בדוגמאות מורכבות יותר.
קיימת גם פונקציית run שרצה כ extension function, הדומה קצת apply:
run המקבלת למבדה מתאימה, כמו apply, לפעולות שרשור – אבל ערך ההחזרה שלה הוא ה evaluation של הבלוק.
היא שימושית כאשר יש שרשור, ואנו רוצים לבצע חישובים על האובייקט ואז להחזיר ערך – למשל: פונקציית ה ()genrate בדוגמה שסיפקתי.
כמו apply – היא “חיה” ב scope של האובייקט (כי היא extension function), ולכן קיימת גישה לפרמטרים של האובייקט.
אפשר לראות אותה בדוגמה הקאנונית מלמעלה – דיי דומה ל apply.
בכל אופן, הדוגמה הראשונה (Password generator) היא הדוגמה המציאותית יותר – ובמיוחד אם מדובר בשרשור.
שאלה: האם ()x.applyAndReturn היה יכול להיות שם מוצלח יותר ל ()x.run?
הגענו לזוג האחרון: let ו also.
הפונקציה let דומה לפונקציה map, כאשר היא פועלת על איבר יחיד.

במקום להיות extension function, היא מעבירה את האובייקט עליו היא פועלת – כפרמטר (it).

היתרון שבכך?

במידה ואתם רוצים בבלוק להתייחס ל this – האובייקט החיצוני. פונקציות כמו apply עושות shadowing ל this המצביע לאובייקט בו רצים. let לא עושה זאת.
כמו כן, let מחזירה את ה evaluation של הבלוק.
שימוש נפוץ ב let הוא כתיבה קצרה להגנה בפני null:
  1. הדוגמה הזו נכשלת בקומפילציה: מכיוון שמדובר ב property ולא משתנה “אטומי”, ייתכן ומאז בדיקת ה null ועד להפעלת הבלוק – ייכנס ל property ערך אחר null-י ש”יפיל” אותנו.
  2. דרך אחת בטוחה היא להעתיק עותק מקומי למשתנה – ולבדוק אותו. הכי טוב val.
  3. דרך יותר קצרה ואלגנטית, היא השימוש ב let: הפונקציה מוערכת ברגע אחד מסוים – כשה evaluation של הביטוי עליה פעלה כבר בזיכרון:
    1. אם ה evaluation הוא null – כל הבלוק לא ירוץ.
    2. אם ה evaluation אינו null – הבלוק ירוץ, וניתן להתייחס ל it בבטחה כ not-null.
שם אפשרי אחר לפונקציה ()let היה יכול להיות ()ApplyItAndReturn.
בקוטלין 1.1 הוסיפו פונקציה בשם also (כלומר: גם כן שם “אינטואטיבי”), הפועלת כמו let – אבל מחזירה את ערך הביטוי עליו פעלה.
היתרון: היכולת לשרשר.
אני אשאיר לדימיון שלכם לתת לה שם יותר משמעותי….
בקרוב תצא קוטלין 1.2 עם פונקציות ה scope החדשות: ()due(), just  ו ()bound.
סתתתאאאם! 😉

Streams

במשך שנים ג’אווה “חטפה” על היותה שפה verbose. בסה”כ מתכנני-השפה ניסו לתכנן שפה שבה הכל מפורש וקריא – אבל התברר שהם “הגזימו” עם המפורשות של השפה.

אחת הנקודות הכואבות ביותר הייתה היכולות “הפונקציונליות” של שפות כמו פייטון, רובי, או סקאלה: היכולת לעבד נתונים בקלות בעזרת פונקציות כמו filter, map, או max.

בהשוואה בזכוכית מגדלת, כל מימוש “פונקציונלי” היה קצר פי כמה – מהמימוש המקביל בג’אווה.

בג’אווה השתפרו עם הזמן, ובג’אווה 8 הציגו את יכולות ה Stream – יכולות פונקציונליות בשפת ג’אווה ועל גבי ה Collections הסטנדרטיים שלה… עם כמה wrapper שנדרשים.

אי אפשר היה להתעלם מצהלת השמחה בקהילת הג’אווה, שחשה גאווה רבה:

אמנם צריך להוסיף את המילה המעצבנת stream, וגם Collector לפעמים – אבל זה היה בהחלט נסלח, מול היתרונות.

האמת?

קוטלין הוציאה גם פה את ג’אווה באור לא מחמיא. היא מצליחה לפשט משמעותית תחביר ה stream של ג’אווה לתחביר נקי הרבה יותר.

למשל, הדוגמה הלא-מחמיאה הבאה:

יכולה להיכתב בקוטלין כך:

השילוב של ה Collections של קוטלין, ויכולות השפה (פרימיטיביים הם אובייקטים, extension functions, ועוד) – הופכות את היתרון -> למשמעותי מאוד.

הערה של קורא: נכון: הדוגמה של קוטלין עושה רק print ולא println ולכן היא קצרה יותר. טעות שלי.

חזרה על עקרונות הבסיס של Streams

ביטוי סטרימי (Stream-י) יהיה בנוי מ:

  • מקור: מקור נתונים. בדר”כ מבנה נתונים מאולס של Java שהופעלה עליו הפונקציה ()stream או Stream שנוצר במיוחד.
    • ה Stream עשוי להיות “אינסופי” (למשל: רצף מספרים אקראיים) ולכן ניתן להגביל את מספר האלמנטים בהם רוצים לטפל בעזרת הפונקציה ()limit.
    • רצפים אינסופיים ניתן לייצר בעזרת פונקציית (Stream.generate(lambda – כאשר lambda מספקת את הערך הבא, או (Stream.iterate(lambda – כאשר lambda מספקת את הערך הבא, תוך כדי שהיא מקבלת את התוצאה הקודמת כפרמטר.
  • פעולות ביניים (Intermediate Operations)
    • אלו פעולות שמקבלות Stream ומחזירות Stream – כך שניתן לשרשר אותן, ולהרכיב אותן זו על זו – בכל הרכב שנבחר. למשל: (…)filter(…), map, או (…)limit.
    • באופן מעשי, הפעולות לא מחויבות לפעול ברגע (או סדר) ה evaluation שלהן – כך שמתכנני מגנון ה Streams יכולים להוסיף אופטימיזציות שונות.
    • מה שיגרום לשרשרת הפעולות להתחיל ולפעול – הוא המצאות פעולת הסיום.
  • פעולת סיום (Terminal Operation) היא התוצאה המצופה מן כלל ביטוי ה Stream.
    • זוהי פונקציה שמקבלת Stream אבל לא מחזירה Stream (בהכרח). למשל: ()sum(), findFirst, או ()findAny.
      • השם findFirst הוא קצת מבלבל: למה צריך “לחפש” את האיבר הראשון?
        • בפועל: לא מחפשים אותו (זמן הריצה יהיה (O(1) – אבל זהו אילוץ שמחייב את ה Stream לשמור על סדר האיברים.
        • כאשר מפעילים את ()findAny – אין אילוץ כזה. בד”כ יחזור האיבר הראשון, אבל לפעמים יחזור איבר אחר מהרשימה (אם הופעלה איזו אופטימיזציה).
    • פעולות סיום נפוצות אחרות הן:
      • (forEach(lambda – שיכולה לבצע פעולה שרירותית כמו הדפסה של האיברים, אבל אחד אחרי השני ולפי הסדר.
      • (reduce(lambda – שיכולה לבצע “סיכום של תשובה” כאשר מגיעים אליה 2 פרמטרים: תשובה חלקית, והאיבר הבא (נניח: חישוב ממוצע מסוג מסוים). בשימוש בה – ניתן לבצע אופטימיזציות על ה Stream.

חשוב לציין גם ש streams הם Immutable ולכן ניתן למקבל חלק מהפעולות שלהם. עבור streams ארוכים – זה עשוי שיפור ביצועים ממשי (אבל גם: לא תמיד).

קוטלין מימשה מנגנון Steam משלה, שנראה מאוד דומה – אך בנוי באופן מובנה על ה collections של השפה.
המימוש ה default-י של streams בקוטלין אינו כולל lazy evaluation ואופטימיזציות או יכולות מקבול כמו בג’אווה. אפרט עוד על ההבדלים בהמשך.
את תחביר ה Streams בקוטלין מפעילים ללא פעולת ה ()stream – בכדי להתחיל stream, ולא צריך את פעולות ה ()collect על מנת להמיר אותו חזרה ל collection ולטפל בטיפוסים שונים:

בקוטלין אפשר פשוט לסיים את פעולת ה Stream ב ()toList בכדי לקבל רשימה.
רוצים מערך? השתמשו ב: ()toList().toTypedArray.

מפה? השתמשבו ב ()associate  או ()associateBy:

גם נושא האינדקסים סודר בקוטלין, ויש פונקציות (למשל: ()mapIndexed) המאפשרות לגשת לאינדקס האיברים ב stream.

האמת: עברתי על 10 השאלות הנפוצות של התג “java-stream” באתר stackoverflow כדי לראות במה כדאי לעסוק בפוסט – ובקוטלין כיסו בצורה אלגנטית את כל הבעיות שהופיעו ב 10 השאלות הללו. נראה לי שגם הם הסתכלו – על אותה הרשימה בדיוק.

הפעולות בקוטלין בעלות שמות זהים ברוב המקרים. הנה כמה הבדלים:

  • findFirst ו findAny נקראות first ו any – בהתאמה.
  • limit נקראת בקוטלין take.
  • peek (כמו forEach, רק שמחזירה Stream) נקראת בקוטלין onEach (שם יותר ברור- לטעמי).

מעבר לכך – הטיפול ב Streams הוא ממש דומה.

בואו נראה קצת דוגמאות:

  • flatmap היא שימושית כמובן כאשר אנו מפעילים פונקציה שמייצרת רשימה – אף אנחנו רוצים את האיברים שבה, או כאשר אנחנו רוצים להפוך איבר אחד ב stream – למספר איברים.
  • חשוב לזכור ש filter משאיר (ולא מסיר) – את מי שעומד בתנאי.
    • filterNot – מסיר.
  • ()takeLast הוא ההופכי ל take, ו ()drop – הוא המשלים.
  • ()takeWhile ימשיך לקחת איברים כל עוד הפרדיקט נכון. ברגע שנתקל בתנאי שלילי – הוא יעצור.
הנה כמה פעולות סיום נפוצות:
  • כמה פעולות סיום, כמו ()last ו ()first מופיעות ב 2 צורות: כפונקציה ללא פרמטרים, או כפילטר עם הפעולה מובנה.
    • הצורה האידיומטית היא צורת הפילטר – כאשר זה אפשרי.
  • ()single תזרוק Exception אם לא נמצאו איברים, או שנמצא יותר מאיבר אחד.
    • יש גם גרסאת ()singleOrNull – שפשוט מחזירה null.
  • ()fold היא ()כמו reduce, רק שהיא מקבל כפרמטר ערך התחלתי לעבוד עליו. במקרה שלנו – אפס.
    • יש גם ()foldRight שפשוט תפעיל את הפעולה בסדר הפוך: מהאיבר האחרון – לראשון. במקרה של חיבור התוצאה תהיה זהה.

לביטוי סטרימי יש overhead של ביצועים. בקוטלין מדובר בעיקר בשימוש של ביטויי הלמבדה – שגורמים לעוד הפעלות של פונקציות. ברוב השימושים הנפוצים (לא עשרות-אלפי איברים, לא עשרות הפעלות בשנייה) – ה overhead הזה הוא שולי מול קריאות הקוד שמושגת.

חשוב לזכור שהסיבה להשתמש בביטויי למבדה היא להפוך את הקוד לקריא יותר – ולא להפגין יכולות אישיות גבוהות של תפיסת לוגיקה מורכבת.
כאשר הביטוי מתחיל להיות מאתגר לקריאה, בחייאת דינאק: פרקו אותו לכמה ביטויים פשוטים יותר.
החלוקה הזו, וגם פעולות כמו ()onEach, יכולות לעזור לכם ב debugging – כאשר נדרש.

Late Evaluation

בכל זאת, יכולים להיות מצבים בהם יש לנו רשימה ארוכה של איברים, ואז הפעלה של ביטויים סטרימיים מורכבים מהווים overhead רציני. למשל: stream של עשרות אלפי איברים, כאשר לא כל פונקציה צריכה לפעול – כי לוקחים בסוף רק את האיבר הראשון.

לצורך כך בקוטלין יש מנגנון דומה לזה של ג’אווה של lazy evaluation הנקרא Sequences (שם שונה על מנת למנוע התנגשות בשם מחלקות).

בקוד הקוטלין, כל מה שצריך להוסיף הוא ()asSequence בתחילת הביטוי.
הפונקציה asSequence  ממירה את ה collection ל lazily evaluated sequence, בדומה ל Steam של ג’אווה.

לאובייקט ה Sequence יש מימושים מתאימים ל filter, map, first ועוד – כל הפונקציות שיכולות לאפשר מצב של אופטימיזציה.

למשל בדוגמה: במקום לרוץ על 5 מיליון איברים ולסנן מי גדול מאפס, ואז לקחת חמש מיליון איברים ולבדוק מי ראשון, ב sequence עובדים ב batches של יחידים: לוקחים איבר, בודקים אם הוא גדול מ 0 – ואז ממשיכים הלאה.
כאשר ה terminator מסופק – מפסיקים, ומכאן שיפור הביצועים.

המחיר של השימוש ב sequence הוא שלא יהיו לנו זמינות סט הפעולות שלא יכולות לעבוד במוד של lazy eval כמו ()takeLast או ()foldRight. במקרים מעטים, בהם יש עבודה אינטנסיבית שנהנית מ memory / resource locality – ה Sequence עלול להיות פחות יעיל.

בקוטלין יש עוד כלים ל lazy evaluation כמו הפונקציה הסטנדרטית lazy או המילה השמורה by – אבל זה נושא לפוסט אחר.

במידה ואתם כותבים תשתית חישובית ל big data, רוצים parallel streams – עליכם להשתמש בתשתית ה Streams של ג’אווה (עדיין אפשר לכתוב את הקוד בקוטלין).

סיכום

הפונקציות שהצגתי בפוסט הן פשוטות ברובן – אך יכולות להציג שיפור מיידי ומשמעותי על קריאות הקוד שלכם.
חבל לעבוד בקוטלין – ולא להשתמש בהן!

שיהיה בהצלחה!

רברסים 2017 – הרצאה על Software Design

ההרשמה לרברסים 2017 נפתחה!

לעניות דעתי – זה הכנס הטוב ביותר בהייטק הישראלי.

אני מרצה על Software Design (ראשי התיבות הם סתם המצאה – אין ראשי תיבות כאלו מקובלים), ובמקביל לחיים ידיד – שעובד איתי!

אם אתם מגיעים לכנס – קפצו להגיד שלום!

ליאור

קוטלין (Kotlin) למפתחי ג’אווה ותיקים – חלק ו’: Collections ו Generics

הפעם נדבר על Collections ו Generics – נושאים שעברו כמה התאמות מהגרסה הג’אווה-ית.

Generics – תזכורת

מהם בעצם Generics (“חסרי ייחוד”)?
הותיקים-באמת שביננו זוכרים את הימים של Java 1.4 בה כל collection בשפה היה מטיפוס Object. בכל שליפה של איבר מתוך הרשימה – היה צריך לבצע פעולת Down-Casting.

בעזרת Generics יכולנו להגדיר טיפוס למבנה הנתונים, ואז להפסיק לדאוג להם.

בשל שיקולים של תאימות-לאחור, ה generics בג’אווה (וליתר דיוק: ב JVM) הם ברמת הקומפילציה (ולא ה runtime). יש שלב של הקומפיילר בשם Type Erasure בו הוא מוחק את ה generics, ומחליף אותם במבני-נתונים מסוג Object עם down-castings מתאימים + מוסיף בדיקות שפרמטרים שהוזנו למתודות הם מהטיפוס הנכון.

זהו. זה כל מה שמפתח צריך לדעת על Generics, לא?!

יש קצת יותר.
אפשר להשתמש ב generics במחלקות שלנו, ולא רק ב Collection המסופקים ע”י ג’אווה.

למשל, אני רוצה לממש Repository כללי בנוסח DDD – אבל אם אשתמש ב Any בתור טיפוס, לא אוכל להתייחס לתכונות הספציפיות של האובייקטים שבהם אני משתמש.

  1. מי ששולף Entities מה Repository צריך לעשות downcasting – בקוטלין, בעזרת המילה השמורה as.
  2. אין בדיקה ברמת הקומפילציה שאני שולח ערכים רלוונטיים לפונקציות… אאוץ.
  3. אני לא יכול בתוך המחלקה Repository להתייחס לתכונות הספציפיות של האובייקט שאני רוצה להשתמש בו.
כאשר אני משתמש ב Generics – הדברים נראים אחרת:
  1. אני מגדיר ב scope של ה class טיפוס בשם T, ממש לפני הגדרת המחלקה שבסוגריים המסולסלים.
    1. אני יכול להשתמש עכשיו ב T במקום טיפוס, בכל מקום בקוד של המחלקה.
    2. ברגע שייווצר instance של המחלקה הזו, טיפוס מסוים היה קשור אליה, וכל התייחסות ל T – בעצם “תוחלף” ע”י הקומפיילר בטיפוס שהוגדר.
  2. אין צורך להצהיר על downcasting מתודות שליפה. הקומפיילר דואג לכך.
  3. הקופיילר יאכוף שהערכים שנשלחים הם מהטיפוס הנכון.
  4. עדיין אני לא יכול לגשת בתוך המחלקה לתכונות של הטיפוס הספציפי.
  5. זה נפתר ע”י כך שאגדיר את הטיפוס: T היורש מ Entity.
    1. הקומפיילר יוודא שטיפוסים שנקשרים למחלקה יורשים מ Entity.
    2. כך בתוך קוד המחלקה, אוכל להניח של T יש את כל התכונות / פונקציות הזמינות של Entity.
  6. שימו לב ש T כברירת מחדל הוא מטיפוס ?Any. אם ארצה שהטיפוס יהיה לא-nullable יהיה עלי להגדיר:
אפשר להגביל את הטיפוס הגנרי (“T”) אף יותר, ולחייב שירש / יממש יותר ממחלקה – כלומר: גם ממשקים. את האכיפה הזו עושים בתחביר המשתמש במילה where:
  1. רק טיפוס שגם יורש מ Entity וגם מממש את הממשק Comparable – יוכל להיקשר למופע של המחלקה.
  2. where הוא המקביל של קוטלין לצורה  של ג’אווה.

מדוע משתמשים ב “T” לתאר את הטיפוס הלא ידוע? מתי יש שמות אחרים?
הקונבנציה אומרת ש:

  • T – אם יש משתנה אחד.
  • S – אם יש משתנה שני, U – אם יש משתנה שלישי, ו V – אם יש משתנה רביעי.
    אפשר לזכור את הסדר כ “SUV” – השם האמריקאי ל”ג’יפון עירוני”.
  • K ו V – אם יש צמד key  ו value, למשל ב Map.
  • E – כדי לתאר אלמנט במבנה נתונים.
  • N – לתאר טיפוס שהוא מספר.
  • R – לתאר טיפוס החזרה (return value).

“חורים” ב Generics

בג’אווה קיימת הבעיה הבאה:

אני יכול להגדיר מבנה נתונים מסוג <List<String, בכדי לקבל הגנה של הקומפיילר.
אבל… אם המתודה שלי, במקרה הזה ()unsfaeAdd (שעשויה להימצא במקום אחר ומרוחק בקוד), מצהירה על ממשק כללי List (להלן “raw type”) – הקומפיילר יאשר את הקוד: הרי <List<String הוא List – חייבים זאת עבור תמיכה לאחור.
הממשק List מתאר מתודה (add(Object o המקבלת אובייקט מכל סוג – מה שיאפשר לי להכניס גם אובייקטים מסוג אחר לרשימה. הכישלון בזמן ריצה יהיה רק ברגע השליפה, כאשר מנסים לעשות casting (שהוסיף הקומפיילר לקוד):
אאוץ! סמכתי על הקומפיילר ומנגנון ה Generics – אך עדיין “חטפתי” שגיאה.
מכיוון שהנפילה היא רק בזמן השליפה – זה עשוי להיות באג מעצבן, שקשה לאתר.

Variance

הפתרון המקורי של ג’אווה היה להוסיף כלי שנקרא wildcard (מסומן כ ?).

במתודה שלי (נניח שהיא במקום מרוחק בקוד) אני מצהיר שאני מקבל רשימה – אבל לא יודע באמת מה הטיפוסים שמאוחסנים בה (List נקרא כ “List of some type”). הקומפיילר לכן יאפשר לי לבצע רק פעולות שליפה – אך לא פעולות השמה. זוהי בעצם הגנה בפני התנהגות לא צפויה.

נראה שה wildcard – בלבל לא מעט מפתחי ג’אווה. נראה שעבור אחוז ניכר של מפתחים – זהו נושא שעדיין לא ברור עד הסוף, בעיקר: מתי ואיך להשתמש בו.

בכלל, כמה אנשים נוחים עם ההגדרה הבאה?

בסה”כ מדובר בספריה הסטנדרטית של ג’אווה: (…)Collections.min. נרצה בוודאי להבין מה שכתוב בתיעוד.

אנחנו מכירים כבר את &, ועד סוף הפוסט, הביטוי (המורכב) הזה – יהיה ברור לחלוטין.

אם נדבר בשפה פורמאלית, אזי String הוא variance של Object – כי הוא יורש ממנו, אבל <List<String הוא invariant של <List<Object – כי הוא לא יורש ממנו (הוא יורש מ <Collection<String).

הפתרון של קוטלין לבעיה הנ”ל הוא מעט אחר, ומוממש כחלק מהספריה הסטנדרטית.
הספריה הסטנדרטית (stdlib) של קוטלין היא קטנה בהגדרה (כ 750KB) – ומכילה התאמות לג’אווה.

בגזרת ה collections, קוטלין לא מציגה collections חדשים מאלו של ג’אווה (Set, Map, Array, List) – אלא רק עוטפת ומרחיבה אותם (פעמים רבות – בעזרת extension functions).

קוטלין מספקת ממשקים למבני-נתונים (Map, List) מ-2 סוגים:

  • Immutable Interfaces – שהם ברירת המחדל, כאלו שניתן רק לשלוף מהם.
    • למשל:<List<E ו <Map<E
  • Mutable Interfaces – כאלו שניתן לבצע בהם גם שינויים.
    • למשל: <MutableList<E  ו <MutableMap<E
התחליף של קוטלין, אם כן, ל wildcard של ג’אווה הם immutable interfaces.

בהגדרת הפונקציה unsafeAdd קוטלין לא מרשה לי להשתמש ב Raw type כמו List – אלא רק במבנים עם הגדרה גנרית.

הנה אנסה כמה תצורות נוספות:
  1. כאן יש שגיאת קומפילציה: ניסיתי להוסיף איבר למבנה נתונים שהוא immutable – אסור. זוהי ההגנה המקבילה ל wildcard.
  2. כאן הגדרתי שאני רוצה מבנה נתונים שניתן לבצע בו שינויים. אבל מה? מכיוון שהגדרתי את list מטיפוס String – הקומפיילר לא מוכל לקבל any.
  3. הנה התיקון – ביצעתי המרה מסודרת של o למחרוזת – והכל תקין.
הפתרון של קוטלין, להגדיר immutable collections הוא פשוט יותר מהפתרון של ג’אווה, הוא לכאורה “לא מפורש”.
הסמנטיקה של immutable collections שימושיים למדי גם ל “functional-like programming” ול concurrency.
corner case שכן הפסדנו בקוטלין, הוא היכולת לעשות ()clear או ()remove ל collection המכיל איברים מסוג לא ידוע. אין סכנה להסיר איברים מסוג “לא ידוע”, ולכן ניתן לעשות זאת ב List, אבל לא ניתן לעשות זאת ב immutable list.
Tradeoff הגיוני, לדעתי.
אוקיי. פתרנו מקרה אחד בעייתי של Generics, אבל יש עוד מקרה בעייתי:
נ.ב. – קוד דומה גם לא יתקמפל בג’אווה
הרי: Int הוא מספר (יורש מ Number) – ולכן אני מצפה שהקוד תעבוד.
הבעיה: <Array<Int אינו יורש מ <Array<Number – הם invariants.
Immutable collection לא יעזור כאן. מה עושים?

Covariance & Contravariance

נפתח בהגדרה.

מבנה גנרי כלשהו Something המקיים ש:

  • טיפוס T הוא  subtype  של טיפוס A
  • וגם ניתן להתייחס ל <Something<T כ  subtype  של <Something<A

נקרא covariance.

בג’אווה אפשר להגדיר קשר של covariance בצורה הבאה:

Something

אנו משתמשים ב ? ולא T – כי אנחנו לא רוצים להתייחס לטיפוס ספציפי בקוד: כל פעם יכול בעצם להופיע טיפוס אחר, שמרחיב את A.

הנה דוגמה:

מה ניתן לעשות במתודה ()foo?

קריאה

  • אפשר להתייחס לכל איבר בשלושת הרשימות כ Number – כולם כאלה.
  • אי אפשר להתייחס לכל איבר בהכרח כ Integer – כי אז “אפול” בטיפול ב list3.
  • אי אפשר להתייחס לכל איבר בהכרח כ Double – כי אז “אפול” בטיפול ב list2.
כתיבה
  • לא ניתן להוסיף לרשימה Integer – כי אז “אפול” ב list3.
  • לא ניתן להוסיף לרשימה Double – כי אז “אפול” ב list2.
  • לא ניתן להוסיף לרשימה גם Number – כי אז “אפול” ב list2 וב list3 המחייבות טיפוסים ספציפיים (אחרת ניפול בשליפה + casting, כמו בדוגמה למעלה).
Generics. הקומפיילר יעזור למנוע טעויות.

Contravariance

הקשר בו מבנה גנרי כלשהו Something מקיים ש:

  • טיפוס T הוא  supertypeשל טיפוס A
  • וגם ניתן להתייחס ל <Something<T כ  supertypeשל <Something<A

נקרא contravariance.

בג’אווה אפשר להגדיר קשר של covariance בצורה הבאה:

Something

בואו נשתמש בדוגמה:

מה ניתן לעשות במתודה ()goo?

קריאה

  • אי אפשר להתייחס לכל איבר בהכרח כ Integer – כי list2 ו list3 לא מכילים Integers בהכרח.
  • אי אפשר להתייחס לכל איבר בהכרח כ Number- כי list3 מכיל אובייקטים שונים.
  • ניתן רק להתייחס לאיברים כ Object – כי תמיד הם יהיו כאלה.
כתיבה
  • ניתן, מן הסתם, להוסיף לרשימה Integers – כי כל הרשימות יכולות להכיל Integers – בהגדרה.
  • ניתן להוסיף subtypes של Integer לו היו: למשל, אם היה PositiveInteger שהיה subtype של Integer.
  • לא ניתן להוסיף Double או Number, וגם לא Object – כי תהיה לנו את list1 שבה מתבצעת בדיקה שנכנסים רק Integers (או subtypes), כדי להימנע מהבעיה של שליפה + casting שראינו למעלה.
Generics. הקומפיילר יעזור למנוע טעויות [א].

ובחזרה לקוטלין…

הסמנטיקות של ג’אווה,  extends A ? ו super B ? הן מוצלחות בלהזכיר מתי ? יורש מ A, או מתי הוא אב של B – אבל לא כ”כ מוצלחות בלהזכיר לנו את ההתנהגות הצפויה: מה מותר לקרוא ומה מותר לכתוב. זה לא self-explanatory.

בכדי לעזור לזכור, ג’ושוע בלוך הציג את הכלל הבא: “Producer Extends, Consumer Super”, או בקיצור PECS.

הווה אומר:

  • אם המבנה הגנרי מספק ערכים (Producer / אנו קוראים ממנו) – השתמשו ב extends, ויהיה לנו אסור להוסיף פריטים לרשימה.
  • אם המבנה הגנרי צורך ערכים (Consumer / אנו כותבים אליו) – השתמשו ב super, אך לא נוכל להסתמך בקריאה על איזה טיפוס יצא.

בקוטלין הטמיעו את הכלל הזה כבר בשפה, בדמות התחבירים:

  • Something<out T>   ==> producer
  • Something<in T>   ==> consumer

במקום לחשוב איזה טיפוס לא ידוע ירחיב או יירש מ T – אנו פשוט מצהירים:

  • האם אנחנו מתכוונים לשלוף ערכי T (או בנים שלהם) – בשימוש ב out.
  • או האם אנחנו הולכים להכניס למבנה ערכי T (או אבות שלהם) – בשימוש ב in.

עכשיו צריכים כלל הפוך שיזכיר לנו: “בחוץ – נמצאים אני והילדים, בפנים – אני והאבות שלי”. (דמיינו מסיבת יומולדת).

כמובן שאנחנו יכולים גם להסתפק בתחביר הפשוט <Something<T שאומר – שליפה והכנסה יעשו בדיוק עם הטיפוס T. ברוב המקרים של שימוש ב generics אין באמת צורך להשתמש ב variants.

בואו נראה את in ו out בשימוש. הנה למשל ההגדרה של הממשק List:

מכיוון ש List הוא Immutable, הגדירו את המבנה הגנרי  – וכך ניתן לשלוף E או sbutypes של E בצורה בטוחה.

את Mutable List הגדירו בדיוק על הטיפוס E, כלומר: המבנה לא יקבל (הכנסה / הוצאה) – טיפוסים ששונים מ E. זה לכאורה “פחות גמיש” אבל זו הגנה חשובה בפני מקרי-קצה בעייתיים.

אם ג’אווה (ליתר דיוק: ה JVM) היה תומך ב reified generics, כאלו שנושאים metadata ב runtime – ההתעסקות הזו הייתה נחסכת מאיתנו. זה המחיר ששילמו בג’אווה 5 על מנת לספק generics עם תאימות לאחור לקוד ישן יותר.

ה Variance בקוטלין הוא declaration-site variance, כלומר: כזה שנקבע בשלב ההגדרה – כמו ב  < List<out E שראינו למעלה. הקומפיילר “קשר” את הטיפוס E (או בנים שלו) למופע הרשימה – ואין צורך להצהיר על זה יותר.

בג’אווה ה variance הוא use-site variance, כלומר יש מגדירים את ה variance על השימוש – על המתודה. למשל.
הנה המתודה ()addall של המחלקה Collection:

הגדרתי עליה שאני מצפה לרשימה אחרת c המכילה את E או בנים שלהם – כי אני מתכוון רק לצרוך אותם.

ההגדרה הזו עשויה להוות שכפול קוד (אני מגדיר אותו variant על מתודות רבות), אך היא מאפשרת לי גמישות להגדיר variant אחד שונה על מתודה ספציפית שבחרתי.

מה עושים בקוטלין?

Type Projections

בקוטלין ניסו לצמצם שכפול קוד, ולכן ברירת המחדל היא declaration-site variance, אך אם צריך – ניתן גם להשתמש ב use-site variance. הנה דוגמה:

ל SomeStructure קשור טיפוס T כלשהו – אבל אני יכול להחליט שבפונקציה copy אני מצפה למבנה של T או supertypes שלו – לקריאה בלבד.  הדוגמה הייתה עובדת גם אם SomeStructure היה קשור ל .

אמנם MutableList קשור לערך מדויק (כפי שראינו למעלה), אבל כאן מדובר בסוגי ה MutableList שיכולים להישלח לפונקציה, כיחס ל T הקשור למחלקה. אין כאן קשר להגדרה של MutableList עצמו.

שימו לב שלא קשרנו טיפוס חדש T על המתודה (כפי שניתן), אלא השתמשנו בטיפוס T הקשור למופע המחלקה.

אם אני רוצה לוודא בפונקציה אם טיפוס מסוים הוא מבנה גנרי מסוג מסוים אני יכול לשאול:

if (x is Collection) …

הכלי הזה נקרא star projection והוא מקביל להגדרה ?out Any וגם in Nothing.

Reified Generics in Kotlin

היינו רוצים reified generics – אך החלטות design של ה JVM לא מאפשרות זאת.
בקוטלין, בכל זאת, התירו שימוש ב reified generics בפינה קטנה, שעשויה להיות שימושית לפעמים.

כאשר יש פונקציה שהורינו לקומפיילר לעשות לה inline – הקומפיילר יכול לאפשר בה שימוש ב reified generics – כאלו שיהיו זמינים ב runtime. למשל:

  1. כאשר הערך T קשור לפונקציה, מה יותר טבעי מלבדוק אם משתנה מסוים הוא מאותו הסוג?
    1. אופס! … T קשור רק בזמן קומפילציה ואז הוא נמחק. הוא לא זמין ב runtime ולכן לא ניתן לבצע reflection: הקומפיילר פשוט לא יכול לנתח איזה ערך יישלח בזמן הרצת התוכנה.
  2. כאשר אני מגדיר את T כ reified – הקומפיילר יודע לבצע את האנליזה המתאימה כאילו יש לי את המידע ב runtime.
    1. זה יכול לעבוד רק על פונקציה שהיא inline.

לא ניתן לקרוא מקוד ג’אווה לפונקציה שהוגדרה כ reified: בכל מקרה הפונקציה היא inline והקומפיילר של ג’אווה לא ימצא הגדרה של פונקציות inline ב class files.

ולקינוח…

זוכרים את הביטוי המורכב של ()Collection.min בספריה הסטנדרטית בג’אווה? – בואו נוודא שאנחנו מבינים אותו, עד הפרט האחרון.

ליתר ביטחון, הוספתי עוד חתימה פשוטה של פונקציה – שתזכיר לנו איך נראית פונקציה גנרית פשוטה בג’אווה:

  1. ראשית קושרית בסוגריים משולשים טיפוס או טיפוסים ל scope של הפונקציה.
    1. האם יש טעם להצהיר T extends Object? זה לא מיותר?
      1. לכאורה כן: ההגדרה <T> שקולה ל <T extends Objects> כשהיא מופיעה לבדה.
      2. כאשר יש הגבלות (&), אם לא נצהיר על Object, ה erasure יתבצע להגבלה (Comparable) – שחסרה כמה מהתמודות של Object. בקוד הזה החליטו לקבוע erasure ל Object (שהוא גם Comparable שאליו קשור טיפוס לא ידוע שהוא supertype של T).
  2. ערך ההחזרה של המתודה (…)min הוא T. פשוט מאוד.
  3. שם הפונקציה.
  4. רשימת הפרמטרים. במקרה שלנו אנו מקבלים Collection אחר, של איברים לקריאה בלבד – שהם T או subtypes של T.
נראה פשוט, לא?

סיכום

לולא ה wildcard של ג’אווה – הפוסט הזה כנראה מתקצר לשליש, אך היה חשוב לי לכסות גם את הנושא הזה.
אני פשוט מניח שללא מעט קוראים שעובדים בג’אווה – עדיין היה מה להשלים בנושא הזה.

אני מקווה שהצלחתי להתיר את הסיבוכיות מהנושא הזה – ולהציג אותו “פרוש על השולחן” בצורה קלה וברורה.

שיהיה בהצלחה!

—

[א] שווה לציין: