• 높은 추상화 수준, 즉 시스템 수준에서도 깨끗함을 유지하는 방법을 살펴본다.

시스템 제작과 시스템 사용을 분리하라.

  • 제작 ( Construction ) 과 사용 ( Use ) 는 아주 다르다.

  • 소프트웨어 시스템은 ( 애플리케이션 객체를 제작하고 의존성을 서로 연결하는 ) 준비 과정과 ( 준비과정 이후에 이어지는) 런티암 로직을 분리해야한다.

  • 시작 단계는 모든 애플리케이션이 풀어야할 관심사다.

  • 관심사 분리는 가장 오래되고 가장 중요한 설계 기법 중 하나

  • 초기화 지연 ( 레이지 이니셜라이제이션 ) 혹은 계산 지연 ( 레이지 에볼루션 ) 기법

    • 객체 null 체크후 null 일 경우만 객체 생성함.
    • 장점은 있다 null 을 반환하지 않는다. 객체 생성시간이 늦어져서 어플리케이션을 시작하는 시간이 빨라진다.
    • 단점
      • 메서드가 생성자와 , 생성자 인수에 의존하게 된다.
      • 테스트도 문제
        • 객체가 무거운 객체라면 단위 테스트에서 메서드를 호출하기전에 적절한 테스트 전용 객체 ( Mock Object) 를 할당해야 한다.
      • 또한 일반 런타임 로직에다 객체 생성 로직을 섞어놓은 탓에 모든 실행경로도 테스트해야 한다. ( 객체가 null인 경로와 null이 아닌 경로 )
      • 책임이 둘 ( null 일 경우 , null이 아닐 경우) 일 경우는 단일책임원칙에 위배된다.
    • 저런 기법으로 모듈성을 깨지 말자.
    • 설정 논리는 일반 실행 논리와 분리해야 모듈성이 높아진다.

메인 분리

  • 생성과 사용을 분리하는 방법중 하나
  • 생성 코드는 main이나 main이 호출하는 모듈로 옮기고 사용은 다른쪽에서한다.
  • 이러면 다른쪽은 main을 보지 않는다. ( 생성 과정을 모른다 )

팩토리

  • 객체가 생성되는 시점을 애플리케이션이 결정
  • Abstract factory 패턴을 사용

 

  • 구체적인 객체 생성 방법은 몰라도 생성되는 시점을 완벽하게 통제.
  • 생성자 인수역시 넘길수 있음.

의존성 주입

  • 사용과 제작을 분리하는 강력한 메커니즘 중 하나
  • 스프링의 IOC 그것이다.
  • 스프링은 특수 컨테이너를 사용한다.

확장

  • 점차 기능이 늘어남.

  • 처음부터 올바르게 시스템을 만들 수 있다는 말은 미신이다.

  • 새로운 스토리에 맞춰 시스템을 조정하고 확장하면 된다.

  • 이것이 반복적이고 점진적인 애자일 방식의 핵심

  • TDD와 리팩토링으로 인해 얻어지는 깨끗한 코드는 코드 수준에서 시스템을 조정하고 확장하기 쉽게 만든다.

  • 시스템과 소프트웨어는 다르다. 소프트웨어는 관심사를 적절히 분리해 관리 한다면 점진적으로 발전할수 있다.

  • 컨테이너와 비지니스 로직이 강하게 결합되어 있다면 독자적인 단위테스트가 어렵고

  • 클래스를 생성할때는 컨테이너에서 파생해야 되며 컨테이너가 요구하는 다양한 생명주기 메서드도 제공해야 한다.

  • DTO는 구조체며 메소드가 없다.

횡단 관심사

  • 영속성과 같은 관심사는 애플리케이션의 자연스러운 객체 경계를 넘나드는 경향이 있다.

  • 모듈화한 영속성 프레임워크와 모듈화한 도메인논리가 세밀한 단위로 겹친다.

  • AOP에서 관점이라는 모듈구성개념 은 특정관심사를 지원하려면 시스템에서 특징 지점들이 동작하는 방식을 일관성 있게 바꿔야 한다.

  • AOP의 진정한 가치는 시스템 동작을 간결하고 모듈화된 방식으로 명시하는 능력

자바 프록시

  • 개별 객체나 클래스에서 메서드 호출을 감싸는 경우가 좋은 예.
  • jdk에서는 동적프록시는 api만 제공
  • 클래스 프록시를 사용하려면 cglib , asm ,javassis등과 같은 바이트코드 처리 라이브러리가 필요
  • 단순한 예제에도 코드가 많아지며 제법 복잡해진다.
  • 프록시를 사용하면 깨끗한 코드를 작성하기 어렵다
  • 프록시는 AOP처럼 시스템 단위로 실행지점을 명시할수도 없다.
  • ( 프록시 패턴 )

순수 자바 AOP 프레임워크

  • 의존성이 적으면 테스트가 쉬워진다.
  • 순수자바 AOP 프레임워크는 스프링관련된 코드가 없어서 스프링과 사실상 독립적이다.
  • 아까 위에 나왔던 컨테이너와 비지니스로직의 결합이 없어진다.
  • ( 이게 자바 프록시보다 낫다는 말 )

AspecJ

  • 관심사를 관점으로 분리하는 가장 강력한 도구
  • 언어차원에서 관점을 모듈화 구성으로 지원하는 자바 언어 확장
  • 관점을 분리하는 강력하고 풍부한 도구 집합을 제공하지만 새 도구를 사용하고
  • 새문법과 사용법을 익혀야하는 단점이 존재.

테스트 주도 시스템 아키텍처 구축

  • 관점 ( 혹은 유사한 개념으로 ) 관심사를 분리하는 방식은 그 위력이 막강하다.

  • 어플리케이션 도메인 논리를 POJO로 작성할 수 있다면.

  • 즉 코드 수준에서 아키텍처 관심사를 분리할 수 있다면 진정한 테스트 주도 아키텍처 구축이 가능해진다.

  • 세계최대의 웹사이트들은 고도의 자료 캐싱, 보안 , 가상화등을 이용해 아주 높은 가용성과 성능을 효율적이고도 유연하게 달성했다.

  • 설계가 최대한 분리되어 각 추상화 수준과 범위에서 코드가 적당히 단순하기 때문이다.

  • 최선의 시스템 구조는 각기 POJO객체로 구현되는 모듈화된 관심사 영역 ( 도메인 ) 으로 구성한다.

  • 이렇게 서로다른 영역은 해당 영역코드에 최소한의 영향을 미치는 관점이나 유사한 도구를 사용해 봉합한다.

  • 이런 구조 역시 코드와 마찬가지로 테스트 주도 기법을 적용할 수 있다.

의사결정을 최적화 하라

  • 최대한 정보를 모아 가능한 마지막 순간까지 결정을 미뤄라
  • 관심사를 모듈로 분리한 POJO 시스템은 기민함을 제공한다.
  • 이런 기민함 덕택에 최신 정보에 기반해 최선의 시점에 최적의 결정을 내리기가 쉬워진다.
  • 또한 결정의 복잡성도 줄어든다.
  • ( 뭔가 만들면서 선택지를 점점 제거해간다는 느낌 )

명백한 가치가 있을때 표준을 현명하게 사용하라

  • 너무 과장되게 포장된 표준은 사용하지 않는 것이 좋다.
  • 표준을 사용하면 아이디어와 컴포넌트를 재사용하기 쉽고, 적절한 경험을 가진 사람을 구하기 쉬우며, 좋은 아이디어를 캡슐화하기 쉽고, 컴포넌트를 엮기 쉽다.
  • 하지만 표준을 만드는 시간이 너무 오래걸릴 수 있다.

