Applying SOLID Principles in TypeScript

Welcome to the final lesson of the "Applying Clean Code Principles" 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 their 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 {
    // User-related attributes and methods
}

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

class UserDataStore {
    storeUserData(user: User): void {
        // 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:

interface Shape {
    calculateArea(): number;
}

class Rectangle implements Shape {
    private width: number;
    private height: number;

    constructor(width: number, height: number) {
        this.width = width;
        this.height = height;
    }

    calculateArea(): number {
        return this.width * this.height;
    }
}

class Circle implements Shape {
    private radius: number;

    constructor(radius: number) {
        this.radius = radius;
    }

    calculateArea(): number {
        return Math.PI * this.radius * this.radius;
    }
}

class AreaCalculator {
    calculateArea(shape: Shape): number {
        return shape.calculateArea();
    }
}

Now, new shapes can be added without altering AreaCalculator. This setup adheres to the Open/Closed Principle by leaving the original 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 {
    // Common behaviors for all birds
}

class FlyingBird extends Bird {
    fly(): void {
        console.log("Flying");
    }
}

class Ostrich extends 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 Liskov’s 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:

interface Workable {
    work(): void;
}

interface Eatable {
    eat(): void;
}

class Robot implements Workable {
    work(): void {
        // Robot work functions
    }
}

class Human implements Workable, Eatable {
    work(): void {
        // Human work functions
    }

    eat(): void {
        // Human eating 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:

interface Switchable {
    turnOn(): void;
    turnOff(): void;
}

class LightBulb implements Switchable {
    turnOn(): void {
        console.log("LightBulb turned on");
    }

    turnOff(): void {
        console.log("LightBulb turned off");
    }
}

class Switch {
    private client: Switchable;

    constructor(client: Switchable) {
        this.client = client;
    }

    operate(): void {
        // Operate on the switchable client
    }
}

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 the quality of your codebase. Good luck, and happy coding! 🎓