🛠️상황

현재 진행중인 Mybatis 프로젝트에서 Mybatis 매핑 객체 (resultType 또는 resultMap)에 @NoArgsConstructor 을 붙여 가져오려 하는데 자꾸 특정 변수에서 null으로 매핑되고 있지 못한 상태였습니다.

그래서 평소에는 @NoArgsConstructor 을 사용하지 않고 @Getter 와 @Builder 만 사용하여 매핑했고, 정상적으로 전부 다 잘 매핑이 되었습니다.
하지만 Mybatis는 기본적으로 기본생성자를 통해 객체를 매핑한다고 모든 기술 블로그에서 말하고 있어서 의문이 생겼습니다.

1. 왜 나는 자꾸 기본생성자를 추가하면 특정 Column이 null이지?
2. 왜 나는 @Getter 와 @Builder 만 사용해도 정상적으로 매핑되지?

평소 의문점이 있었지만 그냥 기능 개발에 바빠 의문점을 묵혀두고 있다가, 또 관련하여 문제가 발생하여 이번에는 확실히 분석하고 해결해 보기로 했습니다.

문제가 발생한 시점은 Mybatis에서 1:N 관계를 List로 포함하여 가져오려 할 때 발생했습니다.
ORM인 JPA를 사용했을 때는 손쉽게 @OneToMany와 @ManyToOne 어노테이션을 사용하여 간단하게 가져올 수 있었습니다.

하지만 Mybatis는 이러한 1:N관계를 join sql으로 가져오기 위해서는 resultMap과 collection을 사용해야 했습니다.
즉, 객체 안에 객체를 매핑해야 했습니다.

따라서 이번 포스팅에서는

1. 기본생성자 (@NoArgsArgument)를 사용하여 매핑할 경우 왜 특정 Column은 null로 매핑되는가
2. 어떻게 하면 기본생성자를 통해 매핑할 때 정상적으로 매핑할 수 있는가

에 대해 알아보겠습니다.

🗂️ 1. 기본생성자 @NoArgsArgument를 사용하여 매핑할 경우, 왜 특정 Column은 null로 매핑이 제대로 이루어지지 않을까?

다음과 같이, 기본생성자를 갖고있는 객체를 통해 매핑을 하려 했지만, 특정 컬럼은 null로 제대로 매핑이 이루어지지 않았습니다.
분석을 해보니, 일반 변수는 매핑이 잘 되고있었지만, Collection 안의 특정 컬럼에만 null로 매핑되고 있었습니다.
(다른 1:N이 아닌 일반적인 조회(단일 객체 매핑)도 기본생성자로 매핑을 테스트해본 결과, 또 특정 컬럼이 null로 매핑이 정상적으로 이루어지지 않았습니다.)

매핑 객체 ProductLineWithProductsResponse

@Builder
@Getter
@Setter
@AllArgsConstructor
@NoArgsConstructor
public class ProductLineWithProductsResponse {
    private Long productLineId;
    private Long memberId;
    private Long categoryId;
    private String name;
    private String content;
    private int price;
    private Long totalStock;
    private ProductLineStatus status;
    private Long saleCount;
    private LocalDateTime createdAt;
    private LocalDateTime modifiedAt;
    private LocalDateTime deletedAt;
    private String brandName;
    private String biz_no;
    private List<Product> productList;
}

Mybatis Mapper.xml 코드

<mapper namespace="org.store.clothstar.productLine.repository.ProductLineRepository">
    <resultMap id="productWithOptions" type="org.store.clothstar.productLine.dto.response.ProductLineWithProductsResponse">
        <id property="productLineId" column="product_line_id"/>
        <result property="memberId" column="member_id"/>
        <result property="categoryId" column="category_id"/>
        <result property="name" column="name"/>
        <result property="content" column="content"/>
        <result property="price" column="price"/>
        <result property="totalStock" column="total_stock"/>
        <result property="status" column="status"/>
        <result property="saleCount" column="sale_count"/>
        <result property="createdAt" column="created_at"/>
        <result property="modifiedAt" column="modified_at"/>
        <result property="deletedAt" column="deleted_at"/>
        <result property="brandName" column="brand_name"/>
        <result property="biz_no" column="biz_no"/>
        <collection property="productList" column="productLineId = product_line_id" javaType="List" ofType="org.store.clothstar.product.domain.Product" select="getProductsByProductLineId"/>
    </resultMap>
    
    <select id="selectProductLineWithOptions" resultMap="productWithOptions">
        SELECT
            pl.*,
            s.brand_name,
            s.biz_no
        FROM product_line pl
        INNER JOIN seller s ON pl.member_id = s.member_id
        WHERE pl.product_line_id = #{productLineId}
    </select>
    <select id="getProductsByProductLineId" parameterType="org.store.clothstar.productLine.dto.response.ProductLineWithProductsResponse" resultType="org.store.clothstar.product.domain.Product">
        SELECT *
        FROM product
        WHERE product_line_id = #{productLineId}
    </select>
