כיצד מגדירים ארכיטקטורה? צעד אחר צעד

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

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

התוצאה: מסר יותר חד ("כך כותבים קוד נקי!"), בד בבד עם אשליה שאנשים באמת כותבים קוד שכזה "במכה ראשונה".

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

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

תהליך ה"ארכיטקטורה" נראה לפעמים כמעט כמיסטיקה - ואני מקווה שפוסט זה יתיר חלק מהערפל (ואולי גם מההילה).

לצורך התרגיל בחרתי בבעיה קלאסית במדעי המחשב (שאני פחות או יותר פותר בעצמי כרגע כחלק מלמידת שפת רובי): "בעיית שבע המלכות והפרש". כיצד ניתן להציב על לוח שחמט 7 מלכות [א] ופרש מבלי שיאיימו זה-על-זה.

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

בואו נצא לדרך.

כיצד מתחילים להגדיר ארכיטקטורה?

הרי אפשר להיתקע ולבהות ב IDE ("אני בוהה בו, הוא בוהה בי") זמן-מה מבלי להגיע להחלטה כיצד להתחיל.

כאשר יש כיוון - הקוד רץ מעצמו, "7 המלכות והפרש" זה לא באמת "אתגר" תכנותי עבורנו. הקושי לרוב יהיה לבחור כיוון ראשוני לארכיטקטורה.

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

שיטה קטנה אחרת היא כלל שמגיע מתכנון-מונחה עצמים, ו DDD: "המלים בהן אנו משתמשים לתאר את הבעיה 'חייבות' לקבל ייצוג מתאים (מחלקות) במערכת".

אז הנה, קיצרנו לעצמנו מעט - ויש לנו נקודת התחלה כלשהי.
מהם המלים שחוזרות על עצמן בתיאור הבעיה? "מלכה" ו"לוח" (לפחות אצלי):

להבהיר: במיוחד במערכת כ"כ קטנה, במיוחד כשכותב אותה אדם בודד, ובמיוחד בעולם האג'ייל - אין הגיון לייצר תרשימי UML! יצרתי את התרשים רק עבורכם - קוראי הבלוג.

האופן הטבעי לעשות זאת הוא לכתוב קוד מסגרת ראשוני (כלומר: skeleton):

לגבי שפת רובי (הנה פוסט "נחיתה" - למי שלא מכיר), attr_accessor היא דרך מהירה לייצר getter/setters לרשימת ה symbols שהוצמדה לפונקציה. למשל, במקרה של המחלקה Board ייווצר משתנה בשם queens@ שערכו nil, מתודה בשם queens שמחזירה את ערך המשתנה, ומתודה בשם =queens שמאפשרת לבצע השמה לערך בעזרת סימן "=" (להלן הסבר יותר מפורט)

כבר ביצירת השלד הזה - בעצם לקחתי כבר כמה החלטות "תכנוניות" (להזכיר: קוד < תכנון < ארכיטקטורה - אך יש ביניהם דמיון רב).

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

אלו החלטות כבר "לקחתי"?

דילמה: כיצד לייצג את הלוח והכלים עליו

• אופציה א': לוח כמטריצה 8x8 של מערך המחזיק אובייקטים.
• יתרונות: מודל פשוט וקל להבנה
• אופציה ב': ניהול רשימות של הכלים השונים - כאשר כל כלי מחזיק את המיקום שלו על הלוח.
• יתרון: יותר יעיל (טיול על x כלים - שזה מספר קטן מ 64 תאים - בכדי למצוא כלי) - לא משמעותי כאן.
• יתרון: מישהו יצטרך לחשב "איום" של כלי על כלי אחר. זה גורר דילמה אחרת (מייד) - שאת התוצאה שלה, אופציה זו "תקבל" בצורה טבעית יותר.

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

דילמה (forward thinking): כיצד מחשבים איומים של כלי אחד על כלים אחרים

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

