"실무로 통하는 클린 코드" 도서 리뷰

 

한빛미디어의 나는리뷰어다 2024를 통해 8월, 실무로 통하는 클린 코드 (Clean Code Cookbook) 도서를 제공 받아 읽어보게 되었습니다.

 

책은 약 500p 정도의 분량으로 얇은 편은 아니고요, 클린 코드에 대해 관심이 많기도 하고, 예전에 읽었던 클린 코드 생각도 나서 읽어보게 되었네요. 전부 읽지는 못했고, 60%정도만 읽은 상태에서 더 읽으면서 내용이 추가될 수 있습니다.

 

결론부터 말씀드리면 클린 코드 (Clean Code) 도서와 비슷한 내용들이 많았어서 클린 코드를 읽었다면, 굳이 이 책을 보지는 않아도 될 것 같습니다..(?)

 

 

2장 공리 설정

38p, 소프트웨어는 시뮬레이터를 구축하는 것과 같으며 MAPPER (매퍼) 라는 약어로 표현합니다.
MAPPER (Model: Abstract Partial and Programmable Explaining Reality), 모델은 부분적 추상화와 프로그래밍을 통해 현실을 묘사해야 함

 

MAPPER 라는 용어가 책 여기 저기에 나오는데요, 추상화를 통해 현실을 묘사해야 한다는 개념입니다.

 

 

3장 빈약한 모델

51p, 객체를 디자인할 때 데이터만 모델링하는 빈약한 객체를 만들기보다는, 객체의 동작을 기반으로 객체를 디자인해야 합니다

// ...

private List<Integer> data;

public List<Integer> getData() {
  return data; // 캡슐화 위반
}

getData() 메서드는 내부 데이터 컬렉션의 복사본을 만드는 대신 내부 데이터 컬렉션에 대한 참조를 반환하여, 외부에서 컬렉션을 변경하면 내부 데이터에 직접 반영되어 예기치 않은 동작, 결함이 발생할 수 있다.

 

 

 

4장 기본형 집착

72p, 작은 객체 생성하기 (VO, Value Object)

// As-Is
public Class Person {
  private final String name;
	
	...
}

// To-Be
public class Person {
  private final Name name;
	
	...
}

VO 객체를 적극적으로 사용해보기도 하고, 사용하지 않은 케이스도 있지만, 각각의 장단점들이 존재하는 것 같습니다.

 

 

6장 선언적 코드

111p, 변수, 메서드, 클래스의 네이밍은 항상 긍정적인 네이밍으로 설정하세요 (가독성)
https://refactoring.com/catalog/removeDoubleNegative.html

// Bad
if (!work.isNotFinished()) ...

// Good
if (work.isDone()) ...

개인적으로 공감하는 규칙인데요, 이중 부정의 네이밍은 한 번 더 생각해야 하는 번거로움이 많았던 것 같습니다.

 

 

7장 명명

134p, 이름을 어떻게 지어야 할 지 모르겠다면, 마지막 함수 호출과 동일한 이름으로 네이밍

// Bad
var result = calculateAverageSalary();

// Good
var averageSalary = calculateAverageSalary();

모든 개발자의 고충 = 네이밍

 

151p, data 명칭 피하기

data가 포함된 이름을 사용하면 객체가 빈약해지므로 도메인 및 역할을 나타내는 이름을 고려해야 합니다.
변수의 이름은 해당 변수의 도메인과 이에 수행하는 역할을 반영해야 합니다.

// Bad
if (!dataExists()) ...

// Good
if (!peopleFound()) ...

data... xxxdata 등의 네이밍은 레거시 코드에서 굉장히 많이 봐왔었던 네이밍이어서 더욱 공감이 가는 것 같네요.. 😂

 

 

8장 주석

164p, 주석을 테스트로 대체하기

문제: 함수가 수행하는 작업을 설명하는 주석이 있는데, 정적이고 오래된 설명대신 동적이고 유지 관리가 잘 되는 문서화를 원합니다.
-> 주석을 가져와서 함축시켜 함수명으로 사용하고, 코드를 테스트한 뒤 주석을 제거하세요.

