Clean Code - 함수

종현·2024년 1월 25일
CLEAN CODE
0

Clean Code

목록 보기
2/7

작게 만들어라!

함수를 만드는 첫째 규치근 '작게'

  • 블록과 들여쓰기
    if/else문, while 문 등에 들어가는 블록은 한 줄이어야 한다.
    대게 거기서 함수를 호출한다.
    그러면 바깥을 감싸는 함수가 작아질 뿐 아니라 블록 안에서 호출하는 함수 이름을 적절히 짓는다면 코드를 이해하기도 쉬워진다.
    => 중첩 구조가 생길만큼 삼수가 커져서는 안된다.
    => 함수에서 들여쓰기 수준은 1단이나 2단을 넘어서면 안된다.
    그래야 함수는 읽고 이해하기 쉬워진다.

한 가지만 해라!

함수는 한가지를 해야 한다. 그 한 가지를 잘 해야 한다. 그 한 가지만을 해야 한다.

지정된 함수 이름 아래에서 추상화 수준이 하나인 단계만 수행한다면 그 함수는 한 가지 작업만 한다.

함수 내 섹션

  • 한가지 작업만 하는 함수는 자연스럽게 섹션으로 나누기 어렵다.

함수당 추상화 수준은 하나로!

함수가 확실히 '한 가지' 작업만 하려면 함수 내 모든 문장의 추상화 수준이 동일 해야 한다.
함수 내 추상화 수준을 섞으면 코드를 읽는사람이 헷갈린다.
특정 표현이 근본 개념인지 아니면 세부사항인지 구분하기 어렵다.

위에서 아래로 코드 읽기: 내려가기 규칙

코드는 위에서 아래로 이야기처럼 읽혀야 좋다.
한 함수 다음에는 추상화 수준이 한 단계 낮은 함수가 온다.
이 것을 내려가기 규칙이라 부른다.
핵심은 '한 가지'만 하는 함수
위에서 아래로 읽어내려 가듯이 코드를 구현하면 추상화 수준을 일관되게 유지하기 쉬워진다.

switch문

switch문은 작게 만들기 어렵다.
또한, '한 가지' 작업만 하는 switch문도 만들기 어렵다.
하지만 각 switch문을 저차원 클래스에 숨기고 절대로 반복하지 않는 방법이 있다. (물론 다형성을 이용한다.)

  • 기존 switch문의 문제
  1. 함수가 길다
  2. 값이 추가되면 더 길어진다.
  3. '한 가지' 작업만 수행하지 않는다.
    => SRP를 위반한다. (코드를 변경할 이유가 여럿)
    => OCP를 위반한다. (값이 추가될 때마다 코드를 변경하기 때문)

가장 심각한 문제라면 위 함수와 구조가 동일한 함수가 무한정 존재한다는 사실.

이는, switch문을 추상 팩토리에 꽁꽁 숨긴다.

public abstract class Employee {
	public abstract boolean isPayday();
    public abstract Money calculatePay();
    public abstract void deliverPay(Money pay);
}
///////////
public interface EmployeeFactory {
	public Employee makeEmployee(EmployeeRecord r) thorws InvalidEmployeeType;
}
///////////
public class EmployeeFactoryImpl implements EmployeeFactory {
	public Employee makeEmployee(EmployeeRecord r) thorws InvalidEmployeeType {
    	switch (r.type) {
        	case COMMISSIONED:
        		return new CommissionedEmployee(r);
            case HOURLY:
            	return new HourlyEmployee(r);
            case SALARIED:
            	return new SalariedEmployee(r);
            default:
            	throw new InvalidEmployeeType(r.type);
        }
    }
}
  • 일반적으로 여기서는 switch문을 단 한번만 참아준다. (다형적 객체를 생성하는 코드 안에서이다.)
  • 이렇게 상속 관계로 숨긴 후에는 절대로 다른 코드에 노출하지 않는다.

서술적인 이름을 사용하라!

코드를 읽으면서 짐작했던 기능을 각 루틴이 그대로 수행한다면 깨끗한 코드라 불러도 되겠다. (워드)

  • 한 가지만 하는 작은 함수에 좋은 이름을 붙인다면 이런 원칙을 달성함에 있어 이미 절반은 성공했다.

  • 함수가 작고 단순할수록 서술적인 이름을 고르기도 쉬워진다.

  • 이름이 길어도 괜찮다.
    => 길고 서술적인 이름이 짧고 어려운 이름보다 좋다.)
    => 길고 서술적인 이름이 길고 서술적인 주석보다 좋다.

  • 함수 이름을 정할 때는 여러 단어가 쉽게 읽히는 명명법을 사용한다.

  • 그런 다음, 여러 단어를 사용해 함수 기능을 잘 표현하는 이름을 선택한다.

  • 이름을 정하느라 시간을 들여도 괜찮다.

  • 이런저런 이름을 넣어 코드를 읽어보면 더 좋다.

  • 이름을 붙일 때는 일관성이 있어야 한다.

  • 모듈 내에서 함수 이름은 같은 문구, 명사, 동사를 사용한다.

