Spring Boot에서 Mybatis 사용법 정리입니다 :D

• 사용 IDE : IntelliJ IDEA Ultimate
• 사용 DB : MySQL
• 사용 언어 & SDK : Java & Amazon correto 11
• 정리본입니다 참고용으로만 봐주세요 :D
  
  

이전 글
θ Spring Boot 예제1 (회원관리)
𝜅 Spring Boot 예제2 (회원관리)
𝜆 Spring Boot 예제3 (회원관리)
𝜇 Spring Boot 예제4 (회원관리)
𝜈 Spring Boot 회원관리 TEST 모음

---

Mybatis 사용 준비 하기

Spring Boot에서 mybatis 사용하는 방법에 대해 정리해보겠습니다.
Spring Framework에서 mybatis를 쓰지만 Spring Boot에서도 사용할 수 있고,
jpa로 할 수 없는 복잡한 쿼리문의 경우 mybatis를 사용해 해결해야 하기 때문에
이에 대해 설명을 하려합니다!
기존 회원관리 예제에서 추가로 작성하는 것이므로 앞에 내용이 궁금하다면 이전글을 참고해주세요 :D

---

Gradle

mybatis를 사용하기 위해선 dependency가 필요합니다.
회원관리 예제를 만들면서 mybatis dependency를 추가를 안했기 때문에
이를 추가해 주는 작업을 해봅시다!!

• build.gradle 파일을 열어 dependencies 부분에 주석 아래 코드 2줄 추가

• 각 jdbc와 mybatis를 사용할 수 있게 추가해주는 dependency

• 코드 추가 후 화면 우측 상단에 코끼리 아이콘이 뜨면 눌러서 gradle 설정 업데이트!

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

    // mybatis와 관련된 dependency (jdbc, mybatis)
    implementation 'org.springframework.boot:spring-boot-starter-data-jdbc'
    implementation 'org.mybatis.spring.boot:mybatis-spring-boot-starter:2.2.0'

    compileOnly 'org.projectlombok:lombok'
    runtimeOnly 'mysql:mysql-connector-java'
    annotationProcessor 'org.projectlombok:lombok'
    testImplementation 'org.springframework.boot:spring-boot-starter-test'
}

---

application.yml

gradle 설정이 완료되었으면 application.yml에 mybatis 관련 설정을 해줘야합니다!
계속 언급을 했지만 yml파일에 내용을 쓸 때 들여쓰기를 꼭 맞춰서 써주세요!
보기에 이쁘게 만든다고 들여쓰기 무사하면 오류가 납니다!!
그럼 아래에 있는 코드를 yml파일에 추가해봅시다 :D