• אופציה א': הלוח הוא זה שמחשב איומים בין הכלים
• יתרונות: אני מעריך שאופציה זו תדרוש פחות שורות קוד.
• אופציה ב': כל כלי הוא זה שמחשב את האיומים שלו
• יתרונות: יותר OO, משום ש"הצלחנו למצוא" מומחיות למחלקות. מלכה מומחית בלהכיר את האיומים שהיא מפיקה, ופרש מומחה בלהכיר את האיומים שהוא מפיק.

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

אם היינו מתמודדים עם בעיה דמיונות בשם "8 המלכות" [ב] בה יש רק מלכות - אולי היה היתרון של אופציה ב' היה פחות ברור. אני חושב שאני אישית עדיין הייתי מעדיף לבחור באופציה ב' - כי אני לא מרגיש עקרונית נוח עם "לוח יודע כל".

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

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

למי שלא מכיר UML - חץ משמעו קשר, שמתבטא בפועל ב member של המחלקה. כלומר: חץ דו-כיווני אומר שבמחלקה Queen יש member בשם board@, ובמחלקה Board יש מערך של members בשם queens@.

יש לנו כאן קשר דו-כיווני, מה שאמור להדליק לנו נורה אדומה. ככל האפשר (עקרונות ה OO) - מומלץ להפחית קשרים דו-כיווניים (וקשרים בכלל) מהמערכת.

בואו נזכר מדוע אנו רוצים את הקשרים האלו:

• מלכה מכירה את הלוח - כי היא צריכה לבדוק מה יש בתאים מסביבה - ("()board.content_at").
• לוח מכיר את המלכות - כי הוא מציב את המלכות.

הממ... האם אפשר "לפטור" את עצמנו מאחד מהקשרים? נראה שכן. אפשר שהלוח לא יהיה אחראי להצבה (הנה הגדרת אחריות). נגדיר מחלקה אחרת, BoardManager (שם מקומם משהו) שתיקח ממחלקת ה Board את האחריות ואת התלויות שבאות איתה.

בואו נכסה עוד יכולת נדרשת לתכנון: היכולת להדפיס את הפתרון (כלומר: מצב הלוח בו 7 מלכות ופרש לא מאיימים זה על זה) על המסך. לצורך המערכת הזו - מדובר בהדפסת ASCII ב console.

דילמה: כיצד לבצע את ההדפסה:

• אופציה א': ה Board אחראי להדפסה
• ייתרון: יש למחלקה את כל המידע הדרוש להדפסה
• חיסרון: עכשיו יהיו למחלקה 2 אחריויות: א. לנהל את ה state של פתרון, ב. לנהל את ההדפסה של ה state הזה. 2 אחריויות היא חריגה מה SRP (קיצור של: Single Responsibility Principle).
• אופציה ב': ה Board מדפיס את הלוח, ועושה to_s (כלומר: toString ברובי) למלכה - כדי לתת לה את האחריות כיצד להציג את עצמה (למשל: האות "Q" או סמיילי)
• ייתרון: פיזור אחריות בין אובייקטים שאחראים למשימה (scalability פיתוחי)
• חיסרון: פיזור אחריויות - אין SRP
• אופציה ג': ליצור מחלקה נוספת שאחראית על ההדפסה
• ייתרון: הפרדת אחריויות ברורה בקוד
• חיסרון: מה השתגענו - עוד מחלקה? כלומר: יותר קוד לכתוב

הדבר הראשון שיש לשים לב אליו במקרה זה הוא שיש לנו 3 אופציות: אופציה א' ו ב' הן יחסית דומות בעוד אופציה ג' שונה. במקרה שכזה כדאי שתידלק לנו נורה אדומה (קטנה) בשל זיהוי דפוס קבלת החלטות שנקרא "A, A-, B".

מה זה אומר? באופן טבעי כבני אדם, אנו נוטים להעדיף השוואות נוחות.
קל יותר להשאוות בין אופציה A לאופציה -A שדומה לה, אך פחות טובה ממנה ולבחור את A, מאשר להחליט בין A ל B.
לכן, אנו נוטים "לזנוח" את B ולהתמקד בהשוואה בין 2 האופציות הנוחות בלבד.

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

1. שלב א': A מול A-, ולהעלות את אופציה A "לגמר".
2. שלב ב': לבחון, מחדש, את אופציה A מול אופציה B.

