[이넘아 놀자] 1. 기존 하드코딩되어 있던 코드 문제점 분석 (복합키+하드코딩)

안녕하세요~ 꾸준함의 미더덕입니다. 
  
이번 시간에는 레거시 코드들을 Enum Class을 사용하여 리팩토링 하는 시간을 가져볼까 합니다.
(그런데, Enum을 Class라고 봐도 될까요? -> 맞습니다.. Enum은 추상클래스입니다..!)
 
 
기존을 하드코딩되어 배드 스멜 코드들을 Enum을 사용하여 클린하게 바꿔볼 것인데요.
크게 두 부분을 봐볼까 합니다. 
 

1. 비즈니스 로직상에서 Enum 활용 
2. JPA 엔티티에서의 활용(@Converter 사용)

 

 

레거시 코드 예시 

우선, 이번 게시물에서는 레거시 코드를 보면서 문제점이 되는 부분들을 찾아보겠습니다.

(상황의 복잡성을 더하기 위해 복합키 설정까지 해보았습니다.)

 

---

cf) 복합키 상황에서 GeneratedValue는 사용할 수 없습니다.

복합 키를 갖고 있는 엔티티는 save() 메서드 내부에서 준영속 상태의 엔티티로 판단됩니다. 

따라서 이미 식별자를 갖고 있지만 영속성 컨텍스트에 등록되지 않은 상태로 판단하기에 식별자가 NULL인 논리적 오류에 빠지게 되는 것 같습니다.

(하지만 자식 엔티티에서 복합키를 부모의 외래키 성격으로 들고 있는 경우 NULL로 flush 될 상황이 없기 때문에 해당 상황에선 적용이 가능합니다.)

복합키 GeneratedValue 사용 시 Id값이 Null로 flush 시도

스프링 에러 발생

 

(단일키는 insert 시 default 값으로 sql 생성되는 것을 확인)

단일키 상황에선 default로 flush

 

---

 

레거시 예시 코드

 

@Getter
@Entity
@Table(name = "post")
@IdClass(PostId.class)
@NoArgsConstructor(access = AccessLevel.PROTECTED)
public class Post {
    @Id
    @Column(name = "category_code")
    private String categoryCode;

    @Id // 심지어 복합키인 상황..!
    @Column(name="some_code")
    private String someCode;

    @Column(name="title")
    private String title;

    @Column(name="content")
    private String content;

    @Column(name = "created_at")
    private LocalDateTime createdAt;

    @Column(name = "delete_type")
    private String deleteType; // 코드 타입에 문자열 사용

    @Column(name = "expenditure_code")
    private String expenditureCode; // 코드 타입에 문자열 사용

    @Column(name = "industry_code")
    private String industryCode; // 코드 타입에 문자열 사용

    @OneToMany(mappedBy = "post")
    private List<Comment> commentsList;

    // 엔티티 내부 값 변경 로직에 하드코딩 사용
    public void deletePost(){
        this.deleteType = "Y";
    }
}

 

@Service
@Transactional
@RequiredArgsConstructor
public class PostService {
	//..
    private void validateCategory(PostForm postForm) {
        String categoryCode = postForm.categoryCode();
        
        // 분기처리 시 조건 코드값이 하드코딩되어 있는 상황
        if (categoryCode.equals("CT000001") ||
                categoryCode.equals("CT000002") ||
                categoryCode.equals("CT000003") ||
                categoryCode.equals("CT000004")) {
                
            throw new IllegalArgumentException("잘못된 카테고리입니다");
        }
    }
    // ..
}

 

@Service
@Transactional
@RequiredArgsConstructor
public class PostService {
    // ...
    public void weirdBusinessLogic(PostForm postForm) {
        Post post = postForm.toEntity();

        // 하드코딩된 코드값 일치 판단 후, 하드코딩된 값으로 엔티티 업데이트
        if (post.getExpenditureCode().equals("CD000001")) {
            post.updateIndustryCode("IC000003");
        }

        postRepository.save(post);
    }
    // ...
}

 
 
문제점들이 보이시나요~?
이제 하나 하나 리팩토링 대상을 분석해봅시다.

 

---

1. 엔티티에서 코드값에 대한 필드가 String으로 타입 지정되어 있는 상황..

 

@Column(name = "expenditure_code")
private String expenditureCode; // 코드 타입에 문자열 사용

 

위처럼 사용되고 있는 필드들은, 도메인 측면에서 보자면 일정한 값들을 가진 고정된 상수들만 쓰이는 상황이 대부분일 겁니다.
 
하지만 문자열 타입으로 지정되어 있기 때문에, 위의 코드만으로는 어떤 값이 들어갈지 감히 추측하기도 힘들고, 코드상에선 아무 값이나 받을 수 있게 됩니다.
특히 두 번째의 필드 같이 특정 도메인에서만 사용되어 익숙하지 않은 내용을 담은 정보라면 관리하기 더욱 어려워지겠죠?

 

---

 

2. 분기 처리 시 여러 코드값 equals() 비교해야하는 상황..

 

  if (categoryCode.equals("CT000001") ||
                categoryCode.equals("CT000002") ||
                categoryCode.equals("CT000003") ||
                categoryCode.equals("CT000004")) {
	// ...
}

 

위 같은 상황에서 가독성 없는 문자열 코드만으로 비즈니스 로직을 처리하기 힘들어 보입니다.. 
위의 예시처럼 복잡한 로직에서 일일이 값이 맞는지 DB를 뒤져가며 개발하는 건 이제 그만..
 

---

 

3. 하드코딩 때문에 도메인 로직이 보이지 않는 상황..

 

public void weirdBusinessLogic(PostForm postForm) {
    validator.validateExpenditureCode(postForm);

    Post post = postForm.toEntity();

    // 하드코딩된 코드값 일치 판단 후, 하드코딩된 값으로 엔티티 업데이트
    if (post.getExpenditureCode().equals("CD000001")) {
        post.updateIndustryCode("IC000003");
    }

    postRepository.save(post);
}

가뜩이나 복잡한 비즈니스 로직에, 이해할 수 없는 코드를 하드코딩하는 로직은 
그 자체만으로는 도저히 어떤 작업인지 알 수가 없어 보입니다... 

 

 

자, 다음 게시물부터 문제점을 하나씩 처리해 보실까요?

 

 

---

 

[참고링크]

https://kihoonkim.github.io/2017/01/27/JPA(Java%20ORM)/3.%20JPA-%EC%97%94%ED%8B%B0%ED%8B%B0%20%EB%A7%A4%ED%95%91/index.html

 

https://lightson2323.tistory.com/113