spring/스프링 DB 2편

3. 데이터 접근 기술 - MyBatis

sh1mj1 2023. 2. 21. 01:37
이 글은 배민 기술이사 김영한 이사님의 인프런 강의 "스프링 DB 2편 - 데이터 접근 활용 기술" 을 기반으로 작성되었습니다. 문제 시 삭제 조치하겠습니다.

 

아래와 같은 순서로 공부를 진행합니다.

 

 

  • MyBatis 소개
  • MyBatis 설정
  • MyBatis 적용1 - 기본
  • MyBatis 적용2 - 설정과 실행
  • MyBatis 적용3 - 분석
  • MyBatis 기능 정리1 -동적 쿼리
  • MyBatis 기능 정리2 - 기타 기능

 

1. MyBatis 소개

MyBatis 는 앞서 설명한 JdbcTemplate보다 더 많은 기능을 제공하는 SQL Mapper 입니다.

기본적으로 JdbcTemplate 이 제공하는 대부분의 기능을 제공합니다.

 

JdbcTemplate 과 비교해서 MyBatis 의 가장 매력적인 점은 SQL을 XML에 편리하게 작성할 수 있고 또 동적 쿼리를 매우 편리하게 작성할 수 있다는 점입니다.

 

아래에서 비교해봅시다.

 

JdbcTemplate - SQL 여러줄

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

MyBatis - SQL 여러줄

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

MyBatis 는 XML 에 작성하기 때문에 라인이 길어져도 문자 더하기에 대한 불편함이 없습니다.

 

JdbcTemplate - 동적 쿼리

String sql = "select id, item_name, price, quantity from item";
//동적 쿼리
if (StringUtils.hasText(itemName) || maxPrice != null) {
    sql += " where";
}

boolean andFlag = false;
if (StringUtils.hasText(itemName)) {
    sql += " item_name like concat('%',:itemName,'%')";
    andFlag = true;
}

if (maxPrice != null) {
    if (andFlag) {
        sql += " and";
    }
    sql += " price <= :maxPrice";
}

log.info("sql={}", sql);
return template.query(sql, param, itemRowMapper());

MyBatis - 동적 쿼리