def multiply(a, b):
	# 두 숫자 곱한 결과
	# 숫자 중 하나가 0이면 결과는 0
	# 두 숫자가 모두 양수이면 결과는 양수
	# 두 숫자가 모두 음수이면 결과는 양수
	return a * b
	
	
# Test
class TestMultiply(unittest.TestCase):
	def test_multiply_both_possitive_outcome_is_possitive ...
	def test_multiply_both_negative_outcome_is_positive
	def test_multiply_first_is_zero_outcome_is_zero ...
	def test_multiply_second_is_zero_outcome_is_zero ...

무의미하고 불필요한 주석은 지양하지만, 주석의 결과물에 대해 테스트 코드로 유지하는 방법도 있겠네요.

 

 

9장 표준

대규모 조직에서는 서로 다른 팀과 개발자가 공통의 규칙과 모범 사례에 따라 작업할 수 있도록 코드 규칙을 마련하는 것이 중요합니다. → 코딩 표준 적용

 

 

10장 복잡성

복잡성을 처리하는 데 가장 효과적인 도구는 추상화입니다. 캡슐화는 객체 지향 프로그래밍에서 복잡성을 관리하는 주요 추상화 방법
복잡성은 모든 대규모 소프트웨어 시스템에 존재하며 종종 문제의 주요 원인이 됩니다. → 우발적인 복잡성을 가능한 한 가장 낮은 수준으로 유지해야 합니다.

복잡성을 잘 관리하는 것이 굉장히 중요하다고 생각하는데요, 책의 내용들은 클린 코드와 거의 비슷해서 더 작성하지는 않았습니다.

(반복 코드 제거, 속성으로 상태 변경하기, 코드에서 교묘함 제거하기, 메서드를 객체로 추출하기 등등)

 

 

11장 블로터

205p, 과도한 메서드 제거하기

클래스를 보다 응집력있는 작은 조각으로 나누세요.

// Bad
public class MyHelperClass {
	public void print() ...
	public void format() ...
	public vod persist() ...
	
	...
}

// Good
public class Printer {
	public void print() ...
}

public class DateToStringFormatter {
	public void format() ...
}

...

Util 성격의 클래스들에 대한 예제이지만, 흔히 사용하는 스프링에서도 적용할 수 있을 것 같습니다. (API, 컨트롤러 분리)

 

 

13장 빠른 실패

231p, switch 문에서 기본값 제거하기

case 문에 default 를 추가하지 말고, 예외를 발생시키는 방식으로 작성하세요. 이는 코드가 더 명시적이며, 추측에 의한 해결책을 사용하지 않도록 합니다.
default(기본값)는 ‘아직 알지 못하는 모든 것’을 의미합니다. 미래는 예측할 수 없으므로 ‘예상치 못한 경우’에 대해 기본값은 예외 처리가 되어야 합니다.

 

 

 

14장 if 문

240p, 우발적 if 문을 다형성으로 대체하기

필수로 식별되는 if문, 우발적인 if문에 대한 구분

// Bad
public class Movie {

    private String rate;

    public Movie(String rate) {
        this.rate = rate;
    }

    public String getRate() {
        return rate;
    }
}


public class MovieWatcher {

    private final int age;

    public MovieWatcher(int age) {
        this.age = age;
    }

    public void watchMovie(Movie movie) {
        // 우발적인 (결합된) 분기처리 -> 문자열로 등급을 모델링하기로 한 설계가 문제라고 한다.
        // 이는 확장을 위해 개방적이지도 않고, 수정을 위해  폐쇄적이지도 않다.
        if ((this.age < 18) && movie.getRate().equals("성인 전용")) {
            throw new IllegalStateException("이 영화를 시청할 수 없습니다.");
        } else if ((this.age < 13) && movie.getRate().equals("13세 전용")) {
            throw new IllegalStateException("이 영화를 시청할 수 없습니다.");
        }

        // else if, else if ...
        // 새로운 등급이 생길 때마다 또 다른 if 문이 필요하다.
        
        playMovie();
    }

    private void playMovie() {
    }

    public static void main(String[] args) {
        final var jane = new MovieWatcher(12);
        final var theExorcist = new Movie("성인 전용");

        // 제인은 12살이어서 영화 <엑소시트스>를 시청할 수 없습니다.
        jane.watchMovie(theExorcist);
    }
}

 

