프로젝트에 수정할 부분이 없나 관찰하다보니, 별점 기능이 눈에 들어왔다.
Service 코드가 굉장히 길고, 메서드가 중구난방인 상태이다.
아래의 사진에서 얼마나 복잡한지 느낄 수 있다.
이 부분을 리팩토링해서 더 깔끔하게 만들 수는 없을까?
고민을 해보기로 결심했다.
책임의 분리
우선은 Service단에서 책임을 분리해야겠다는 생각이 들었다.
지금은 별점 추가와 별점 수정이 같은 함수에서 일어나고 있다.
또한 같은 Controller에 대해서 처리가 되고 있다.
아래와 같이 구현되었으며, 이는 객체 지향의 SRP에 위반 된다고 생각한다.
차라리 Controller를 분리시켜서, 프론트엔드에서 처리를 하는게 맞다는 생각이 들었다.
프론트엔드에서 이미 별점이 있다면 /updateStar 경로로 요청을 보내고,
처음 별점을 매기는 것이라면 /pushStar로 요청을 보내는 식으로 구현할 수 있을 것이다.
아래와 같이 Controller`를 분리시켰다.
또한 Service 레이어도 아래와 같이 함수를 분리시켰다.
이제 Controller와 Service의 메서드들은 각각 하나의 책임을 가진다.
코드 중복 제거
또한 Service 레이어의 코드 중복을 제거하려고 한다.
기존에는 아래와 같이 중복되는 코드들이 곳곳에 사용되고 있었다.
getScore()과 같은 코드는 한번에 빼서 재사용할 수 있다.
저런 부분 또한 나는 Code smell이라고 생각하며, 아래와 같이 수정했다.
함수 통합
코드 중복 이외에도, Entity 내부의 함수를 손봐야겠다는 생각이 들었다.
기존의 Webtoon Entity 내부 메서드에는 아래와 같은 메서드들이 있다.
내가 생각하기에는 updateStar로 충분히 통합할 수 있는 부분이라고 생각된다.
아래와 같이 통합해보자.
메서드를 위와 같이 통합하니, Service 로직도 아래와 같아졌다.
기존에 if문으로 분기하던 로직이 사라지고, 굉장히 깔끔해졌다.
또한 Member Entity의 내부에는 아래와 같은 메서드들이 있다.
칭호 시스템이 존재하기 때문에 만들어 놓은 메서드들이다.
생각해보니 updateStar로 통합하거나, 1점, 5점 2개의 메서드만 있어도 될 것 같다.
이번에는 Member Entity를 한번 수정해보도록 하자.
우선은 위와 같이 통합해보았다.
차라리 Member Entity에 if 분기를 주는게 낫다고 판단했다.
칭호에 대한 책임은 Member Entity에 있기 때문이다.
또한 Service 로직에서 분기를 없애기 위해 Enum을 사용했다.
이런식으로 Enum을 사용할 수 있다는 것은 이번에 처음 알게 되었다.
위와 같이 계산 식을 Enum 클래스에 정의해서 사용하는 것이다.
Enum의 생성자로 들어온 매개변수를 Function으로 받을 수가 있다.
그럼 Function의 apply 메서드를 통해 내가 넣은 수식을 실행할 수 있다.
이제 아래와 같이 Service 로직이 더 깔끔해지게 된다.
분기문들이 싹 사라진 모습을 보니 굉장히 기분이 좋다.
이제 제대로 동작하는 지 테스트를 해보도록 하자.
테스트 코드
기존에 테스트 코드를 짜놓지 않아서 걱정이 었는데 잘됐다.
이번 기회에 테스트 코드를 쭉 짜며 테스트에 대해서도 공부하려 한다.
먼저 아래와 같이 별점 기능에 대한 테스트를 만들었다.
따로 Mock객체를 사용해서 실제 동작을 테스트하거나 하지는 않았다.
단순히 로직이 올바르게 동작하는지만 확인할 수 있는 코드이다.
@BeforeAll 어노테이션을 통해 미리 Entity들을 생성해 사용한다.
테스트 프레임워크인 Junit에서 제공하는 Assertion을 통해 값을 비교한다.
객체도 비교가 가능한데, 나는 지금 별점 기능을 테스트하니 Double 값만 비교한다.
위의 사진과 같이 테스트에 실패할 경우 왜 실패했는지 친절하게 알려준다.
뭔가 로직이 잘못되었는지, 원하는 대로 값이 나오지 않았다.
곰곰히 생각해보니 Source - Target을 빼는 것이 잘못되었다.
당연히 내가 바꾸려는 값에서 원래 등록해놓은 값을 빼야 차이가 계산이 된다.
예를 들어 원래 별점이 4점 이었는데 1점으로 변경하고 싶다면?
1 - 4인 -3을 starSum에 계산해주어야 하는 것이다.
바꿔주니 모든 테스트가 무사히 통과되었다!
뭔가 더 리팩토링 해야할게 있는지 좀 더 고민해보도록 하자.