$30 off During Our Annual Pro Sale. View Details »

CSC509 Lecture 03

CSC509 Lecture 03

Software Design
SOLID Principles
(202310)

Javier Gonzalez-Sanchez
PRO

September 27, 2023
Tweet

More Decks by Javier Gonzalez-Sanchez

Other Decks in Programming

Transcript

  1. jgs
    CSC 509
    Software Engineering II:
    Modeling and Design
    Lecture 03:
    Understanding SOLID Principles
    Dr. Javier Gonzalez-Sanchez
    [email protected]
    www.javiergs.com
    Building 14 -227
    Office Hours: By appointment

    View Slide

  2. jgs
    Previously …

    View Slide

  3. jgs
    Javier Gonzalez-Sanchez | CSC 509 | Fall 2023 | 3
    Relationships
    Association Directed
    Association
    Reflexive
    Association
    Multiplicity
    Aggregation Composition Generalization Realization

    View Slide

  4. jgs
    Javier Gonzalez-Sanchez | CSC 308 | Winter 2023 | 4
    public class A extends B {
    C c1, c2;
    public A() {
    c1 = new C();
    }
    public void method() {
    D d = new D();
    d.working();
    }
    }
    public class X {
    public void m() {
    B var = new A();
    double x = Math.sqrt(5);
    }
    }
    public class B implements E {
    public B() {
    C c1 = new C();
    }
    public void method() {
    B b = new B();
    b.sleep();
    }
    }
    public class Y {
    A [] a = new A[5];
    }
    Lab

    View Slide

  5. jgs
    SOLID Principles
    Let’s Start from the Beginning

    View Slide

  6. jgs
    Javier Gonzalez-Sanchez | CSC 509 | Fall 2023 | 6
    Key idea
    § Just like the source code a design should be clean, and that includes.
    § Keep it Simple - over-designing the system is as bad as their absence
    when needed.
    § A design that is more than what we need smells.
    § So, abstract classes, interfaces, design patterns, and other infrastructure
    elements that do not solve a problem create a problem.
    § Eliminating design smells is the goal of design principles.

    View Slide

  7. jgs
    Javier Gonzalez-Sanchez | CSC 509 | Fall 2023 | 7
    Key Idea
    Design principles are not a perfume to be liberally scattered all over the
    system.
    Robert Martin
    (Agile manifesto, SOLID principles, Books)

    View Slide

  8. jgs
    Javier Gonzalez-Sanchez | CSC 509 | Fall 2023 | 8
    Design Principles
    There are five key design principles to consider in Object-Oriented:
    § Single Responsibility Principle (SRP)
    § Open-Closed Principle (OCP)
    § Liskov Substitution Principle (LSP)
    § Interface Segregation Principle (ISP)
    § Dependency Inversion Principle (DIP)

    View Slide

  9. jgs
    Single Responsibility Principle
    SRP

    View Slide

  10. jgs
    Javier Gonzalez-Sanchez | CSC 509 | Fall 2023 | 10
    Definition
    A class should have only one responsibility
    SRP is all about understanding when and how to apply decoupling.
    Why?
    Because each responsibility implies a possibility of a change.

    View Slide

  11. jgs
    Javier Gonzalez-Sanchez | CSC 509 | Fall 2023 | 11
    SRP Example
    § Imagine that you need a piece of software to read data from diverse sensor
    devices (a heart rate monitor, a brain-computer interface, a skin
    conductance sensor, etc.)
    § And you need to store that information for future use also.
    § For some sensors, we need to gather data directly from a serial port.
    § For others, we use a WebSockets (third-party APIs help us get data from
    the physical device).
    § To store data, we want to be able to store data in a local file (text file) or in a
    database

    View Slide

  12. jgs
    Javier Gonzalez-Sanchez | CSC 509 | Fall 2023 | 12
    SRP Example

    View Slide

  13. jgs
    Javier Gonzalez-Sanchez | CSC 509 | Fall 2023 | 13
    SRP Example

    View Slide

  14. jgs
    Open-Closed Principle
    OCP

    View Slide

  15. jgs
    Javier Gonzalez-Sanchez | CSC 509 | Fall 2023 | 15
    Definition
    Software entities (functions, classes, modules, etc.) should be open for
    extension but closed for modification.
    OCP is all about achieving changes adding new code, not changing the old
    code that already works.
    Closure cannot be complete. There will always be some change against
    which the entity is not closed. Thus, the closure must be strategic. As a
    developer, make educated guesses about the likely kinds of changes that the
    application could suffer over time.
    OCP means that we do not want to modify the class, i.e., write code into a
    class. Once you create a class and put that class in a production
    environment, you do not want to touch that class.
    OCP can be satisfied with a simple and effective heuristic: inheritance

    View Slide

  16. jgs
    Javier Gonzalez-Sanchez | CSC 509 | Fall 2023 | 16
    OCP Example
    § Imagine you are asked to create a program to draw geometric shapes on
    screen.
    § We want to draw circles and draw squares; maybe later, we would ask for
    draw triangles, etc.

    View Slide

  17. jgs
    Javier Gonzalez-Sanchez | CSC 509 | Fall 2023 | 17
    OCP Example

    View Slide

  18. jgs
    Javier Gonzalez-Sanchez | CSC 509 | Fall 2023 | 18
    OCP Example

    View Slide

  19. jgs
    Liskov Substitution Principle
    LSP

    View Slide

  20. jgs
    Javier Gonzalez-Sanchez | CSC 509 | Fall 2023 | 20
    Definition
    Subtypes must be substitutable for all their base types.
    i.e., a child should always be better than its parent. And, “better” means
    more behaviors, not less.
    That principle is the answer proposed by Barbara Liskov (1988) to the
    questions:
    § What are the characteristics of the best inheritance hierarchies?
    § What are the traps that could create hierarchies that jeopardize the OCP?

    View Slide

  21. jgs
    Javier Gonzalez-Sanchez | CSC 509 | Fall 2023 | 21
    LSP Example
    § Imagine you already have a class Circle, and you are asked to create a
    class Cylinder.
    § Or maybe you have a class Rectangle, and you are asked to create a
    class Square (a square is a rectangle with the same width and height).
    § Or you have a class LinkedList, and you are asked to create a
    class PersistentLinkedList (one that writes out its elements to a stream
    and can read them back later).
    If you are tempted to use inheritance from Circle to Cylinder, or
    from Rectangle to Square, or from LinkedList to PersistentLinkedList, i.e.,
    create a parent-child relationship for any of these cases, you will have
    problems.

    View Slide

  22. jgs
    Javier Gonzalez-Sanchez | CSC 509 | Fall 2023 | 22
    LSP Example
    § The class Cylinder would eliminate the
    method calculateArea() in Circle since calculating an area does not make
    sense. It is impossible to use our Cylinder object to replace a Circle object.
    § The class Square will make the methods setWidth() and setHeight() to
    modify both width and height attributes (they are equal in a square, right?).
    Therefore, it will be impossible to use a Square object to replace
    a Rectangle object.
    § The class PersistentLinkedList needs persistent (serializable) objects
    while LinkedList does not. Moreover,
    probably, PersistentLinkedList would need to throw some exceptions.

    View Slide

  23. jgs
    Interface Segregation Principle
    ISP

    View Slide

  24. jgs
    Javier Gonzalez-Sanchez | CSC 509 | Fall 2023 | 24
    Definition
    § Clients should not be forced to depend on methods that they do not use.
    § ISP deals with the disadvantage of “fat” interfaces (or abstract classes).
    § ISP recommends to broke up interfaces with a lot of methods into several
    interfaces.

    View Slide

  25. jgs
    Dependency Inversion Principle
    DIP

    View Slide

  26. jgs
    Javier Gonzalez-Sanchez | CSC 509 | Fall 2023 | 26
    Definition
    § High-level modules should not depend on low-level modules. Both should
    depend on abstractions.
    § Traditional procedural programming creates software structures in which
    high-level modules depend on low-level modules.
    § The dependency structure of a well-designed object-oriented program
    is “inverted” with respect to the dependency structure that generally results
    from traditional procedural methods.
    § DIP is what makes software fulfill the object-oriented paradigm.

    View Slide

  27. jgs
    Javier Gonzalez-Sanchez | CSC 509 | Fall 2023 | 27
    Definition
    § Hollywood Principle: “do not call us, we will call you.”
    § Review DIP whenever one class sends a message to another. DIP is about
    calling methods.
    § When doing that, depend on abstractions (use abstract classes or
    interfaces).

    View Slide

  28. jgs
    Javier Gonzalez-Sanchez | CSC 509 | Fall 2023 | 28
    DIP Example

    View Slide

  29. jgs
    Javier Gonzalez-Sanchez | CSC 509 | Fall 2023 | 29
    DIP Example
    What about ISP?

    View Slide

  30. jgs
    Test Yourselves

    View Slide

  31. jgs
    Javier Gonzalez-Sanchez | CSC 509 | Fall 2023 | 31
    Guidelines
    Create a UML Class Diagram for
    the following scenario:

    View Slide

  32. jgs
    Javier Gonzalez-Sanchez | CSC 509 | Fall 2023 | 32
    Homework
    Read:
    Wettel, R. & Lanza, M. (2007). Visualizing Software Systems as Cities. 2007
    4th IEEE International Workshop on Visualizing Software for Understanding
    and Analysis, 92–99. https://doi.org/10.1109/vissof.2007.4290706

    View Slide

  33. jgs
    Javier Gonzalez-Sanchez | CSC 509 | Fall 2023 | 33
    Questions

    View Slide

  34. jgs
    CSC 509 Software Design
    Javier Gonzalez-Sanchez, Ph.D.
    [email protected]
    Fall 2023
    Copyright. These slides can only be used as study material for the class CSC509 at Cal Poly.
    They cannot be distributed or used for another purpose.

    View Slide