시스템은 도메인 특화 언어가 필요하다.

  • DSL은 간단한 스크립트 언어나 표준 언어로 구현한 API

  • 좋은 DSL은 도메인 개념과 그 개념을 구현한 코드 사이에 존재하는 의사소통의 간극을 줄여준다.

  • 애자일 기법이 팀과 프로젝트 이해관계자 사이에 의사소통 간극을 줄여주듯이.

  • 효과적으로 사용한다면 DSL은 추상화 수준을 코드 관용구나 디자인 패턴 이상으로 끌어올린다.

  • 그래서 개발자가 적절한 추상화 수준에서 코드 의도를 표현할 수 있다.

  • DSL을 사용하면 고차원 정책에서 저차원 세부사항에 이르기까지 모든 추상화 수준과 모든 도메인을 POJO로 표현할 수 있다.

결론

  • 시스템 역시 깨끗해야 한다.

  • ( 보기 좋아야 된다는 말 , solid 원칙을 지켜야 된다는 말)

  • 도메인 논리가 흐려지면 제품 품질이 떨어진다.

  • 기민성도 떨어진다.

  • 기민성이 떨어지면 생산성이 낮아져 TDD가 제공하는 이점도 사라진다.

  • 모든 추상화 단계에서 의도는 명확히 표현해야 한다.

  • POJO를 이용해 관심사를 분리하자

  • ( Entity를 포조로 )

  • 시스템을 설계하든 개별 모듈을 설계하든, 실제로 돌아가는 가장 단순한 수단을 사용해야 한다는 사실을 명심하자.

'book > 클린코드' 카테고리의 다른 글

13장 동시성  (0) 2021.01.05
12장 - 창발성  (0) 2021.01.03
10장 - 클래스  (0) 2020.12.22
9장 - 단위 테스트  (0) 2020.12.02
8장 - 경계  (0) 2020.11.30

