(MyBatis) Service 와 Mapper/Repository 의 관계 (feat. @Mapper, @Select, xml 파일)

🌟 공부하게 된 계기

MyBatis 초기 세팅 후 테스트 코드를 작성하는 과정에서 기존 JPA 와 다르게 작성하는 부분이 크게 ① 'MyBatis 는 따로 Entity 의 개념이 없다.' ② 'Repository interface 에서 JpaRepository 를 상속받던 JPA 방식과는 달리 @Mapper 를 이용한 초기화가 이루어진다.' 였는데, 그중에서도 Repository 속 어노테이션 역할이 어떤 건지 궁금해서 좀 더 자세히 정리 해보기로 했다.

🌟 초기 설정 (공통 부분)

① 테스트 작성

@SpringBootTest
class AppTest {
    @Autowired
    private AriticleService ariticleService;
    @Test
    @DisplayName("게시물_리스트_반환")
    void t1() {
        List<Article> articles = articleService.getArticles();
        System.out.println(articles);
        System.out.println(articles.get(1).getSubject());
    }
}

② Service 생성

@Service
@RequiredArgsConstructor
public class ArticleService {
    private final ArticleRepository articleRepository;

    public List<Article> getArticles() {
        return articleRepository.getArticles();
    }
}

③ DTO 클래스 생성 (MyBatis 에는 Entitiy 의 개념이 따로 없음)

@Getter
public class Article {
    private long id;
    private String subject;
    private String content;
}

④ DB 생성

DROP DATABASE IF EXISTS mybatis;
CREATE DATABASE mybatis;
USE mybatis;

CREATE TABLE article (
	id BIGINT UNSIGNED NOT NULL AUTO_INCREMENT,
	PRIMARY KEY(id),
	createDate DATETIME NOT NULL,
	modifyDate DATETIME NOT NULL,
	`subject` CHAR(100) NOT NULL,
	content LONGTEXT NOT NULL
);

INSERT INTO article
SET createDate = NOW(),
modifyDate = NOW(),
`subject` = '제목1',
content = '내용1';

INSERT INTO article
SET createDate = NOW(),
modifyDate = NOW(),
`subject` = '제목2',
content = '내용2';

1️⃣ 방법 1 : @Mapper 와 @Select 활용

① Repository 생성

@Mapper
public interface ArticleRepository {
    @Select("""
        <script>
        SELECT *
        FROM article
        </script>
        """)
    List<Article> getArticles();
}

➡️ @Mapper : 해당 interface 를 마이바티스 매퍼로 등록하겠다는 뜻이다.

➡️ @Select : 동적 쿼리를 작성할 필요가 없을 때 사용한다. 만약 동적 쿼리를 만들어야하면 @SelectProvider 를 사용한다.

class MemberSQL {
  public static final String FIND_MEMBERS =
          '''
          SELECT id, name FROM MEMBER
          '''

  public String findMembersByName(String memberName) {
      StringBuilder query = new StringBuilder();
      query.append('''
                  SELECT id, name FROM MEMBER
                  ''')
      if (!StringUtils.isEmpty(memberName)) {
          query.append("WHERE ")
          query.append(QueryUtils.like("name", memberName))
      }
      return query.toString()
  }
}

@Mapper
interface MemberMapper {
        @Select(MemberSQL.FIND_MEMBERS)
        public List<Member> findMembers()

        @SelectProvider(type = MemberSQL.class, method = "findMembersByName")
        public List<Member> findMembersByName(@Param("name") String name)
}

➡️ 별다른 세팅 없이 @Mapper 와 @Select 두 어노테이션으로 쉽게 해결된다. 이렇게 끝낼 수 있지만 어노테이션의 역할이 뭔지 이해해보기 위해 아래의 방법 2 도 시도해보았다.

2️⃣ 방법 2 : @Mapper 와 xml 파일 활용 (@Select 사용 x)

 

 

① application.yml 파일에 설정 추가

# MyBatis 관련 설정
mybatis:
    mapper-locations: mybatis-mapper/*.xml
    type-aliases-package: com.ay.study.mybatis_1101.app.article.dto

• mapper-locations : mapper.xml 파일 경로 지정
• type-aliases-package : mapper.xml 파일에서 package 상세 경로 생략 가능 (해당 설정을 활용하려면 모든 클래스 파일이 한 폴더에 들어가 있어야할듯!)

⬇️

테스트 결과 확인

② Mapper 생성

@Mapper
public interface ArticleMapper {
    List<Article> getArticles();
}

③ xml 파일 생성 (경로 : resource/mybatis-mapper/ArticleMapper.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="com.ay.study.mybatis_1101.app.article.repository.ArticleMapper">

  <select id="getArticles" resultType="Article">
    select * from article
  </select>
</mapper>

⬇️

테스트 결과 확인

🌟 생각 정리

누가봐도 방법 2️⃣ 보다는 방법 1️⃣이 간편하다. 찾아보니 스프링은 3.0 부터 Java Config 를 지원하기 시작했고, 스프링 부트는 물론 여진히 xml 설정은 가능하지만,  xml 설정 없이 동작 한다고 한다. 마이바티스 또한 xml 설정 없이 java 클래스만을 사용하여서, 동적 쿼리 생성이 가능하여 스프링부트와 함께 사용하면 효율적이라고 한다. 추가로 xml 설정에서는 MyBatis 가 제공하는 문법에 따라서만 조립이 가능하지만, 스프링부트와 함께 사용하면 Java 문법을 사용해서 로직에 맞춰 조립할 수 있는 장범도 존재한다고 한다. 물론 스프링 부트를 사용하면 xml 까지 알 필요는 없지만, MyBatis 의 기본적인 동작에 대해서 이해하기는 더 좋았던 것 같다.

📚 참고

① mapper 어노테이션을 통한 springboot, mybatis 세팅하기 : https://frozenpond.tistory.com/85

[spring] mapper 어노테이션을 통한 springboot, mybatis 세팅하기

② Mapper, Repository 역할 및 간단한 예시 : https://ddacker.tistory.com/13

[SI에서 살아남기] 내맘대로 Mapper,Repostiory 역할 및 간단한 예시

③ 마이바티스 동적 쿼리 Java 로 만들기 (@Select 관련 내용 볼 수 있음 & 추천!) : https://jason-moon.tistory.com/130

마이바티스(MyBatis) 동적 쿼리 Java로 만들기.