Java 클래스 설계 안전하게 잘 하기

클래스는 코드를 작성하기 위한 초기 단계라고 할 수 있을 것 같은데, 객체 지향 언어에서 클래스를 활용하여 설계를 잘 하기 위해 어떠한 점들을 고려해야 할 지 살펴봅니다

 

예제는 금액을 나타내는 Money 클래스를 토대로 설계 방법을 살펴보겠습니다.

Money Class

 

 

1. 생성자를 통해 정상적인 값 설정하기

위와 같이 모든 인스턴스 변수를 초기화하는 데 필요한 매개변수들을 받는 생성자를 만들 수 있는데, 위의 문제점은 매개변수로 잘못된 값이 전달될 수 있다는 점입니다.

 

위의 경우 객체는 정상적으로 생성되지만, 프로그램이 동작하여 객체가 사용된다면 버그가 발생합니다.

 

따라서, 잘못된 값이 유입되지 못하게 유효성 검사를 객체가 생성될 때 진행합니다.

• 금액 (amount): 0 이상의 정수
• 통화 (currency): null 외의 데이터

위와 같은 유효성 검사를 통해 애초에 잘못된 값을 가진 Money 객체는 존재할 수 없습니다.

따라서 항상 안전하고 정상적인 객체가 존재한다는 것을 보장할 수 있습니다.

 

 

2. 변수를 불변으로 만들어서 예상하지 못한 동작 예방하기

변수의 값이 불변이 아닌 상태로 메서드 내에서 계속해서 변경된다면, 값이 언제 변경되었는지, 현재 값은 무엇인지 등 계속 신경 써야 합니다.

또한 비즈니스 요구 사항의 변경으로 인해 코드를 수정하다가 의도하지 않은 값을 할당하는 '예상하지 못한 사이드 이펙트' 문제도 쉽게 발생할 수 있습니다.

특히 위와 같은 코드를 레거시 서비스에서 굉장히 많이 봤었는데 유지보수가 어려운 코드인 것 같습니다. 🤐

 

불변으로 만들면서 발생할 수 있는 장점은 다음과 같습니다.

• 변수의 의미가 변하지 않기 때문에 혼란을 줄일 수 있음
• 동작이 안정적이게 되므로, 결과를 예측하기가 쉬움
• 코드의 영향 범위가 한정적이므로, 유지 보수가 편리해짐

 

이를 해결하기 위해 변수를 불변으로 생성하면 됩니다.

 

 

3. 불변을 변경해야 하는 경우, 새로운 인스턴스를 생성하기

2.에서 불변의 변수를 변경해야 하는 경우가 발생하면, 새로운 인스턴스를 생성하면 해결할 수 있습니다.

위의 방법을 통해 불변을 유지하면서 값을 변경할 수 있습니다.

 

 

4. 메서드 매개변수와 지역 변수도 불변으로 만들기

2. 의 연장선으로 메서드의 매개변수 값을 변경하는 코드도 굉장히 많이 봤었는데요, 위의 경우도 결국 매개변수가 변경된 값을 계속해서 추적해야 하기 때문에 유지보수가 힘듭니다.

따라서, 매개변수에도 final을 선언하여 불변으로 만든다면, 값의 변경을 막을 수 있습니다.

 

(개인적으로 메서드의 매개변수에는 final을 따로 선언하지는 않고, 값을 변경하는 작업은 하지 않지만 기능 변경으로 인해 로직을 변경하는 경우, 의도하지 않게 매개변수 값이 바뀔 가능성으로 인해 예상하지 못한 동작을 일으킬 가능성은 항상 존재하기 때문에 앞으로는 메서드의 매개변수에도 final을 선언하려고 합니다.

이렇게 된다면 메서드의 매개변수 값을 변경하는 일이 발생하더라도, 이미 선언해놓은 final 키워드로 인해 최소한 한 번은 더 고려하고 코드를 작성하는 최소한의 방어 장치이기 때문에 좋을 것 같습니다. 😀)

 

 

 

5. 메서드에 잘못된 값의 전달을 예방하기

위 코드의 문제점이 무엇인지 알아채셨나요?

메서드의 인자에 '잘못된 값'이 전달되는 경우인데요, 금액을 더하는 메서드에 가격이 아닌, 티켓의 수를 더해 버렸습니다.

사실상 전달이 되어서는 안되는 값이지만, 컴파일 에러는 발생하지 않고 실제 로직이 수행된 후에서나 (힘들게) 파악이 가능할 것 같은데요, 비슷하게 사용하는 개념으로 생성자의 Builder 패턴이 있을 것 같습니다.

 

위의 경우가 발생하지 않으려면 Money 자료형만 매개변수로 받을 수 있도록 수정하면 됩니다.

매개변수의 자료형을 `int -> Money`로 변경함에따라 이제는 Money 외의 자료형은 전달이 불가능합니다.

따라서 의미가 다른 값을 전달하게 된다면 컴파일 오류가 발생하게 되기 때문에 빠른 시점에서 오류를 파악할 수 있습니다.

 

 

검토하기

 

위와 같은 클래스 설계를 통해 개선된 점을 정리하면 다음과 같습니다.

중복 코드	필요한 비즈니스 로직이 Money 클래스 내부에 모여 있기에 다른 클래스에 중복 코드가 작성될 일이 줄어듦
유지보수 비용 감소	Money 클래스의 높은 응집도로 인해 가독성 증가 및 유지보수 비용 감소
안전한 객체	생성자를 통해 변수의 유효성 검증을 진행하기 때문에, 초기화되지 않은 상태는 존재할 수 없음
잘못된 값	매개변수 자료형을 특정함으로써 방어 로직을 추가하고, 인스턴스 변수에 불변을 설정하여 잘못된 값 사전에 예방
사이드 이펙트	final 키워드를 통해 불변으로 만들었기에, 부수 효과로 부터 안전

 

 

참고자료

• 내 코드가 그렇게 이상한가요?