객체의 처리는 추상화다. 스레드는 일정의 추상화다.

  1. 동시성이 필요한 이유 ?

    • 동시성은 커플링 ( 결합 ) 을 없애는 전략이다.

    • 즉, 무엇과 언제를 분리하는 전략.

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

    • 호출 스택을 살펴보면 프로그램 상태가 곧바로 드러난다.

    • 이 무엇과 언제를 분리하면 애플리케이션 구조와 효율이 극적으로 나아진다.

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

      • 대기시간이 아주 길어 여러 쓰레드가 프로세서를 공유할 수 있거나, 여러 프로세서가 동시에 처리할 독립적인 계산이 충분히 많은 경우에만 성능이 높아진다.
      • 어느쪽도 일상적으로 발생하는 상황은 아니다.
    • 단일 스레드와 멀티 스레드 시스템은 설계가 판이하게 다르다.

      • 일반적으로 무엇과 언제를 분리하면 시스템 구조가 크게 달라진다.
    • 실제로 컨테이너가 어떻게 동작하는지, 어떻게 동시 수정, 데드락 등과 같은 문제를 피할 수 있는지를 알아야만 한다.

    • 동시성은 다소 부하를 유발한다.

      • 성능 측면에서 부하가 걸리며 코드도 더 짜야 한다.
    • 동시성은 복잡하다.

      • 간단한 문제라도 동시성은 복잡하다.
    • 일반적으로 동시성 버그는 재현하기 어렵다.

      • 그래서 진짜 결함으로 간주되지 않고 일회성 문제로 여겨 무시하기 쉽다.
    • 동시성을 구현하려면 흔히 근본적인 설계 전략을 재고해야 한다.

  2. 난관

    여러 쓰레드가 같은 객체의 필드를 참조할 경우 필드가 쓰레드에 의해 값이 계속 바뀐다.

  3. 동시성 방어 원칙

    1. 단일 책임 원칙

      • 동시성 코드는 독자적인 개발,변경,조율 주기가 있다.
      • 동시성 코드에는 독자적인 난관이 있다.
        • 다른 코드에서 겪는 난관과 다르며 훨씬 어렵다.
      • 잘못 구현한 동시성 코드는 별의별 방식으로 실패한다.
        • 주변에 있는 다른 코드가 발목을 잡지 않더라도 동시성 하나만으로도 충분히 어렵다.
      • 동시성 코드는 다른 코드와 분리하라.
    2. 따름 정리: 자료 범위를 제한하라.

      • 난관에서 나온 것 처럼 두 스레드가 하나의 객체에 필드를 건드리게 되므로 예상치 못한 결과를 낳는다.

      • 이런 문제를 해결하기 위해서는 공유 객체를 사용하는 코드 내 임계영역을 synchronized 키워드로 보호하라고 권장한다.

      • 이런 임계영역의 수를 줄이는 기술이 중요하다.

      • 임계 영역이 많을 때 단점

        • 보호할 임계영역을 빼먹으면 공유자료를 수정하는 모든 코드가 망가진다.
        • 모든 임계영역을 올바로 보호했는지 ( DRY 위반 ) 을 확인하느라 똑같은 노력과 수고를 반복한다.
        • 버그가 찾기 더 어려워진다.
        • 자료를 캡슐화 하여 공유 자료를 최대한 줄여라.
    3. 따름정리 : 자료 사본을 사용하라.

      • 공유 자료를 처음 부터 공유하지 않으면 공유 자료를 줄일 수 있다.

      • 객체를 복사해 읽기 전용으로 사용해도 줄일수 있다.

      • 각 스레드가 객체를 복사해 사용 한 후 한 스레드가 해당 사본에서 결과를 가져오는 방법도 가능.

      • 복사의 비용과 시간이 걱정스러울 수도 있다.

        • 복사비용이 진짜 문제인지 실측 해보도록 한다.
        • 하지만 사본으로 동기화 를 피할 수 있다면 내부 잠금 ( LOCK ) 을 없애 절약한 수행시간이 사본 생성과 카비지 컬렉션에 드는 부하를 상쇄할 가능성이 크다.
    4. 따름정리 : 쓰레드는 가능한 독립적으로 구현하라

      • 다른 스레드와 자료를 공유 하지 않는 독립적인 스레드를 구현한다.

      • 각 스레드는 클라이언트 요청 하나를 처리

      • 모든 정보는 비공유 출처에서 가져오며 로컬변수에 저장.

      • 그러면 각 스레드는 각각 독립적이게 된다.

      • HttpServlet 클래스에서 파생한 클래스는 모든 정보를 doGet과 doPost 매개변수로 받는다.

        • 각 서블릿은 마치 자신이 독자적인 시스템에서 동작하는 양 요청을 처리한다.

        • 물론 서블릿을 사용하는 대다수 프로그램은 데이터베이스 연결과 같은 자원을 공유하는 상황에 처한다.

        • 권장사항

          • 독자적인 스레드로 가능하면 다른 프로세서에서 돌려도 괜찮도록 자료를 독립적인 단위로 분할하라.
    라이브러리를 이해하라.
    • 쓰레드 환경에 안전한 컬렉션을 사용한다. ( 자바 5부터 제공)
    • 서로 무관한 작업을 수행할 떄는 executor 프레임워크를 사용한다.
    • 가능하다면 스레드가 blocking 되지 않는 방법을 사용한다.
    • 일부 클래스 라이브러리는 스레드에 안전하지 못하다.
    쓰레드 환경에 안전한 컬렉션

    이사람이 스레드에 사용해도 안전한 컬렉션 클래스 몇개를 구현햇는데

    나중에 이게 java.util.concurrent 패키지에 추가됬다.

    • java.util.concurrent 패키지가 제공하는 클래스는 다중 스레드 환경에서 사용해도 안전

    • ReentrantLock

      • 한 메서드에서 잠그고 다른메서드에서 푸는 락 ( Lock ) 이다.
    • Semaphore

      • 전형적인 세마포어다. 개수 ( Count ) 가 있는 락이다.
    • CountDownLatch

      • 지정한 수 만큼 이벤트가 발생하고 나서야 대기중인 쓰레드를 모두 해제하는 락이다.
      • 모든 스레드에게 동시에 공평하게 시작할 기회를 준다.
    • java.util.concurrent

    • java.util.concurrent.atomic

    • java.util.concurrent.locks

    • 위에 3가지 를 익혀라.

    실행 모델을 이해하라
    • Bound Resources
      • 다중 스레드 환경에서 사용하는 자원으로 크기나 숫자가 제한적이다.
      • 데이터베이스 연결, 길이가 일정한 읽기/쓰기 버퍼 등이 예다.
    • Mutual Exclusion
      • 한번에 한 쓰레드만 공유 자료나 공유 자원을 사용할 수 있는 경우를 가리킨다.
    • Starvation
      • 한 스레드나 여러 스레드가 굉잦ㅇ히 오랫동안 혹은 영원히 자원을 기다린다.
      • 예를 들어 항상 짧은 스레드에게 우선순위를 준다면 짧은 스레드가 지속적으로 이어질 경우 긴 스레드가 기아 상태에 빠진다.
    • Deadlock
      • 여러 스레드가 서로가 끝나기를 기다린다.
      • 모든 스레드가 각기 필요한 자원을 다른 스레드가 점유하는 바람에 어느 쪽도 더이상 진행하지 못한다.
    • Livelock
      • 락을 거는 단계에서 각 스레드가 서로를 방해한다.
      • 스레드는 계속해서 진행하려 하지만, 공명( Resonance ) 으로 인해 굉장히 오랫동안 혹은 영원히 진행하지 못한다.
    생산자 - 소비자
    • 하나 이상 생산자 스레드가 정보를 생성해 버퍼 ( Buffer ) 나 대기열 ( Queue )에 넣는다.

    • 하나 이상 소비자 스레드가 대기열에서 정보를 가져와 사용한다.

    • 생산자 스레드와 소비자 스레드가 사용하는 대기열은 한정된 자원 이다.

    • 생산자 스레드는 대기열에 빈 공간이 있어야 정보를 채운다.

      • 즉 빈공간이 생길때까지 기다린다.
    • 소비자 스레드는 대기열에 정보가 있어야 가져온다.

      • 즉 정보가 채워질 때 까지 기다린다.
    • 대기열을 올바로 사용하고자 두 스레드는 서로에게 신호를 보낸다.

    • 생산자 스레드는 대기열에 정보를 채우고 소비자 스레드에 신호를 보낸다.

    • 소비자 스레드는 대기열 정보를 읽고 빈 공간이 있다는 시그널을 보낸다.

    • 잘못하면 생산자 스레드 , 소비자 스레드 둘다 진행 가능함에도 불구하고

    • 동시에 서로에게서 시그널을 기다릴 가능성이 존재한다.

    • 생산자 스레드는 빈 공간이 있어야 정보를 채우기 때문에 하나만 넣고 신호를 보내면

    • 소비자 스레드는 빈 공간이 있다는 정보를 다시 생산자한테 보낸다.

    • 그래서 둘다 기다리는 상태가 될 수가 있다.

    읽기-쓰기
    • 읽기 쓰레드를 위한 주된 정보원으로 공유 자원을 사용하지만, 쓰기 스레드가 이 공유 자원을 이따금 갱신한다고 하자, 이런 경우 처리율 ( throughtput ) 이 문제의 핵심이다.

    • 처리율을 강조하면 기아 ( starvation ) 현상이 생기거나 오래된 정보가 쌓인다.

    • 갱신을 허용하면 처리율에 영향을 미친다.

    • 쓰기 쓰레드가 버퍼를 갱신하는 동안 읽기 쓰레드가 버퍼를 읽지 않으려면 반대로 읽기 쓰레드가 읽는동안 쓰기 쓰레드가 버퍼를 갱신하지 않으려면 복잡한 균형잡기가 필요하다.

    • 대개는 쓰기 쓰레드가 버퍼를 오랫동안 점유하기 떄문에 여러 읽기스레드가 버퍼를 기다리느라 처리율이 떨어진다.

    • 따라서 두 쓰레드의 요구를 적절히 만족시켜 처리율도 적당히 높이고 기아도 방지하는 해법이 필요.

    • 간단한 전략은 읽기 스레드가 없을 떄 까지 갱신을 원하는 쓰기 쓰레드가 버퍼를 기다리는 방법.

      • 하지만 읽기 스레드가 계속 이어진다면 쓰기 스레드는 기아 상태에 빠진다.
      • 반면 쓰기스레드에게 우선권을 준 상태에서 쓰기 쓰레드가 계속 이어진다면 처리율이 떨어진다.
    • 양쪽균형을 잡으면서 동시에 갱신문제를 피하는 해법이 필요하다.

    식사하는 철학자들
    • 기업 애플리케이션은 여러 프로세스가 자원을 얻으려 경쟁한다.
    • 주의해서 설계하지않으면 데드락, 라이브락, 처리율 저하, 효율성 저하 등을 겪는다.
    동기화하는 메서드 사이에 존재한는 의존성을 이해하라
    • 동기화하는 메서드 사이에 의존성이 존재하면 동시성 코드에 찾아내기 어려운 버그가 생긴다.

    • 자바 언어는 개별 메서드를 보호하는 synchronized라는 개념을 지원.

    • 하지만 공유 클래스 하나에 동기화된 메서드가 여럿이라면 구현이 올바른지 다시한번 확인하라.

    • 공유 객체 하나에는 메서드 하나만 사용하자.

    공유 객체 하나에 여러 메서드가 필요할 때
    • 클라이언트에서 잠금
      • 클라이언트에서 첫번째 메서드를 호출하기 전에 서버를 잠근다. 마지막 메서드를 호출할 때 까지 잠금을 유지한다.
    • 서버에서 잠금
      • 서버에다 "서버를 잠그고 모든 메서드를 호출 한 후 잠금을 해제하는" 메서드를 구현한다. 이
    • 연결( adapted ) 서버
      • 잠금을 수행하는 중간 단계를 생성한다.
      • "서버에서 잠금" 방식과 유사하지만 원래 서버는 변경하지 않는다.
    동기화하는 부분을 작게 만들어라
    • 자바에서 synchronized 키워드를 사용하면 락을 설정한다.

    • 같응ㄴ 락으로 감싼 모든 영역은 한번에 한 스레드만 실행이 가능하다.

    • 락은 스레드를 지연시키고 부하를 가중시킨다.

    • 그러므로 synchronized문을 남발하지 말아야 한다.

    • 반면 임계영역 (동시에 사용하는 부분 ) 은 반드시 보호해야한다.

    • 코드를 짤때 임계영역은 최소로 줄이자.

    • 동기화 하는 부분을 최대한 작게 만들어라

    올바른 종료코드는 구현하기 어렵다.
    • 영구적으로 돌아가는 시스템을 구현하는 방법과 잠시 돌다 깔끔하게 종료하는 시스템을 구현하는 방법은 다르다.

    • 흔히 발생하는 문제는 데드락.

    • 깔끔하게 종료하는 다중스레드 코드를 짜야 한다면 시간을 투자해 올바로 구현하자.

    • 종료 코드를 개발 초기부터 고민하고 동작하게 초기부터 구현하라

    • 생각보다 오래 걸린다. 생각보다 어려우므로 이미 나온 알고리즘을 검토하라

    쓰레드코드 테스트하기
    • 테스트가 정확성을 보장하지는 않는다.

    • 그럼에도 테스트는 위험을 낮춰준다.

    • 스레드가 하나인 프로그램은 위험을 낮춰주지만 같은 코드와 같은 자원을 사용하는 스레드가 둘 이상으로 늘어나면 상황은 급격하게 복잡해진다.

    • 문제를 노출하는 테스트 케이스를 작성하라.

    • 프로그램 설정과 시스템 설정과 부하를 바꿔가며 자주 돌려라.

    • 테스트가 실패하면 원인을 추적하라. 다시 돌렸더니 통과하더라는 이유로 넘어가면 절대 안된다.

    • 고려할 사항이 매우 많다. 아래 구체적인 지침을 제시한다.

    구체적인 지침
    • 말이 안되는 실패는 잠정적인 스레드 문제로 취급하라.
    • 다중 스레드를 고려하지 않은 순차 코드부터 제대로 돌게 만들자.
    • 다중 스레드를 쓰는 코드 부분을 다양한 환경에 쉽게 끼워 넣을 수 있도록 스레드 코드를 구현하라.
    • 다중 스레드를 쓰는 코드 부분을 상황에 맞춰 조정할 수 있게 작성하라.
    • 프로세서 수보다 많은 스레드를 돌려보라.
    • 다른 플랫폼에서 돌려보라.
    • 코드에 보조 코드를 넣어 돌려라. 강제로 실패를 일으키게 해보라.
    말이 안되는 실패는 잠정적인 스레드 문제로 취급하라.
    • 다중 스레드 코드느 때때로 말이 안되는 오류를 일으킨다.

    • 실패를 재현하기가 아주 어렵다.

    • 일회성 문제를 계속 무시한다면 잘못된 코드위에 코드가 계속 쌓인다.

    • 시스템 실패를 일회성이라 치부하지마라

    다중 스레드를 고려하지 않은 순차코드부터 제대로 돌게 만들자.
    • 당연한 소리.

    • 스레드 환경 밖에서 코드가 제대로 도는지 반드시 확인한다.

    • 스레드가 호출하는 POJO를 만들면 스레드 환경밖에서 테스트가 가능하다.

    • POJO에 넣는 코드는 많을수록 좋다.

    • 스레드 환경 밖에서 생기는 버그와 스레드 환경에서 생기는 버그를 동시에 디버깅하지마라

    • 먼저 스레드 환경밖에서 코드를 올바르게 돌려보자

    다중 스레드를 쓰는 코드 부분을 상황에 맞춰 조정할 수 있게 작성하라.
    • 다중 스레드를 쓰는 코드는 다양한 설정으로 실행하기 쉽게 구현하자.

    • 한 스레드로 실행하거나, 여러 스레드로 실행하거나, 실행 중 스레드 수를 바꿔본다.

    • 스레드 코드를 실제 환경이나 테스트 환경에서 돌려본다.

    • 테스트 코드를 빨리, 천천히, 다양한 속도로 돌려본다.

    • 반복 테스트가 가능하도록 테스트 케이스를 작성한다.

    • 다양한 설정에서 실행할 목적으로 다른 환경에 쉽게 끼워 넣을 수 있게 코드를 구현하라

    다중 스레드를 쓰는 코드 부분을 상황에 맞게 조율할 수 있게 작성하라
    • 적절한 스레드 개수를 파악하려면 상당한 시행착오가 필요하다.
    • 스레드개수를 조율하기 쉽게 코드를 구현한다.
    • 프로그램이 돌아가는 도중에 스레드 개수를 변경하는 방법도 고려한다.
    • 프로그램 처리율과 효율에 따라 스스로 스레드 개수를 조율하는 코드도 고민한다.
    프로세서 수보다 많은 스레드르 돌려보라.
    • 시스템이 스레드를 스와핑할 떄도 문제가 발생한다.
    • 스와핑을 일으키려면 프로세서 수보다 많은 스레드를 돌린다.
    • 스와핑이 잦을수록 임계영역을 빼먹은 코드나 데드락을 일으키는 코드를 찾기 쉬워진다.
    다른 플랫폼에서 돌려보라.
    • 윈도우에서 돌아가도 OS X에서는 안될수 있다.
    코드에 보조 코드를 넣어 돌려라. 강제로 실패를 일으키게 해보라.
    • 흔히 스레드 코드는 오류를 찾기가 쉽지 않다.

    • 오류가 엄청난 오랜시간이 지난뒤에 드러날수도 있다.

    • 수천가지 경로중에 아주 소수만 실패하기 때문이다.

    • 보조 코드를 추가해 코드가 실행되는 순서를 바꿔준다.

    • 예를들어 Object.wait(), Object.sleep(), Object.yield(), Object.priority() 등과 같은 메서드를 추가해 코드를 다양한 순서로 실행한다.

    • 각 메서드는 스레드가 실행되는 순서에 영향을 미친다. 따라서 버그가 드러날 가능성도 높아진다.

    • 잘못된 코드라면 초반에 그리고 가능한 자주 실패하는 편이 좋다.

    • 코드에 보조코드를 추가하는 방법은 두가지다.

      • 직접 구현하기
      • 자동화
    직접 구현하기.
    • 직접 구현해서 추가했는데 에러가 났다면 어차피 잘못된 코드인데 증거가 드러난것이다.

      • 항상 맞는말은 아니다.
      • JVM은 선점형 스레드 스케줄링을 지원하지 않는다.
      • 따라서 선점형 스케줄링을 지원하지 않는 OS에서 코드가 문제없이 돌아갈지도 모른다.
      • 이유는 다르지만 반대상황 역시 가능하다.
    • 이 방법에는 몇가지 문제가 있다.

      • 보조코드를 삽입할 적정 위치를 직접 찾아야한다.
      • 어떤 함수를 어디서 호출해야 적당한지 어떻게 알까 ?
      • 배포 환경에 보조 코드를 그대로 남겨두면 프로그램 성능이 떨어진다.
      • 무작위적이다. 오류가 드러날지도 모르고 드러나지 않을지도 모른다. 사실 안드러날 확률이 높다.
    • 배포 환경이 아닌 테스트 환경에서 보조 코드를 실행할 방법이 필요하다.

    • 실행할 떄마다 설정을 바꿔줄 방법도 필요하다.

    • 그래야 전체적으로 오류가 드러날 확률이 높아진다.

    • 스레드를 전혀 모르는pojo와 스레드를 제어하는 클래스로 프로그램을 분할하면 보조코드를 추가할 위치를 찾기가 쉬워진다.

    • 게다가 여러상황에서 sleep,yield등으로 pojo를 호출하게 다양한 테스트 지그 ( jig ) 를 구현할 수도 있다.

    자동화
    • 보조 코드를 자동으로 추가하려면 AOF ( Aspect-Oriented Framework ) , CGLIB , ASM등과 같은 도구를 사용한다.

    • 스레드 코드 테스트를 도와주는 도구중에 IBM이 개발한 ConTest라는 도구가 있다.

    • 코드를 다양하게 삽입해서 실행 ( 흔들기 ) 하는 이유는 매번 다른 순서로 실행하기 위해서도

    • 좋은 테스트 케이스와 흔들기 기법은 오류가 드러날 확률을 크게 높여준다.

    • 흔들기 기법을 사용해 오류를 찾아내라

    결론

    • SRP를 준수하자.

    • POJO를 사용해 스레드를 아는 코드와 스레드를 모르는 코드를 분리하자.

    • 스레드 코드를 테스트할때는 전적으로 스레드만 테스트한다.

    • 즉 스레드 코드는 최대한 집약되고 작아야 한다는 의미다.

    • 동시성 오류가 나는 잠정적인 원인을 철저히 이해한다.

    • 사용하는 라이브러리와 기본 알고리즘을 이해한다.

    • 특정 라이브러리 기능이 기본 알고리즘과 유사한 어떤 문제를 어떻게 해결하는지 파악한다.

    • 보호할 코드 영역을 찾아내는 방법과 특정 코드 영역을 잠그는 방법을 이해한다.

    • 잠글 필요가 없는 코드는 잠그지 않는다.

    • 그러려면 공유하는 정보와 공유하지 않는 정보를 제대로 이해해야 한다.

    • 공유하는 객체 수와 범위를 최대한 줄인다.

    • 클라이언트에게 공유 상태를 관리하는 책임을 떠넘기지 않는다.

    • 필요하다면 객체 설계를 변경해 클라이언트에게 편의를 제공한다.

    • 일회성문제를 가볍게 치부하고 넘기지 말라 나중에 부채가 되서 돌아온다.

    • 스레드 코드는 많은 플랫폼에서 테스트해봐야 한다.

    • 테스트 용이성은 TDD 3대규칙을 따르면 자연히 얻는다.

    • 시간을 들여 보조 코드를 추가하면 오류가 드러날 가능성이 높아진다.

    • 직접 구현이나 자동화기술을 사용하자.

    • 초반부터 보조 코드를 고려해야 한다.

    • 스레드 코드는 출시하기 전까지 최대한 오랫동안 돌려봐야 한다.

    • 깔끔한 접근방식을 취한다면 코드가 올바로 돌아갈 가능성이 극적으로 높아진다.

  4. 더그 리라는 사람이 cuncurrent programing in java란 책을 집필했다.