// Good
public interface MovieRate {
	// 성인 전용, 13세 전용 등의 분기 처리에 대한 구현체
    void warnIfNotAllowed(int age);
}

public class AdultsOnlyMovieRate implements MovieRate {

    // 1. 모든 if 문을 추상화로 이동하세요.
    @Override
    public void warnIfNotAllowed(int age) {
        if (age < 18) {
            throw new IllegalStateException("이 영화를 시청할 수 없습니다.");
        }
    }
}

public class PG13MovieRate implements MovieRate {

    // 2. 모든 if 문을 추상화로 이동하세요.
    @Override
    public void warnIfNotAllowed(int age) {
        if (age < 13) {
            throw new IllegalStateException("이 영화를 시청할 수 없습니다.");
        }
    }
}

public class Movie {

    private final MovieRate rate;

    public Movie(MovieRate rate) {
        this.rate = rate;
    }
    
    public void checkWatchAllowed(int age) {
        rate.warnIfNotAllowed(age);
    }
}



public class MovieWatcher {
    private final int age;

    public MovieWatcher(int age) {
        this.age = age;
    }

    public void watchMovie(Movie movie) {
        movie.checkWatchAllowed(this.age);
    }

    public static void main(String[] args) {
        final var theExorcist = new Movie(new AdultsOnlyMovieRate());
        final var gremlins = new Movie(new PG13MovieRate());

        final var jane = new MovieWatcher(12);

        jane.watchMovie(theExorcist); // 12살이어서 시청 불가
        jane.watchMovie(gremlins); // 12살이어서 시청 불가

        final var joe = new MovieWatcher(16);

        joe.watchMovie(theExorcist); // 16살이어서 시청 불가
        joe.watchMovie(gremlins); // 16살이어서 시청 가능
    }
}

 

위 예제에서는 MovieRate의 문자열 비교가 우발적인 if문에 대한 분기처리라고 하여, 필수로 식별되는 if문의 경우 대체할 필요가 없다고 말하고 있는데, 이것에 대한 정확한 판단이 잘 안서는 것 같습니다.

 

이와는 별개로 위와 같은 if, else if ... 등의 코드는 굉장히 많이 존재하는 형식이기에 유용하게 활용할 수 있는 방식입니다.

 

 

249p, boolean 변수 재구성하기

boolean 변수는 if를 작성하게 하므로 사용하지 말고, 다형성 상태를 생성하세요.

function processBatch(
	bool $useLogin,
	bool $deleteEntries) {
	// ...
}


function processBatch(
	LoginStrategy $login,
	DeletePolicy $deleteionPolicy) {
	// ...
}

boolean 변수 자체를 파라미터로 안넘기는 것도 하나의 방법일 것 같은데, 위와 같이 객체로 재구성하는 것도 좋은 방법인 것 같습니다.

 

 

256p, 암시적 else 문 추가하기

else 문이 없는 if문이 있는데, 명시적으로 표현해야 합니다.
명시적인 else 문이 있는 코드는 가독성이 높고 인지 부하가 적습니다. 또한 예기치 않은 조건을 감지하고 빠르게 실패하기 원칙을 준수합니다.

function carBrandImplicit(model) {
	if (model === 'A4') return 'Audi';
	
	return 'Mercedes-Benz';	
}


function carBrandImplicit(model) {
	if (model === 'A4') return 'Audi';
	if (model === 'AMG') return 'Mercedes-Benz';
	
	throw new Exception(model + ' 을 찾을 수 없습니다.');
}

생각해보지 못했던 포인트였는데, 좋은 방법인 것 같네요.

 

 

15장 null

276p, null 객체 생성하기

null 객체 패턴은 일반 객체처럼 동작하지만 기능이 거의 없는 특수 객체인 'null 객체' 생성을 제안합니다. 이 패턴은 if로 null 참조를 확인하지 않고도 null 객체에서 메서드를 안전하게 호출할 수 있다는 장점이 있습니다.

public class CartItem {

    private int price;

    public CartItem(int price) {
        this.price = price;
    }

    public int getPrice() {
        return price;
    }
}


