Functions and Methods in Clean Code

Lesson 3

Introduction

Welcome to your next step in mastering Clean Code! 🚀 Previously, we emphasized the significance of naming conventions in clean coding. Now, we delve into the realm of functions and methods, which serve as the backbone of application logic and are crucial for code organization and execution. Structuring these functions effectively is vital for enhancing the clarity and maintainability of a codebase. In this lesson, we'll explore best practices and techniques to ensure our code remains clean, efficient, and readable.

Clean Functions at a Glance

Let's outline the key principles for writing clean functions:

Keep functions small. Small functions are easier to read, comprehend, and maintain.
Focus on a single task. A function dedicated to one task is more reliable and simpler to debug.
Limit arguments to three or fewer. Excessive arguments complicate the function signature and make it difficult to understand and use.
Avoid boolean flags. Boolean flags can obscure the code's purpose; consider separate methods for different behaviors.
Eliminate side effects. Functions should avoid altering external state or depending on external changes to ensure predictability.
Implement the DRY principle. Employ helper functions to reuse code, minimizing redundancy and enhancing maintainability.

Now, let's take a closer look at each of these rules.

Keep Functions Small

Functions should remain small, and if they become too large, consider splitting them into multiple, focused functions. While there's no fixed rule on what counts as large, a common guideline is around 15 to 25 lines of code, often defined by team conventions.

Below, you can see the processOrder function which is manageable but has the potential to become unwieldy over time:

Java
1public void processOrder(Order order, Inventory inventory, Logger logger) {
2    // Step 1: Validate the order
3    if (!order.isValid()) {
4        logger.log("Invalid Order");
5        return;
6    }
7
8    // Step 2: Process payment
9    if (!order.processPayment()) {
10        logger.log("Payment failed");
11        return;
12    }
13
14    // Step 3: Update inventory
15    inventory.update(order.getItems());
16
17    // Step 4: Notify customer
18    order.notifyCustomer();
19
20    // Step 5: Log order processing
21    logger.log("Order processed successfully");
22}

Given that this process involves multiple steps, it can be improved by extracting each step into a dedicated private function, as shown below:

Java
1public void processOrder(Order order, Inventory inventory, Logger logger) {
2    if (!validateOrder(order, logger)) return;
3    if (!processPayment(order, logger)) return;
4    updateInventory(order, inventory);
5    notifyCustomer(order);
6    logOrderProcessing(logger);
7}
8
9private boolean validateOrder(Order order, Logger logger) {
10    if (!order.isValid()) {
11        logger.log("Invalid Order");
12        return false;
13    }
14    return true;
15}
16
17private boolean processPayment(Order order, Logger logger) {
18    if (!order.processPayment()) {
19        logger.log("Payment failed");
20        return false;
21    }
22    return true;
23}
24
25private void updateInventory(Order order, Inventory inventory) {
26    inventory.update(order.getItems());
27}
28
29private void notifyCustomer(Order order) {
30    order.notifyCustomer();
31}
32
33private void logOrderProcessing(Logger logger) {
34    logger.log("Order processed successfully");
35}

Single Responsibility

A function should embody the principle of doing one thing only. If a function handles multiple responsibilities, it may include several logical sections. Below you can see the saveAndNotifyUser function which is both too lengthy and does multiple different things at once:

Java
1public void saveAndNotifyUser(User user, DataSource dataSource, WebClient webClient) {
2    // Save user to the database
3    String sql = "INSERT INTO users (name, email) VALUES (?, ?)";
4
5    try (Connection connection = dataSource.getConnection();
6         PreparedStatement statement = connection.prepareStatement(sql)) {
7        // Set user details in the prepared statement
8        statement.setString(1, user.getName());
9        statement.setString(2, user.getEmail());
10
11        // Execute the update query to save user
12        statement.executeUpdate();
13    } catch (SQLException e) {
14        e.printStackTrace(); // Handle SQL exception
15    }
16
17    // Send a welcome email to the user
18    webClient.post()
19             .uri("/sendWelcomeEmail")
20             .bodyValue(user)
21             .retrieve()
22             .onStatus(HttpStatus::isError, response -> Mono.error(new RuntimeException("Failed to send email")))
23             .block();
24}

