클린 코드의 황금률: 함수는 한 가지 일을 해야 합니다

Patricia Arquette
풀어 주다: 2024-10-07 18:19:31
원래의
939명이 탐색했습니다.

The Golden Rule of Clean Code: Functions Should Do One Thing

소프트웨어 엔지니어링의 세계에는 다른 모든 것보다 중요한 한 가지 원칙이 있습니다. 즉, 함수는 한 가지 일을 잘 수행해야 한다는 것입니다. 단일 책임 원칙(SRP)이라고도 하는 이 개념은 깔끔하고 유지 관리가 가능한 코드의 초석입니다.

이것이 왜 중요합니까?

기능에 단일 책임이 있는 경우:

  1. 이해하고 추론하기가 더 쉽습니다
  2. 테스트가 더욱 단순해지고 집중됩니다
  3. 리팩토링은 덜 위험하고 더 간단합니다
  4. 코드 재사용성이 대폭 향상됩니다
  5. 디버깅이 덜 귀찮아집니다

이 원칙을 실제로 보여주는 예를 살펴보겠습니다.

나쁜 습관: 다중 책임 기능

고객에게 이메일을 보내는 다음 기능을 고려해 보세요.


function emailClients(clients) {
  clients.forEach(client => {
    const clientRecord = database.lookup(client);
    if (clientRecord.isActive()) {
      email(client);
    }
  });
}


로그인 후 복사

이 기능은 여러 가지 작업을 수행합니다.

  1. 클라이언트 반복
  2. 고객별 기록 조회
  3. 클라이언트 활성화 여부 확인
  4. 활성 고객에게 이메일 보내기

이 모든 것을 한 곳에 두는 것이 효율적으로 보일 수도 있지만 기능을 유지 관리하고 테스트하기가 더 어려워집니다.

모범 사례: 단일 책임 함수

이제 이를 더 작고 집중된 함수로 리팩토링해 보겠습니다.


function emailActiveClients(clients) {
  clients.filter(isActiveClient).forEach(email);
}

function isActiveClient(client) {
  const clientRecord = database.lookup(client);
  return clientRecord.isActive();
}


로그인 후 복사

이 리팩터링 버전에서는:

  • emailActiveClients는 활성 클라이언트에게 이메일을 보내는 높은 수준의 작업에 중점을 둡니다
  • isActiveClient는 클라이언트가 활성 상태인지 확인하는 세부 사항을 처리합니다

이러한 관심사 분리를 통해 각 기능을 더 쉽게 이해하고 테스트할 수 있으며 코드베이스의 다른 부분에서 재사용할 수도 있습니다.

이 접근 방식의 이점

  1. 가독성: 코드는 명확한 내용을 전달합니다. emailActiveClients를 읽는 사람은 누구나 구현 세부 사항에 얽매이지 않고 그 목적을 빠르게 이해할 수 있습니다.
  2. 테스트 용이성: 이제 이메일 전송 로직과 클라이언트 활동 확인에 대한 별도의 테스트를 쉽게 작성할 수 있습니다.
  3. 유연성: 활성 클라이언트 결정 방법을 변경해야 하는 경우 isActiveClient 함수만 수정하면 됩니다.
  4. 재사용성: 이제 필요한 경우 코드베이스의 다른 곳에서 isActiveClient 함수를 사용할 수 있습니다.

결론

"함수는 한 가지 일을 해야 한다"는 원칙을 수용하는 것이 처음에는 장황하게 느껴질 수도 있지만, 코드베이스의 유지 관리 가능성과 팀의 생산성에 대한 장기적인 이점은 엄청납니다. 코드를 작성하고 리팩터링할 때 항상 스스로에게 "이 함수가 두 가지 이상의 작업을 수행하는가?"라고 자문해 보세요. 대답이 '예'라면 이제 분석해 볼 시간입니다!

클린 코드는 단순히 작동하도록 만드는 것이 아니라 우아하고 지속 가능하게 작동하도록 만드는 것입니다. 즐거운 코딩하세요!

위 내용은 클린 코드의 황금률: 함수는 한 가지 일을 해야 합니다의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!

원천:dev.to
본 웹사이트의 성명
본 글의 내용은 네티즌들의 자발적인 기여로 작성되었으며, 저작권은 원저작자에게 있습니다. 본 사이트는 이에 상응하는 법적 책임을 지지 않습니다. 표절이나 침해가 의심되는 콘텐츠를 발견한 경우 admin@php.cn으로 문의하세요.
저자별 최신 기사
인기 튜토리얼
더>
최신 다운로드
더>
웹 효과
웹사이트 소스 코드
웹사이트 자료
프론트엔드 템플릿
회사 소개 부인 성명 Sitemap
PHP 중국어 웹사이트:공공복지 온라인 PHP 교육,PHP 학습자의 빠른 성장을 도와주세요!