אני חייב להודות שבמקרה שלנו זה סוג של אופציה A1 ו A2 - כי קשה לי לומר בהכרח מי עדיפה מבין אופציה א' וב'.

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

אם אתם מעוניינים להעביר החלטה "בלי שקולגות יפריעו לכם" (לא יפה!!) - צרו אופציה A- מגוחכת, בכדי להעלות את סיכוייה של אופציה A להיבחר. עוד פרטים על כך אפשר לקרוא בפרק הראשון בספרו של דן אריאלי "לא רציונלי, ולא במקרה".

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

• אופציה א': ה Board אחראי להדפסה
• ייתרון: יש את כל המידע הדרוש להדפסה
• חיסרון: עכשיו יהיו לו 2 אחריויות: א. לנהל את ה state של פתרון, ב. לנהל את ההדפסה של ה state הזה. 2 אחריויות היא חריגה מה SRP (קיצור של: Single Responsibility Principle).
• אופציה ב' (החדשה): ליצור מחלקה נוספת שאחראית על ההדפסה
• ייתרון: הפרדת אחריויות ברורה בקוד
• חיסרון: מה השתגענו - עוד מחלקה? כלומר: יותר קוד לכתוב

בדילמה ביניהן - אני בוחר באופציה ב'. 

אופציה א' היא מהירה יותר למימוש, אבל אני אישית מרגיש יותר נוח לתקתק קצת יותר - ולבנות מבנה שהוא יותר scalabale לעתיד.

מצד אחד, זוהי אולי "שריטה של ארכיטקט". המערכת שלנו הולכת להיות קטנה למדי (אין לה "עתיד") - והקוד יהיה ניתן לניהול גם ללא קנאות ל SRP. זהו Waste.

מצד שני, זהו הרגל טוב למערכות גדולות - והרגלים לא מחליפים בקלות כמו גרביים. אני מעדיף לחיות עם אינטואיציה שהיא פחות יעילה למערכות קטנות, אך יותר יעילה למערכות בינוניות / גדולות (שם אני מבלה את רוב זמני).

אני בוחר באופציה ב' והמבנה שלנו כעת נראה כך:

ארכיטקטורה א'

זהו, האם הגעתי לארכיטקטורה המושלמת לבעיה הנתונה?

אז זהו... בוודאי שלא!

