[클린 코드] - 12장 창발성, 13장 동시성

12장 - 창발성

창발적 설계로 깔끔한 코드를 구현하자.

창발성이라는 말이 조금은 생소할 수 있다. 창발성이란, 복잡한 시스템이나 구조의 특성이 간단한 구성 요소들의 상호작용을 통해 나타나는 현상을 말한다. 다시 말해, 간단한 부분들의 조합으로 인해 전체적인 시스템이나 패턴이 생겨나는 것을 의미한다.

아래 네가지 규칙을 준수한다면 소프트웨어 설계 품질은 크게 높아진다.

모든 테스트를 실행한다.
중복을 없앤다.
프로그래머 의도를 표현한다.
클래스와 메서드 수를 최소로 줄인다.

단순한 설계 규칙 1 : 모든 테스트를 실행하라

테스트가 불가능한 시스템은 검증이 불가능하다.

그리고 검증이 불가능한 시스템은 절대 출시하면 안된다.

결합도가 높으면 테스트 케이스를 작성하기 어려우므로, DIP와 같은 원칙을 적용하고, 의존성 주입, 인터페이스,

추상화 같은 도구들을 사용해 결합도를 낮춰 설계 품질을 높이자.

테스트 케이스를 만들고 돌리기만해도, 시스템은 낮은 결합도와 높은 응집력이라는, 객체 지향 방법론이 지향하는

목표를 저절로 달성한다.

단순한 설계 규칙 2 : 중복을 없애라

중복을 없애는 것은 리팩터링의 가장 주요한 첫 번째 단계이다.

예를 들어, 다음 예시를 보자.

public class Example {
    private int[] data; 

    public int size() {
        if (data != null) {
            return data.length; 
        } else {
            return 0; 
        }
    }

    public boolean isEmpty() {
   	    if (data != null) {
            return false; 
        } else {
            return true; 
        }
    }
}

해당 클래스의 두 함수 size(), isEmpty()는 각각 개수를 반환하는 역할과 개수를 확인 후 부울값을 반환하는 역할을 한다.

두 함수를 봤을때, isEmpty에서도 size와 비슷한 역할을 수행하는 것을 볼 수 있다. 따라서 다음과 같이 구현하여

중복을 제거해줄 수 있다.

public class Example {
    private int[] data; 

    public int size() {
        if (data != null) {
            return data.length; 
        } else {
            return 0;
        }
    }

    public boolean isEmpty() {
        return size() == 0; 
    }
}

Template Method 패턴 기법을 사용하라.

Template Method 패턴은 고차원 중복을 제거할 목적으로 자주 사용하는 기법이다.

다음 예시를 살펴보자.

public class VacationPolicy {
	public void accureUSDDivisionVacation() {
    
    //지금까지 근무한 시간을 바탕으로 휴가 일수를 계산하는 코드
    //...
    //휴가 일수가 미국 최소 법정 일수를 만족하는지 확인하는 코드
    //...
    //휴가 일수를 급여대장에 적용하는 코드
    //...
    }
    
    public void accureKRWDivisionVacation() {
    
    //지금까지 근무한 시간을 바탕으로 휴가 일수를 계산하는 코드
    //...
    //휴가 일수가 한국 최소 법정 일수를 만족하는지 확인하는 코드
    //...
    //휴가 일수를 급여대장에 적용하는 코드
    //...
    }
    
}

위 코드에서 최소 법정 일수를 계산하는 코드만 제외한다면, 두 메서드는 거의 동일하다.

최소 법정 일수를 계산하는 알고리즘만 살짝씩 변하게 되는데,

이때 다음과 같이 Templeat Method 패턴을 적용하면 눈에 들어오는 중복을 제거할 수 있다.

abstract public class VacationPolicy {
	public void accureVacation() {
    	calculateBaseVacationHours();
        alterForLegalMinimums();
        applyToPayroll();
    }
    
