Software Design Principles

1. Software Design Principles August 28, 2017

2. Symptoms of Rotting Design • Rigidity • No change can be afforded anymore since it may cause cascading changes. • Fragility • A simple change breaks the software in many places • Fragility leads to Rigidity • Immobility • A module cannot be easily reused because it has too much baggage that depends on. It is more efficient to write a new one instead of reuse. • Viscosity • Viscosity of Design: It is harder to make changes in the way that preserves the good design than hacking. • Viscosity of Environment: the IDE is slow and inefficient. Detours are used to avoid large re-compile for example.

3. Software design principles • The single-responsibility principle • The open-closed principle • The Liskov substitution principle • The interface segregation principle • The dependency inversion principle

4. The single-responsibility principle • “A class should have only one reason to change.” -- Robert Martin • A responsibility = a reason to change • Separate coupled responsibilities into separate classes • Linux: every “module” should do just one thing and do it well.

5. The single-responsibility principle • Example: • Often we need to sort students by their name, or ssn. So one may make Class Student implement the Java Comparable interface. class Student implements Comparable { … intcompareTo(Object o) { … } … };

6. Student SSN Name getSSN() getName() major getMajor() int compareTo() AClient op() { ;} Comparable int compareTo() The single-responsibility principle Register Add(Course d, Student s); When a new requirement needs to sort students in a different order, Student, Register, and AClient all need to be recompiled, even Register has nothing to do with the new ordering of Students. It invokes Collections.sort(aListofStudents);

7. Java Comparable • Each time students are ordered differently, the compareTo method needs to be changed and Students needs to be recompiled and also its clients. • Student is a business entity, it does not know in what order it should be sorted since the order of sorting is imposed by the client of Student. • Cause of the problem: we bundled two separate responsibilities (i.e., a business entity and ordering) into one class – a violation of SRP

8. Register Add(Course d, Student s); Student SSN Name getSSN() getName() major getMajor() ClientA op() { ;} ClientB op() { ;} Comparator int compare(Object o1, Object o2) StudentByName int compare(Object o1, Object o2) StudentBySSN int compare(Object o1, Object o2) The single-responsibility principle The solution is to separate the two responsibilities into two separate classes and use another version of Collections.sort(). It invokes Collections.sort(aListofStudents, StudentBySSN);

9. Rectangle +draw():void +area():integer The single-responsibility principle Computational Geometry Application Graphical Application GUI Class Rectangle may be forced to make changes from two different unrelated sources. One is from the Computational Geometry Application (CGA). E.g., adding area function for length and width of type double. The other is from Graphical Application (GA). E.g., add draw() in Windows XP to the existing draw in X Windows. A change from either of the two source would still cause the other application to recompile.

10. The single-responsibility principle Computational Geometry Application Graphical Application Geometric Rectangle +area():double Graphic Rectangle +draw():void GUI • Package CGA is no longer dependent on graphical side of Rectangle and thus it becomes independent of package GUI. Any change caused by graphical application no longer requires CGA to be recompiled. • However, any changes from the CGA side may cause GA to be recompiled.

11. The single-responsibility principle Computational Geometry Application Graphical Application Rectangle -double length -double width +getLength():dobule +getWidth():dobule Geometric Rectangle +area():double Graphic Rectangle +draw():void GUI Class Rectangle contains the most primitive attributes and operations of rectangles. Classes GeometricRectangle and GraphicRectangle are independent of each other. A change from either side of CGA or GA, it would not cause the other side to be recompiled. NOTE: this does not violate LSP, since Rectangle does not have any client.

12. The open-closed principle • “Software entities (classes, modules, functions, etc,) should be open for extension, but closed for modification.” – R. Martin • To make a class open for extension, closed for modification, program the class to interfaces (or abstract classes), not implementation (concrete classes). • “You can new features to existing code, without changing the existing code, but by only adding new code”. • “Changes do not propagate into existing code that already works.” • Abstraction is the key to the OCP.

13. Violation of the OCP Employee +int EmpType Faculty +getOffice() Staff +getDept() Secretary +getTypeSpeed() Engineer +getEngTYpe() void printEmpRoster(Employee[] emps) { for (int i; i<emps.size(); i++) { if (emps[i].empType == FACULTY) printfFaculty((Faculty)emps[i]); else if (emps[i].empType ==STAFF) printStaff((Staff)emps[i]); else if (emps[i].empType == SECRETARY) printSecretary((Secretary)emps[i]); } } What if we need to add Engineer??

14. OCP – Dynamic Polymorphism Employee +printInfo() Faculty +printInfo() Staff +printInfo() Secretary +printInfo Engineer +printInfo() void printEmpRoster(Employee[] emps) { for (int i; i<emps.size(); i++) { emps[i].printInfo(); } } When Engineer is added, printEmpRoster() does not even need to recompile. PrintEmpRoster() is open to extension, closed for modification.

15. OCP – Dynamic Polymorphism • Three versions of SORT • sort(List list) • Elements of list must implement Comparable interface • sort(List list, StringComparator sc) • Elements of list are not required to implement Comparable • StringComparator orders objects of String only • Sort(List list, Comparator comp) • Elements of list are not required to implement Comparable • Comparator may compare objects of any type. • Open to extension since it can sort objects of any type at any order specified in the second parameter.