1. אנו לא בעסקי המושלמות (לפחות לא אני). המטרה היא לייצר ארכיטקטורה "טובה" (ככה "top 5") ולא "הטובה ביותר". למה? כי זה פשוט בלתי-אפשרי לוגית. כל דרישה חדשה למוצר הופכת את הסדר בין כמה הארכיטקטורות הטובות ומציבה ארכיטקטורה אחרת בראש הטבלה כ"ארכיטקטורה הטובה ביותר". מכיוון שאי אפשר לחזות את העתיד - אז אי אפשר גם להעריך איזו ארכיטקטורה, מבין הארכיטקטורות "הטובות" היא הטובה ביותר. פשוט אי אפשר.
2. ארכיטקטורה מתאימים להקשר מסוים: מי הצוות שיעבוד איתה, מי הלקוח, ומה הסיטואציה (לחץ, פרויקט אסטרטגי, וכו'). לא יהיה נכון להשוות ארכיטקורות שונות כאשר יש להן הקשרים שונים.
   למשל: בארכיטקטורה הזו אני עומד להיות המפתח. מה שטוב עבורי, לא בהכרח מספיק טוב לכל אדם אחר.
3. את הארכיטקטורה ניתן באמת להעריך רק לאחר זמן ממושך. דברו איתי עוד חודשיים - ואספר לכם כמה טובה היא הייתה.
   כלומר: מדובר בהימור מחושב.

ברגע שהתגבש מבנה בסיסי, זוהי נקודת זמן טובה להשוות אותו למבנה אחר.

מה קרה? לקחנו סט של בחירות במהלך הדרך - והשוונו בחירה מול בחירה, אך לא תמונה מול תמונה.

ייתכן שלאור הבחירה הראשונה שביצענו - אכן בחרנו בחירות טובות. אבל, אם הבחירה הראשונה הייתה אחרת - היינו מגיעים לסט בחירות שסה"כ הוא מוצלח יותר.

בואו נבנה מבנה הגיוני אחר (או שניים) - ונבחן אותם. נראה אם אנו יכולים להגיע לפתרון שהוא סה"כ טוב יותר.
הנה אלטרנטיבה אחרת (להלן ארכיטקטורה ב'):

ארכיטקטורה ב'

היתרונות של ארכיטקטורה א' הם:

• הפרדת אחריויות מקיפה (כל מחלקה אחראית על משהו אחד)
• מוכנות לגדילה* (development scalability). 

* מדוע מוכנות לגדילה היא ייתרון? תמיד הרי נוכל לעשות refactoring למבנה הרצוי, ברגע שנזדקק לו בפועל.

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

עבורי אישית זה עניין של הרגל / שלווה פנימית.

היתרונות של ארכיטקטורה ב' הם:

• מעט מחלקות - מעט קוד -> יותר מהר לפתח. בד"כ עוד מחלקות דורשות כתיבה של עוד "Gluing Code".
• הפרדה בין אחריויות - אם כי פחות מקיפה.

אין פה עניין של ארכיטקטורה "נכונה". שתי הארכיטקטורות סבירות, ומה שנותר לנו הוא שקלול תמורות (trade-off) - איזו ארכיטקטורה נראית לנו מתאימה יותר בהקשר הנתון. בארכיטקטורה, בוחנים trade-offs כל הזמן.

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

סיכום התהליך

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

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

1. הידע על הארכיטקטורה איננו קיים - הוא מתגלה. אנו מגלים תוך כדי תכנון ומעט קידוד ("spike solutions" ו/או POCs) תובנות חדשות, ומשלבים אותן בארכיטקטורה.
   נכון, שאם בנינו מערכות דומות בעבר - אנו יכולים להשתמש בידע שנצבר שם בכדי לקצר תהליכים.
2. אפשרויות בחירה הן קריטיות לתכנון איכותי. ההרגל נוטה למשוך אותנו ל"פתרון הראשון שיכול לעבוד" ולהישאר שם, אבל חשוב לעצור לרגע וליצור עוד אלטרנטיבות ישימות - ואז לבחור מביניהן את הטובה יותר.
   
   כקוריוז: שימו לב שזה אחד הנושאים עליהם מבקר המדינה מעיר שוב ושוב לממשלה: לא הוצגו חלופות (ישימות) בפני חברי הממשלה - ולכן נבחרה החלופה היחידה שהוצגה. אני מניח שהעקרונות לשיטה הם דומים.
3. ידע תאורטי מוקדם (SOLID, אחר) מסייע לנו לזהות "נקודות בעייתיות" - לבחון אותן, ולתקן אותן (במידת הצורך). יש הרבה מאוד כללים מנחים בעולם התוכנה לגבי תכנון מערכת - חלקם אפילו סותרים.
   
   למשל: בארכיטקטורה א' הצבנו את כל אחריות ההדפסה על הלוח. בגלל ריבוי הכלים (מלכה, פרש) הוא יאלץ לבצע if (או case) ולהגדיר התנהגויות לכל כלי (המקביל לקריאה ל ()to_s בארכיטקטורה ב'). מצב כזה נחשב כ bad smell בו מומלץ לעשות refactoring לכיוון State Pattern. מצד שני - המצב שייווצר יפגע ב SRP. פה יש עניין של הבחנה עיקר וטפל - שמבוסס במידה רבה על ניסיון מכיוון שאין דרך מתמטית "להוכיח" איזה מצב הוא עדיף. ניסיון הוא בסהכ ה"מושכל" ב"הימור מושכל", כמובן.

זהו, בחמש דקות - עיקרו של תהליך הגדרת הארכיטקטורה.

סיכום

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

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

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

----

[א] מלכה ברבים, מלכות, יש לקרוא כמְלָכוֹת (כ' רפה) - כמו "MELAHOT"

[ב] "8 המלכות" זו כמובן הבעיה המקרית. אני רציתי לגוון ולנסות משהו טיפה אחר.