[Spring] 마이바티스(MyBatis)란? & 연동하는 방법

MyBatis란?

• 쿼리 기반 웹 애플리케이션을 개발할 때 가장 많이 사용되는 SQL 매퍼(Mapper) 프레임워크이다.
• 마이바티스를 사용하지 않고 직접 JDBC를 이용할 경우 문제점:
  • 개발자가 반복적으로 작성해야 할 코드가 많고, 서비스 로직 코드와 쿼리를 분리하기가 어렵다.
  • 또한 커넥션 풀의 설정 등 개발자가 신경 써야 할 부분이 많아 여러 가지 어려움이 있다. 
• 따라서, JDBC를 이용해서 직접 개발하기보다는 마이바티스와 같은 프레임워크를 사용하는 게 일반적이다.
• JDBC를 이용하여 프로그래밍을 하는 방식: 
  • 클래스나 JSP와 같은 코드 안에 SQL문을 작성하는 방식
  • 따라서 SQL의 변경 등이 발생할 경우 프로그램을 수정해야 한다.
    • -> 유연하지 않다, 코드가 복잡하게 섞여 있어서 가독성도 떨어짐
• 마이바티스에서는 SQL을 XML 파일에 작성하기 때문에, SQL의 변환이 자유롭고 가독성도 좋다.

 

 

MyBatis 설정

 

1. 저번 포스팅에서 작성한 DBConfig 파일에 sqlSessionFactory 함수와 sqlSessionTemplate 함수를 추가해 줍니다.

• sqlSessionFactory():
  • [Spring-MyBatis]에서는 SqlSessionFactory를 생성하기 위해 SqlSessionFactoryBean을 사용한다.
  • 만약 spring이 아닌 MyBatis 단독으로 사용할 경우에는 SqlSessionFactoryBuilder를 사용한다.
  • Mapper 파일 위치: "classpath:/mapper/**/sql-*.xml"로 지정
• Mapper: 사용할 SQL을 담고 있는 XML 파일을 의미
• Configuration 최종 코드:

package com.example.board;

import com.zaxxer.hikari.HikariConfig;
import com.zaxxer.hikari.HikariDataSource;
import org.apache.ibatis.session.SqlSessionFactory;
import org.mybatis.spring.SqlSessionFactoryBean;
import org.mybatis.spring.SqlSessionTemplate;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.PropertySource;

import javax.sql.DataSource;

@Configuration
@PropertySource("classpath:/application.properties") // 설정 파일 위치 지정
public class DBConfig {

    @Autowired
    private ApplicationContext applicationContext;

    @Bean
    @ConfigurationProperties(prefix="spring.datasource.hikari") // 다음의 prefix로 시작하는 설정을 이용해서 hikariCP의 설정 파일을 만듦
    public HikariConfig hikariConfig(){
        return new HikariConfig();
    }

    @Bean
    public DataSource dataSource() throws Exception{ // 위에서 만든 설정 파일을 이용해서 디비와 연결하는 데이터 소스를 생성
        DataSource dataSource = new HikariDataSource(hikariConfig());
        System.out.println(dataSource.toString());
        return dataSource;
    }

    @Bean
    public SqlSessionFactory sqlSessionFactory(DataSource dataSource) throws Exception{
        SqlSessionFactoryBean sqlSessionFactoryBean = new SqlSessionFactoryBean();
        sqlSessionFactoryBean.setDataSource(dataSource);
        sqlSessionFactoryBean.setMapperLocations(applicationContext.getResources("classpath:/mapper/**/sql-*.xml"));
        return sqlSessionFactoryBean.getObject();
    }

    @Bean
    public SqlSessionTemplate sqlSessionTemplate(SqlSessionFactory sqlSessionFactory){
        return new SqlSessionTemplate(sqlSessionFactory);
    }
}

 

2. Mapper 폴더 생성하기

• src/main/resources 폴더 밑에 mapper 폴더 생성
• 위 DBConfig에서 Mapper 파일 위치를 "classpath:/mapper/**/sql-*.xml"로 지정했다.
  • 이 패턴은 다음을 의미한다.
  • [classpath]: resource 폴더 의미
  • [/mapper/**/]: mapp 폴더 밑의 모든 폴더를 의미
  • [/sql-*.xml]: 이름이 sql-로 시작하고 확장자가 xml인 모든 파일을 의미

 

 

3. MaBtis 연결 확인하기

• 간단한 테스트 코드를 작성해서 확인해본다.
• test/java/.../board 밑에 있는 (프로젝트 생성 때부터 존재) BoardApplicationTests에 아래의 코드를 작성한다.

package com.example.board;

import org.junit.jupiter.api.Test;
import org.mybatis.spring.SqlSessionTemplate;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

@SpringBootTest
class BoardApplicationTests {

    @Autowired
    private SqlSessionTemplate sqlSession;

    @Test
    void contextLoads() {
    }

    @Test
    public void testSqlSession() throws Exception{
        System.out.println(sqlSession.toString());
    }
}

• 그 후 해당 코드(19번째 줄) 좌측에 위치한 초록색 화살표를 눌러 실행시킨다.

• 위 사진처럼 나온다면, MaBatis가 정상적으로 연결되었다는 것을 확인할 수 있다.

 

 

 

참고:

- [스프링 부트 시작하기: 차근차근 따라 하는 단계별 실습]