16. OCP – Static Polymorphism • Static polymorphism • Generics in Java public class LinkedList<E> { boolean add(E e); boolean add(int index, E e); booleanaddFirst(E e); booleanaddLast(E e); void clear(); E get(int index); ... } • The container can take objects of any type.

17. The Liskov substitution principle • “Subtypes must be substitutable for their base types.” – R. Martin • Demand no more, promise no less • Demand no more: the subclass would accept any arguments that the superclass would accept. • Promise no less: Any assumption that is valid when the superclass is used must be valid when the subclass is used. • Interface inheritance – The LSP should be conformed to. • Implementation inheritance – use composition instead of inheritance (in Java) or use private base classes (in C++).

18. LSP – Design by Contract • The contract of a method: • Precondition: what must be true when calling it • If the precondition fails, the results are undefined • Postcondition: What are guaranteed to be true • If the postcondition fails, it shall not return. • The LSP in terms of contract • A derived class is substitutable for its base class if • Its preconditions are not stronger than the base class method • Its postconditions are no weaker than the base class method.

19. The Liskov substitution principle • Implementation inheritance • When you use List to implementQueue (in Java), use composition, not inheritance. • The intention is that you use only List’s implementation <foundation> List +insert() +delete() +find() List +insert() +delete() +find() List +insert() +delete() +find() MyList Queue +enqueue() +dequeue() +isEmpty() Queue +enqueue() +dequeue() +isEmpty() Queue +enqueue() +dequeue() +isEmpty()

20. The Liskov substitution principle class Square extends Rectangle { public void setWidth(int width) { super.setWidth(width); super.setHeight(width); } public void setHeight(int height) { super.setHeight(height); super.setWidth(height); } } void clientOfRectangle(Rectangle r) { r.setWidth(10); r.setHeight(20); print(r.area()); } Rectangle r = new Square(…); clientOfRectangle(r); // what would be printed? Rectangle -int width; -int height +getWidth() +setWidth() +getHeight() +setHeight() +area(); IS-A Square +getWidth() +setWidth() +getHeight() +setHeight()

21. The Liskov substitution principle • Rectangle and Square • Invariant of Rectangle: width and height are independent of each other (which can be expected from the setWidth and setHeight operations) • Square violates the width-height-independence invariant of Rectangle • Design by Contract: • The precondition (width == height) of the derived methods is stronger than that (width is independent of height) of the base methods

22. The Liskov substitution principle • There are cases in which the substitutability may not be needed • Generalization: we found that Faculty, Staff, Secretary and Engineer all have the same set of attributes and operations, so we created the Employee as a placeholder for those common properties. • For this system, there is no client for Employee • Thus, the four subclasses do not need to be substitutable • Actually, there is no way we can tell whether they are or not. Employee +printInfo() Faculty +printInfo() Staff +printInfo() Secretary +printInfo Engineer +printInfo() Generalization

23. The dependency inversion principle • “Abstraction should not depend on details. Details should depend on abstraction.” – R. Martin • High-level concepts are more stable than low-level implementation

24. The dependency inversion principle Policy Layer High-level modules make calls to low-level modules. Mechanism Layer Utility Layer The upper-level layer is dependent upon lower-level layers.

25. The dependency inversion principle Dependency Inversion: Lower-level layers is dependent upon upper-level layers. Policy Policy Layer Mechanism Mechanism Layer <<interface>> Policy Service Utility <<interface>> Mechanism Service Utility Layer Ownership Inversion: The client (upper-level layer) owns the interface, not the lower-level layers

26. DIP and OCP • High-level concepts are more stable than low-level implementation • Concrete things change often and abstract things change less often. • Abstractions are “hinge points”, places when the design can provide different implementations • That is the OCP

27. The interface segregation principle • “Clients should not be forced to depend on methods that they do not use.” – R. Martin • When we bundle functions for different clients into one interface/class, we create unnecessary coupling among the clients. • When one client causes the interface to change, all other clients are forced to recompile.

28. ISP – A Bad Design Service Methods For ClientA Methods For ClientB Methods For ClientC Client A Client B Client C The problem is that any change in Service introduced by one client (e.g., Client A) causes Service and the other clients (Client A and Client C) to be recompiled.

29. ISP – A Good Design ServiceA Methods For ClientA ServiceImpl Methods For ClientA Methods For ClientB Methods For ClientC Client A ServiceB Methods For ClientB Client B ServiceC Methods For ClientC Client C Changes introduced by one client (e.g., Client A) may require its designated interface (ServiceA) and the service implementation to change. However, other clients (Client A & Client C) and their Interfaces (ServiceB & ServiceC) are not required to change or recompile.

30. Software design principles - summary • The single-responsibility principle • There is only one source that may the class to change • The open-closed principle • Open to extension, closed for modification • The Liskov substitution principle • A subclass must substitutable for its base class • The dependency inversion principle • Low-level (implementation, utility) classes should be dependent on high-level (conceptual, policy) classes • The interface segregation principle • A client should not be forced to depend on methods it does not use.