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

[YuDeokRin]

데이터 접근 기술 - MyBatis

1️⃣ MyBatis 소개

• JdbcTmeplate과 비교해서 MyBatis는 SQL을 XML에 편리하게 작성할 수 있고 또 동작 쿼리를 매우 편리하게 작성할 수 있다는 점이다.

• JdbcTemplate - SQL 쿼리 작성 예시

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

• MyBatis - SQL 쿼리 작성 예시
  • XML에 작성하기 때문에 라인이 길어져도 문자 더하기에 대한 불편함이 없다.

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

• 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는 약간의 설정이 필요하다.

2️⃣ MyBatis 설정

• 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:3.0.3'

	//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 설정

  • main

  spring.profiles.active=local
  spring.datasource.url=jdbc:h2:tcp://localhost/~/test
  spring.datasource.username=sa
  
  # JdbcTemplate
  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

  spring.profiles.active=test
  #spring.datasource.url=jdbc:h2:tcp://localhost/~/testcase
  #spring.datasource.username=sa
  
  #schema.sql
  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.configuration.map-underscore-to-camel-case

  • JdbcTemplate의 BeanPropertyRowMapper 에서 처럼 언더바를 카멜로 자동 변경해주는 기능을 활성화 한다. 바로 다음에 설명하는 관례의 불일치 내용을 참고하자.

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

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

3️⃣ MyBatis 적용1 - 기본

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 java.util.List;
import java.util.Optional;

@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을 실행하고 결과를 돌려준다.
  • ItemMapper 인터페이스의 구현체에 대한 부분은 뒤에 별도로 설명한다.

• 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 파일도 함께 수정해야 테스트를 실행할 때 인식할 수 있다.

• 위 코드 설명 2 번째
  • insert -save
    • 파라미터는 #{} 문법을 사용하면 된다. 그리고 매퍼에서 넘긴 객체의 프로퍼티 이름을 적어주면 된다.
    • #{} 문법을 사용하면 PreparedStatement 를 사용한다. JDBC의 ? 를 치환한다 생각하면 된다.
    • useGeneratedKeys는 데이터베이스가 키를 생성해 주는IDENTITY전략일 때 사용한다.keyProperty는 생성되는 키의 속성 이름을 지정한다. Insert가 끝나면item 객체의 id 속성에 생성된 값이 입력된다.

void save(Item item); 

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

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

• 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 - 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 문장을 만들어준다.
  • 예제에서 가 모두 실패하게 되면 SQL where 를 만들지 않는다.
  • 예제에서 가 하나라도 성공하면 처음 나타나는 and 를 where 로 변환해준다.

✅XML 특수문자

• 비교하는 조건을 보자

and price <= #{maxPrice}

• 여기에보면 <= 를사용하지않고 <= 를사용한것을확인할수있다.그이유는XML에서는데이터영역에 < , > 같은특수문자를사용할수없기때문이다.이유는간단한데,XML에서TAG가시작하거나종료할때 < , > 와같은 특수문자를 사용하기 때문이다.

< : &lt;
> : &gt;
& : &amp;

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