<select id="findAll" resultType="Item">
    select id, item_name, price, quantity
    from item
    <where>
        <if test="itemName != null and itemName != ''">
            and item_name like concat('%',#{itemName},'%')
        </if>
        <if test="maxPrice != null">
            and price &lt;= #{maxPrice}
        </if>
    </where>
</select>

JdbcTemplate 은 자바 코드로 직접 동적 쿼리를 작성해야 하는 반면에 MyBatis 는 동적 쿼리를 매우 편리하게 작성할 수 있는 다양한 기능들을 제공합니다.

 

설정의 장단점

JdbcTemplate 은 스프링에 내장된 기능이고, 별도의 설정없이 사용할 수 있는 반면에 MyBatis 는 약간의 설정이 필요합니다.

 

정리

프로젝트에서 동적 쿼리와 복잡한 쿼리가 많다면 MyBatis 를 사용하고, 단순한 쿼리들이 많으면 JdbcTemplate 을 선택해서 사용하면 됩니다.

물론 둘을 함께 사용해도 되지만 MyBatis 를 선택했다면 굳이 JdbcTemplate 을 함께 사용할 필요 없이 MyBatis 만으로 충분합니다.

 

참고 - 강의에서는 MyBatis의 기능을 하나하나를 자세하게 다루지는 않습니다. MyBatis 를 왜 사용하는지, 그리고 주로 사용하는 기능 위주로 다룰 것입니다.
MyBatis는 기능도 단순하고 또 공식 사이트가 한글로 잘 번역되어 있어서 원하는 기능을 편리하게 찾아볼 수 있습니다.

공식 사이트 https://mybatis.org/mybatis-3/ko/index.html

 

2. MyBatis 설정

mybatis-spring-boot-starter 라이브러리를 사용하면 MyBatis 를 스프링과 통합하고, 설정도 아주 간단히 할 수 있습니다.

 

build.gradle에 다음 의존 관계를 추가합시다.

//MyBatis 추가
implementation 'org.mybatis.spring.boot:mybatis-spring-boot-starter:2.2.0'

 

참고로 뒤에 버전 정보가 붙는 이유는 스프링 부트가 버전을 관리해주는 공식 라이브러리가 아니기 때문입니다.

 

만약 스프링 부트가 버전을 관리해주는 경우에는 버전 정보를 붙이지 않아도 최적의 버전을 자동으로 찾아줍니다.

 

build.gradle - 의존관계 전체

dependencies {
    implementation 'org.springframework.boot:spring-boot-starter-thymeleaf'
    implementation 'org.springframework.boot:spring-boot-starter-web'

    //JdbcTemplate 추가
    implementation 'org.springframework.boot:spring-boot-starter-jdbc'
    //MyBatis 추가
    implementation 'org.mybatis.spring.boot:mybatis-spring-boot-starter:2.2.0'

    //H2 데이터베이스 추가
    runtimeOnly 'com.h2database:h2'
    compileOnly 'org.projectlombok:lombok'
    annotationProcessor 'org.projectlombok:lombok'
    testImplementation 'org.springframework.boot:spring-boot-starter-test'

    //테스트에서 lombok 사용
    testCompileOnly 'org.projectlombok:lombok'
    testAnnotationProcessor 'org.projectlombok:lombok'
}

다음과 같은 라이브러리가 추가될 수 있습니다.

  • mybatis-spring-boot-starter: MyBatis 를 스프링 부트에서 편리하게 사용할 수 있게 시작하는 라이브러리입니다.
  • mybatis-spring-boot-autoconfigure: MyBatis 와 스프링 부트 설정 라이브러리입니다.
  • mybatis-spring: MyBatis와 스프링을 연동하는 라이브러리
  • mybatis: MyBatis 라이브러리

 

설정

application.properties에 다음 설정을 추가합시다. #MyBatis를 참고

주의 - 웹 애플리케이션을 실행하는 main 과 테스트를 실행하는 test 각각의 위치의 application.properties를 모두 수정해주어야 합니다.

 

main - application.properties

spring.profiles.active=local
spring.datasource.url=jdbc:h2:tcp://localhost/~/test
spring.datasource.username=sa

logging.level.org.springframework.jdbc=debug

#MyBatis
mybatis.type-aliases-package=hello.itemservice.domain
mybatis.configuration.map-underscore-to-camel-case=true
logging.level.hello.itemservice.repository.mybatis=trace

 

test - application.properties

spring.profiles.active=test
#spring.datasource.url=jdbc:h2:tcp://localhost/~/testcase
#spring.datasource.username=sa

logging.level.org.springframework.jdbc=debug

#MyBatis
mybatis.type-aliases-package=hello.itemservice.domain
mybatis.configuration.map-underscore-to-camel-case=true
logging.level.hello.itemservice.repository.mybatis=trace

 

mybatis.type-aliases-package

  • MyBatis 에서 타입 정보를 사용할 때는 패키지 이름을 적어주어야 하는데, 여기에 명시하면 패키지 이름을 생략할 수 있습니다.
  • 지정한 패키지와 그 하위 패키지가 자동으로 인식됩니다.
  • 여러 위치를 지정하려면 ,, ;로 구분하면 됩니다.

 

mybatis.configuration.map-underscore-to-camel-case

  • JdbcTemplate 의 BeanPropertyRowMapper에서 처럼 언더바를 카멜로 자동 변경해주는 기능을 활성화시키는 설정입니다. 바로 다음에 설명하는 관례의 불일치 내용에서 자세히 설명합니다.

 

logging.level.hello.itemservice.repository.mybatis=trace

  • MyBatis 에서 실행되는 쿼리 로그를 확인할 수 있습니다.

 

관례의 불일치

자바 객체에는 주로 카멜(camelCase) 표기법을 사용합니다.

반면에 관계형 데이터베이스에서는 주로 언더스코어를 사용하는 snake_case표기법을 사용합니다.

 

이렇게 관례로 많이 사용하다 보니 map-underscore-to-camel-case 기능을 활성화 하면 언더스코어 표기법을 카멜로 자동 변환합니다. 따라서 DB에서 select item_name으로 조회해도 객체의 itemName( setItemName()) 속성에 값이 정상 입력됩니다.

 

정리하면 해당 옵션을 켜면 snake_case는 자동으로 해결되니 그냥 두면 되고, 컬럼 이름과 객체 이름이 완전히 다른 경우에는 조회 SQL에서 별칭을 사용하면 됩니다.

 

예)

  • DB select item_name
  • 객체 name
  • 별칭을 통한 해결방안: select item_name as name

 