서술적인 이름을 사용하면 개발자 머릿속에도 설계가 뚜렷해지므로 코드를 개선하기 쉬워진다.

함수 인수

함수에서 이상적인 인수 개수는 0개(무항)이다.
다음은 1개(단항) 다음은 2개(이항). 3개(삼항)는 가능한 피하는 편이 좋다. 4개 이상 (다항)은 특별한 이유가 필요하다. (특별한 이유가 있어도 사용하면 안 된다.

  • 인수는 개념을 이해하기 어렵게 만든다. (코드를 읽는 사람이 발견할 때마다 의미를 해석해야 한다.)
  1. 함수 이름과 인수 사이에 추상화 수준이 다르다.
  2. 코드를 읽는 사람이 현 시점에서 별로 중요하지 않은 세부사항을 알아야 한다.
  • 테스트 관점에서 보면 인수는 더 어렵다.
  • 출력 인수는 입력 인수보다 이해하기 어렵다.

많이 쓰는 단항 형식

  • 함수에 인수 1개를 넘기는 이유로 가장 흔한 경우는 두 가지.
  1. 인수에 질문을 던지는 경우 (ex. String -> boolean)
  2. 인수를 뭔가로 변환해 결과를 반환하는 경우 (ex. String -> InputStream)
  • 다소 드물게 사용하지만 그래도 아주 유용한 단항 함수 형식이 이벤트. (출력 인수 X)
  • 위 경우가 아니라면 단항 함수는 가급적 피한다.

플래그 인수

  • 플래그 인수는 추하다. 함수로 boolean 값을 넘기는 관례는 정말로 끔찍하다.
  • 한꺼번에 여러 가지를 처리한다고 대놓고 공표하는 셈이다.

이항 함수

삼항 함수

인수 객체

  • 인수가 2~3개 필요하다면 일부를 독자적인 클래스 변수로 선언할 가능성을 짚어본다.

인수 목록

  • 때로는 인수 개수가 가변적인 함수도 필요하다.
String.format("%s worked %.2f hours.", name, hours);

public String format(String formant, Object... args);
  • 가변 인수를 취하는 모든 함수에 같은 원리가 적용된다.
  • 가변 인수를 취하는 함수는 단항, 이항, 삼항 함수로 취급할 수 있다.

동사와 키워드

  • 함수의 의도나 인수의 순서와 의도를 제대로 표현하려면 좋은 함수 이름이 필수다.
  • 단항 함수는 함수와 인수가 동사/명사 쌍을 이뤄야 한다.
write(name);
  • write(name)은 누구나 곧바로 이해한다.
  • 이름(name)이 무엇이든 쓴다(write)
writeField(name);
  • 좀 더 나은 이름 : 이름(name)이 필드(field)라는 사실이 분명히 드러난다.
  • 위 예제는 함수 이름에 키워드를 추가하는 형식.
  • 즉 함수 이름에 인수 이름을 넣는다.

부수 효과를 일으키지 마라!

부수 효과는 거짓말이다.
함수에서 한 가지를 하겠다고 약속하고선 남몰래 다른 짓도 하게된다.
때로는예상치 못하게 클래스 변수를 수정하거나, 함수로 넘어온 인수나 시스템 전역 변수를 수정한다.

  • 많은 경우 시간적인 결합이나 순서 종속성을 초래한다.
public boolean checkPassword(String userName, String password) {
	...
    if("Valid Password".equals(phrase)) {
    	Session.initialize();
        return true;
    }
    ...
}
  • 여기서 함수가 일으키는 부수 효과는 Session.initialize(); 호출이다.
  • checkPassword 함수는 이름 그대로 암호를 확인한다.
  • 이름만 봐서는 세션을 초기화 한다는 사실이 드러나지 않는다.
  • 이런 부수 효과가 시간적인 결합을 초래한다.
  • 즉, 이 함수는 특정 상황에서만 호출이 가능하다. (세션을 초기화해도 괜찮은 경우에만 호출이 가능하다.)
  • 자칫 잘못 호출하면 의도하지 않게 세션 정보가 날아가 시간적인 결합은 혼란을 일으킨다.
  • 만약 시간적인 결합이 필요하다면 함수 이름에 분명히 명시한다.
    - checkPasswordAndInitializeSession
    - 물론 한 가지 만 한다는 규칙을 위반하지만,,

출력 인수

명령과 조회를 분리하라!

함수는 뭔가를 수행하거나 뭔가에 답하거나 둘 중 하나만 해야 한다.
둘 다 하면 안된다.
객체 상태를 변경하거나 아니면 객체 정보를 반환하거나 둘 중 하나다.

public boolean set(String attribute, String value);
  • 이 함수는 이름이 attribute인 속성을 찾아 값을 value로 설정한 후 true / false를 반환한다.
if(set"username", "unclebob"))...

  • 그래서 아래와 같이 괴상한 코드가 나온다.

  • 함수를 구현한 개발자는 set을 동사로 의도했다.

  • 하지만 if 문에 넣고 보면 형용사로 느껴진다.

