One Level of Abstraction: The Key to Clean Functions

Ever looked at a function and felt lost in its complexity? Let's explore a fundamental principle of clean code: functions should maintain only one level of abstraction.

Here's a real-world example of user creation in a web application:

// ❌ A function doing too many things at different abstraction levels
function createUser(userData) {
  // Validate data
  if (!userData.email || !userData.email.includes('@')) {
    return 'Invalid email';
  }
  if (userData.password.length 



<p>This function mixes different levels of abstraction:</p>

• High-level business logic (user creation flow)
• Mid-level operations (data validation, formatting)
• Low-level details (password hashing)

Let's refactor it following the single level of abstraction principle:

// ✅ Clean version with one level of abstraction
function createUser(userData) {
  const validationError = validateUserData(userData);
  if (validationError) return validationError;

  const securePassword = hashPassword(userData.password);
  const formattedUser = formatUserData(userData.email, securePassword);

  return saveUserToDatabase(formattedUser);
}

function validateUserData({ email, password }) {
  if (!email || !email.includes('@')) return 'Invalid email';
  if (password.length 



<h2>
  
  
  Benefits of This Approach
</h2>

<ol>
<li>
<strong>Readability</strong>: The main function reads like a story, describing what happens at a high level</li>
<li>
<strong>Maintainability</strong>: Each function has a single responsibility, making changes safer</li>
<li>
<strong>Testability</strong>: You can test each piece of logic independently</li>
<li>
<strong>Reusability</strong>: These focused functions can be reused in other contexts</li>
</ol>

<h2>
  
  
  Key Takeaways
</h2>

<p>When writing functions:</p>

• Keep them focused on one level of abstraction
• Extract complex operations into well-named functions
• Make the main function tell a story
• Think of each function as a single step in your process

Remember: If you're mixing "how" and "what" in the same function, you're probably dealing with multiple levels of abstraction. Split them up!

The above is the detailed content of One Level of Abstraction: The Key to Clean Functions. For more information, please follow other related articles on the PHP Chinese website!