'book > 클린코드' 카테고리의 다른 글

11장 - 시스템  (0) 2021.02.22
12장 - 창발성  (0) 2021.01.03
10장 - 클래스  (0) 2020.12.22
9장 - 단위 테스트  (0) 2020.12.02
8장 - 경계  (0) 2020.11.30
  1. 창발적 설계로 깔끔한 코드를 구현하자.

    • 단순한 설계 규칙 4가지가 소프트웨어 설계 품질을 크게 높여준다고 믿는다.
      1. 모든 테스트를 실행한다.
      2. 중복을 없앤다.
      3. 프로그래머 의도를 표현한다.
      4. 클래스와 메소드 수를 최소로 줄인다.
        • 이 4가지 규칙을 줄이면서 너무 남발적으로 클래스와 메소드를 사용하는 경우가 있다.
        • 이럴 경우 최소로 줄여주자.
        • 클래스와 메소드를 최소단위로 줄여서 작게작게 만들자. 라는 기준이 우선이고
        • 최소로 줄이는건 후순위다.
    • 위 목록은 중요도 순이다.
    1. 모든 테스트를 실행한다.

      • 무엇보다 먼저, 설계는 의도한 대로 돌아가는 시스템을 내놓아야 한다.
      • 문서로는 시스템을 완벽하게 설계 했지만 시스템이 의도한 대로 돌아가는지 검증할 간단한 방법이 없다면, 문서 작성을 위해 투자한 노력에 대한 가치는 인정받기 힘들다.
      • 검증이 불가능한 시스템 ( 테스트 로 검증 할수 없는 시스템 ) 은 절대 출시하면 안된다.
      • SRP를 준수하는 클래스는 테스트가 훨씬 더 쉽다.
      • 결합도가 높으면 테스트 케이스를 작성하기 어렵다.
      • DIP 원칙을 적용하여 DI , 인터페이스 , 추상화 등과 같은 도구를 사용해 결합도를 낮춰라
      • 낮추면 낮출수록 품질이 더욱 좋아진다.
      • 결과적으로 테스트 케이스를 만들고 계속 돌려라 라는 간단한 단순한 규칙을 따르면
      • 시스템은 낮은 결합도와 높은 응집력이라는 객체 지향 방법론이 지향하는 목표를 저절로 달성한다.
    2. 2~4 리팩토링

      • 테스트 케이스를 모두 작성했다면 이제 코드와 클래스를 정리해도 괜찮다.
      • 코드를 정리하면서 시스템이 깨질까 걱정할 필요가 없다. 테스트 케이스가 있으니까.
      • 응집도를 높이고, 결합도를 낮추고, 관심사를 분리하고, 시스템 관심사를 모듈로 나누고, 함수와 클래스 크기를 줄이고, 더 나은 이름을 선택하는 등 다양한 기법을 동원한다.
    3. 중복을 없애라.

      • 우수한 설계에서 중복은 커다란 적이다.
      • 중복은 추가 작업, 추가 위험, 불필요한 복잡도를 의미
      int size() {} boolean isEmpty(){} boolean isEMpty() { return 0 == size(); }
      • 위와 같은 두개의 메소드가 존재할때 empty 메소드는 size 메소드를 이용하여 내부 구현을 함으로 중복 구현을 줄인다.
      • 단 몇줄이라도 중복을 제거하겠다는 의지가 필요하다.
      • 소규모라도 줄이면 시스템 복잡도가 극적으로 줄어든다.
      • 소규모 재사용을 익혀야 대규모 재사용이 가능하다.
      • Template method 패턴은 고차원 중복을 제거할 목적으로 자주 사용된다.
      • ( 어렵다 자주자주 보도록 하자 )
    4. 표현하라

      • 자신이 이해하는 코드는 짜기 쉽다.
      • 코드를 짜는동안 문제에 푹빠져 코드를 구석구석 이해하니까.
      • 코드를 변경하면서 버그의 싹을 심지 않으려면 유지보수 개발자가 시스템을 제대로 이해해야 한다.
      • 그러므로 코드는 개발자의 의도를 분명히 표현해야 한다.
      1. 좋은 이름을 선택한다.
        • 이름과 기능이 완전히 딴판인 클래스나 함수로 유지보수 담당자를 놀래키지 말자.
      2. 함수와 클래스 크기를 가능한 줄인다.
        • 작은 클래스와 작은 함수는 이름짓기도 쉽고, 구현하기도 쉽고 이해하기도 쉽다.
      3. 표준 명칭을 사용한다.
        • 디자인 패턴은 의사소통과 표현력 강화가 주요 목적이다.
        • 클래스가 COMMAND나 VISITOR같은 표준 패턴을 사용해 구현하게 된다면
        • 클래스 이름에 패턴 이름을 넣어준다.
        • 그러면 다른 개발자가 클래스 설계 의도를 이해하기 쉬워진다.
      4. 단위 테스트 케이스를 꼼꼼히 작성한다.
        • 예제로 보여주는 문서
        • 잘 만든 테스트 케이스를 읽어보면 클래스 기능이 한눈에 들어온다.
      5. 표현력을 높이는 가장 중요한 방법은 노력이다.
        • 흔히 코드만 돌린 후 다음 문제로 직행하는 사례가 너무 흔하다.
        • 나중에 읽을 사람을 고려해 조금이라도 읽기 수비게 만들려는 충분한 고민은 거의찾기 어렵다.
        • 함수와 클래스에 조금 더 시간을 투자하자.
        • 더 나은 이름을 선택하고 큰 함수를 작은 함수 여럿으로 나누고
        • 자신의 작품에 조금만 더 주의를 기울이자.
        • 주의는 대단한 재능이다.
    5. 클래스와 메서드 수를 최소로 줄여라.

      • 중복을 제거하고 , 의도를 표현하고, SRP를 준수한다는 기본적인 개념도 극단으로 치달으면 득보다 실이 많아진다.
      • 클래스와 메서드 크기를 줄이자고 조그만 클래스와 메서드를 수없이 만드는 사례도 없지 않다.
      • 그래서 이 규칙은 함수와 클래스 수를 가능한 줄이라고 제안한다.
      • 이 규칙은 다른 4가지중 가장 우선순위가 낮다.
      • 클래스와 함수를 줄이는 작업도 중요하지만
      • 테스트 케이스를 만들고 중복을 제거하고 의도를 표현하는 작업이 더 중요하다는 뜻이다.

    결론

    • 경험을 대신할 단순한 개발 기법은 없다.
    • 단순한 설계 규칙을 따른다면 우수한 기법과 원칙을 단번에 활용 할 수 있다.

