본문 바로가기
더 좋은 코드를 위하여

[CleanCode] 오류처리와 단위테스트

by seaweed_one 2023. 1. 6.
728x90

이번 포스팅에서는 오류처리와 단위 테스트 작성법에 대해 알아보려고 합니다.

지난 포스팅을 못 보신 분들은 아래 링크를 참고해주세요.

 

CleanCode

깨끗한 코드란? 클린 코드는 아래와 같은 특징을 가진다. 단순함 직접적 읽기 쉬움 고치기 쉬움 목적 달성의 방법은 오로지 하나 최소한의 의존성 테스트 케이스가 존재 주의 깊게 작성함 중복

seaweed-one.tistory.com

 

CleanCode - 객체와 메서드 그리고 클래스

네이밍 의미 있는 이름 변수 및 메서드의 이름은 의미를 담아 짓는다. 무의미한 네이밍은 가독성을 떨어트린다. 접두어 사용 자제 아직까지 멤버 변수 앞에는 m을 붙이는 등 접두어를 사용하는

seaweed-one.tistory.com

그럼 본격적으로 클린코드를 위한 오류처리 방법과 테스트코드 작성법에 대하여 알아보겠습니다.

오류처리

깨끗한 코드는 읽기도 좋아야 하지만 안정성도 높아야 한다.
오류 처리를 프로그램 논리와 분리해 독자적인 사안으로 고려하면 튼튼하고 깨끗한 코드를 작성할 수 있으며 코드 유지보수성도 높아진다.
오류 처리를 위한 클린 코드 작성 원칙은 다음과 같다.

미확인 예외를 사용
확인된 예외를 사용하는 것이 좋아 보일 수 있으나 대규모 시스템에서의 호출을 생각한다면 어떨까?
최상위 함수가 아래 함수를, 아래 함수는 또 그 아래 함수를 호출하는 경우 가장 하위의 함수를 변경해 새로운 오류를 던진다고 가정한다면 함수를 호출하는 모든 함수에 catch 문이 추가되거나 선언부에 throw 문이 추가되어야 한다.

캡슐화가 깨지게 되는 것이다.
아주 중요한 라이브러리의 경우 확인된 예외도 유용하지만 일반적 애플리케이션은 의존성이라는 비용이 이익보다 크다.

예외에 의미 제공
예외를 던질 때는 전 후 상황을 충분히 덧붙여 오류 발생 원인과 위치를 찾기 쉽도록 하자

null을 반환하지 마라
해당 코드는 나쁜 코드다.
한 곳에서라도 null 체크를 빼먹는다면 애플리케이션은 통제 불능이 될지도 모른다.
null을 반환하고 싶은 유혹이 든다면 예외를 던지거나 특수 사례 객체를 반환해라.
예를 들어 리스트를 반환하는 메서드라면 null 대신 Collections.emptyList()라는 읽기 전용 리스트를 반환하도록 하자.

null을 전달하지 마라
반환도 나쁘지만 전달은 더 나쁘다.
대다수의 프로그래밍 언어는 호출자가 실수로 넘기는 null을 적절히 처리하지 못하므로 인수로 null 이 넘어오는 코드라면 문제가 있다는 말이다.

 

단위 테스트

애자일과 TDD (Test Driven Development) 단위 테스트를 자동화하는 프로그래머들이 많아졌으며 점점 더 증가하고 있다.

참고로 TDD란 실제 코드를 짜기 전에 단위 테스트부터 짜는 개발 방식이다.

그럼 TDD 작성엔 어떤 법칙이 있을까?
TDD 법칙 3가지
-실패 케이스 작성 전까지 실제 코드를 작성하지 않는다.
-컴파일은 실패하지 않으면서 실행이 실패하는 정도로만 단위 테스트를 작성한다.
-현재 실패 테스트를 통과할 정도만 실제 코드를 작성한다.

이렇게 일하면 매일 수십 개, 매년 수천 개의 테스트 케이스가 나오며 실제 코드를 사실상 전부 테스트하는 테스트 케이스가 나온다.

깨끗한 테스트 코드 유지하기
테스트 코드를 설계하지 않고 그저 실제 코드를 테스트만 하면 그만이라는 생각을 버리자.
실제 코드 업데이트 시 테스트 코드도 업데이트되어야 하는데 지저분한 테스트 코드는 변경하기 어려워지며 실제 코드를 짜는 시간보다 테스트 코드를 짜는 시간이 더 늘어날 수 있다.
또 실제 코드 변경으로 기존 테스트 케이스가 실패하게 되면 지저분한 코드로 인해 실패 테스트 케이스를 통과하기가 점점 어려워진다.

깨끗한 테스트 코드 작성법!
깨끗한 테스트 코드를 작성하기 위해서는 세 가지가 필요하다.
-가독성
-가독성
-가독성

가독성을 높이기 위해 필요한 것은 무엇일까?
바로 명료성, 단순성, 표현력이 필요하다.

테스트 코드는 최소한의 표현으로 많은 것을 나타내야 한다.

테스트는 유연성, 유지보수성, 재사용성을 제공한다
코드의 유연성 , 유지보수성, 재사용성을 제공하는 버팀목이 바로 단위 테스트!
이유는? 테스트 케이스가 있으면 변경이 두렵지 않다.

아키텍처가 부실하고 설계가 모호한 코드라도 우려 없이 변경이 가능하다.

테스트 당 assert 하나
assert가 하나뿐인 함수는 결론이 하나이다.
해서 코드를 이해하기 쉽고 빠르다.
테스트당 개념 하나만을 테스트한다! 최대한 줄일 것!

F.I.R.S.T
깨끗한 테스트는 다음 다섯 가지 규칙을 따른다
Fast 
테스트는 빨라야 한다.
테스트는 빨리 돌아야 한다는 뜻으로 테스트가 느리면 자주 돌릴 엄두를 내지 못한다.
Independent
각 테스트는 서로 독립적이어야 한다.
한 테스트가 다음 테스트가 실행될 환경을 준비해서는 안된다.
테스트가 서로 의존적이라면 하나가 실패할 경우 나머지도 잇달아 실패하므로 원인 진단이 어려워지고 후반 테스트가 찾아야 할 결함이 숨겨진다.
Repeatable
테스트는 어떤 환경에서도 반복 가능해야 한다. (네트워크가 연결되지 않은 환경에서도!)
Self-Vaildating
테스트는 bool 값으로 결과를 내야 한다.
성공 혹은 실패이며 통과 여부를 알기 위해 로그 파일을 읽게 해서는 안된다!
Timely
테스트는 적시에 작성해야 한다.
단위 테스트는 테스트하려는 실제 코드 구현 직전에 구현한다.
코드 구현 후에 테스트코드를 만들면 실제 코드가 테스트하기 어렵다는 사실을 발견할지도 모른다!

728x90

'더 좋은 코드를 위하여' 카테고리의 다른 글

[CleanCode] 창발성  (2) 2023.01.23
[CleanCode] 시스템  (0) 2023.01.13
[CleanCode] 객체와 메서드 그리고 클래스  (4) 2023.01.03
[CleanCode] 깨끗한 코드란?  (0) 2022.12.05