פרמטרים רבים מדי בשיטות Java, חלק 3: תבנית בונה

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

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

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

Person.java (ללא תבנית בונה)

package dustin.examples; /** * Person class used as part of too many parameters demonstration. * * @author Dustin */ public class Person { private final String lastName; private final String firstName; private final String middleName; private final String salutation; private final String suffix; private final String streetAddress; private final String city; private final String state; private final boolean isFemale; private final boolean isEmployed; private final boolean isHomewOwner; public Person( final String newLastName, final String newFirstName, final String newMiddleName, final String newSalutation, final String newSuffix, final String newStreetAddress, final String newCity, final String newState, final boolean newIsFemale, final boolean newIsEmployed, final boolean newIsHomeOwner) { this.lastName = newLastName; this.firstName = newFirstName; this.middleName = newMiddleName; this.salutation = newSalutation; this.suffix = newSuffix; this.streetAddress = newStreetAddress; this.city = newCity; this.state = newState; this.isFemale = newIsFemale; this.isEmployed = newIsEmployed; this.isHomewOwner = newIsHomeOwner; } } 

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

PersonBuilder.java

package dustin.examples; public class PersonBuilder { private String newLastName; private String newFirstName; private String newMiddleName; private String newSalutation; private String newSuffix; private String newStreetAddress; private String newCity; private String newState; private boolean newIsFemale; private boolean newIsEmployed; private boolean newIsHomeOwner; public PersonBuilder() { } public PersonBuilder setNewLastName(String newLastName) { this.newLastName = newLastName; return this; } public PersonBuilder setNewFirstName(String newFirstName) { this.newFirstName = newFirstName; return this; } public PersonBuilder setNewMiddleName(String newMiddleName) { this.newMiddleName = newMiddleName; return this; } public PersonBuilder setNewSalutation(String newSalutation) { this.newSalutation = newSalutation; return this; } public PersonBuilder setNewSuffix(String newSuffix) { this.newSuffix = newSuffix; return this; } public PersonBuilder setNewStreetAddress(String newStreetAddress) { this.newStreetAddress = newStreetAddress; return this; } public PersonBuilder setNewCity(String newCity) { this.newCity = newCity; return this; } public PersonBuilder setNewState(String newState) { this.newState = newState; return this; } public PersonBuilder setNewIsFemale(boolean newIsFemale) { this.newIsFemale = newIsFemale; return this; } public PersonBuilder setNewIsEmployed(boolean newIsEmployed) { this.newIsEmployed = newIsEmployed; return this; } public PersonBuilder setNewIsHomeOwner(boolean newIsHomeOwner) { this.newIsHomeOwner = newIsHomeOwner; return this; } public Person createPerson() { return new Person(newLastName, newFirstName, newMiddleName, newSalutation, newSuffix, newStreetAddress, newCity, newState, newIsFemale, newIsEmployed, newIsHomeOwner); } } 

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

Person.java עם Nested Person.Builder