public interface DiscountCoupon {

    double discount(double subtotal);
}


public class RateDiscountCoupon implements DiscountCoupon {
    private double rate;

    public RateDiscountCoupon(double rate) {
        this.rate = rate;
    }

    @Override
    public double discount(double subtotal) {
        return subtotal * (1 - rate);
    }
}


// Null Object 패턴
public class NullDiscountCoupon implements DiscountCoupon {

    @Override
    public double discount(double subtotal) {
        return subtotal;
    }
}


import java.util.List;

public class Cart {
    private List<CartItem> items;
    private DiscountCoupon discountCoupon;

    public Cart(List<CartItem> items, DiscountCoupon discountCoupon) {
        this.items = items;
        this.discountCoupon = discountCoupon;
    }

    public double subtotal() {
        return items.stream()
                .mapToDouble(CartItem::getPrice)
                .sum();
    }

    public double total() {
        return discountCoupon.discount(subtotal());
    }
}


import java.util.Arrays;

public class Main {
    public static void main(String[] args) {
        Cart cartWithDiscount = new Cart(
                Arrays.asList(
                        new CartItem(1),
                        new CartItem(2),
                        new CartItem(7)
                ),
                new RateDiscountCoupon(0.15)
        );
        System.out.println("Cart total with discount: " + cartWithDiscount.total()); // 8.5

        Cart cartWithoutDiscount = new Cart(
                Arrays.asList(
                        new CartItem(1),
                        new CartItem(2),
                        new CartItem(7)
                ),
                new NullDiscountCoupon()
        );
        System.out.println("Cart total without discount: " + cartWithoutDiscount.total()); // 10.0
    }
}

 

null 객체 패턴은 이전에도 적용해본 케이스가 있었는데, 잘 활용한다면 실제로도 굉장히 유용한 패턴이라고 생각합니다.

 

 

17장 결합도

327p, 기능에 대한 욕심 방지하기

문제: 한 객체가 다른 객체의 메서드를 너무 많이 사용합니다.
해결: 종속성을 없애고 동작을 리팩터링하세요.

기능에 대한 욕심은 한 객체가 다른 객체의 메서드를 과도하게 사용함으로써 자신의 동작보다 다른 객체의 동작에 더 관심을 가질 때 발생합니다.

// Bad
public class Candidate {
    void printJobAddress(Job job) {
    	print("...");
        print(job.address().street());
        print(job.address().city());
        ...
        }
}


// Good
public class Job {
    void printAddress() {
    	print("...");
        print(address().street());
        print(address().city());
        ...
    }
}

 

 

330p, 기본 인수를 맨 끝으로 이동하기

문제: 인수 목록 중간에 기본 인수가 있습니다.
해결: 함수 시그니쳐는 오류가 발생하기 쉽지 않아야 합니다. 기본 인수를 사용하지 않도록 하되, 꼭 필요한 경우 선택적 인수를 필수 인수 앞에 사용하지 마세요.

// Bad
function buildCar($color = "red", $model) {
	...
}

// Good
function buildCar($model, $color = "red") {
	...
}

코틀린과 같은 언어에서는 인수의 변수를 직접 설정해서 값을 넘겨줄 수 있지만, 위와 같이 사용한다면 좀 더 간단하게 나타낼 수 있을 것 같긴 합니다.

 

 

20장 테스트

아무리 많은 테스트를 해도 소프트웨어가 정확하다는 것을 증명할 수는 없지만, 한 번의 테스트로 소프트웨어가 잘못되었음을 증명할 수는 있습니다.  - 아미르 가라이 -

 

 

384p, private 메서드 테스트하기

문제: private 메서드를 테스트해야 합니다.
해결: private 메서드를 테스트하지 말고, 해당 메서드를 추출하세요

개발자라면 상위 수준의 기능을 중요하게 지원하는 내부 함수나 메서드에 대한 테스트를 작성해야 하는 어려움에 직면한 적이 있을 것입니다. 메서드의 캡슐화를 깨뜨릴 가능성이 있고, 메서드를 복사하거나 공개하고 싶지 않기 때문에 이를 직접 테스트할 수 없었습니다.

// Bad
public final class Star {

    private double distanceInParsecs;

