🛠️상황

지난 포스팅에서는 기본 생성자와 객체 매핑시 주의할 점에 대해 다루었습니다.

그중 아직 해결하지 못했던 의문점인

2. 왜 나는 Mybatis에서 @Getter 와 @Builder 만 사용해도 정상적으로 객체 매핑이 되는가?

에 대해 알아보려 합니다.

해당 이유를 알아보기 위해, 먼저 Mybatis가 생성자를 통한 객체 매핑을 하는 방법의 종류 및 동작 방식에 대해 알아보겠습니다.

🗂️ Mybatis의 생성자를 통한 객체 매핑

MyBatis를 사용해서 조회한 쿼리를 DTO에 매핑할 때,어떠한 매핑 방식들이 존재하고, 어떤 방식으로 동작할까요?

저는 해당 프로젝트에 가독성, 유연성, 불변성 등의 이유로 @Builder 패턴을 사용하였기 때문에, @Builder 패턴을 활용한 결과 매핑에 대해서 다뤄보겠습니다.

🧩 Mybatis에서 @Builder 패턴을 사용할 경우 주의점

@Builder는 빌더 클래스가 사용할 수 있도록 private 생성자를 생성하는데, 이는 모든 필드 값을 포함합니다.

1. 🦕 @Builder + 기본 생성자(@NoArgsConstructor)

기본생성자를 통해 매핑할 경우, 변수 네이밍과 column 이름이 같으면 리플렉션을 통해 자동으로 매핑이 됩니다. (이때 대소문자는 구별하지 않지만, camelCase는 구별합니다.)

즉 대소문자 상관 없이 DB의 column명과 정확히 일치해야 인식합니다.

2. 🦕 @Builder + 기본 생성자(@NoArgsConstructor) + 별칭(Alias)

대소문자는 무시하고 변수와 컬럼명이 일치하면 자동으로 매핑이 되지만, 위의 경우만으로는 보통 만족할만한 결과를 얻기 어렵습니다.

자바 명명 규칙으로 대게 camelCase를 사용하고, 기본생성자의 자동 매핑의 경우 camelCase까지 고려해 주지는 않기 때문입니다.

따라서 이럴 때는 별칭(Alias)을 사용할 수 있습니다. 기본 생성자 + 컬럼 Alias를 지정하여 결과를 매핑하는 경우, 모든 필드 및 컬럼에 대해 매핑이 정상적으로 진행됩니다.

하지만 방법 1과 2를 준수하기에는 필드명이 카멜케이스인 필드가 많을 경우 생산성이 떨어집니다.
따라서 camelCase까지 변환하여 변수 네이밍에 따라 자동 매핑해주는 설정을 할 수 있습니다.
MyBatis - 🛠️TroubleShooting

3. 🦕 @Builder = 모든 필드를 포함하는 생성자 (@AllArgsConstructor)

하지만 모든 필드를 포함하는 생성자로만 매핑한다면, 자바 문법인 전체생성자로 생성자를 생성할 때, 파타미터의 개수, 타입과 변수 순서를 맞춰 생성해 주어야 하는 점과 같이 주의를 해야합니다.

모든 필드를 포함하는 생성자로 매핑하면, 파라미터 순서에 조회 쿼리의 결괏값 순서대로 매핑이 됩니다.

따라서 @AllArgsConstructor 만 사용 하는 경우, 다음을 주의해야 합니다.

1. 객체의 변수 순서를 테이블의 column 순서와 똑같이 맞춰야 한다.
2. 그 순서대로 매핑되므로 CamelCase를 사용해도 정상적으로 매핑된다.

하지만 많은 매개 변수를 가진 생성자를 다루는 경우, arg 엘리먼트의 순서를 유지하는 것은 오류가 발생하기 쉽습니다.
Mybatis 3.4.3v 이후부터는 각 매개 변수의 이름을 지정하여 임의의 순서로 arg 엘리먼트를 작성할 수 있습니다.

Mybatis 공식 문서
https://mybatis.org/mybatis-3/ko/sqlmap-xml.html

4. 🦕 @Builder + 기본 생성자(@NoArgs) + 모든 필드를 포함하는 생성자(@AllArgs)

🗂️ 2. @Getter 와 @Builder 만 사용해도 정상적으로 매핑됐던 이유

따라서 많은 기술 블로그에서 Mybatis는 기본생성자가 있어야 정상적으로 매핑이 된다고 말하고 있지만, 이는 잘못된 기술입니다.

따라서 @Getter와 @Builder 만 붙어있는 클래스에는 모든 필드값을 포함한 생성자가 생성되기에, 자바 문법에 따라 기본생성자가 없습니다.

하지만 전체생성자만으로도 객체 매핑을 할 수 있습니다.
하지만 전체생성자로 매핑하는 경우 몇가지 주의사항이 있습니다.

🗂️ 참고

• https://goodteacher.tistory.com/650
• https://zzang9ha.tistory.com/420
• https://velog.io/@bushyerin/Mybatis%EC%97%90%EC%84%9C-ResponseDto-%EB%A7%A4%ED%95%91-Builder-%ED%8C%A8%ED%84%B4
• http://skylarcoding.tistory.com/107
• https://dlwjdcks5343.tistory.com/78
• https://yeti.tistory.com/278
• https://jasper-rabbit.github.io/posts/mybatis-refector/