    private void calculateBaseVacationHours(){
    	//지금까지 근무한 시간을 바탕으로 휴가 일수를 계산하는 코드
    }
    abstract protected void alterForLegalMinimums(); //하위 클래스에서 구현
    private void applyToPayroll(){
        //휴가 일수를 급여대장에 적용하는 코드
    }
}
    
public class USVacationPolicy extends VacationPolicy {
    @Override protected void alterForLegalMinimums(){
        //미국 최소 법정 일수를 사용한다.
    }
}

public class KRVacationPolicy extends VacationPolicy {
    @Override protected void alterForLegalMinimums(){
        //한국 최소 법정 일수를 사용한다.
    }
}

단순한 설계 규칙 3 : 표현하라

내가 짠 코드를 타인이 보고 유지보수를할 때에는 코드를 짜는 사람만큼 이해하기 힘들다.

이후 코드를 이해하기 쉽게 하기 위해서는 개발자의 의도를 분명히 표현해야 한다.

따라서 몇가지 규칙을 준수하자.

좋은 이름을 선택한다. 이름과 기능이 일치하도록 하자.
함수와 클래스 크기를 가능한 줄인다. SRP 원칙을 준수하여 이름짓기, 구현하기, 이해하기 쉽게 한다.
표준 명칭을 사용한다. 클래스가 COMMAND나 VISITOR 같은 표준 패턴을 사용해 구현된다면 클래스 이름에 패턴 이름을 넣어주자.
단위 테스트 케이스를 꼼꼼히 작성한다. 잘 만든 테스트 케이스를 읽어보기만 해도, 클래스 기능이 한눈에 들어온다.

나중에 코드를 읽을 사람은 바로 자신일 가능성이 가장 높다는 사실을 명심하자.

훗날의 나를 위해서라도 코드를 꼼꼼히, 깔끔하게 작성하는 노력을 조금 더 들여보자.

단순한 설계 규칙 4 : 클래스와 메서드 수를 최소로 줄여라

중복을 제거하고 SRP를 준수하다보면 조그만 클래스와 메서드가 수없이 늘어날 수밖에 없다.

그런데 이제와서 클래스와 메서드 수를 줄이라니 모순적이게 느껴질 수도 있다.

물론 함수와 클래스 크기를 작게 유지하는 것이 가장 중요하고 앞선 규칙들에 비해 우선 순위가 가장 낮지만,

시스템 크기를 작게 유지하는 것 또한 중요하다는 것을 늘 명심하자.

단순한 설계 규칙 2~4 : 리팩터링

코드를 추가할 때마다 설계를 조감하는 것이 좋다.

이때에는 매번 테스트 케이스를 돌려 기존 시스템이 깨지는지 확인하자.

지금까지 배웠던 모든 기법

응집도를 높이고
결합도를 낮추고
관심사를 분리하고
시스템 관심사를 모듈로 나누고
함수와 클래스 크기를 줄이고
더 나은 이름을 선택하고

등, 다양한 기법들을 총동원하여 리팩터링을 진행한다.

즉, 단순한 설계 규칙 2~4에 해당하는 내용들을 리팩터링 단계에서 진행한다.

결론

앞서 설명한 단순한 설계 규칙들을 따른다면, 오랜 경험 후에나 익힐 우수한 기법과 원칙을 활용할 수 있다.

13장 - 동시성

동시성이 필요한 이유?

기본 개념

멀티쓰레딩(Multithreading)

하나의 프로세스 내에서 여러 개의 스레드를 동시에 실행하는 프로그래밍 방식.

비동기(Asynchronous)는 어떤 작업을 요청한 후 그 작업이 완료되기 전에도 다른 작업을 수행할 수 있는

프로그래밍 방식을 의미.

스레드가 하나인 프로그램은 무엇과 언제가 서로 밀접하다.

따라서 이 두 요소를 분리하는 것이 동시성을 가지도록 프로그래밍을 한다면, 구조와 효울이 극적으로 나아진다.