    public double timeToReachLightToUs() {
        return convertDistanceInParsecsToLightYears(distanceInParsecs);
    }

    private double convertDistanceInParsecsToLightYears(double distanceInParsecs) {
        return 3.26 * distanceInParsecs;
        // 함수는 이미 사용 가능한 인수를 사용하고 있습니다.
        // 이 함수는 distanceInParsecs에 private 접근을 가지고 있기 때문에
        // 이는 또 다른 코드 스멜의 지표가 됩니다.

        // 이 함수는 private이기 때문에 테스트할 수 없습니다.
    }
}


// Good
public final class Star {

    private double distanceInParsecs;

    public double timeToReachLightToUs() {
        return new ParsecsToLightYearsConverter().convert(distanceInParsecs);
    }
}

public final class ParsecsToLightYearsConverter {
    public double convert(double distanceInParsecs) {
        return 3.26 * distanceInParsecs;
    }
}


public class ParsecsToLightYearsConverterTest {

    @Test
    public void testConvert0ParsecsReturns0LightYears() {
        assertEquals(0, new ParsecsToLightYearsConverter().convert(0));
    }

    // 다양한 테스트를 추가할 수 있으며, 이 객체에 의존할 수 있습니다.
    // 따라서 Star의 변환을 테스트할 필요가 없습니다.
    // 그러나 여전히 Star의 timeToReachLightToUs() 메소드를 테스트할 수 있습니다.
    // 이건 간소화된 시나리오입니다.
}

 

 

399p, 캡슐화를 위반하는 테스트 보호하기

문제: 캡슐화를 위반하는 테스트가 있습니다.
해결: 테스트를 위해 메서드를 만들지 마세요.

가끔은 테스트를 우선시하는 코드를 작성하다 보면 해당 코드가 캡슐화를 위반하고 나쁜 인터페이스를 유발해 불필요한 결합을 가져올 수 있습니다. 테스트는 전체 환경을 통제해야 하며, 여러분이 객체를 제어할 수 없다면 원치 않는 결합을 발견할 것입니다. 이들을 분리하세요.

// Bad
import java.util.Random;

public class Hangman {

    private String wordToGuess;

    public Hangman() {
        this.wordToGuess = getRandomWord();
        // 테스트는 이것을 제어할 수 없습니다.
    }

    public String getWordToGuess() {
        return wordToGuess;
        // 안타깝게도 이것을 공개해야 합니다.
    }

    private String getRandomWord() {
        // 무작위 단어 생성 로직 (간단한 예시)
        String[] words = {"apple", "banana", "cherry"};
        return words[new Random().nextInt(words.length)];
    }
}

import static org.junit.jupiter.api.Assertions.assertEquals;
import org.junit.jupiter.api.Test;

public class HangmanTest {

    @Test
    public void testWordIsGuessed() {
        Hangman hangmanGame = new Hangman();
        assertEquals("tests", hangmanGame.getWordToGuess());
        // 어떻게 단어가 맞추어졌는지 확인할 수 있습니까?
    }
}


// Good
public interface WordRandomizer {
    String newRandomWord();
}

public class Hangman {

    private String wordToGuess;
    private StringBuilder guessedWord;

    public Hangman(WordRandomizer wordRandomizer) {
        this.wordToGuess = wordRandomizer.newRandomWord();
        this.guessedWord = new StringBuilder("_".repeat(wordToGuess.length()));
    }

    public boolean wordWasGuessed() {
        return wordToGuess.equals(guessedWord.toString());
    }

    public void play(char letter) {
        for (int i = 0; i < wordToGuess.length(); i++) {
            if (wordToGuess.charAt(i) == letter) {
                guessedWord.setCharAt(i, letter);
            }
        }
    }
}

public class MockRandomizer implements WordRandomizer {

    @Override
    public String newRandomWord() {
        return "tests";
    }
}

import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertTrue;
import org.junit.jupiter.api.Test;

public class HangmanTest {