'book > 클린코드' 카테고리의 다른 글

11장 - 시스템  (0) 2021.02.22
13장 동시성  (0) 2021.01.05
10장 - 클래스  (0) 2020.12.22
9장 - 단위 테스트  (0) 2020.12.02
8장 - 경계  (0) 2020.11.30
  • 클래스 체계

    • 표준자바 관례에 따르면 가장 먼저 변수 목록이 나온다
    • static , public 상수가 있다면 맨 처음 나온다.
    • 다음 private 변수가 나오며 이어서 비공개 인스턴스 변수가 나온다.
    • 변수 목록 다음에는 공개 함수가 나온다.
    • 비공개 함수는 자신을 호출하는 공개 함수 직후에 넣는다.
    • 즉 추상화 단계가 순차적으로 내려간다.
    • 그래서 프로그램은 신문 기사처럼 읽힌다.
  • 캡슐화

    • 변수와 유틸리티 함수는 가능한 공개하지 않는 편이 낫지만
    • 반드시 숨겨야 한다는 법칙도 없다.
    • 떄로는 protected로 선언해 테스트코드에 접근을 허용하기도 한다.
    • 같은 패키지 안에서 테스트코드가 함수를 호출하거나 변수를 사용해야 한다면
    • 그 함수나 변수를 protected로 선언하거나 패키지 전체로 공개한다.
    • 하지만 그전에 비공개 상태를 유ㅜ지할 온갖 방법을 강구한다.
    • 캡슐화를 풀어주는 결정은 언제나 최후의 수단이다.
  • 클래스는 작아야 한다.

    • 작아야 이해하기가 쉽고

    • 작아야 짜기도 쉽다.

    • 클래스가 작아야 한다는 기준은 책임 이다.

    • 클래스 이름은 해당 클래스 책임을 적어야 한다.

    • 작명은 클래스의 책임을 줄이는 첫번째 관문이다.

    • 간결한 이름이 떠오르지 않는다면 클래스의 책임이 많은것이다. 나눠라

    • 클래스 설명은 if , and , or , but 을 사용 하지않고서 25단어 내외로 가능해야 한다.

    • 단일책임원칙 ( SRP )

      • 말그대로 클래스는 책임이 하나여야 된다.
    • 응집도

      • 클래스는 인스턴스 변수의 수가 적어야 한다.

      • 일반적으로 메서드가 변수를 더 많이 사용할수록 메서드와 클래스는 응집도가 높다.

      • 함수를 작게, 매개변수 목록을 짧게

      • 라는 전략을 따르다보면 때떄로 몇몇 메서드만이 사용하는 인스턴스 변수가 아주 많아진다.

      • 이때는 새로운 클래스로 쪼개야 된다는 신호.

      • 응집도가 높아지도록 변수와 메서드를 적절히 분리해 새로운 클래스로 쪼갠다

    • 응집도를 유지하면 작은 클래스 여럿이 나온다.

      • 몇몇 함수만 사용하는 인스턴스 변수가 늘어난다면

      • 쪼개라 따로 클래스로 쪼개버려라

      • 이렇게 큰함수를 작은함수로 쪼개다보면 작은 클래스 여럿으로 쪼개지게 되는데

      • 이러면 프로그램에 점점 더 체계가 잡히고 구조가 투명해진다.

      • 가장 먼저 원래 프로그램의 정확한 동작을 검증하는 테스트 코드를 작성

      • 그런 다음 한번에 하나씩 수차례에 걸쳐 조금씩 코드를 변경

      • 코드를 변경할때마다 테스트를 수행해 원래 프로그램과 동일하게 동작하는지 확인했다.

      • 조금씩 원래 프로그램을 정리한 결과 최종 프로그램이 얻어졌다.

    • 변경하기 쉬운 클래스

      • 깨끗한 시스템은 클래스를 체계적으로 정리해 소스 변경시 일어나는 의도대로 동작하지 않을 위험을 낮춘다.

      • 클래스에 손을 대는 순간 설계를 개선하려는 고민과 시도가 필요.

      • 클래스를 분리 시킴으로써 SRP와 OCP 두가지 장점을 취한다.

      • 메인기능 클래스를 따로 빼서 나머지 기능 클래스들이 그 기능을 상속받아 오버라이딩 한다. ( OCP )

      • 확장에 개방적이고 수정에 폐쇄적인 구조가 생성된다.

    • 변경으로부터 격리

      • 상세한 구현에 의존하는 코드는 개념이 바뀌면 위험에 빠진다.
      • 시스템의 결합도를 낮추면 유연성과 재사용성도 더욱 높아진다.
      • 결합도가 낮다는 소리는 각 시스템 요소가 다른 요소로부터 격리되어 있다는 의미

