7-10장 ) 오류 처리, 경계, 단위 테스트, 클래스

Reference : Clean Code

http://www.yes24.com/Product/Goods/11681152

Clean Code 클린 코드 - YES24

 

7장 ) 오류 처리

 

깨끗한 코드와 오류 처리는 연관성이 있다.

 

• 오류 코드보다 예외를 사용하라
• Try-Catch-Finally 문부터 작성하라
  • try 블록은 트랜잭션과 비슷하다. try 블록에서 무슨 일이 생기든지 catch 블록은 프로그램 상태를 일관성 있게 유지해야 한다.
  • try 블록에서 무슨 일이 생기든지 호출자가 기대하는 상태를 정의한다.
• 미확인 예외를 사용하라
  • 확인된 예외는 OCP (Open Closed Principle)을 위반한다.
• 예외에 의미를 제공하라
• 호출자를 고려해 예외 클래스를 정의하라
  • 애플리케이션에서 오류를 정의할 때 프로그래머에게 가장 중요한 관심사는 오류를 잡아내는 방법이 되어야 한다.
  • 외부 API를 감싸면 외부 라이브러리와 프로그램 사이에서 의존성이 크게 줄어든다.
  • 감싸기 기법을 사용하면 특정 업체가 API를 설계한 방식에 발목 잡히지 않는다.
  • 한 예외는 잡아내고 다른 에외는 무시해도 괜찮은 경우라면 여러 예외 클래스를 사용한다.
• 정상 흐름을 정의하라
  • 클래스를 만들거나 객체를 조작해 특수 사례를 처리하면 클라이언트 코드가 예외적인 상황을 처리할 필요가 없어진다.
• null을 반환하지 마라
  • null을 반환하는 코드는 호출자에게 문제를 떠넘긴다.
• null을 전달하지 마라
  • 정상적인 인수로 null을 기대하는 API가 아니라면 메서드로 null을 전달하는 코드는 최대한 피한다.

 

결론

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

오류 처리를 프로그램 논리와 분리해 독자적인 사안으로 고려하면 튼튼하고 깨끗한 코드를 작성할 수 있다.

 

 

 

8장 ) 경계

 

소프트웨어 경계를 깔끔하게 처리하는 법을 알아보자.

 

• 외부 코드 사용하기
• 경계 살피고 익히기
• log4j 익히기
• 학습 테스트는 공짜 이상이다. 즉, 투자하는 노력보다 얻는 성과가 더 크다.
• 아직 존재하지 않는 코드를 사용하기
• 깨끗한 경계
  • 통제하지 못하는 코드를 사용할 때는 너무 많은 투자를 하거나 향후 변경 비용이 지나치게 커지지 않도록 각별히 주의해야 한다.
  • 경계에 위치하는 코드는 깔끔히 분리하고, 기대치를 정의하는 테스트 케이스도 작성한다.
  • 외부 패키지를 호출하는 코드를 가능한 줄여 경계를 관리한다.

 

 

9장 ) 단위 테스트

TDD란?

Test Driven Development 로, 단위 테스트를 말하며, 실제 코드를 짜기 전에 단위 테스트부터 짜라고 요구한다.

 

TDD 법칙 세가지

1. 실패하는 단위 테스트를 작성할 때까지 실제 코드를 작성하지 않는다.
2. 컴파일은 실패하지 않으면서 실행이 실패하는 정도로만 단위 테스트를 작성한다.
3. 현재 실패하는 테스트를 통과할 정도로만 실제 코드를 작성한다.

 

• 깨끗한 테스트 코드 유지하기
  • 테스트코드가 지저분할 수록 변경하기 어려워지며, 복잡할수록 실제 코드를 짜는 시간보다 테스트 케이스를 추가하는 시간이 더 걸린다.
  • 테스트 코드는 실제 코드 못지 않게 중요하다.
  • 테스트는 유연성, 유지보수성, 재사용성을 제공한다.
  • 깨끗한 테스트 코드를 만들려면 가독성이 필요하다.
• 테스트 당 assert 하나만 사용한다.
  • 테스트 함수마다 한 개념만 테스트하라.
  • F.I.R.S.T 규칙 : Fast, Independent, Repeatable, Self-Validating, Timely. 즉, 테스트는 빨리 돌아야하며 각 테스트는 서로 의존하면 안되고, 어떤 환경에서도 반복 가능해야하며 bool 값으로 결과(성공/실패)를 내고, 적시에 작성해야한다.

 

 

10장 ) 클래스

깨끗한 클래스

• 클래스 체계
  • 가장 먼저 변수 목록이 나온다. 정적 공개 상수가 있다면 맨 처음에 나온다.
  • 다음으로 정적 비공개 변수가 나오며, 이어서 비공개 인스턴스 변수가 나온다. 
  • 변수 목록 다음에는 공개 함수가 나온다.
• 클래스는 작아야 한다.
  • 클래스 이름은 해당 클래스 책임을 기술해야 한다.
  • 단일 책임 원칙은 클래스나 모듈을 변경할 이유가 하나뿐이어야 한다는 원칙이다.
  • 큰 클래스 몇개가 아니라, 작은 클래스 여럿으로 이뤄진 시스템이 더 바람직하다. 작은 클래스는 각자 맡은 책임이 하나며, 변경할 이유가 하나며, 다른 작은 클래스와 협력해 시스템에 필요한 동작을 수행한다.
  • 응집도 : 클래스는 인스턴스 변수 수가 작아야한다. 각 클래스 메서드는 클래스 인스턴스 변수를 하나 이상 사용해야 한다.
  • 일반적으로 메서드가 변수를 더 많이 사용할수록 메서드와 클래스는 응집도가 더 높다.
  • 응집도를 유지하면 작은 클래스 여럿이 나온다.
  • 리팩터링한 프로그램은 더 길고 서술적인 변수 이름을 사용하며, 코드에 주석을 추가하는 수단으로 함수 선언과 클래스 선언을 활용한다. 또한 가독성을 높이고자 공백을 추가하고 형식을 맞추어 코드가 더 길어진다.
• 변경하기 쉬운 클래스
  • 깨끗한 시스템은 클래스를 체계적으로 정리해 변경에 수반하는 위험을 낮춘다.
  • OCP(Open-Closed Principle)란, 클래스는 확장에 개방적이고 수정에 폐쇄적이어야 한다는 원칙이다.
  • 새 기능을 수정하거나 기존 기능을 변경할 때 건드릴 코드가 최소인 시스템 구조가 바람직하다. 이상적인 시스템이라면 새 기능을 추가할 때 시스템을 확장할 뿐 기존 코드를 변경하지는 않는다.