[스프링 DB 2편] #4. 데이터 접근 기술 - MyBatis (2)

[YuDeokRin]

4️⃣ MyBatis 적용2 - 설정과 실행

• MyBatisItemRepository

@Repository
@RequiredArgsConstructor
@Slf4j
public class MyBatisItemRepository implements ItemRepository {

    private final ItemMapper itemMapper; // 

    @Override
    public Item save(Item item) {
        log.info("itemMapper class={}", itemMapper.getClass());
        itemMapper.save(item);

        return item;
    }

    @Override
    public void update(Long itemId, ItemUpdateDto updateParam) {
        itemMapper.update(itemId, updateParam);
    }

    @Override
    public Optional<Item> findById(Long id) {
        return itemMapper.findById(id);
    }

    @Override
    public List<Item> findAll(ItemSearchCond cond) {
        return itemMapper.findAll(cond);
    }
}

• ItemRepository 를 구현해서 MyBatisItemRepository 를 만들자.

• MyBatisItemRepository는 단순히 ItemMapper 에 기능을 위임한다.

• MyBatisConfig

@Configuration
@RequiredArgsConstructor
@MapperScan("hello.itemservice.repository.mybatis")
public class MyBatisConfig {

    private final ItemMapper itemMapper; //MyBatisConfig는 ItemMapper를 주입받는다. 

    @Bean
    public ItemService itemService() {
        return new ItemServiceV1(itemRepository());
    }

    @Bean
    public ItemRepository itemRepository() {
        return new MyBatisItemRepository(itemMapper);
    }

}

• MyBatisConfig 는 ItemMapper 를 주입받고, 필요한 의존관계를 만든다.

package hello.itemservice;

import hello.itemservice.config.*;
import hello.itemservice.repository.ItemRepository;
import lombok.extern.slf4j.Slf4j;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Import;
import org.springframework.context.annotation.Profile;

@Slf4j
//@Import(MemoryConfig.class)
//@Import(JdbcTemplateV1Config.class)
//@Import(JdbcTemplateV2Config.class)
//@Import(JdbcTemplateV3Config.class)
@Import(MyBatisConfig.class)
@SpringBootApplication(scanBasePackages = "hello.itemservice.web")
public class ItemServiceApplication {

	public static void main(String[] args) {
		SpringApplication.run(ItemServiceApplication.class, args);
	}
}

• 코드 추가 및 변경

  • @import(MyBatisConfig.class) → MyBatisConfig.class를 사용하도록 설정

• 테스트 실행해 보기

  • ItemRepositoryTest 시작 → 모두 성공해야함.

• 애플리케이션 실행

  • ItemServiceApplication → 실행 (단, H2 데이터베이스 서버 먼저 실행)

5️⃣ MyBatis 적용 3 - 분석

• ItemMapper 매퍼 인터페이스의 구현체가 없는데 어떻게 동작하는 것일까?

• ItemMapper 인터페이스

@Mapper
public interface ItemMapper {

    void save(Item item);

    void update(@Param("id") Long id, @Param("updateParam") ItemUpdateDto updateParam);

    Optional<Item> findById(Long id);

    List<Item> findAll(ItemSearchCond itemSearch);

}

• MyBatis 스프링 연동 모듈에서 자동으로 처리해주는데 다음과 같다.

1. 애플케이션 로딩 시점에 MyBatis 스프링 연동 모듈은 @Mapper가 붙어있는 인터페이스를 조사한다.
2. 해당 인터페이스가 발견되면 동적 프록시 기술을 사용해서 ItemMapper 인터페이스의 구현체를 만든다.
3. 생성된 구현체를 스프링 빈으로 등록한다.

• MyBatisItemRepository - 로그 추가

@Repository
@RequiredArgsConstructor
@Slf4j
public class MyBatisItemRepository implements ItemRepository {

    private final ItemMapper itemMapper;

    @Override
    public Item save(Item item) {
        log.info("itemMapper class={}", itemMapper.getClass());
        itemMapper.save(item);

        return item;
    }
    
    ...
}

• 결과

itemMapper class=class jdk.proxy2.$Proxy57

✅ 매퍼 구현체

• 마이바티스 스프링 연동 모듈이 만들어주는 ItemMapper 구현체 덕분에 인터페이스 만으로 편리하게 XML의 데이터를 찾아서 호출할 수 있다.
• 매퍼 구현체 덕분에 번잡한 코드를 거치는 과정을 생략할 수 있다.
• 매퍼 구현체는 예외 변환까지 처리해준다. MyBatis에서 발생한 예외를 스프링 예외 추상화인
  DataAccessException 에 맞게 변환해서 반환해준다.

▶️참고
마이바티스 스프링 연동 모듈이 자동으로 등록해주는 부분은 MybatisAutoConfiguration 클래스를 참고하자.

6️⃣ MyBatis 기능 정리1 - 동적 쿼리

✅ 동적 SQL

• if

• choose (when, otherwise)

• trim(where, set)

• foreach

• if

<select id="findActiveBlogWithTitleLike"
      resultType="Blog">
   SELECT * FROM BLOG
   WHERE state = ‘ACTIVE’
   <if test="title != null">
     AND title like #{title}
   </if>
</select>

• 내부의 문법은 OGNL을 사용한다. 자세한 내용은 OGNL을 검색해보자.

• choose, when, otherwise

