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.
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.
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:
php1function processOrder($order, $inventory, $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 function, as shown below:
php1function processOrder($order, $inventory, $logger) { 2 // Step 1: Validate the order 3 if (!validateOrder($order, $logger)) return; 4 5 // Step 2: Process payment 6 if (!processPayment($order, $logger)) return; 7 8 // Step 3: Update inventory 9 updateInventory($order, $inventory); 10 11 // Step 4: Notify customer 12 notifyCustomer($order); 13 14 // Step 5: Log order processing 15 logOrderProcessing($logger); 16} 17 18function validateOrder($order, $logger) { 19 if (!$order->isValid()) { 20 $logger->log("Invalid Order"); 21 return false; 22 } 23 return true; 24} 25 26function processPayment($order, $logger) { 27 if (!$order->processPayment()) { 28 $logger->log("Payment failed"); 29 return false; 30 } 31 return true; 32} 33 34function updateInventory($order, $inventory) { 35 $inventory->update($order->getItems()); 36} 37 38function notifyCustomer($order) { 39 $order->notifyCustomer(); 40} 41 42function logOrderProcessing($logger) { 43 $logger->log("Order processed successfully"); 44}
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:
php1function saveAndNotifyUser($user, $dataSource, $webClient) { 2 // Save user to the database 3 $sql = "INSERT INTO users (name, email) VALUES (?, ?)"; 4 5 try { 6 $connection = $dataSource->getConnection(); 7 $statement = $connection->prepare($sql); 8 9 // Set user details in the prepared statement 10 $statement->execute([$user->getName(), $user->getEmail()]); 11 } catch (Exception $e) { 12 echo $e->getMessage(); // Handle exception 13 } 14 15 // Send a welcome email to the user 16 $webClient->post('/sendWelcomeEmail', [ 17 'json' => ['name' => $user->getName(), 'email' => $user->getEmail()] 18 ]); 19}
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:
php1function saveAndNotifyUser($user, $dataSource, $webClient) { 2 // Save user to the database 3 saveUser($user, $dataSource); 4 5 // Send a welcome email to the user 6 notifyUser($user, $webClient); 7} 8 9function saveUser($user, $dataSource) { 10 $sql = "INSERT INTO users (name, email) VALUES (?, ?)"; 11 12 try { 13 $connection = $dataSource->getConnection(); 14 $statement = $connection->prepare($sql); 15 16 // Set user details in the prepared statement 17 $statement->execute([$user->getName(), $user->getEmail()]); 18 } catch (Exception $e) { 19 echo $e->getMessage(); // Handle exception 20 } 21} 22 23function notifyUser($user, $webClient) { 24 $webClient->post('/sendWelcomeEmail', [ 25 'json' => ['name' => $user->getName(), 'email' => $user->getEmail()] 26 ]); 27}
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:
php1function saveAddress($street, $city, $state, $zipCode, $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:
php1function saveAddress($address) { 2 // Logic to save address 3}
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:
php1function setFlag($user, $isAdmin) { 2 // Logic based on flag 3}
A cleaner approach is to have distinct methods representing the different behaviors:
php1function grantAdminPrivileges($user) { 2 // Logic for admin rights 3} 4 5function revokeAdminPrivileges($user) { 6 // Logic to remove admin rights 7}
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:
php1// Not Clean - Side Effect 2function addToTotal($value) { 3 global $total; 4 $total += $value; // modifies external state 5 return $total; 6}
A cleaner version, calculateTotal, performs the operation without altering any external state:
php1// Clean - No Side Effect 🌟 2function calculateTotal($initial, $value) { 3 return $initial + $value; 4}
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:
php1function printUserInfo($user) { 2 echo "Name: " . $user->name; 3 echo "Email: " . $user->email; 4} 5 6function printManagerInfo($manager) { 7 echo "Name: " . $manager->name; 8 echo "Email: " . $manager->email; 9}
To adhere to DRY principles, use a generalized printInfo function that operates on a parent Person type:
php1function printInfo($person) { 2 echo "Name: " . $person->name; 3 echo "Email: " . $person->email; 4}
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! 🎓