기본적으로 웹 애플리케이션에서 클라이언트의 요청을 독립적인 서블릿 스레드로 처리

➡️결합분리 전략은 완벽과는 거리가 멀다. 동시성을 정확히 구현하는 것은 정말 어려움

미신과 오해

동시성은 항상 성능을 높여준다?

동시성은 때로 성능을 높여준다.

여러 프로세스가 동시에 처리할 독립적인 계산이 충분히 많은 경우
대기시간이 아주 길어 여러 스레드가 프로세서를 공유할 수 있는경우

두 경우 모두 흔한 경우는 아니다.

동시성을 구현해도 설계는 변하지 않는다?

단일 스레드 시스템과 다중 스레드 시스템은 설계가 판이하게 다르다.

웹 또는 EJB 컨테이너를 사용하면 동시성을 이해할 필요가 없다?

컨테이너가 어떻게 동작하는지 알아야, 데드락 같은 문제를 피할 수 있다.

동시성에 대한 불편한 진실

동시성은 다소 부하를 유발한다.
동시성은 복잡하다.
동시성 버그는 재현하기 어렵다 . ex) 데드락
동시성을 구현하려면 근본적인 설계 전략을 재고해야 함.

동시성 방어 원칙

SRP

SRP는 클래스나 모듈을 변경할 이유가 하나뿐이어야 한다는 원칙이다.

동시성은 복잡성 하나만으로도 분리할 이유 충분.

동시성을 구현할 때는 다음 몇 가지를 고려한다.

동시성 코드는 독자적인 개발, 변경, 조율 주기가 있다.
동시성 코드에는 다른 코드보다 훨씬 어려운 독자적인 난관이 있다.
잘못 구현한 동시성 코드는 갖가지 방식으로 실패한다.
권장사항: 동시성 코드는 다른 코드와 분리하라!

따름 정리 : 자료 범위를 제한하라

코드 내 임계영역(critical section) 을 최소한으로 하라.

공유 자료가 많을수록 다음 부작용들이 발생한다.

lock을 걸어주어야할 임계영역을 놓치는 경우 ➡️ 공유 자료를 수정하는 모든 코드가 망가진다.
모든 임계영역을 올바르게 보호했는지 확인하느라 똑같은 노력과 수고 반복
버그들을 더더욱 찾기 어려워짐
권장사항 : 자료를 캡슐화하고, 공유 자료를 최대한 줄여라!

따름정리 : 자료 사본을 사용하라

처음부터 공유자료를 사용하지 않고, 참조 대신 복사해서 사용하기.

복사 비용과 동기화 에러 해결 비용과 저울질 해보자.

따름정리 : 스레드는 가능한 독립적으로 구현하라

스레드간의 자료 공유는 최대한 피하고, 한 스레드는 클라이언트 요청 하나를 맡아 처리한다.

라이브러리를 이해하라

자바 5로 스레드 코드를 구현한다면 고려해야할 사항들

자바 5부터 제공하는 스레드 환경에 안전한 컬렉션 사용.
서로 무관한 작업을 수행할 때는 executor 프레임워크 사용
가능하다면 스레드가 차단되지 않는 방법 사용
일부 클래스 라이브러리는 스레드에 안전하지 x

java.util.concurrent 패키지가 제공하는 클래스는 대개 다중 스레드 환경에서 사용해도 안전하고, 성능이 좋다.

실제로 ConcurrentHashMap은 거의 모든 상황에서 HashMap보다 빠르다.

유용한 패키지들 : java.util.concurrent, java.util.concurrent.atomic, java.util.concurrent.locks

실행 모델을 이해하라

멀티쓰레딩의 기본 용어 정리