To enhance this code, you can create two dedicated functions for saving the user and sending the welcome email. This results in dedicated responsibilities for each function and clearer code coordination:

Java
1public void saveAndNotifyUser(User user, DataSource dataSource, WebClient webClient) {
2    saveUser(user, dataSource);
3    notifyUser(user, webClient);
4}
5
6private void saveUser(User user, DataSource dataSource) {
7    String sql = "INSERT INTO users (name, email) VALUES (?, ?)";
8
9    try (Connection connection = dataSource.getConnection();
10         PreparedStatement statement = connection.prepareStatement(sql)) {
11        statement.setString(1, user.getName());
12        statement.setString(2, user.getEmail());
13        statement.executeUpdate();
14    } catch (SQLException e) {
15        e.printStackTrace(); // Handle SQL exception
16    }
17}
18
19private void notifyUser(User user, WebClient webClient) {
20    webClient.post()
21             .uri("/sendWelcomeEmail")
22             .bodyValue(user)
23             .retrieve()
24             .onStatus(HttpStatus::isError, response -> Mono.error(new RuntimeException("Failed to send email")))
25             .block();
26}

Limit Number of Arguments

Try to keep the number of function arguments to a maximum of three, as having too many can make functions less understandable and harder to use effectively. 🤔

Consider the saveAddress function below with five arguments, which makes the function less clean:

Java
1public void saveAddress(String street, String city, String state, String zipCode, String country) {
2    // Logic to save address
3}

A cleaner version encapsulates the details into an Address object, reducing the number of arguments and making the function signature clearer:

Java
1public void saveAddress(Address address) {
2    // Logic to save address
3}

Avoid Boolean Flags

Boolean flags in functions can create confusion, as they often suggest multiple pathways or behaviors within a single function. Instead, use separate methods for distinct behaviors. 🚫

The setFlag function below uses a boolean flag to indicate user status, leading to potential complexity:

Java
1public void setFlag(User user, boolean isAdmin) {
2    // Logic based on flag
3}

A cleaner approach is to have distinct methods representing the different behaviors:

Java
1public void grantAdminPrivileges(User user) {
2    // Logic for admin rights
3}
4
5public void revokeAdminPrivileges(User user) {
6    // Logic to remove admin rights
7}

Avoid Side Effects

A side effect occurs when a function modifies some state outside its scope or relies on something external. This can lead to unpredictable behavior and reduce code reliability.

Below, the addToTotal function demonstrates a side effect by modifying an external state:

Java
1// Not Clean - Side Effect
2public int addToTotal(int value) {
3    total += value; // modifies external state
4    return total;
5}

A cleaner version, calculateTotal, performs the operation without altering any external state:

Java
1// Clean - No Side Effect 🌟
2public int calculateTotal(int initial, int value) {
3    return initial + value;
4}

Don't Repeat Yourself (DRY)

Avoid code repetition by introducing helper functions to reduce redundancy and improve maintainability.

The printUserInfo and printManagerInfo functions below repeat similar logic, violating the DRY principle:

Java
1public void printUserInfo(User user) {
2    System.out.println("Name: " + user.name);
3    System.out.println("Email: " + user.email);
4}
5
6public void printManagerInfo(Manager manager) {
7    System.out.println("Name: " + manager.name);
8    System.out.println("Email: " + manager.email);
9}

To adhere to DRY principles, use a generalized printInfo function that operates on a parent Person type:

Java
1public void printInfo(Person person) {
2    System.out.println("Name: " + person.name);
3    System.out.println("Email: " + person.email);
4}

Summary

In this lesson, we learned that clean functions are key to maintaining readable and maintainable code. By keeping functions small, adhering to the Single Responsibility Principle, limiting arguments, avoiding side effects, and embracing the DRY principle, you set a strong foundation for clean coding. Next, we'll practice these principles to further sharpen your coding skills! 🎓

Enjoy this lesson? Now it's time to practice with Cosmo!

Practice is how you turn knowledge into actual skills.