'book > 클린코드' 카테고리의 다른 글

13장 동시성  (0) 2021.01.05
12장 - 창발성  (0) 2021.01.03
9장 - 단위 테스트  (0) 2020.12.02
8장 - 경계  (0) 2020.11.30
7장 - 오류처리  (0) 2020.11.27

TDD 법칙 3가지

  • 첫째 법칙

    • 실패하는 단위 테스트를 작성할 때 까지 실제 코드를 작성하지 않는다.
  • 둘째 법칙

    • 컴파일은 실패하지 않으면서 실행이 실패하는 정도로만 단위테스트를 작성한다.
  • 셋째 법칙

    • 현재 실패하는 테스트를 통과할 정도로만 실제 코드를 작성한다.
  • 실제코드와 맞먹을 정도로 방대한 테스트코드는 심각한 관리문제를 유발하기도 한다.

  • 깨끗한 테스트 코드 유지하기

    • 지저분한 테스트코드는 차라리 안하니만 못하다.

    • 코드가 진화하면 테스트코드도 맞춰서 진화해야한다.

    • 코드만진화하고 안바꾸면 나중에 엄청난 부채로 돌아온다

    • 테스트 코드는 실제 코드 못지않게 중요하다

    • 테스트는 유연성, 유지보수성, 재사용성을 제공한다.

      • 코드에 유연성 , 유지보수성, 재사용성을 제공하는것은 바로 단위테스트
      • 테스트코드가 지저분하면 코드를 변경하는 능력이 떨어지며
      • 테스트 코드가 지저분할수록 실제코드도 지저분해진다.
      • 실제 코드도 망가지고 테스트코드도 잃어버린다.
  • 깨끗한 테스트 코드

    • 깨끗한 코드를 만들기 위해선 3가지가 필요하다

    • 가독성 , 가독성 , 가독성

    • ( 가독성 개 중요 )

    • 테스트 코드에 가독성을 높이려면 ?

      • 명료성, 단순성, 풍부한 표현력이 필요하다.
      • 테스트 코드는 최소한의 표현으로 많은것을 나타내야 한다.
    • build operate check 패턴

      • 웬지 given when then 느낌나는 패턴임
  • 도메인에 특화된 언어

    • 테스트에 특화된 API를 따로 만들어라.
  • 이중 표준

    • 테스트 API코드에 적용하는 표준은 실제 코드에 적용하는 표준과 확실히 다르다.
    • 단순하고 간결하고 표현력이 풍부해야 하지만, 실제 코드만큼 효율적일 필요는 없다.
    • 실제 환경에서는 절대로 안되지만 테스트 환경에서는 전혀 문제없는 방식이 있다.
    • 대개 메모리나 CPU 효율과 관련 있는 경우다.
    • 코드의 깨끗함과는 철저히 무관하다
  • 테스트당 assert 하나

    • JUNIT으로 테스트 코드를 짤 때는 함수마다 assert문을 단 하나만 사용해야 한다고 주장한 학파가 있다.

    • 장점은 있다.

    • assert문이 하나인 함수는 결론이 하나라서 코드를 이해하기 쉽고 빠르다.

    • 만약 어거지로 합쳐서 하나로 만드는 경우가 있다면 차라리 두개로 나눠라

    • 이럴때 중복되는 부분이 있는데 이런것은 템플릿 메소드 패턴을 사용하면

    • 중복을 제거할수 있다.

    • given when 부분을 부모 클래스에 두고 then 부분을 자식클래스에 두면 된다.

    • 아니면 완전히 독자적인 테스트 캘르스를 만들어 @Before 함수에 given when 부분을 넣고 @Test함수에 then부분을 넣어도 된다.

    • 하지만 모두가 배보다 배꼽이 더 크다.

    • 이것저것 감안해보면 결국 assert문을 여럿 사용하는 편이 좋다고 생각한다.

    • 결국 assert문이 여러개 써서 깔끔해진다면 여러개써라

    • 단지 assert문 개수는 최대한 줄여야 좋다는 생각이다.

    • ( 왜냐 이해하기가 쉬워지니까 )

  • 테스트당 개념 하나

    • 테스트 함수마다 한 개념만 테스트하라
    • 가장 좋은 규칙은
    • 개념당 assert문 수를 최소로 줄여라 와 테스트 함수 하나는 개념 하나만 테스트하라
  • F.I.R.S.T

    • 깨끗한 테스트는 다음 다섯가지 규칙을 가진다.
      • 빠르게

        • 테스트는 빨라야한다. 느리면 자주 돌릴 엄두를 못낸다.
        • 자주 돌리지 않으면 초반에 문제를 찾아내 고치지 못한다.
        • 코드를 마음껏 정리하지도 못한다.
      • 독립적으로

        • 각 테스트는 서로 의존하면 안된다.
        • 한 테스트가 다음 테스트가 실행될 환경을 준비해서는 안된다.
        • 테스트가 서로에게 의존하게 되면 하나가 실패할때 나머지도 잇달아 실패하므로 원인을 진단하기 어렵다.
      • 반복가능하게

        • 어떤 환경에서도 테스트는 반복가능해야한다.
        • 그렇지 않으면 환경이 지원되지 않기에 테스트를 수행하지 못하는 상황이 직면한다.
      • 자가검증하는

        • 테스트는 bool 값으로 결과를 내야한다.
        • 성공 아니면 실패다.
        • 통과여부를 알려고 로그파일을 읽게 만들어서는 안된다.
      • 적시에

        • 테스트는 적시에 작성해야 한다.

        • 단위테스트는 테스트하려는 실제 코드를 구현하기 직전에 구현한다.

        • 실제 코드를 구현한 다음에 테스트 코드를 만들면 실제 코드가 테스트하기 어렵단

        • 사실을 발견할지도 모른다.

        • 테스트가 불가능하도록 실제 코드를 설계할지도 모른다.

        • ( 결국 테스트를 만들기전에 실제 코드를 만들면 테스트가 불가능하게 설계할수도 있는 상황이 올수도 있다는 것인듯..? )