3. MyBatis 적용1 - 기본

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);
}

마이바티스 매핑 XML을 호출해주는 매퍼 인터페이스입니다.

이 인터페이스에는 @Mapper 애노테이션을 붙여주어야 MyBatis 에서 인식할 수 있습니다.

이 인터페이스의 메서드를 호출하면 다음에 보이는 xml 의 해당 SQL을 실행하고 결과를 반환합니다.

 

 

이제 같은 위치에 실행할 SQL 이 있는 XML 매핑 파일을 생성합니다.

참고로 자바 코드가 아니기 때문에 src/main/resources 하위에 만들되, 패키지 위치는 맞추어 주어야 합니다.

 

src/main/resources/hello/itemservice/repository/mybatis/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">
<mapper namespace="hello.itemservice.repository.mybatis.ItemMapper">
    <insert id="save" useGeneratedKeys="true" keyProperty="id">
        insert into item (item_name, price, quantity)
        values (#{itemName}, #{price}, #{quantity})
    </insert>

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

    <select id="findById" resultType="Item">
        select id, item_name, price, quantity
        from item
        where id = #{id}
    </select>

    <select id="findAll" resultType="Item">
        select id, item_name, price, quantity
        from item
        <where>
            <if test="itemName != null and itemName != ''">
                and item_name like concat('%',#{itemName},'%')
            </if>
            <if test="maxPrice != null">
                and price &lt;= #{maxPrice}
            </if>
        </where>
    </select>
</mapper>

 

namespace : 앞서 만든 매퍼 인터페이스를 지정합니다.

 

주의 - 경로와 파일 이름에 주의해야 합니다.

참고 - XML 파일 경로 수정하기 XML 파일을 원하는 위치에 두고 싶으면 application.properties 에 다음과 같이 설정하면 됩니다.

mybatis.mapper-locations=classpath:mapper/**/*.xml


이렇게 하면 resources/mapper 를 포함한 그 하위 폴더에 있는 XML 을 XML 매핑 파일로 인식합니다.
이 경우 파일 이름은 자유롭게 설정해도 됩니다.

참고로 테스트의 application.properties 파일도 함께 수정해야 테스트를 실행할 때 인식할 수 있습니다.

 

insert - save

void save(Item item);

<insert id="save" useGeneratedKeys="true" keyProperty="id">
    insert into item (item_name, price, quantity)
    values (#{itemName}, #{price}, #{quantity})
</insert>

Insert SQL은 <insert>를 사용합니다.

 

id에는 매퍼 인터페이스에 설정한 메서드 이름을 지정합니다. 여기서는 메서드 이름이 save()이므로 save로 지정하였습니다.

파라미터는 #{} 문법을 사용합니다. 그리고 매퍼에서 넘긴 객체의 프로퍼티 이름을 기입해야 합니다.

 

#{} 문법을 사용하면 PreparedStatement를 사용하여 JDBC의 ? 를 치환한다 생각하면 됩니다.

 

useGeneratedKeys는 데이터베이스가 키를 생성해 주는 IDENTITY 전략일 때 사용합니다.

 

keyProperty는 생성되는 키의 속성 이름을 지정합니다. Insert 가 끝나면 item 객체의 id 속성에 생성된 값이 입력됩니다.

 

update - update

import org.apache.ibatis.annotations.Param;

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

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

Update SQL은 <update>를 사용합니다.

 

여기서는 파라미터가 Long id, ItemUpdateDto updateParam으로 2개입니다.

 

파라미터가 1개만 있으면 @Param을 지정하지 않아도 되지만, 파라미터가 2개 이상이면 @Param으로 이름을 지정해서 파라미터를 구분해야 합니다.

 

select - findById

Optional<Item> findById(Long id);

<select id="findById" resultType="Item">
    select id, item_name, price, quantity
    from item
    where id = #{id}
</select>

Select SQL은 <select>를 사용합니다.

 

resultType은 반환 타입을 명시합니다. 여기서는 결과를 Item 객체에 매핑하고 있습니다.

 

앞서 application.properties 에 mybatis.type-aliasespackage=hello.itemservice.domain 속성을 지정한 덕분에 모든 패키지 명을 다 적지는 않아도 됩니다. 만약 속성을 지정하지 않았다면 모든 패키지 명을 다 적어야 합니다.

 

JdbcTemplate 의 BeanPropertyRowMapper처럼 SELECT SQL 의 결과를 편리하게 객체로 바로 변환합니다.

  • mybatis.configuration.map-underscore-to-camel-case=true 속성을 지정한 덕분에 언더스코어를 카멜 표기법으로 자동으로 처리합니다. (item_name → itemName)

 

자바 코드에서 반환 객체가 하나이면 Item, Optional<Item>과 같이 사용하면 되고, 반환 객체가 하나 이상이면 컬렉션을 사용하면 됩니다. 주로 List를 사용합니다.

 

select - findAll

List<Item> findAll(ItemSearchCond itemSearch);

<select id="findAll" resultType="Item">
    select id, item_name, price, quantity
    from item
    <where>
        <if test="itemName != null and itemName != ''">
            and item_name like concat('%',#{itemName},'%')
        </if>
        <if test="maxPrice != null">
            and price &lt;= #{maxPrice}
        </if>
    </where>
</select>

Mybatis는 <where>, <if> 같은 동적 쿼리 문법을 통해 편리한 동적 쿼리를 지원합니다.

 

<if>는 해당 조건이 만족하면 구문을 추가합니다.

<where>은 적절하게 where 문장을 생성합니다.

  • 예제에서 <if>가 모두 실패하게 되면 SQL where를 만들지 않음
  • 예제에서 <if>가 하나라도 성공하면 처음 나타나는 and를 where로 변환

 

XML 특수문자

가격을 비교하는 조건에서 and price &lt;= #{maxPrice} 여기에 보면 <=를 사용하지 않고 &lt;=를 사용합니다.

그 이유는 XML에서는 데이터 영역에 <, > 같은 특수 문자를 사용할 수 없기 때문입니다. 이유는 간단한데, XML에서 TAG가 시작하거나 종료할 때 <, > 와 같은 특수문자를 사용하기 때문이죠.

 

아래처럼 사용합니다.

<  :  &lt;

>  :  &gt;

&. :  &amp;​

 

다른 해결 방안으로는 XML에서 지원하는 CDATA 구문 문법을 사용할 수 있습니다. 이 구문 안에서는 특수문자를 사용할 수 있는 대신 이 구문 안에서는 XML TAG 가 단순 문자로 인식되기 때문에 <if>, <where> 등이 적용되지 않습니다.

 

XML CDATA 사용

<select id="findAll" resultType="Item">
    select id, item_name, price, quantity
    from item
    <where>
        <if test="itemName != null and itemName != ''">
            and item_name like concat('%',#{itemName},'%')
        </if>
        <if test="maxPrice != null">
            <![CDATA[
            and price <= #{maxPrice}
            ]]>
        </if>
    </where>
</select>

특수문자와 CDATA 각각 상황에 따른 장단점이 있으므로 원하는 방법을 그때그때 선택하면 됩니다.

 

4. MyBatis 적용2 - 설정과 실행

MyBatisItemRepository

@Repository
@RequiredArgsConstructor
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);
    }
}

ItemRepository를 구현해서 MyBatisItemRepository를 개발하겠습니다.

MyBatisItemRepository는 단순히 ItemMapper에 기능을 위임하였습니다.

 

MyBatisConfig

@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);
    }
}

