Applying SOLID Principles in C++

Welcome to the final lesson of the "Applying Clean Code Principles in C++" course! Throughout this course, we've covered vital principles such as DRY (Don't Repeat Yourself), KISS (Keep It Simple, Stupid), and the Law of Demeter, all of which are foundational to writing clean and efficient code. In this culminating lesson, we'll explore the SOLID Principles, a set of design principles introduced by Robert C. Martin, commonly known as "Uncle Bob." Understanding SOLID is crucial for creating software that is flexible, scalable, and easy to maintain. Let's dive in and explore these principles together.

To start off, here's a quick overview of the SOLID Principles and their purposes:

• Single Responsibility Principle (SRP): Each class or module should only have one reason to change, meaning it should have only one job or responsibility.
• Open/Closed Principle (OCP): Software entities should be open for extension but closed for modification.
• Liskov Substitution Principle (LSP): Objects of a superclass should be replaceable with objects of its subclasses without affecting the correctness of the program.
• Interface Segregation Principle (ISP): No client should be forced to depend on methods it does not use.
• Dependency Inversion Principle (DIP): High-level modules should not depend on low-level modules. Both should depend on abstractions.

These principles are guidelines that help programmers write code that is easier to understand and more flexible to change, leading to cleaner and more maintainable codebases. Let's explore each principle in detail.

The Single Responsibility Principle states that each class should have only one reason to change, meaning it should only have one job or responsibility. This helps in reducing the complexity and enhancing the readability and maintainability of the code. Consider the following:

class User {
public:
    void printUserInfo() {
        // Print user information
    }

    void storeUserData() {
        // Store user data in the database
    }
};

In the above code, the User class has two responsibilities: printing user information and storing user data. This violates the Single Responsibility Principle by taking on more than one responsibility. Let's refactor:

class User {
public:
    // User-related attributes and methods
};

class UserPrinter {
public:
    void printUserInfo(const User &user) {
        // Print user information
    }
};

class UserDataStore {
public:
    void storeUserData(const User &user) {
        // Store user data in the database
    }
};

In the refactored code, we have three classes, each handling a specific responsibility. This makes the code cleaner and easier to manage.

The Open/Closed Principle advises that software entities should be open for extension but closed for modification. This allows for enhancing and extending functionalities without altering existing code, reducing errors and ensuring stable systems. Consider this example:

class Rectangle {
public:
    Rectangle(double width, double height) : width(width), height(height) {}

    double area() const {
        return width * height;
    }

private:
    double width, height;
};

class AreaCalculator {
public:
    double calculateRectangleArea(const Rectangle& rectangle) const {
        return rectangle.area();
    }
};

In this setup, if we want to add a new shape like Circle, we need to modify the AreaCalculator class, which violates the Open/Closed Principle. Here is an improved version using polymorphism:

class Shape {
public:
    virtual double area() const = 0;
    virtual ~Shape() {}
};

class Rectangle : public Shape {
public:
    Rectangle(double width, double height) : width(width), height(height) {}

    double area() const override {
        return width * height;
    }

private:
    double width, height;
};

class Circle : public Shape {
public:
    Circle(double radius) : radius(radius) {}

    double area() const override {
        return 3.14159 * radius * radius;
    }

private:
    double radius;
};

class AreaCalculator {
public:
    double calculateArea(const Shape& shape) const {
        return shape.area();
    }
};

Now, new shapes can be added without altering AreaCalculator. This setup adheres to the Open/Closed Principle by leaving the existing code unchanged when extending functionalities.

The Liskov Substitution Principle ensures that objects of a subclass should be able to replace objects of a superclass without altering the functionality or causing any errors in the program.

class Bird {
public:
    virtual void fly() {
        std::cout << "Flying" << std::endl;
    }

    virtual ~Bird() {}
};

class Ostrich : public Bird {
public:
    void fly() override {
        throw std::runtime_error("Ostrich can't fly");
    }
};

Here, substituting an instance of Bird with Ostrich causes an issue because Ostrich cannot fly, leading to an exception. Let's refactor:

class Bird {
    // Common behaviors for all birds
    virtual ~Bird() {}
};

class FlyingBird : public Bird {
public:
    virtual void fly() {
        std::cout << "Flying" << std::endl;
    }
};

class Ostrich : public Bird {
    // Specific behaviors for ostriches
};

By introducing FlyingBird and having only birds that can actually fly inherit from it, we can substitute Bird with Ostrich without errors, adhering to the Liskov Substitution Principle.

The Interface Segregation Principle states that no client should be forced to depend on methods it does not use. Interfaces should be split into smaller, more specific entities so that clients only implement the methods they need:

class Worker {
public:
    virtual void work() = 0;
    virtual void eat() = 0;
    virtual ~Worker() {}
};

class Robot : public Worker {
public:
    void work() override {
        // Robot work functions
    }

    void eat() override {
        // Robots don't eat, but must implement this method
    }
};

Robot being forced to implement eat() violates the Interface Segregation Principle. Here's the refactored version:

class Workable {
public:
    virtual void work() = 0;
    virtual ~Workable() {}
};

class Eatable {
public:
    virtual void eat() = 0;
    virtual ~Eatable() {}
};

class Robot : public Workable {
public:
    void work() override {
        // Robot work functions
    }
};

Now, Robot only implements the Workable interface, adhering to the Interface Segregation Principle.

The Dependency Inversion Principle dictates that high-level modules should not depend on low-level modules, but both should depend on abstractions. Here's an example:

class LightBulb {
public:
    void turnOn() {
        std::cout << "LightBulb turned on" << std::endl;
    }

    void turnOff() {
        std::cout << "LightBulb turned off" << std::endl;
    }
};

class Switch {
private:
    LightBulb lightBulb;

public:
    Switch() : lightBulb() {}

    void operate() {
        // Operate on the light bulb
        lightBulb.turnOn();
        lightBulb.turnOff();
    }
};

Here, Switch directly depends on LightBulb, making it challenging to extend the system with new devices without modifying Switch. Every time a new device type is introduced, the Switch class would need modification, leading to tight coupling between the Switch and the device.

To adhere to the Dependency Inversion Principle, we introduce an abstraction:

class Switchable {
public:
    virtual void turnOn() = 0;
    virtual void turnOff() = 0;
    virtual ~Switchable() {}
};

class LightBulb : public Switchable {
public:
    void turnOn() override {
        std::cout << "LightBulb turned on" << std::endl;
    }

    void turnOff() override {
        std::cout << "LightBulb turned off" << std::endl;
    }
};

class Switch {
private:
    Switchable* client;

public:
    Switch(Switchable* client) : client(client) {}

    void operate() {
        // Operate on the switchable client
        client->turnOn();
        client->turnOff();
    }
};

Now Switch uses the Switchable interface, which can be implemented by any switchable device. This setup allows the Switch class to remain unchanged when introducing new devices, thus following the Dependency Inversion Principle by depending on an abstraction and reducing the system's rigidity.

In this lesson, we delved into the SOLID Principles — Single Responsibility, Open/Closed, Liskov Substitution, Interface Segregation, and Dependency Inversion. These principles guide developers to create code that is maintainable, scalable, and easy to extend or modify. As you prepare for the upcoming practice exercises, remember that applying these principles in real-world scenarios will significantly enhance your coding skills and codebase quality. Good luck, and happy coding! 🎓