'book > 클린코드' 카테고리의 다른 글

12장 - 창발성  (0) 2021.01.03
10장 - 클래스  (0) 2020.12.22
8장 - 경계  (0) 2020.11.30
7장 - 오류처리  (0) 2020.11.27
6장 - 객체와 자료구조  (0) 2020.11.25
  • 오픈소스 라이브러리를 사용해야 할 경우
  1. 외부코드 사용하기

    • 외부 코드를 사용할경우 반환하는 Object를 올바른 유형으로 반환할 책임은 사용하는 클라이언트에 있다.
    • 랩퍼 클래스로 한번 숨기면 그 안에서 객체 유형을 관리하기 때문에 나머지 프로그램에는 영향을 미치지 않는다.
    • 그리고 이 랩퍼 클래스는 사용자에게 필요한 인터페이스만 제공하므로 이해하기 쉽고
    • 오용하기는 어렵다.
    • 또한 이 랩퍼 클래스는 설계규칙과 비즈니스 규칙을 따르도록 강제할수 있다.
  2. 경계 살피고 익히기

    • 간단한 테스트 케이스를 작성해 외부 코드를 익히는 방법
    • 이를 학습 테스트 라고 한다.
    • 학습테스트는 프로그램에서 사용하려는 방식대로 외부 API를 호출한다.
    • 학습테스트는 API를 사용하려는 목적에 초점을 맞춘다.
  3. log4j 익히기

    • 2번의 방식대로 log4j로 로그 찍는법을 익혀보자.
  4. 학습 테스트는 꽁짜 이상이다.

    • 어차피 api를 배워야 하기 때문에 학습테스트에 드는 비용은 없다.
    • 나중에 새버전나왓을때 호환이 되는지 확인하기도 좋다.
  5. 아직 존재하지 않는 코드를 사용하기

  • 인터페이스를 만들어 어댑터 패턴을 이용해 api 사용을 캡슐화해 api가 바뀔 때 수정할 코드를 한곳으로 모았다.

  • 이와 같은 설계는 테스트도 아주 편하다.

  • ( 뭔소린지 모르겠다 다시 읽어봐야 할듯 )

  1. 깨끗한 경계
  • 경계에 위치하는 코드는 깔끔히 분리한다.
  • 외부 패키지를 호출하는 코드를 가능한 줄여 경계를 관리하자
  • 아니면 새로운 랩퍼 클래스를 만들던지 adapter 패턴을 사용해
  • 외부 패키지가 제공하는 인터페이스를 우리가 원하는 방식으로 바꾼다.

'book > 클린코드' 카테고리의 다른 글