package dustin.examples; /** * Person class used as part of too many parameters demonstration. * * @author Dustin */ public class Person { private final String lastName; private final String firstName; private final String middleName; private final String salutation; private final String suffix; private final String streetAddress; private final String city; private final String state; private final boolean isFemale; private final boolean isEmployed; private final boolean isHomewOwner; public Person( final String newLastName, final String newFirstName, final String newMiddleName, final String newSalutation, final String newSuffix, final String newStreetAddress, final String newCity, final String newState, final boolean newIsFemale, final boolean newIsEmployed, final boolean newIsHomeOwner) { this.lastName = newLastName; this.firstName = newFirstName; this.middleName = newMiddleName; this.salutation = newSalutation; this.suffix = newSuffix; this.streetAddress = newStreetAddress; this.city = newCity; this.state = newState; this.isFemale = newIsFemale; this.isEmployed = newIsEmployed; this.isHomewOwner = newIsHomeOwner; } public static class PersonBuilder { private String nestedLastName; private String nestedFirstName; private String nestedMiddleName; private String nestedSalutation; private String nestedSuffix; private String nestedStreetAddress; private String nestedCity; private String nestedState; private boolean nestedIsFemale; private boolean nestedIsEmployed; private boolean nestedIsHomeOwner; public PersonBuilder( final String newFirstName, final String newCity, final String newState) { this.nestedFirstName = newFirstName; this.nestedCity = newCity; this.nestedState = newState; } public PersonBuilder lastName(String newLastName) { this.nestedLastName = newLastName; return this; } public PersonBuilder firstName(String newFirstName) { this.nestedFirstName = newFirstName; return this; } public PersonBuilder middleName(String newMiddleName) { this.nestedMiddleName = newMiddleName; return this; } public PersonBuilder salutation(String newSalutation) { this.nestedSalutation = newSalutation; return this; } public PersonBuilder suffix(String newSuffix) { this.nestedSuffix = newSuffix; return this; } public PersonBuilder streetAddress(String newStreetAddress) { this.nestedStreetAddress = newStreetAddress; return this; } public PersonBuilder city(String newCity) { this.nestedCity = newCity; return this; } public PersonBuilder state(String newState) { this.nestedState = newState; return this; } public PersonBuilder isFemale(boolean newIsFemale) { this.nestedIsFemale = newIsFemale; return this; } public PersonBuilder isEmployed(boolean newIsEmployed) { this.nestedIsEmployed = newIsEmployed; return this; } public PersonBuilder isHomeOwner(boolean newIsHomeOwner) { this.nestedIsHomeOwner = newIsHomeOwner; return this; } public Person createPerson() { return new Person( nestedLastName, nestedFirstName, nestedMiddleName, nestedSalutation, nestedSuffix, nestedStreetAddress, nestedCity, nestedState, nestedIsFemale, nestedIsEmployed, nestedIsHomeOwner); } } } 

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

Person.java עם אובייקט Nested Builder, סוגי מותאמים אישית ופרמטרים

package dustin.examples; /** * Person class used as part of too many parameters demonstration. * * @author Dustin */ public class Person { private final FullName name; private final Address address; private final Gender gender; private final EmploymentStatus employment; private final HomeownerStatus homeOwnerStatus; /** * Parameterized constructor can be private because only my internal builder * needs to call me to provide an instance to clients. * * @param newName Name of this person. * @param newAddress Address of this person. * @param newGender Gender of this person. * @param newEmployment Employment status of this person. * @param newHomeOwner Home ownership status of this person. */ private Person( final FullName newName, final Address newAddress, final Gender newGender, final EmploymentStatus newEmployment, final HomeownerStatus newHomeOwner) { this.name = newName; this.address = newAddress; this.gender = newGender; this.employment = newEmployment; this.homeOwnerStatus = newHomeOwner; } public FullName getName() { return this.name; } public Address getAddress() { return this.address; } public Gender getGender() { return this.gender; } public EmploymentStatus getEmployment() { return this.employment; } public HomeownerStatus getHomeOwnerStatus() { return this.homeOwnerStatus; } /** * Builder class as outlined in the Second Edition of Joshua Bloch's * Effective Java that is used to build a {@link Person} instance. */ public static class PersonBuilder { private FullName nestedName; private Address nestedAddress; private Gender nestedGender; private EmploymentStatus nestedEmploymentStatus; private HomeownerStatus nestedHomeOwnerStatus; public PersonBuilder( final FullName newFullName, final Address newAddress) { this.nestedName = newFullName; this.nestedAddress = newAddress; } public PersonBuilder name(final FullName newName) { this.nestedName = newName; return this; } public PersonBuilder address(final Address newAddress) { this.nestedAddress = newAddress; return this; } public PersonBuilder gender(final Gender newGender) { this.nestedGender = newGender; return this; } public PersonBuilder employment(final EmploymentStatus newEmploymentStatus) { this.nestedEmploymentStatus = newEmploymentStatus; return this; } public PersonBuilder homeOwner(final HomeownerStatus newHomeOwnerStatus) { this.nestedHomeOwnerStatus = newHomeOwnerStatus; return this; } public Person createPerson() { return new Person( nestedName, nestedAddress, nestedGender, nestedEmploymentStatus, nestedHomeOwnerStatus); } } } 

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