    @Test
    public void testWordIsGuessed() {
        Hangman hangmanGame = new Hangman(new MockRandomizer());
        // 이제 완전한 제어를 가집니다!
        assertFalse(hangmanGame.wordWasGuessed());
        hangmanGame.play('t');
        assertFalse(hangmanGame.wordWasGuessed());
        hangmanGame.play('e');
        assertFalse(hangmanGame.wordWasGuessed());
        hangmanGame.play('s');
        assertTrue(hangmanGame.wordWasGuessed());
        // 이제 동작을 테스트합니다.
    }
}

 

 

22장 예외

420p, 중첩된 try/catch 재작성하기

문제: 중첩된 try/catch가 많습니다.
해결: 예외를 중첩시키지 마세요. 그렇게 되면 내부 블록에서 수행하는 작업을 따라가기 어렵습니다. 처리 메커니즘을 다른 클래스나 함수로 추출하세요.

// Bad
try {
    transaction.commit();
} catch (e) {
    logerror(e);
    if (e instanceOf DBError) {
      try {
          transaction.rollback();
      } catch (e) {
          doMoreLoggingRollbackFailed(e);
      }
    }
}


// Good
try {
    transaction.commit();
} catch (transactionError) {
    this.withTransactionErrorDo(
        transationError, transaction);
}

 

 

25장 보안

복잡성은 치명적입니다. 복잡성은 개발자의 생기를 빼앗아가고 제품을 계획, 구축, 테스트하기 어렵게 만들고, 보안 문제를 발생시키며 최종 사용자와 관리자가 좌절을 맛보게 합니다.
시니어 개발자는 단순히 깨끗하고 유지 보수 가능한 코드를 작성하는 능력뿐만 아니라 성능, 자원 사용량, 보안과 같은 다양한 소프트웨어 품질 속성을 고려한 견고한 솔루션을 구축하는 능력을 가져야 합니다. 코드를 작성할 때 보안 중심적인 접근을 채택하는 것은 잠재적인 보안 취약점에 대한 초기 방어 역할을 하기 때문에 매우 중요합니다.

 

450p, 입력값 검열하기

문제: 사용자 입력을 검열하지 않은 코드가 있습니다.
해결: 통제할 수 없는 모든 것을 검열하세요.
설명: 악의적인 사용자는 항상 존재합니다. 따라서 사용자의 입력에 매우 주의를 기울여야 하며, 입력 필터링 기술을 사용하고 검열해야 합니다.

 

입력 검열 (Input Sanitization)
사용자의 입력을 처리하기 전에 입력이 안전하고 형식을 준수하는지 확인하기 위해 유효성을 검사하고 정리하는 작업입니다. 악의적인 사용자가 실행할 수 있는 SQL 삽입, 사이트 간 스크립팅(XSS), 기타 공격과 같은 다양한 보안 취약점을 방지할 수 있습니다.

 

SQL 삽입 (SQL Injection)
공격자가 데이터베이스와 통신하는 프로그램에 악성 SQL 코드를 삽입하는 것입니다. 공격자는 텍스트 상자나 양식과 같은 입력 필드에 SQL 코드를 입력합니다. 그러면 애플리케이션이 해당 코드를 실행해 데이터에 접근하거나 수정하고, 민감한 정보를 검색하거나, 심지어 시스템을 제어할 수도 있습니다.

import java.util.regex.Pattern;
import java.util.regex.Matcher;

public class Main {
    public static String sanitize(String input) {
        // 문자와 숫자가 아닌 경우 모두 제거합니다.
        return input.replaceAll("[^a-zA-Z0-9]", "");
    }

	...
}

 

 

후기

모든 챕터가 문제 - 해결 - 설명 - 예제 코드 등의 구조로 이루어져 있어서 코드를 많이 볼 수 있지만, 굉장히 다양한 언어들로 구성되어 있어서 오히려 이해하기가 더 힘든 부분이 많았던 것 같습니다. (Java, C#, Python, Ruby, PHP, JS ...)

예제 코드가 대부분 길지는 않지만, 각 언어마다 적용할 수 있는 케이스들도 존재해서 조금 아쉬웠네요.

 

또한 서론에서 말한 것 처럼, 클린 코드와 중복 내용들이 굉장히 많이 존재하는 것 같은 느낌이었습니다.

 

 

"한빛미디어 <나는 리뷰어다> 활동을 위해서 책을 제공받아 작성된 서평입니다."