</mapper>

위와 같이 작성한 객체와 mapper.xml 을 통해 조회 결과를 매핑하면, 아래와 같이 1:N에서 N인 Collection에만 특정 컬럼에 null이 발생했습니다.

🦕원인

원인은, 기본생성자를 통해 매핑할 경우, 변수 네이밍과 column 이름이 같으면 자동으로 매핑해주지만, camelCase까지는 인식이 안됩니다. (대소문자는 구별하지 않습니다.)
즉 DB의 column명과 정확히 일치해야 인식합니다.

따라서 위와 같이 camelCase 설정 없이, @NoArgsConstructor 생성자가 있는 객체와 resultMap, Collection을 통해 매핑했을 때 Collection에만 camelCase에 null로 매핑됐던 이유는,

1. collection (List타입 변수) 제외 일반 변수에는 직접 column을 명시했다.
2. collection 타입 안의 변수들에는 column을 직접 명시해주지 않았다 따라서 camelCase로 된 변수들은 매핑이 자동적으로 안된다 .

두가지 이유 때문입니다.

🧩 collection에도 각 행마다 result행 (property + column)를 명시해준다면
camelCase 설정 없이, @NoArgsConstructor 생성자만 있어도 정상적으로 매핑이 가능합니다.

🗂️ 2. 기본생성자로 정상적으로 매핑하는 방법

그렇다면 어떻게 기본생성자로 정상적으로 매핑할 수 있을까요?

방법은 세가지가 존재합니다.

1. mapper.xml에 직접 select문에 alias를 적어준다.
2. 매핑 객체의 변수명과 column 명을 camelCase까지 완전히 일치시킨다.
3. Mybatis 설정에 데이터베이스의 컬럼명언더스코어(_) -> 카멜케이스 자동 변환 기능 설정

자바에서 통상적으로 사용하는 명명 규칙은 카멜케이스 이기 때문에, 2번을 적용하기는 어렵다고 판단했습니다.

따라서 1번과 3번중에 택해야 했는데, 직접 select문에 alias를 다 적기에는 생산성이 떨어진다고 생각했습니다.

따라서 자바의 통상적인 명명 규칙인 카멜 케이스를 사용하면서도, 자동으로 매핑할 수 있도록 3번 방법을 선택하여 Mybatis에 camelCase를 설정해주기로 했습니다.

🦕 Mybatis에 camelCase 자동 변환 설정

해당 기능은 데이터베이스의 언더스코어(_)로 구분된 컬럼명을 자바의 카멜 표기법(camelCase)에 맞게 자동 변환해주는 기능입니다.

3번 방법을 택했을때의 장점은

1. 데이터베이스(언더바_)와 자바 언어(camelCase) 간에 사용되는 변수명을 일관성 있게 유지할 수 있다.
2. 개발자가 직접 매핑 column을 명시할 필요가 없어져서 개발 생산성을 향상시킬 수 있다

는 점입니다.

해당 방법은 다음 포스팅에서 따로 다루도록 하겠습니다.

[MyBatis - 🛠️TroubleShooting] Mybatis에 camelCase 변환 적용하기

🗂️ 정리

1. MyBatis에서 기본 생성자를 사용하여 매핑하는 경우, 컬럼의 순서를 일치시킬 필요는 없다. 변수명과 컬럼명이 완전히 일치하면 자동으로 매핑을 수행한다.

2. 생성자 매핑에서 파라미터는 camelCase까지 자동으로 인식하지 못한다.

3. 따라서 변수명과 컬럼명이 완전히 일치하지 않는 경우, 다음 두 가지 방법 중 하나를 따라야 한다.

• mapper.xml에 직접 select문에 alias를 적어준다.
• Mybatis 설정을 통해 camelCase도 자동으로 인식할 수 있도록 설정한다.

다음 포스팅에서는

1. [MyBatis - 🛠️TroubleShooting] Mybatis에 camelCase 변환 적용하기

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

에 대해 각각 다른 포스팅에서 다뤄보도록 하겠습니다.

참고

• https://mybatis.org/mybatis-3/ko/sqlmap-xml.html
• https://m.blog.naver.com/fbfbf1/223185640519
• https://heejjeoyi.tistory.com/174
• https://blog.seongseob.dev/114