[Spring] MyBatis 와 Spring 연동하기(3) : Interface Mapper를 사용한 연동

MyBatisSimple Project🔎

MyBatis 적용 방법에는 두가지 방식이 있다.
1. XML Mapper 를 사용하는 방식
2. Interface Mapper를 사용하는 방식

Interface Mapper를 사용하는 방식이 XML Mapper를 사용하는 방식보다 간단하여 더 추천한다.

 

※XML Mapper를 사용하는 방식은 아래 글을 참고한다.

https://steady-record.tistory.com/entry/Spring-MyBatis-와-Spring-연동하기1-XML-Mapper를-사용한-연동

[Spring] MyBatis 와 Spring 연동하기(1) : XML Mapper를 사용한 연동

---

- 파일 구성

패키지(경로)	하위 패키지(경로)	파일명
src/test/java	com.test.persistence	MapperTest.java
src/main/java	com.test.mapper	TestMapper.java(I)
src/main/resources	com > test > mapper	TestMapper.xml

 

mapper.xml 파일 만들 때는 폴더 생성을 주의해야 한다.

다른 패키지와 다르게 com, test, mapper 순으로 순차적으로 폴더를 생성한다.

---

- 환경설정

1. 기초 환경

https://steady-record.tistory.com/entry/Spring-스프링-프로젝트-설정-일괄-적용

[Spring] 스프링 프로젝트 설정 일괄 적용

 

2. root-context.xml 수정

mybatis-spring 태그 설정

Namespaces 탭에서 mybatis-spring 체크 후 저장

 

 

인터페이스 매퍼를 인식하는 코드 한 줄을 추가한다.

<mybatis-spring:scan base-package="com.test.mapper"/>

 

---

- Mapper 인터페이스 만들기

src/main/java에 com.test.mapper 패키지 생성 후 TestMapper interface 파일을 생성한다.

Interface Mapper 방식에서는 TestMapper interface 파일이 SQL 실행하는 담당자가 된다.

이전 XML Mapper 방식 때 사용하던 SqlSessionTemplate 사용하지 않고 TestMapper interface가 대신 담당하는 것이다.

 

 

TestMapper.java

package com.test.mapper;

import org.apache.ibatis.annotations.Select;

//인터페이스 매퍼
public interface TestMapper {
	
	@Select("select count(*) from tblAddress")	
	String getTime();
}

 

추상메서드 위에 @Select, @Insert, @Update 등 어노테이션으로 쿼리문을 작성한다.

 

어노테이션 방식의 장점은 편리하다는 것이다.

SQL 쿼리가 Java 코드 내에 인터페이스 메소드로 정의되어 있기 때문에, 코드 가독성이 좋다. 또한, SQL 쿼리가 코드와 밀접하게 연결되어 있어 개발자가 쿼리를 쉽게 파악할 수 있다.

 

하지만,  SQL 를 문자열로 표현하므로 동적 쿼리를 표현할 때는 상대적으로 어렵다. 그리고 엔터를 자유롭게 사용할 수 없어 가독성이 떨어질 수 있다는 단점이 있다.

 

이런 단점을 해소하기 위해 XML 파일로 쿼리를 분리할 수 있다.

---

- 쿼리 분리

어노테이션에 기재한 쿼리를 xml 파일로 분리할 수 있다.

 

XML 위치한 폴더는 반드시 인터페이스 매퍼가 들어있는 패키지와 구조가 동일해야한다.

인터페이스 매퍼의 패키지는 com.test.mapper으로 XML 파일은 아래와 같이 생성한다.

src/main/resources 패키지 하위,
com 폴더 > test 폴더 > mapper 폴더 > TestMapper.xml 파일

 

어노테이션에 경로를 따로 지정하지 않아도 인터페이스 매퍼가 XML 위치를 인식할 수 있게 된다.

 

TestMapper.java

public interface TestMapper {
	
	@Select("select count(*) from tblAddress")	
	String getTime();
	
	String getTime2();
}

 

String getTime2();

어노테이션 없이 추상메서드만 작성한다.

 

TestMapper.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.test.mapper.TestMapper">

	<select id="getTime2" resultType="String">
		select sysdate from dual
	</select>

</mapper>

 

namespace에는 호출한 인터페이스 경로를 적어 연동을 시켜준다.

그리고, id에는 추상메소드의 이름을 적는다.

 

 

Interface Mapper 방식으로도 쿼리를 작성하는 방법에는 2가지가 있다.

1. 어노테이션

2. XML 파일 분리

보통, 간단한 쿼리는 어노테이션 방식으로 사용하고 복잡한 쿼리는 xml 파일에 적어 혼용하여 사용한다.

---

주소록 데이터 접근하기🔎

interface Mapper 방식으로 주소록 데이터를 접근한다.

 

- 파일 구성  

패키지(경로)	하위 패키지(경로)	파일명
src/main/java	com.test.controller	AddressController.java
	com.test.domain	AddressDTO.java
	com.test.mapper	AddressMappper.java(I)
src/main/resources	com > test > mapper	AddressMapper.xml
WEB-INF	views	list.jsp

 

- 전체 주소록 조회하기

AddressController.java

@Controller
public class AddressController {
	
	@Autowired
	private AddressMapper mapper;
	
	@GetMapping(value = "/list.do")
	public String list(Model model) {

		model.addAttribute("list", mapper.list());
		return "list";
	}
}

 

AddressMapper.java

public interface AddressMapper {
	
	@Select("select * from tblAddress")
	List<AddressDTO> list();
}

 

어노테이션 방식으로 쿼리문을 작성했다.

 

결과 페이지

 

 

- 특정 회원 검색하기

AddressController.java

@Controller
public class AddressController {
	
	@Autowired
	private AddressMapper mapper;
	
	@GetMapping(value = "/list.do")
	public String list(Model model) {

		model.addAttribute("dto", mapper.get());
		return "list";
	}
}

 

AddressMapper.java

public interface AddressMapper {
	AddressDTO get();
}

 

 

AddressMapper.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.test.mapper.AddressMapper">

	<select id="get" resultType="com.test.domain.AddressDTO">
		select * from tblAddress where seq = 22
	</select>
</mapper>

 

 

결과 페이지

 

---

📢org.xml.sax.SAXParseException

에러는 xml에서 문제가 생겨 발생하는 에러이다.

namespace는 잘 작성됐는지, id는 틀리지않았는지  xml파일을 잘 살펴보도록한다.