if (attributeExists("username")) {
	setAttribute("username", "unclebob");
    ...
}
  • 명령과 조회를 분리해 혼란을 뿌리뽑는 방법.

오류 코드보다 예외를 사용하라!

명령 함수에서 오류 코드를 반환하는 방식은 명령/조회 분리 규칙을 미묘하게 위반한다.
자칫하면 if문에서 명령을 표현식으로 사용하기 쉬운 탓이다.

if(deletePage(page) == E_OK) {
	...
} else {
	...
}
  • 위 코드는 동사/형용사 혼란을 일으키지 않는 대신 여러 단계로 중첩되는 코드를 야기한다.
  • 오류 코드를 반환하면 호출자는 오류 코드를 곧바로 처리해야 한다는 문제에 부딪힌다.
try {
	deletePage(page);
	...
} catch (Exception e) {
	...
}
  • 오류 코드 대신 예외를 사용하면 오류 처리 코드가 원래 코드에서 분리되므로 코드가 깔끔해진다.

Try/Catch 블록 뽑아내기

  • try/catch 블록은 원래 추하다.
  • 코드 구조에 혼란을 일으키며, 정상 동작과 오류 처리 동작을 뒤섞는다.

오류 처리도 한 가지 작업이다.

  • 함수는 한 가지 작업만 해야 한다. (오류 처리도 이에 속한다.)
  • 함수에 키워드 try가 있다면 함수는 try문으로 시작해 catch/finally 문으로 끝나야 한다.

Error.java 의존성 자석

  • 오류 코드를 반환한다는 이야기는 클래스든 열거형 변수든, 어디선가 오류 코드를 정의한다는 뜻이다.
public enum Error {
	OK,
    INVALID,
    NO_SUCH,
    LOCKED,
    OUT_OF_RESOURCES,
    WATING_FOR_EVENT;
}
  • 위와 같은 클래스는 의존성 자석이다. (다른 클래스에서 Error enum을 import해 사용해야 함)
  • Error enum이 변한다면 사용하는 클래스 전부를 다시 컴파일하고 다시 배치해야 한다.
  • 오류 코드 대신 예외를 사용하면 새 예외는 Exception 클래스에서 파생된다.
  • 따라서, 재컴파일/재배치 없이도 새 예외 클래스를 추가할 수 있다.

반복하지 마라!

반복되는 알고리즘 코드는 코드 길이가 늘어날 뿐 아니라 알고리즘이 변하면 일일이 수정해야 한다.
내부 메소드를 이용하여 중복을 없애면 모듈 가독성이 크게 높아진다.
어쩌면 중복은 소프트웨어에서 모든 악의 근원이다.

구조적 프로그래밍

데이크스트라는 모든 함수와 함수 내 모든 블록에 입구와 출구는 하나만 존재해야 한다고 말했다.
즉, 함수는 return문이 하나여야 한다.
루프 안에서 break나 continue를 사용해선 안 되며 goto는 절대로, 절대로 안 된다.

함수를 어떻게 짜죠?

소프트웨어를 짜는 행위는 여느 글짓기와 비슷하다.
논문이나 기사를 작성할 때는 먼저 생각을 기록한 후 읽기 좋게 다듬는다.
초안은 대개 서투르고 어수선하므로 원하는 대로 읽힐 때까지 말을 다듬고 문장을 고치고 문단을 정리한다.

  • 함수를 짤 때도 마찬가지다.

서투른 코드를 빠짐없이 테스트하는 단위 테스트 케이스도 만든다.
그런 다음 코드를 다듬고, 함수를 만들고, 이름을 바꾸고, 중복을 제거한다.
메서드를 줄이고 순서를 바꾼다.
때로는 전체 클래스를 쪼개기도 한다.
이 와중에 코드는 항상 단위 테스트를 통과한다.

profile
종현
jh
이전 포스트

Clean Code - 깨끗한 코드

다음 포스트

Clean Code - 주석

0개의 댓글