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

[YONGHYNG]

MyBatis

• JdbcTemplate 보다 많은 기능을 제공하는 SQL Mapper
• SQL을 XML에 편리하게 작성할 수 있고, 동적 쿼리를 편리하게 작성 가능

JdbcTemplate

String sql = "update item " +
                 "set item_name=:itemName, price=:price, quantity=:quantity " +
                 "where id=:id";

MyBatis

<update id="update">
           update item
           set item_name=#{itemName},
                 price=#{price},
                 quantity=#{quantity}
           where id = #{id}
</update>

Jdbc Template 동적 쿼리

// 아이템 데이터를 조회하기 위한 동적 SQL 쿼리 생성
String sql = "SELECT id, item_name, price, quantity FROM item";

// 조건이 있을 경우 WHERE 절을 추가
if (StringUtils.hasText(itemName) || maxPrice != null) {
    sql += " WHERE";
}

boolean andFlag = false; // AND 조건 사용 여부를 나타내는 플래그

// itemName 조건 추가
if (StringUtils.hasText(itemName)) {
    sql += " item_name LIKE CONCAT('%', :itemName, '%')";
    andFlag = true;
}

// maxPrice 조건 추가
if (maxPrice != null) {
    if (andFlag) {
        sql += " AND";
    }
    sql += " price <= :maxPrice";
}

// 최종 SQL 쿼리를 로그로 확인
log.info("Generated SQL: {}", sql);

// 생성된 SQL을 실행하여 결과 반환
return template.query(sql, param, itemRowMapper());

MyBatis 동적 쿼리