MyBatisConfig는 ItemMapper를 주입받고, 필요한 의존관계를 생성합니다.

 

ItemServiceApplication - 변경

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

@Import(MyBatisConfig.class): 앞서 설정한 MyBatisConfig.class를 사용하도록 설정했습니다.

 

테스트 실행

ItemRepositoryTest를 통해서 리포지토리가 정상 동작하는지 확인해봅시다. 테스트가 모두 성공해야 합니다.

 

애플리케이션 실행

ItemServiceApplication를 실행해서 애플리케이션이 정상 동작하는지 확인해봅시다.

 

 

주의 - H2 데이터베이스 서버를 먼저 실행해야 함

 

5. MyBatis 적용3 - 분석

ItemMapper 인터페이스

@Mapper
public interface ItemMapper {
  void save(Item item);

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

  List<Item> findAll(ItemSearchCond itemSearch);

  Optional<Item> findById(Long id);
}

 

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

이 부분은 MyBatis 스프링 연동 모듈에서 자동으로 처리되는 것입니다.

 

설정 원리

https://user-images.githubusercontent.com/52024566/187686571-ba8fa9fa-4732-469c-8487-e16398d329cf.png

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

 

실제 동적 프록시 기술이 사용되었는지 간단히 확인해봅시다.

 

MyBatisItemRepository - 로그 추가