# mybatis 관련 설정
mybatis:
  # resources/mapper/ 에 있는 모든 xml 파일
  mapper-locations: mapper/*.xml
  # alias 설정
  # Spring Framework처럼 이름을 사용하기 편하게 바꿔주는게 아니라 길이를 줄여주는 역할.
  # IntelluJ는 자동완성을 지원하기 때문에 굳이 안써도 됨.
  # type-aliases-package: com.icia.member.dto

---

Repository

Mybatis 설정을 전부 끝마쳤으니 Mybatis용 Repository를 만들어 봅시다!
주의할점으로 repository 패키지에 Interface Class로 만들어야합니다 :D
그럼 바로 만들러 가시죠!

@Mapper // Mapper용으로 쓸 Repository라고 선언하는 어노테이션
public interface MemberMapperRepository {

}

---

Mapper

mapper까지만 만들면 Mybatis를 본격적으로 사용할 수 있습니다.
아까 application.yml에서 경로를 resources/mapper/ 로 만들었기 때문에 여기에 만들어야 합니다.
또한 Spring Framework에서 사용하는 것과 똑같이 설정을 해줘야합니다.
그것까지 전부 포함해서 코드를 올리니 참고해주세요 :D

<?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 설정을 하는 코드 -->

<!-- Mapper를 사용하는 Repository의 전체 경로를 적어줘야함. -->
<mapper namespace="com.icia.member.repository.MemberMapperRepository">

</mapper>

---

Mybatis 사용 준비 끝

여기까지 잘 따라오셨으면 mybatis 를 사용할 준비가 끝났습니다!
그럼 간단한 기능 2개를 사용해보며 어떻게 만들어야하는지 알아봅시다 :D
Mybatis를 이용한 기능은 Test코드로만 실행해보도록 하겠습니다!!

---

Mybatis로 회원가입

Mybatis 사용을 시작하기 전에 주의사항이 있습니다.
jpa와 달리 mybatis에서는 DB에 저장된 컬럼이름을 반.드.시 맞춰줘야합니다.
jpa는 카멜케이스로 작성 시(MemberId) 자동으로 언더바 (member_id)로 바꿔주지만,
mybatis는 작성한 그대로 데이터가 가기 때문에 컬럼명과 DTO의 필드이름이 같아야합니다.
이에 맞춰서 DTO를 하나 더 생성해줍시다 :D

---

Mybatis용 DTO생성

@Data
@NoArgsConstructor
@AllArgsConstructor
public class MemberMapperDTO {

	private Long member_id;
	private String member_email;
	private String member_password;
	private String member_name;

	// 아래 생성자는 회원가입 때 필요한 정보만 모아놓은 생성자로 미리 만들어둡시다 :D
	public MemberMapperDTO (String member_email, String member_password, String member_name) {
	this.member_email = member_email;
	this.member_password = member_password;
	this.member_name = member_name;
	}
}

---

Repository

Repository에서 mybatis를 사용해 DB에 연결하는 방법은 2가지가 있습니다.
Spring Framework처럼 mapper에 쿼리문을 만드는 방법이 있고,
Repository에서 mapper를 호출하지않고 쿼리를 수행하는 방법이 있습니다.
둘다 하는역할은 같기 때문에 같이 설명하겠습니다 :D

// 아래 코드를 Repository에 추가

// mapper를 호출하는 방식
// 회원가입
void save1(MemberMapperDTO memberMapperDTO);

// mapper를 호출하지 않고 여기서 쿼리까지 수행하는 방식
// 아래같이 코드를 작성하면 mapper에 내용을 추가하지 않아도 됨
// 사용하고자 하는 쿼리 종류(insert, select 등)에 맞춰 어노테이션을 붙여야함
@Insert("insert into member_table(member_email, member_password, member_name) values(#{member_email}, #{member_password}, #{member_name})")
void save2(MemberMapperDTO memberMapperDTO);

---

Mapper

Repository에 메서드를 추가했으니 mapper에 해당 쿼리를 수행하는 쿼리문을 만들어봅시다!
Spring Framework에서 사용하는 방식과 똑같으니 바로 진행하겠습니다 :D
쿼리문은 <mapper> </mapper>안에 작성!

<!-- yml에서 alias를 설정했다면 아래 코드와 같이 쓸 수 있음. -->
<!-- <insert id="save" parameterType="MemberMapperDTO"> -->

<insert id="save1" parameterType="com.icia.member.dto.MemberMapperDTO">
	insert into member_table(member_email, member_password, member_name)
		values(#{member_email}, #{member_password}, #{member_name})
</insert>

---

Test

mapper에 회원가입(회원정보 저장)하는 쿼리문을 완성했으니 이제 Test를 해봅시다!

@Test
@Transactional
@Rollback
@DisplayName("mybatis 회원가입 테스트")
public void memberSaveTest1() {
	mmr.save1(new MemberMapperDTO("mybatis회원이메일", "mybatis회원비밀번호", "mybatis회원이름"));
}

@Test
@Transactional
@Rollback
@DisplayName("mybatis 회원가입 테스트 mapper X")
public void memberSaveTest2() {
	mmr.save2(new MemberMapperDTO("mybatis회원이메일", "mybatis회원비밀번호", "mybatis회원이름"));
}

---

회원가입 종료

위 테스트 코드가 성공이 되었다면 해당 메서드는 사용이 가능하다는 것입니다.
두 테스트 코드 다 같은 쿼리를 수행하는 작업이기 때문에 둘 중 편하신 방법으로 사용시면 될겁니다 :D

---

Mybatis로 목록 조회

이번에는 Mybatis로 목록조회까지 해봅시다!
각 사용법에 대한 설명은 회원가입 부분에서 설명을 했으므로 여기서는 생략하겠습니다.

---

Repository

// 목록 출력
List<MemberMapperDTO> memberList1();

@Select("select * from member_table")
List<MemberMapperDTO> memberList2();

---

Mapper

<select id="memberList1" resultType="com.icia.member.dto.MemberMapperDTO">
	select * from member_table
</select>

---

Test

@Test
@DisplayName("mybatis 목록 출력 테스트")
public void mybatisMemberListTest1() {
	List<MemberMapperDTO> memberDetailDTOList = mmr.memberList();
	for (MemberMapperDTO m: memberDetailDTOList) {
		System.out.println("m = " + m.toString());
	}
}

@Test
@DisplayName("mybatis 목록 출력 테스트 mapper X")
public void mybatisMemberListTest2() {
	List<MemberMapperDTO> memberDetailDTOList = mmr.memberList2();
	for (MemberMapperDTO m: memberDetailDTOList) {
		System.out.println("m = " + m.toString());
	}
}

---

목록 조회 종료

위 테스트 코드 실행 시 콘솔창에 회원 목록이 잘 출력 되면 성공입니다.

---

마치며

이렇게 회원관리 예제의 기능 2개를 예로 들어 Mybatis로 구현하는 방법에 대해 설명했습니다.
기존 Spring Framework와 설정 방법이 조금 다르지만 사용하는 방법은 거의 동일합니다!
그럼 다음시간엔 Interceptor에 대해 알아보도록 하고 다음에 건강한 모습으로 만나요 :D