10장 - 클래스  (0) 2020.12.22
9장 - 단위 테스트  (0) 2020.12.02
7장 - 오류처리  (0) 2020.11.27
6장 - 객체와 자료구조  (0) 2020.11.25
5장 - 형식 맞추기  (0) 2020.11.23
  • 오류처리는 깨끗한 코드와 연관성이 있다.
  • 하지만 오류처리로 인해 프로그램 논리를 이해하기 어려워 진다면 깨끗한 코드라 부르기 어렵다.
  1. 오류 코드보다 예외를 사용하라.

    • 함수를 호출 하는 즉시 오류 를 확인하고 처리해야하기 때문에 복잡한다.
    • 그래서 그냥 예외를 던지면 편하다.
    • 코드도 깔끔해지고 로직을 이해하기가 더 쉬워진다.
  2. Try- Catch - Finally 문 부터 작성하라.

  • try-catch 문은 트랜잭션과 유사하다.
  • 예외가 발생할 코드를 짤때는 try catch 문 부터 작성하자.
  1. 미확인 ( Unchecked ) 예외를 사용하라.
  • 확인된 예외는 OCP를 위반한다.

    • 확인된 예외를 던졌는데 catch 블록이 세 단계 위에 있다면 그 사이 메소드 모두가 선언부에 해당 예외를 정의해야 한다.
    • 즉 하위 단계에서 코드를 변경하면 상위 단계 메서드 선언부를 전부 고쳐야 한다는 말이다.
  • 최상위 함수에서 점점 아래함수를 호출하여 최하위 함수에서 새로운 오류를 던진다고 했을떄

  • 확인된 오류를 던진다면 최하위 함수를 거쳐온 모든 함수들을 수정해야 한다. ( throws 절을 추가 하거나 catch 블록에서 예외처리 )

  • 그리고 모든 함수가 최하위 함수가 던지는 예외를 알아야 하므로 캡슐화가 깨진다.

  • 아주 중요한 라이브러리를 작성한다면 모든 예외를 잡아야 한다.

  • 하지만 일반적인 애플리케이션은 의존성이라는 비용이 이익보다 크다.

  1. 예외에 의미를 제공해라.
  • 오류메세지에 정보를 담아 예외와 함께 던지면 발생한 원인과 위치를 찾기가 쉬워진다.
  • 로깅도 사용한다면 catch 블록에서 오류를 기록하도록 충분한 정보를 넘겨준다.
  1. 호출자를 고려해 예외 클래스를 정의하라.
  • 애플리케이션에서 오류를 정의할때 프로그래머에게 가장 중요한 관심사는

  • 오류를 잡아내는 방법 이 되어야 한다.

  • 외부 api를 사용할때 wrapper 클래스를 하나 만들어서 예외 처리하는 것은 좋은 방법이다.

  • 외부 api를 감싸면 외부 라이브러리와 프로그램 사이에 의존성이 크게 줄어든다.

  • 갈아끼우는것도 쉽다. wrapper 클래스에서 수정하면 되기 떄문.

  • ( wrapper 클래스 작성하는 비용이면 그냥 wrapper 클래스 안쓰고 class에 쓰면 되지않나 ? )

  • ( 의존성이 줄어든다는 장점때문에 wrapper를 사용하는것 같다 )

  • 흔히 예외 클래스가 하나만 있어도 충분한 코드가 많다.

  • 예외 클래스에 포함 된 정보로 오류를 구분해도 괜찮은 경우가 그렇다.

  • 한 예외는 잡아내고 다른 예외는 무시해도 괜찮은 경우라면 여러 예외 클래스를 사용한다.

  • ( 이 3문단이 이해가 안된다. )

  1. 정상 흐름을 정의하라.
  • 비즈니스와 오류처리가 잘 분리되면 코드가 대부분이 깨끗하고 간결하게 보인다.

  • 하지만 그러다보면 점점 오류처리가 저 멀리 떨어져 나가게된다

  • 굳이 예외처리를 안하는 상황이 있다.

  • 이를 특수사례 패턴이라 부른다.

  • 클래스를 만들거나 객체를 조작해 특수사례를 처리하는 방식이다.

  • 그러면 클라이언트 코드가 예외적인 상황을 처리할 필요가 없어진다.

  • 클래스나 객체가 예외적인 상황을 캡슐화해서 처리하므로.

  • ( 굳이 예외처리가 코드를 복잡하게 만든다면 Martin Fowler의 Special Case Pattern을 사용하자.(참조 3) )

  1. null을 반환하지 마라.
  • null을 반환하는 코드는 호출자에게 일거리를 늘려주는일이다.
  • null대신에 특수사례 객체를 반환하자.
  • 사용하려는 외부 API가 null을 반환한다면 wrapper method를 구현해 예외를 던지거나
  • 특수사례 객체를 반환하는 방식을 고려한다.
  • 많은 경우에 특수사례 객체가 손수윈 해결책이다.
  1. null을 전달하지 마라.
  • 정상적인 인수로 null을 기대하는 API가 아니라면 메서드로 null을 전달하는 코드는 최대한 피한다.
  • assert문을 사용해서 null체크 하는것도 괜찮은 방법이다.
  • ( 신기하다 다시보자 )

결론

  • 깨끗한 코드는 읽기도 좋아야 하지만 안전성도 높아야 한다.

'book > 클린코드' 카테고리의 다른 글

9장 - 단위 테스트  (0) 2020.12.02
8장 - 경계  (0) 2020.11.30
6장 - 객체와 자료구조  (0) 2020.11.25
5장 - 형식 맞추기  (0) 2020.11.23
4장 - 주석  (0) 2020.11.22
  • 변수를 private으로 하는 이유는남들이 변수에 의존하게 하고싶지 않기 떄문이다.
  1. 자료 추상화

    • 추상 인터페이스를 사용해 사용자가 구현을 모른채 자료의 핵심을 구현할수 있어야
    • 진정한 클래스다.
    • 자료를 세세하게 공개하기 보다는 추상적인 개념으로 표현하는 것이 좋다.
    • 인터페이스나 조회 설정 함수만으로는 추상화가 이뤄지지 않는다.
    • 개발자는 객체가 포함하는 자료를 표현할 가장 좋은 방법을 심각하게 고민해야 한다.
    • 아무 생각없이 조회/설정 함수를 추가하는 방법이 가장 나쁘다.
  2. 자료/객체 비대칭

    • 객체는 추상화 뒤로 자료를 숨긴채 자료를 다루는 함수만 공개한다.
    • 자료 구조는 자료를 그대로 공개하며 별다른 함수는 제공하지 않는다.
    • 객체지향 코드에서는 어려운 변경은 절차적인 코드에서 쉽고
    • 절차적인 코드에서 어려운 변경은 객체지향 코드에서 어렵다.
    • ( 나는 아직 까지 절차지향에서 벗어나지 못하고 있었다. )
  3. 디미터 법칙

    • 모듈은 자신이 조작하는 객체의 속사정을 몰라야 한다는 법칙

    • 위에서 봣듯이 객체는 자료를 숨기고 함수를 공개한다.

    • 객체는 조회 함수로 내부 구조를 공개하면 안된다는 의미다.

    • 디미터 법칙은 클래스C의 메서드f는 다음과 같은 객체의 메서드만 호출해야 한다고 주장한다.

      • 클래스 C
      • f가 생성한 객체
      • f 인수로 넘어온 객체
      • C인스턴스 변수에 저장된 객체
    • 디미터 법칙은 메소드 체이닝을 사용하지 말라고한다.

    • 기차 충돌

      • 메소드체이닝을 기차충돌이라고 부른다고 한다.
      • 객체가 한줄로
    • 잡종 구조

      • 절반은 객체 절반은 자료 구조인 잡종 구조
      • 되도록 피하는 것이 좋다.
    • 구조체 감추기

      • 객체에게 뭔가를 시켜야지 객체의 내부구조를 보이게 해선 안된다.
      • ( 어렵다 )
    • 자료 전달 객체

      • DTO 라고도 한다.

      • bean 구조 이며 데이터베이스에 저장된 가공되지 않은 정보를 애플리케이션 코드에서 사용할 객체로 변환하는 일련의 단계에서 가장 처음으로 사용되는 구조체다.

      • DTO의 private 변수를 조회 설정 함수로 조작한다는 것을 작가 할아버지는 사이비 캡슐화로 보고있으며 별다른 이익을 제공하지 않는다고 한다.

      • ( 난 여태까지 이렇게 해왔었는데 잘못된 것이였는가 ? )

      • 활성 레코드

        • DTO와 같으며 대개 save와 find 같은 탐색함수도 제공한다.
        • 활성 레코드는 데이터베이스 테이블이나 다른소스에서 자료를 직접 변환한 결과다.
        • 활성레코드는 자료 구조로 취급한다.

      결론

      • 객체는 동작을 공개하고 자료를 숨긴다.
      • 기존 동작을 변경하지 안ㅇ흐면서 객체 타입을 추가하기는 쉬운 반면
      • 기존 객체에 새동작을 추가하기는 어렵다.
      • 자료구조는 별다른 동작 없이 자료를 노출한다.
      • 그래서 기존 자료구조에 새 동작을 추가하기는 쉬우나
      • 기존 함수에 새 자료구조를 추가하기는 어렵다.

'book > 클린코드' 카테고리의 다른 글

8장 - 경계  (0) 2020.11.30
7장 - 오류처리  (0) 2020.11.27
5장 - 형식 맞추기  (0) 2020.11.23
4장 - 주석  (0) 2020.11.22
3장 - 함수  (0) 2020.11.19

+ Recent posts