한정된 자원(Bound Resource): 다중 스레드 환경에서 사용하는 자원으로, 크기나 숫자가 제한적이다. 데이터베이스 연결, 길이가 일정한 읽기/쓰기 버퍼 등.
상호 배제(Mutual Exclusion): 한 번에 한 스레드만 공유 자료나 공유 자원을 사용할 수 있는 경우를 가리킨다.
기아(Starvation): 한 스레드나 여러 스레드가 굉장히 오랫동안 혹은 영원히 자원을 기다린다.
데드락(Deadlock): 여러 스레드가 서로가 끝나기를 기다린다. 모든 스레드가 각기 필요한 자원을 다른 스레드가 점유하는 바람에 어느 쪽도 더 이상 진행하지 못한다.
라이브락(Livelock): 라이브락은 두 스레드가 락의 해제와 획득을 무한 반복하는 상태이다. 라이브락은 데드락을 피하려는 의도에서 수정한 코드가 불완전할 때 발생하곤 한다.

라이브락 예시

Thread 0

int done = 0;
while(!done)
{
  획득(A)
  
  if(획득시도(B) == true){
    어떤작업()
    
    해제(B)

    해제(A)

    done = 1;

  }
  else{
    해제(A)
  }
}

Thread 1

while(!done){
  획득(B)

  if(획득시도(A) == true){
    어떤작업()

    해제(A)

    해제(B)

    done = 1;
  }
  else{
   해제(B)
  }
}

동기화하는 메서드 사이에 존재하는 의존성을 이해하라

공유 클래스 하나에 동기화된 여러 메서드 사이의 의존성을 파악하라.

이왕이면, 공유 객체 하나당 메서드 하나만 사용하라.

어쩔수 없이 메서드 여러개를 사용해야 하는 상황이면 다음 규칙을 지킬 것.

클라이언트에서 잠금 - 클라이언트에서 동기화된 메서드를 사용하는 부분 전체에 lock을 건다.
서버에서 잠금 - 동기화된 메서드를 사용하는 부분전체에 lock을 걸었다가 푸는 메서드를 따로 구현하고, 클라이언트는 해당 메서드를 호출한다.
연결 서버 - 잠금을 수행하는 중간 단계를 생성한다.

동기화하는 부분을 작게 만들어라

임계영역은 반드시 보호해야 하지만, 그 수를 최대한 줄여야 한다.

올바른 종료 코드는 구현하기 어렵다

만약 생산자 쓰레드가 먼저 종료되고 , 소비자 쓰레드는 생산자 쓰레드의 시그널을 기다린다면,

시스템은 영영 종료되지 못한다.

권장사항 : 종료 코드를 개발 초기부터 고민하고 동작하게 초기부터 구현할 것

스레드 코드 테스트하기

권장사항 : 데드락 등 문제를 노출하는 TC를 작성하고, 테스트가 실패하는 원인을 추적할 것

말이 안되는 실패는 잠정적인 스레드 문제로 취급할 것.
다중 스레드를 고려하지 않은 순차 코드부터 제대로 돌게 할 것.
다중 스레드를 쓰는 코드 부분을 다양한 설정으로 실행하기 쉽게 구현할 것.
다중 쓰레드를 쓰는 코드 부분을 상황에 맞춰 조정할 수 있게 작성할 것.
다른 플랫폼에서 돌려볼 것.
코드에 보조 코드를 넣어 돌려볼 것. 강제로 실패를 일으키게 하라.
- object.wait()등 메서드를 추가해 다양한 순서로 코드를 실행 시킨다.
- ConTest등의 도구를 활용한다.

결론

스레드 코드는 올바르게 구현하기 어렵다.

SRP를 준수해야 하고, 쓰레드를 테스트할 때는 전적으로 쓰레드만 테스트해야한다.

또, 동시성 오류를 일으키는 잠정적인 원인들을 철저히 이해한다.

사용하는 라이브러리와 기본 알고리즘을 이해하고 , 특정 기능이 어떻게 작동하는지 파악한다.

LOCK은 최대한 작은 구간에 최대한 적게 건다.

'📖BOOK > 📙Clean Code' 카테고리의 다른 글

[클린 코드] - 10장 클래스 , 11장 시스템 (0)	2023.07.18