SpringBoot에서 Mybatis 사용

LikeGhost·2023년 8월 20일

Spring boot에서 Mybatis를 사용해본다.

Mybatis는 데이터베이스로부터 직접 SQL문으로 데이터를 가져오고 객체(Entity든지, DTO든지, VO든지)에 반영하여 사용하도록 해주는 데이터베이스 접근 프레임워크이다.
이번에 Spring boot에서 Mybatis를 사용해본다.

Spring MVC 클래스(Controller, Service, Entity 등) 가 준비된 상태에서 Mybatis 기능을 추가하여 사용하는 방식으로 설명한다.

1. build.gradle에 의존성 추가

위 그림과 같이 build.gradle 파일에 의존성을 추가한다.

2. application.yml 파일 설정

resources 디렉토리 내 application.yml 설정파일에

mybatis:
  mapper-location: classpath:mapper/*.xml

을 입력한다.

이는 resources/.../mapper 라는 디렉토리 안의 모든 xml파일은 mybatis의 매핑 xml파일로 인식하겠다는 의미이다.

※ mybatis.configuration.log-impl 이나 logging.level.com.posting.mybatisCategory.mapper 내용은 콘솔에 로그를 확인할 경우 사용한다.

3. 데이터를 받을 객체클래스 준비

나중에 SQL 파라미터나 결과데이터로 받게 될 객체클래스를 생성한다.

4. Mapper Interface 생성

위와 같이 @Mapper 애너테이션을 사용하여 Mybatis Mapper 인터페이스를 생성한다.

여기서는 데이터요청에 사용되는 메서드 시그니처를 선언한다.
파라미터로 사용할 변수나 객체를 선언하고 리턴받을 타입을 선언한다.

※ Mapstruct를 사용할 경우 @Mapper가 서로 다르니
org.apache.ibatis.annotations.Mapper의 Mapper를 사용한다.

※ 파라미터가 객체가 아닌 특정 변수로 받을 경우 위와 같이 @Param을 사용한다.

5. Mapper Interface 의존성 주입

비즈니스 역할 클래스에 위에서 만든 Mapper Interface 을 의존성 주입한다.

보통은 서비스 클래스에서 비즈니스 역할을 수행하므로 서비스 클래스에 의존성 주입 을 하였다.

6. 서비스클래스 메서드에서 mapper 메서드 호출

서비스클래스의 메서드에서 각 역할에 맞게 Mapper Interface의 메서드를 호출한다.

7. Mapper.xml 파일 생성

실질적으로 데이터베이스로부터 SQL문으로 데이터를 받아올 XML파일을 생성한다.

Mapper Interface에서 선언해뒀던 메서드에 대한 SQL문을 작성한다.

※ Mapper.xml 작성 시 유의사항

1. Mapper.xml 파일은 main 디렉토리 아래 resources 디렉토리 안에 작성해야 한다.

그리고 위와 같이 디렉토리 구조를 java디렉토리 안의 해당 Mapper Interface의 디렉토리구조와 맞춰줘야 한다.

2. Mapper.xml 내 namespace 값은 위 그림처럼 해당 Mapper의 Interface의 위치를 적는다.

3. 각 SQL 요청 별 id 값은 Mapper Interface에서 선언했던 메서드명을 적는다.

4. resultType은 SQL문을 실행 후 결과값을 어디로 반영할지를 의미하므로 데이터를 위와 같이 데이터를 받을 객체클래스의 위치를 적는다.

5. 객체를 파라미터로 사용할 경우 parameterType란에 파라미터로 사용할 객체 위치를 적는다. 그냥 특정 값을 파라미터를 쓸 경우 mapper Interface에서 @Param을 사용하여 파라미터를 선언하고 mapper.xml에서 그냥 #{@Param에 적은 파라미터명}을 적는다.

※ 특정 위치가 반복될 경우 아래처럼 alias를 선언하고 사용할 수 있다.

...

    <typeAliases>
        <typeAlias type="com.posting.mybatisCategory.entity.MybatisCategory" alias="CategoryAlias"/>
    </typeAliases>
    
    <select id="findCategories" resultType="CategoryAlias">

        SELECT category_id as categoryId, category_name as categoryName
        FROM category
    </select>
    ...

※ 사용예제

위의 데이터를 기반으로 간단한 CRUD 예제를 작성한다.

- GET 요청

요청을 받을 Controller 메서드를 작성한다.
파라미터로 Id 값을 받기로 한다.

Controller에서 호출되는 Service 메서드를 작성한다.

이어서 Service 메서드에서 호출될 Mapper 메서드를 작성한다.
파라미터로 Id값을 사용하므로 @Param("categoryId") long categoryId 를 선언한다.

Mapper Interface에서 선언한 메서드에 대한 SQL문을 작성한다.

GET 요청에 맞춰 Select 문을 작성한다.
@Param에 선언했던 파라미터 categoryId를 where 에 사용한다.
그리고 결과데이터를 MybatisCategory 객체에 닮아보낸다.

select 문을 보면 category_id as categoryId, category_name as categoryName 식으로 적었는데, 데이터베이스 category 테이블의 컬럼명은 category_id, category_name 이고, MybatisCategory 클래스의 멤버명은 categoryId, categoryName 이기에 select문에서 컬럼명을 멤버명으로 바꾸어 요청했다.