2022-06-20 @이영훈
서술적인 이름을 사용하라!
코드를 읽으면서 짐작했던 기능을 각 루틴이 그대로 수행한다면 깨끗한 코드라 불러도 되겠다.
- 워드 아저씨
길고 서술적인 이름이 짧고 어려운 이름보다 좋다.
길고 서술적인 이름이 길고 서술적인 주석보다 좋다.
함수 이름을 정할 때는 여러 단어가 쉽게 읽히는 명명법을 사용한다. 그런 다음, 여러 단어를 사용해 함수 기능을 잘 표현하는 이름을 선택한다.
•
testableHtml 보다 setupTeardownIncluder 가 더 좋다
이름을 붙일 때는 일관성이 있어야 한다. 모듈 내에서 함수 이름은 같은 문구, 명사, 동사를 사용한다.
•
includeSetupAndTeardownPages, includeSetupPages, includeSuiteSetupPage, includeSetupPage
함수 인수
함수에서 이상적인 인수 개수는 0개(무항)다. 다음은 1개고, 다음은 2개다. 3개는 가능한 피하는 편이 좋다. 4개 이상은 특별한 이유가 필요하다. 특별한 이유가 있어도 사용하면 안된다.
인수는 어렵다. 인수는 개념을 이해하기 어렵게 만든다.
많이 쓰는 단항 형식
함수에 인수 1개를 넘기는 이유는 크게 두 가지다.
1.
인수에 질문을 던지는 경우
boolean fileExists("SomeFile")
2.
인수를 뭔가로 변환해 결과를 반환하는 경우
InputStream fileOpen("SomeFile")
드물게 사용하지만 그래도 유용한 단항 함수 형식은 이벤트다
플래그 인수
함수로 boolean 값을 넘기는 관례는 끔찍하다. 함수가 여러 가지를 처리하는 것이기 때문이다.
render(boolean isSuite)보다는, renderForSuite()와 renderForSingleTest()로 나누어야 한다.
이항 함수
인수가 2개인 함수는 인수가 1개인 함수보다 이해하기 어렵다.
•
writeField(name)은 writeField(outputStream, name)보다 이해하기 쉽다
assertEquals(expected, actual)에도 문제가 있다. expected 인수에 actual 값을 집어넣는 실수가 얼마나 많던가
좋은 예도 있다. 두 인수의 자연적인 순서가 있는 경우
Point p = new Point(0, 0)
가능하면 단항함수로 바꾸도록 해야한다.
•
writeField 메서드를 outputStream 클래스 맴버 함수로 만들어 outputStream.writeField(name)
삼항 함수
인수가 3개인 함수는 인수가 2개인 함수보다 훨씬 더 이해하기 어렵다.
예를 들어, assertEquals(message, expected, actual)
인수 객체
인수가 2~3개 필요하다면 일부를 독자적인 클래스 변수로 선언할 가능성을 짚어본다
•
Circle makeCircle(double x, double y, double radius); 보다
•
Circle makeCircle(Point center, double radius); 가 낫다
x, y를 묶었듯이 묶었듯이 변수를 묶어 넘기려면 이름을 붙여야 하므로 결국은 개념을 표현하게 된다.
동사와 키워드
‘함수의 의도’나 ‘인수의 순서와 의도’를 제대로 표현하려면 좋은 함수 이름이 필수다.
단항 함수는 함수와 인수가 동사/명사 쌍을 이뤄야 한다.
•
write(name)은 누구나 이해한다.
•
더 나은 이름은 writeField(name)이다. 그러면 name이 field라는 사실이 분명히 드러난다
함수 이름에 키워드를 추가하는 형식이다.
•
assertEquals(expected, actual)보다
•
assertExpectedEqualsActual(expected, actual)이 더 좋다. 그러면 인수 순서를 기억할 필요가 없다.
부수 효과를 일으키지 마라!
함수에서 한 가지를 하겠다고 약속하고 남몰래 다른 짓을 하면 안된다.
•
예상치 못하게 클래스 변수를 수정한다.
•
함수로 넘어온 인수나 시스템 전역 변수를 수정한다.
•
시간적인 결합)(temporal coupling), 순서 종속성(order dependency)을 초래한다.
public class UserValidator {
private Cryptographer cryptographer;
public boolean checkPassword(String userName, String password) {
User user = UserGateway.findByName(userName); // 예전에는 JPA가 없었을 때, 또는 그 전 gateway라 썼나봄
if (user != User.NULL) {
String codedPhrase = user.getPhraseEncodedByPassword();
String phrase = cryptographer.decrypt(codedPhrase, password);
if ("Valid Password".equals(phrase)) {
Session.initialize(); // ❌
return true;
}
}
return false;
}
}
Java
복사
이 함수가 일으키는 부수 효과는 Session.initialize() 호출이다. 이름만 봐서는 세션을 초기화한다는 사실이 드러나지 않는다. 세션을 초기화해도 괜찮은 경우에만 호출이 가능하다. 시간적인 결합은 혼란을 일으킨다.
이 함수는 checkPassword 이름보다 checkPasswordAndInitializeSession이 더 좋다. 물론 함수가 ‘한 가지'만 한다는 규칙을 위반하지만.
출력 인수
일반적으로 우리는 인수를 함수 입력으로 해석한다.
일반적으로 출력 인수는 피해야 한다. 함수에서 상태를 변경해야 한다면 함수가 속한 객체 상태를 변경하는 방식을 택한다.
•
appendFooter(s); 이 함수는 s에 바닥글을 첨부할까? 바닥글에 s를 첨부할까?
•
s가 report라면,
•
report.appendFooter(); 방식으로 작성해야 한다.
명령과 조회를 분리하라!
함수는 ‘뭔가를 수행’하거나 ‘뭔가에 답하거나' 둘 중 하나만 해야 한다.
‘객체 상태를 변경'하거나 아니면 ‘객체 정보를 반환'하거나 둘 중 하나다.
public boolean set(String attribute, String value);
// ❌ 나쁜 예시
if (set("username", "unclebob")) {
...
}
// ⭕️ 좋은 예시
// 명령과 조회를 분리해 혼란을 애초에 막는다.
if (attributeExists("username")) {
setAttribute("username", "unclebob");
...
}
Java
복사
오류 코드보다 예외를 사용하라!
명령 함수에서 오류 코드를 반환하는 방식은 ‘명령/조회 분리 규칙'을 미묘하게 위반한다. 자칫하면 if 문에서 명령을 표현식으로 사용하기 쉬운 탓이다.
오류 코드를 반환하면 호출자는 오류 코드를 곧바로 처리해야 하는 문제에 부딪힌다.
if (deletePage(page) == E_OK) {
if (registry.deleteReference(page.name) == E_OK) {
if (configKeys.deleteKey(page.name.makeKey()) == E_OK) {
logger.log("page deleted");
} else {
logger.log("configKey not deleted");
}
} else {
logger.log("deletReference from registry failed");
}
} else {
logger.log("delete failed");
return E_ERROR;
}
Java
복사
반면 오류 코드 대신 예외를 사용하면 오류 처리 코드가 원래 코드에서 분리되므로 코드가 깔끔해진다.
try {
deletePage(page);
registry.deleteReference(page.name);
configKeys.deleteKey(page.name.makeKey());
} catch (Exception e) {
logger.log(e.getMessage());
}
Java
복사
여기에서 더 나아가 아래 문단을 읽어보고 더 깔끔하게 코드를 작성하자
Try/Catch 블록 뽑아내기
‘정상 동작’과 ‘오류 처리 동작’을 분리하면 코드를 이해하고 수정하기 쉬워진다.
deletePageAndAllReferences는 예외를 처리하지 않는다. 정상 동작으로 분리한다.
public void delete(Page page) {
try {
deletePageAndAllReferences(page);
} catch (Exception e) {
logError(e);
}
}
private void deletePageAndAllReferences(Page page) throws Exception {
deletePage(page);
registry.deleteReference(page.name);
configKeys.deleteKey(page.name.makeKey());
}
private void logError(Exception e) {
logger.log(e.getMessage());
}
Java
복사
오류 처리도 한 가지 작업이다.
함수는 ‘한 가지' 작업만 해야 한다. 오류 처리도 ‘한 가지' 작업에 속한다.
오류를 처리하는 함수는 오류만 처리해야 마땅하다.
함수에 키워드 try가 있다면 함수는 try 문으로 시작해 catch/finally 문으로 끝나야 한다.
반복하지 마라!
어쩌면 중복은 소프트웨어에서 모든 악의 근원이다. 많은 원칙과 기법이 중복을 없애거나 제어할 목적으로 나왔다.
•
E.F.커드는 자료에서 중복을 제거할 목적으로 관계형 데이터베이스에 정규 형식을 만들었다.
•
객체 지향 프로그래밍은 코드를 부모 클래스로 몰아 중복을 없앤다.
•
구조적 프로그래밍, AOP(Aspect Oriented Programming), COP(Component Oriented Programming) 모두 어떤 면에서 중복 제거 전략이다.
함수를 어떻게 짜죠?
소프트웨어를 짜는 행위는 글짓기와 비슷하다.
1.
처음에는 길고 복잡하다 들여쓰기 단계도 많고 중복된 루프도 많다. 인수 목록도 아주 길다. 이름은 즉흥적이고 코드는 중복된다. 하지만 나는 그 서투른 코드를 빠짐없이 테스트하는 단위 테스트 케이스도 만든다.
2.
그런 다음 코드를 다듬고, 함수를 만들고, 이름을 바꾸고, 중복을 제거한다. 메서드를 줄이고 순서를 바꾼다. 때로는 전체 클래스를 쪼개기도 한다. 이 와중에도 코드는 항상 단위 테스트를 통과한다.
결론
대가 프로그래머는 시스템을 구현할 프로그램이 아니라 풀어갈 이야기로 여긴다. 프로그래밍 언어라는 수단을 사용해 좀 더 풍부하고 좀 더 표현력이 강한 언어를 만들어 이야기를 풀어간다.
진짜 목표는 시스템이라는 이야기를 풀어가는 데 있다. 작성하는 함수가 분명하고 정확한 언어로 깔끔하게 같이 맞아떨어져야 이야기를 풀어가기가 쉬워진다라는 사실을 기억하기 바란다.