<!-- 모든 아이템을 조건에 따라 검색하는 Mapper -->
<select id="findAll" resultType="Item">
    SELECT id, item_name, price, quantity
    FROM item
    <where>
        <!-- itemName이 null이 아니고 비어있지 않은 경우 -->
        <if test="itemName != null and itemName != ''">
            AND item_name LIKE CONCAT('%', #{itemName}, '%')
        </if>
        <!-- maxPrice가 null이 아닌 경우 -->
        <if test="maxPrice != null">
            AND price &lt;= #{maxPrice}
        </if>
    </where>
</select>

• 동적 쿼리와 복잡한 쿼리가 많다면 MyBatis 사용, 단순 쿼리 많으면 JdbcTemplate 선택

MyBatis를 스프링에 사용하기 위한 설정

• mybatis.type-aliases-package : 마이바티스에서 타입 정보를 사용할 때, 패키지 이름을 적어주어야 함, 여기에 명시함
  패키지 이름 생략 가능, 여러 위치 지정하려면 ',' . ';' 구분하면 됨
• mybatis.configuration.map-underscore-to-camel-case : JdbcTemplate의 BeanPropertyRowMapper에서 처럼 언더바를 카멜로 자동
  변경해주는 기능을 활성화

ItemMapper

package hello.itemservice.repository.mybatis;

import hello.itemservice.domain.Item;
import hello.itemservice.repository.ItemSearchCond;
import hello.itemservice.repository.ItemUpdateDto;
import org.apache.ibatis.annotations.Mapper;
import org.apache.ibatis.annotations.Param;
import org.apache.ibatis.annotations.Select;

import java.util.List;
import java.util.Optional;

@Mapper //MyBatis 매퍼 인터페이스
public interface ItemMapper {
    
    // 새로운 아이템 저장
    void save(Item item);

    //특정 아이템 정보 업데이트
    void update(@Param("id") Long id, @Param("updateParam") ItemUpdateDto updateParam);
     
    //특정 아이템 ID로 조회     
    Optional<Item> findById(Long id);
    
    //검색 조건에 따라 모든 아이템 조회
    List<Item> findAll(ItemSearchCond itemSearch);
}

• MyBatis 매핑 XML을 호출해주는 매퍼 인터페이스
• 이 interface에 @Mapper 애노테이션 붙여야 함, 그래야 MyBatis 인식
• 이 인터페이스의 메서드 호출하면 다음에 보이는 xml의 해당 sql 실행 및 결과 돌려줌

ItemMapper.xml

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
    "http://mybatis.org/dtd/mybatis-3-mapper.dtd">

<!-- ItemMapper의 MyBatis 매퍼 설정 -->
<mapper namespace="hello.itemservice.repository.mybatis.ItemMapper">

    <!-- 아이템 저장 -->
    1. Insert SQL은 <insert>를 사용하면 됨
    2. id에는 매퍼 인터페이스 설정한 메서드 이름 지정, 여기서 메서드 이름 save 지정
    3. 파라미터 #{} 문법 사용, 매퍼에서 넘긴 객체의 프로퍼티 이름 적음
    4. useGenerateKeys는 디비에 키를 생성해 주는 IDENTITY 전략 사용, keyProperty 생성 키 속성 이름 지정,
        insert 끝나면 item 객체의 id 속성에 생성된 값 입력
    <insert id="save" useGeneratedKeys="true" keyProperty="id">
        INSERT INTO item (item_name, price, quantity)
        VALUES (#{itemName}, #{price}, #{quantity})
    </insert>

    <!-- 아이템 업데이트 -->
    1. Update SQL은 <update>를 사용하면 됨
    2. 여기서 파라미터가 Long id, ItemUpdateDto updateParam 2개, 파라미터가 1개만 있으면 @Param 지정하지 않아도 됨,
        파라미터가 2개 이상이면 @Param으로 이름을 지정, 파라미터 구분
    <update id="update">
        UPDATE item
        SET 
            item_name = #{updateParam.itemName},
            price = #{updateParam.price},
            quantity = #{updateParam.quantity}
        WHERE id = #{id}
    </update>

    <!-- 아이템 ID로 조회 -->
    1. Select SQL은 <select> 사용하면 됨
    2. resultType은 반환 타입 명시, 결과 Item 객체에 매핑
    3. 자바 코드에서 반환 객체 하나면 Item, Optional<Item>과 같이 사용, 반환 객체가 하나 이상임면 컬렉션 사용 주로 List 사용
    <select id="findById" resultType="Item">
        SELECT id, item_name, price, quantity
        FROM item
        WHERE id = #{id}
    </select>

    <!-- 조건에 따라 모든 아이템 조회 -->
     1. Mybatis는 <where>, <if> 같은 동적 쿼리 문법을 통해 편리한 동적 쿼리 지원
     2. <if>는 해당 조건이 만족하면 구문 추가 
    <select id="findAll" resultType="Item">
        SELECT id, item_name, price, quantity
        FROM item
        <where>
            <!-- itemName 조건 -->
            <if test="itemName != null and itemName != ''">
                AND item_name LIKE CONCAT('%', #{itemName}, '%')
            </if>
            <!-- maxPrice 조건 -->
            <if test="maxPrice != null">
                AND price &lt;= #{maxPrice}
            </if>
        </where>
    </select>
</mapper>

• namespace : 앞서 만든 매퍼 인터페이스 지정하면 됨

XML 특수문자

• < : <
• < : <
• & : &

MyBatis 적용2 - 설정과 실행

MyBatisItemRepository

package hello.itemservice.repository.mybatis;

import hello.itemservice.domain.Item;
import hello.itemservice.repository.ItemRepository;
import hello.itemservice.repository.ItemSearchCond;
import hello.itemservice.repository.ItemUpdateDto;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Repository;

import java.util.List;
import java.util.Optional;

@Repository //Spring 데이터 접근 계층 DAO로 사용 됨
@RequiredArgsConstructor //Lombok이 생성자 자동 생성
public class MyBatisItemRepository implements ItemRepository {

    private final ItemMapper itemMapper; //쿼리 연결 디비 작업 수행

    @Override
    public Item save(Item item) {
        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);
    }
}

package hello.itemservice.config;

import hello.itemservice.repository.ItemRepository;
import hello.itemservice.repository.jdbctemplate.JdbcTemplateItemRepositoryV3;
import hello.itemservice.repository.mybatis.ItemMapper;
import hello.itemservice.repository.mybatis.MyBatisItemRepository;
import hello.itemservice.service.ItemService;
import hello.itemservice.service.ItemServiceV1;
import lombok.RequiredArgsConstructor;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
@RequiredArgsConstructor
public class MyBatisConfig {

    private final ItemMapper itemMapper;

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

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

@import 변경 후 실행

ItemMapper에 매퍼 인터페이스 구현체 없어도 동작하는 방법

@Mapper
public interface ItemMapper{

      void save(Item item);

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

      List<Item> findAll(ItemSearchCond itemSearch);

      Optional<Item> findById(Long id);
}

• 애플리케이션 로딩 시점에 MyBatis 스프링 연동 모듈은 @Mapper가 붙어 있는 인터페이스로 조사
• 해당 인터페이스가 발견되면 동적 프록시 기술 사용 ItemMapper 인터페이스 구현체 만듬
• 생성된 구현체 스프링 빈 등록

실행 결과

• 출력해 보면 JDK 동적 프록시가 적용 된 것을 확인

매퍼 구현체

• 마이바티스 스프링 연동 모듈이 만들어 주는 ItemMapper의 구현체 덕분에 인터페이스 만으로 편리하게 XML 데이터 찾아서 호출
• 원래 마이바티스 사용하려면 번잡한 코드 거쳐야 함, 이런 부분을 인터페이스 하나로 매우 깔끔, 편리 사용
• 매퍼 구현체는 예외 변환까지 처리, MyBatis에서 발생한 예외를 스프링 예외 추상화인 DataAccessException에 맞게 변환해서 반환

MyBatis 기능 - 동적 쿼리

• select id="findActiveBlogLike" resultType="Blog" : MyBatis에서 실행할 SQL SELECT 쿼리 정의, id = "findActiveBlogLike" 매퍼 인터페이스 호출할 메서드, resultType = "Blog" 조회 결과를 매핑할 객체 타입
• choose : 조건 분기 처리 MyBatis 태그, switch 문과 유사하게 작동, 하나의 조건만 실행, 여러 조건 중 하나를 선택적으로 실행
• when : 조건에 따라 실행
• otherwise : 의 모든 when 조건이 fasle일 경우 실행

• id="findActiveBlogLike" 인터페이스 호출 메서드 이름, resultType="Blog" 쿼리 결과를 매핑할 객체 타입 지정
• resultType="Blog" 쿼리 결과를 매핑할 객체 타입 지정
• 내부에 조건이 있으면 자동으로 WHERE 키워드 추가, 첫 번째 조건 앞의 AND 제거
• if : 조건부 SQL 쿼리문 추가, test 속성에 조건식 작성, true 경우에만 SQL 문 포함 됨

trim

• SQL 구문에서 불필요한 접두사나 접미사(AND, OR) 자동으로 처리하여 오류 없는 쿼리 생성

• 컬렉션을 반복 처리할 때 사용, where in (1, 2,3,4,5,6) 같은 문장 완성
• 파라미터 List로 전달

MyBatis 기능 - 기타 기능

• @insert, @update, @delete, @select 기능 제공
• 이 경우 XML에서 ~ 제거 필요

문자열 대체

• #{} 문법은 ? 넣고 파라미터를 바인딩하는 PreparedStatement 사용, 파라미터 바인딩 문자 그대로 처리하고 싶음 ${} 사용

재사용 가능한 SQL 조각

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

Result Maps

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

• 별칭을 사용하지 않고도 문제 해결 가능, 다음과 같이 resultMap 선언해서 사용

• 복잡한 결과매핑 MyBatis 매우 복잡한 결과에 객체 연관관계를 고려 데이터 조회 가능
• , 등 사용

[YuDeokRin]

빠르시군요 ... 이번주 나오시나요 ?

[YONGHYNG]

네넵~ 이번주 나갑니다요~ 2024년 12월 9일 (월) 오후 10:07, Dante ***@***.***>님이 작성:

…

빠르시군요 ... 이번주 나오시나요 ? — Reply to this email directly, view it on GitHub <#554 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AZVBIAOSLXSYTRZBLJRKE2L2EWIX7AVCNFSM6AAAAABTIIAPQCVHI2DSMVQWIX3LMV43URDJONRXK43TNFXW4Q3PNVWWK3TUHMYTCNJQHAYTENQ> . You are receiving this because you authored the thread.Message ID: ***@***.*** com>