@Slf4j
@Repository
@RequiredArgsConstructor
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 의 클래스를 출력해봅시다.

 

실행 결과

itemMapper class=class jdk.proxy.$Proxy66

출력해보면 JDK 동적 프록시가 적용된 것을 확인할 수 있습니다.

 

매퍼 구현체

마이바티스 스프링 연동 모듈이 만들어주는 ItemMapper의 구현체 덕분에 인터페이스 만으로 편리하게 XML의 데이터를 찾아서 호출할 수 있습니다.

 

원래 마이바티스를 사용하려면 더 번잡한 코드를 거쳐야 하는데, 이런 부분을 인터페이스 하나로 매우 깔끔하고 편리하게 사용할 수 있습니다.

 

매퍼 구현체는 예외 변환까지 처리해줍니다. MyBatis 에서 발생한 예외를 스프링 예외 추상화인 DataAccessException에 맞게 변환해서 반환해줍니다. JdbcTemplate 이 제공하는 예외 변환 기능을 여기서도 제공한다고 이해하면 됩니다.

 

정리

매퍼 구현체 덕분에 마이바티스를 스프링에 편리하게 통합해서 사용할 수 있습니다.

매퍼 구현체를 사용하면 스프링 예외 추상화도 함께 적용할 수 있습니다.

마이바티스 스프링 연동 모듈이 많은 부분을 자동으로 설정해주는데, 데이터베이스 커넥션, 트랜잭션과 관련된 기능도 마이바티스와 함께 연동하고, 동기화됩니다.

 

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

 

6. MyBatis 기능 정리1 -동적 쿼리

 

동적 SQL

마이바티스가 제공하는 최고의 기능이자 마이바티스를 사용하는 이유는 바로 동적 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을 사용합니다.

 

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>

자바의 switch 구문과 유사한 구문입니다.

 

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>

이 예제의 문제점은 문장을 모두 만족하지 않을 때 발생합니다.

 

SELECT * FROM BLOG
WHERE

이렇게 SQL 문이 WHERE 로 끝나버립니다.

 

title만 만족할 때도 문제가 발생합니다.

SELECT * FROM BLOG
WHERE
AND title like ‘someTitle’

결국 WHERE 문을 언제 넣어야 할지 상황에 따라서 동적으로 달라지는 문제가 있습니다.

 

이 때 <where>를 사용하면 이런 문제를 해결할 수 있습니다.

<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>는 문장이 없으면 where를 추가하지 않습니다. 문장이 있으면 where를 추가합니다. 만약 and가 먼저 시작된다면 and를 삭제하게 됩니다.

 

