TIL (Today I Learned)
2024.03.05
🔖 오늘 읽은 범위
3장. 함수
💡 책에서 기억하고 싶은 내용
어떤 프로그램이든 가장 기본적인 단위가 함수다.
작게 만들어라!
함수를 만드는 첫째 규칙은 '작게!'다. 함수를 만드는 둘째 규칙은 '더 작게!'다.
블록과 들여쓰기
if문/else문/while문 등에 들어가는 블록은 한 줄이어야 한다는 의미다. 대게 거기서 함수를 호출한다. 그러면 바깥을 감싸는 함수가 작아질 뿐 아니라, 블록 안에서 호출하는 함수 이름을 적절히 짓는다면, 코드를 이해하기도 쉬워진다.
이 말은 중첩 구조가 생길만큼 함수가 커져서는 안 된다는 뜻이다. 그러므로 함수에서 들여쓰기 수준은 1단이나 2단을 넘어서면 안 된다. 당연한 말이지만, 그래야 함수는 읽고 이해하기 쉬워진다.
한 가지만 해라!
함수는 한 가지를 해야 한다. 그 한 가지를 잘 해야 한다. 그 한 가지만을 해야 한다.
지정된 함수 이름 아래에서 추상화 수준이 하나인 단계만 수행한다면 그 함수는 한 가지 작업만 한다. 어쨌거나 우리가 함수를 만드는 이유는 큰 개념을 다음 추상화 수준에서 여러 단계로 나눠 수행하기 위해서가 아니던가.
의미 있는 이름으로 다른 함수를 추출할 수 있다면 그 함수는 여러 작업
을 하는 셈이다.
함수 당 추상화 수준은 하나로!
함수가 확실히 '한 가지' 작업만 하려면 함수 내 모든 문장의 추상화 수준이 동일해야 한다.
한 함수 내에 추상화 수준을 섞으면 코드를 읽는 사람이 헷갈린다.
특정 표현이 근본 개념인지 아니면 세부사항인지 구분하기 어려운 탓이다. 근본 개념과 세부사항을 뒤섞기 시작하면, 깨어진 창문처럼 사람들이 함수에 세부사항을 점점 더 추가한다.
위에서 아래로 코드 읽기: 내려가기 규칙
코드는 위에서 아래로 이야기처럼 읽혀야 좋다.
한 함수 다음에는 추상화 수준이 한 단계 낮은 함수가 온다. 즉, 위에서 아래로 프로그램을 읽으면 함수 추상화 수준이 한 번에 한 단계씩 낮아진다. 이것을 내려가기 규칙이라 부른다.
Switch문
switch문은 작게 만들기 어렵다. 하지만 switch문을 저차원 클래스에 숨기고 절대로 반복하지 않는 방법이 있다. 물론 다형성을 이용한다.
switch문을 추상 팩토리에 꽁꽁 숨긴다. 아무에게도 보여주지 않는다.
팩토리는 switch문을 사용해 적절한 Employee 파생 클래스의 인스턴스를 생성한다. Employee 인터페이스를 거쳐서 호출된 함수는 다형성으로 인해 실제 파생 클래스의 함수가 실행된다.
서술적인 이름을 사용하라!
워드가 말했던 원칙을 기억하는가? "코드를 읽으면서 짐작했던 기능을 각 루틴이 그대로 수행한다면 깨끗한 코드라 불러도 되겠다." 한 가지만 하는 작은 함수에 좋은 이름을 붙인다면 이런 원칙을 달성함에 있어 이미 절반은 성공했다. 함수가 작고 단순할수록 서술적인 이름을 고르기도 쉬워진다.
이름이 길어도 괜찮다. 겁먹을 필요없다.
길고 서술적인 이름이 짧고 어려운 이름보다 좋다.
길고 서술적인 이름이 길고 서술적인 주석보다 좋다.
서술적인 이름을 사용하면 개발자 머릿속에서도 설계가 뚜렷해지므로 코드를 개선하기 쉬워진다.
이름을 붙일 때는 일관성이 있어야 한다.
모듈 내에서 함수 이름은 같은 문구, 명사, 동사를 사용한다.incloudSetupAndTearDownPages incloudSetupPages incloudSuiteSetupPage incloudSetupPage
함수 인수
함수에서 이상적인 인수 개수는 0개(무항)다. 3개(삼항)는 가능한 피하는 편이 좋다. 4개 이상(다항)은 특별한 이유가 필요하다. 특별한 이유가 있어도 사용하면 안 된다.
테스트 관점에서 보면 인수는 더 어렵다. 갖가지 인수 조합으로 함수를 검증하는 테스트 케이스를 작성한다고 상상해보라! 인수가 없다면 간단하다.
단항 형식
함수에 인수 1개를 넘기는 이유로 가장 흔한 경우는 두 가지다.
하나는 인수에 질문을 던지는 경우다.
boolean fileExists("MyFile")
다른 하나는 인수를 뭔가로 변환해 결과를 반환하는 경우다.
플래그 인수
플래그 인수는 추하다. 함수로 부울 값을 넘기는 관례는 정말로 끔찍하다. 왜냐고? 함수가 한꺼번에 여러 가지를 처리한다고 대놓고 공표하는 셈이니까!
이항 함수
인수가 2개인 함수는 인수가 1개인 함수보다 이해하기 어렵다.
물론 이항 함수가 적절한 경우도 있다. 인수 2개에 자연적인 순서가 있을 때다.
하지만 그만큼 위험이 따른다는 사실을 이해하고 가능하면 단항 함수로 바꾸도록 애써야 한다.
삼항 함수
인수가 3개인 함수는 인수가 2개인 함수보다 훨씬 더 이해하기 어렵다. 순서, 주춤, 무시로 야기되는 문제가 두 배 이상 늘어난다. 그래서 삼항 함수를 만들 때는 신중히 고려하라 권고한다.
인수 객체
인수가 2-3개 필요하다면 일부를 독자적인 클래스 변수로 선언할 가능성을 짚어본다.
인수 목록
동사와 키워드
함수의 의도나 인수의 순서와 의도를 제대로 표현하려면 좋은 함수 이름이 필수다. 단항 함수는 함수와 인수가 동사/명사 쌍을 이뤄야 한다.
writeField(name)
name이 field라는 사실이 분명히 드러남
함수 이름에 키워드를 추가하는 형식
함수 이름에 인수 이름을 넣는다. 그러면 인수 순서를 기억할 필요가 없어진다.❌ assertEquals ⭕️ assertExpectedEqualsActual(expected, actual)
부수 효과를 일으키지 마라!
부수 효과는 거짓말이다. 함수에서 한 가지를 하겠다고 약속하고선 남몰래 다른 짓도 하니까.
출력 인수
일반적으로 출력 인수는 피해야 한다. 함수에서 상태를 변경해야 한다면 함수가 속한 객체 상태를 변경하는 방식을 택한다.
명령과 조회를 분리하라!
함수는 객체 상태를 변경하거나 아니면 객체 정보를 반환하거나 둘 중 하나다. 둘 다 하면 안 된다. 둘 다 하면 혼란을 초래한다.
진짜 해결책은 명령과 조회를 분리해 혼란을 애초에 뿌리뽑는 방법이다.
오류 코드보다 예외를 사용하라!
명령 함수에서 오류 코드를 반환하는 방식은 명령/조회 분리 규칙을 미묘하게 위반한다.자칫하면 if문에서 명령을 표현식으로 사용하기 쉬운 탓이다.
오류 코드를 반환하면 호출자는 오류 코드를 곧바로 처리해야 한다는 문제에 부딪힌다.
반면 오류 코드 대신 예외를 사용하면 오류 처리 코드가 원래 코드에서 분리되므로 코드가 깔끔해진다.
Try/Catch 블록 뽑아내기
try/catch 블록은 원래 추하다. 코드 구조에 혼란을 일으키며, 정상 동작과 오류 처리 동작을 뒤섞는다. 그러므로 try/catch 블록을 별도 함수로 뽑아내는 편이 좋다. - p.58
오류 처리도 한 가지 작업이다.
오류를 처리하는 함수는 오류만 처리해야 마땅하다.
함수에 키워드 try가 있다면 함수는 try문으로 시작해 catch/finally문으로 끝나야 한다는 말이다.
Error.java 의존성 자석
오류 코드 대신 예외를 사용하면 새 예외는 Exception 클래스에서 파생된다. 따라서 재컴파일/재배치 없이도 새 예외 클래스를 추가할 수 있다.
반복하지 마라!
incloud 방법으로 중복을 없앤다.
객체 지향 프로그래밍은 코드를 부모 클래스로 몰아 중복을 없앤다.
구조적 프로그래밍, AOP, COP 모두 어떤 면에서 중복 제거 전략이다.
구조적 프로그래밍
모든 함수와 함수 내 모든 블록에 입구와 출구가 하나만 존재해야 한다고 말했다. 즉, 함수는 return문이 하나여야 한다는 말이다.
루프 안에서 break나 continue를 사용해선 안 되며 goto는 절대로, 절대로 안 된다.
구조적 프로그래밍의 목표와 규율은 공감하지만 함수가 작다면 위 규칙은 별 이익을 제공하지 못한다. 함수가 아주 클 때만 상당한 이익을 제공한다.
함수를 작게 만든다면 간혹 return, break, continue를 여러 차례 사용해도 괜찮다. 반면, goto문은 큰 함수에서만 의미가 있으므로, 작은 함수에서는 피해야만 한다.
함수를 어떻게 짜죠?
소프트웨어를 짜는 행위는 여느 글짓기와 비슷하다.
처음부터 탁 짜내지 않는다. 그게 가능한 사람은 없으리라.
결론
진짜 목표는 시스템이라는 이야기를 풀어가는 데 있다는 사실을 명심하길 바란다.
작성하는 함수가 분명하고 정확한 언어로 깔끔하게 같이 맞아떨어져야 이야기를 풀어가기가 쉬워진다는 사실을 기억하기 바란다.
✏️ 오늘 읽은 소감
매번 코드를 짤 때 함수를 어디까지 나눠야 할지 궁금했었는데 드디어 이번 챕터를 읽고 그 궁금증을 해소할 수 있었다.
특히 글에서 계속 강조하고 있는 "함수는 한 가지만을 해야 한다" 라는 팁은 꼭 명심해야겠다.
함수가 한 가지 작업만 하는 그 기준이 추상화 수준이 하나라는 것도 잊지 말아야겠다는 생각이 들었다.
함수 이름을 지을 때도 짧게 지어줘야 하는 건지, 길게 지어주는게 맞는지 항상 긴가만가했는데 길어지더라도 목적이 뚜렷하면 짧고 모호한 것보다는 훨씬 낫다고 하니 길더라도 목적을 뚜렷하게 잘 드러낼 수 있도록 잘 지어야겠다는 점도 배울 수 있었다.
그리고 켄트가 개발했다는 화면에 반짝이를 뿌려주는 프로그램이 너무 궁금하다. 함수가 얼마나 작았던 거지? 모든 함수가 5줄이 안 되는데 명백하고 깔끔하다고 할 정도라고 하니🤔
나 또한 저번 글에서 개발자는 작가랑 비슷하다는 말을 했었는데 이 책에서도 '함수를 어떻게 짜죠?' 부분에서 소프트웨어를 짜는 행위는 글짓기와 비슷하다는 말을 하고 있어서 놀랐다..ㅎ
역시 공감이 가는게 지금 이렇게 소감을 쓰는 것도 일단 한 번에 쓰고 여러 번 고치면서 다듬고 있는데 개발도 마찬가지인 것 같다. 처음부터 한 번에 개발하려고 하면 오히려 시간이 많이 걸리니 일단 한 줄씩 작성하면서 구현이 완료되면 중복을 제거하고 쪼개는 것부터 차근차근 해 나가자!
예제들이 잘 되어있으니 참고해서 연습해보려고 한다.
책에서 알려준 귀중한 팁들을 새겨두고 하나씩 실천해보자.
🤔 궁금한 내용이나 잘 이해되지 않는 내용
- 시간적인 결합 / 순서 종속성
- 의존성 자석
- 구조적 프로그래밍
