Welcome to the very first lesson of the "Clean Code with Multiple Classes" course! 🎉 This course aims to guide you in writing code that's easy to understand, maintain, and enhance. Within the broader scope of clean coding, effective class collaboration is crucial for building well-structured applications. In this lesson, we will delve into the intricacies of class collaboration and coupling — key factors that can make or break the maintainability of your software. Specifically, we'll address some common "code smells" that indicate problems in class interactions and explore ways to resolve them.

Let's dive into the challenges of class collaboration by focusing on four common code smells:

• Feature Envy: Occurs when a method in one class is overly interested in methods or data in another class.
• Inappropriate Intimacy: Describes a situation where two classes are too closely interconnected, sharing private details.
• Message Chains: Refer to sequences of method calls across several objects, indicating a lack of clear abstraction.
• Middle Man: Exists when a class mainly delegates its behavior to another class without adding functionality.

Understanding these code smells will enable you to improve your class designs, resulting in cleaner and more maintainable code.

These code smells can significantly impact system design and maintainability. Let's consider their implications:

• They can lead to tightly coupled classes, making them difficult to modify or extend. 🔧
• Code readability decreases, as it becomes unclear which class is responsible for which functionality.

Addressing these issues often results in code that's not only easier to read but also more flexible and scalable. Tackling these problems can markedly enhance software architecture, making it more robust and adaptable.

Feature Envy occurs when a method in one class is more interested in the fields or methods of another class than its own. Here's an example:

Kotlin
Copy to clipboard
1class ShoppingCart {
2    private val items = mutableListOf<Item>()
3
4    fun calculateTotalPrice(): Double {
5        var total = 0.0
6        for (item in items) {
7            total += item.price * item.quantity
8        }
9        return total
10    }
11}
12
13class Item(val price: Double, val quantity: Int)

In this scenario, calculateTotalPrice() in ShoppingCart overly accesses data from Item, indicating feature envy.

To refactor, consider moving the logic to the Item class:

Kotlin
Copy to clipboard
1class ShoppingCart {
2    private val items = mutableListOf<Item>()
3
4    fun calculateTotalPrice(): Double {
5        var total = 0.0
6        for (item in items) {
7            total += item.calculateTotal()
8        }
9        return total
10    }
11}
12
13class Item(val price: Double, val quantity: Int) {
14    fun calculateTotal() = price * quantity
15}

Now, each Item calculates its own total, reducing dependency and distributing responsibility appropriately. ✔️

Inappropriate Intimacy occurs when a class is overly dependent on the internal details of another class. Here's an example:

Kotlin
Copy to clipboard
1class Library(private val book: Book) {
2
3    fun printBookDetails() {
4        println("Title: ${book.title}")
5        println("Author: ${book.author}")
6    }
7}
8
9class Book(val title: String, val author: String)

In this scenario, the Library class relies too heavily on the details of the Book class, demonstrating inappropriate intimacy.

To refactor, allow the Book class to handle its own representation:

Kotlin
Copy to clipboard
1class Library(private val book: Book) {
2
3    fun printBookDetails() {
4        println(book.getDetails())
5    }
6}
7
8class Book(private val title: String, private val author: String) {
9    
10    fun getDetails() = "Title: $title\nAuthor: $author"
11}

This adjustment enables Book to encapsulate its own details, encouraging better encapsulation and separation of concerns. 🛡️

Message Chains occur when classes need to traverse multiple objects to access the methods they require. Here's a demonstration:

Kotlin
Copy to clipboard
1class User(private val address: Address) {
2    fun getAddress() = address
3}
4
5class Address(private val zipCode: ZipCode) {
6    fun getZipCode() = zipCode
7}
8
9class ZipCode {
10    fun getPostalCode() = "90210"
11}
12
13// Usage
14val user = User(Address(ZipCode()))
15user.getAddress().getZipCode().getPostalCode()

The chain user.getAddress().getZipCode().getPostalCode() illustrates this problem.

To simplify, encapsulate the access within methods:

Kotlin
Copy to clipboard
1class User(private val address: Address) {
2
3    fun getUserPostalCode() = address.getPostalCode()
4}
5
6class Address(private val zipCode: ZipCode) {
7
8    fun getPostalCode() = zipCode.getPostalCode()
9}
10
11// Usage
12val user = User(Address(ZipCode()))
13user.getUserPostalCode()

This adjustment makes the User class responsible for retrieving its postal code, creating a clearer and more direct interface. 📬

A Middle Man problem occurs when a class primarily exists to delegate its functionalities. Here's an example:

Kotlin
Copy to clipboard
1class Controller(private val service: Service) {
2
3    fun execute() {
4        service.performAction()
5    }
6}
7
8class Service {
9    fun performAction() {
10        // Action performed
11    }
12}

The Controller doesn't do much beyond delegating to Service.

To refactor, simplify delegation or reassign responsibilities:

Kotlin
Copy to clipboard
1class Service {
2    fun performAction() {
3        // Action performed
4    }
5}
6
7// Usage
8val service = Service()
9service.performAction()

By removing the unnecessary middle man, the design becomes more streamlined and efficient. 🔥

In this lesson, you've explored several code smells associated with suboptimal class collaboration and coupling, including Feature Envy, Inappropriate Intimacy, Message Chains, and Middle Man. By identifying and refactoring these smells, you can elevate your code's clarity and maintainability.

Get ready to put these concepts into practice with upcoming exercises, where you'll identify and refactor code smells, strengthening your skills. Keep striving for cleaner, more effective code! 🌟