다음과 같이 trim이라는 기능으로 사용해도 이렇게 정의하면 <where>와 같은 기능을 수행합니다.

<trim prefix="WHERE" prefixOverrides="AND |OR ">
...
</trim>

 

foreach

<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>

컬렉션을 반복 처리할 때 사용합니다. where in (1,2,3,4,5,6)와 같은 문장을 쉽게 완성할 수 있습니다.

파라미터로 List를 전달합니다.

 

참고 - 동적 쿼리에 대한 자세한 내용은 다음을 참고합시다.
https://mybatis.org/mybatis-3/ko/dynamic-sql.html

 

7. MyBatis 기능 정리2 - 기타 기능

애노테이션으로 SQL 작성

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

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

@Insert, @Update, @Delete, @Select 기능이 제공됩니다.

 

이 경우 XML에는 <select id="findById"> ~ </select>는 제거해야 합니다.

동적 SQL이 해결되지 않으므로 간단한 경우에만 사용하는 것입니다.

참고: https://mybatis.org/mybatis-3/ko/java-api.html

 

문자열 대체(String Substitution)

#{} 문법은 ‘?’ 를 넣고 파라미터를 바인딩하는 PreparedStatement를 사용합니다.

파라미터 바인딩이 아니라 문자 그대로를 처리하고 싶은 경우 ${} 를 사용합니다.

 

ORDER BY ${columnName}

@Select("select * from user where ${column} = #{value}")
User findByColumn(@Param("column") String column, @Param("value") String value);

 

주의 - ${} 를 사용하면 SQL 인젝션 공격을 당할 수 있으므로 가급적 사용하면 안 됩니다. 사용하더라도 매우 주의깊게 사용해야 합니다.

 

재사용 가능한 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>

 

<include>를 통해서 <sql> 조각을 찾아서 사용할 수 있습니다.

<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

컬럼명과 객체의 프로퍼티 명이 다를 경우, 다음과 같이 별칭(as)을 사용합니다.

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

 

별칭을 사용하지 않고도 문제를 해결할 수 있는데, 다음과 같이 resultMap을 선언해서 사용하면 됩니다.

<resultMap id="userResultMap" type="User">
  <id property="id" column="user_id" />
  <result property="username" column="username"/>
  <result property="password" column="password"/>
</resultMap>

<select id="selectUsers" resultMap="userResultMap">
  select user_id, user_name, hashed_password
  from some_table
  where id = #{id}
</select>

 

복잡한 결과매핑

MyBatis 도 매우 복잡한 결과에 객체 연관관계를 고려해서 데이터를 조회하는 것이 가능합니다.

이 때는 <association>, <collection> 등을 사용합니다.

이 부분은 성능과 실효성에서 측면에서 많은 고민이 필요합니다.

 

JPA는 객체와 관계형 데이터베이스를 ORM 개념으로 매핑하기 때문에 이런 부분이 자연스럽지만, MyBatis 에서는 들어가는 공수도 많고, 성능을 최적화하기도 어렵습니다.. 따라서 해당기능을 사용할 때는 신중하게 사용해야 합니다.

 

참고 - 결과 매핑에 대한 자세한 내용은 다음을 참고합시다. https://mybatis.org/mybatis-3/ko/sqlmap-xml.html#Result_Maps

'spring > 스프링 DB 2편' 카테고리의 다른 글

5. 스프링 데이터 JPA(2) - 적용하기  (0) 2023.02.22
5. 스프링 데이터 JPA(1) 소개와 기능  (0) 2023.02.22
4. 데이터 접근 기술 - JPA (2) JPA 적용, 예외 변환  (0) 2023.02.22
4. 데이터 접근 기술 - JPA (1) JPA 와 JPA 을 사용해야 하는 이유  (2) 2023.02.21
2. 데이터 접근 기술 - 데이터베이스 테스트하는 방법들  (0) 2023.02.20

'spring/스프링 DB 2편'의 다른글

  • 현재글3. 데이터 접근 기술 - MyBatis

관련글

티스토리툴바