<select id="findActiveBlogLike"
      resultType="Blog">
   SELECT * FROM BLOG WHERE state = ‘ACTIVE’
   <choose>
     <when test="title != null">
       AND title like #{title}
     </when>
     <when test="author != null and author.name != null">
       AND author_name like #{author.name}
     </when>
     <otherwise>
       AND featured = 1
     </otherwise>
   </choose>
</select>

• trim, where, set

 <select id="findActiveBlogLike"
      resultType="Blog">
   SELECT * FROM BLOG
   WHERE
   <if test="state != null">
     state = #{state}
   </if>
   <if test="title != null">
     AND title like #{title}
   </if>
   <if test="author != null and author.name != null">
     AND author_name like #{author.name}
   </if>
</select>

→ 위 예제에서 주의해야할 점

• 잘못된 예) where 뒤에 없을 때

SELECT * FROM BLOG
WHERE

• 잘못된 예) and가 먼저나와서 잘못되었을 때

SELECT * FROM BLOG
 WHERE
AND title like ‘someTitle’

• 사용
  • 를 사용하면 where 문장에 조건을 만족하지 않으면 실행되지 않는다.
  • 를 사용하면 and가 먼저 시작하는 조건이면 and를 삭제하고 실행된다.

<select id="findActiveBlogLike"
      resultType="Blog">
   SELECT * FROM BLOG
   <where>
     <if test="state != null">
          state = #{state}
     </if>
     <if test="title != null">
         AND title like #{title}
     </if>
     <if test="author != null and author.name != null">
         AND author_name like #{author.name}
     </if>
   </where>
</select>

• - 컬랙션을 반복 처리할 때 사용 - 예) where in (1,2,3,4,5)와 같은 문장을 처리할 때 - 파라미터 List를 전달하면 된다.

<select id="selectPostIn" resultType="domain.blog.Post">
   SELECT *
   FROM POST P
   <where>
     <foreach item="item" index="index" collection="list"
         open="ID in (" separator="," close=")" nullable="true">
           #{item}
     </foreach>
</where>
</select> 

7️⃣ MyBatis 기능 정리2 - 기타 기능

다음과 같이 XML 대신에 애노테이션에 SQL을 작성할 수 있다.

@Select("select id, item_name, price, quantity from item where id=#{id}")
Optional<Item> findById(Long id);

• @select 말고도 @update, @delete, @insert가 있다.
• 이 경우 XML에는 <select id="findById"> ~ </select> 는 제거해야 한다.
• 동적 SQL이 해결되지 않으므로 간단한 경우에만 사용한다.
• 잘 쓰지 않는 기능이다.

✅ 문자열 대체(String Substitution)

• #{} 문법은 ?를 넣고 파라미터를 바인딩하는 PreparedStatment를 사용한다.
• 때로는 파라미터 바인딩이 아니라 문자 그대로를 처리하고 싶은 경우도 있다. 이때는 ${} 를 사용하면 된다.

${} 를 사용하면 SQL 인젝션 공격을 당할 수 있다. 따라서 가급적 사용하면 안된다. 사용하더라도 매우 주의깊게 사용해야 한다.

✅ 재사용 가능한 SQL 조각

• 을 사용하면 SQL 코드를 재사용할 수 있음

<sql id="userColumns"> ${alias}.id,${alias}.username,${alias}.password </sql>

• 를 통해서 조각을 찾아서 사용할 수 있다.

<select id="selectUsers" resultType="map">
   select
     <include refid="userColumns"><property name="alias" value="t1"/></include>,
     <include refid="userColumns"><property name="alias" value="t2"/></include>
   from some_table t1
     cross join some_table t2
 </select>

<sql id="sometable">
   ${prefix}Table
</sql>
 <sql id="someinclude">
   from
     <include refid="${include_target}"/>
 </sql>
 <select id="select" resultType="map">
   select
     field1, field2, field3
   <include refid="someinclude">
     <property name="prefix" value="Some"/>
     <property name="include_target" value="sometable"/>
   </include>
</select>

• 프로퍼티 값을 전달할 수 있고, 해당 값은 내부에서 사용할 수 있다.

✅ Result Maps

• 결과를 매핑할 때 테이블은 user_id 이지만 객체는 id 이다.
• 이 경우 컬럼명과 객체의 프로퍼티 명이 다르다. 그러면 다음과 같이 별칭( as )을 사용하면 된다.

<select id="selectUsers" resultType="User">
  select
    user_id
    user_name
    hashed_password
  from some_table
  where id = #{id}
</select>

• 별칭을 사용하지 않고도 문제 해결할 수있는데, 그것이 ResultMap이다.

 <resultMap id="userResultMap" type="User">
   <id property="id" column="user_id" />
   <result property="username" column="user_name"/>
   <result property="password" column="hashed_password"/>
 </resultMap>
 <select id="selectUsers" resultMap="userResultMap">
   select user_id, user_name, hashed_password
   from some_table
   where id = #{id}
</select>

✅ 복잡한 결과 매핑

• MyBatis도 매우 복잡한 결과에 객체 연관관계를 데이터를 조회하는 것이 가능하다.
• 이 때 사용하는 것은 , 등을 사용한다.
• 사용할때 성능 최적화하기도 어려울 뿐더러 공수도 많이 잡혀 해당 기능을 사용할 때는 신중하게 선택해야한다.