[Spring] MyBatis 쿼리문 작성하기

🔻Spring 프로젝트에서 MyBatis 쿼리문 작성하기

파일 구성

패키지명(경로)	파일명
com.test.controller
	MyBatisController.java
com.test.persistence
	MyBatisDAO.java
	MyBatisDAOImpl.java
views
	list.jsp
src/main/resources/mapper
	mybatis.xml

 

mybatis.xml은 아래 글에서 설명했던 MyBatis 환경설정 시 mapperLocations으로 설정해둔 경로에 존재해야한다.

 

참조글:

https://steady-record.tistory.com/entry/Spring-MyBatis-와-Spring-연동하기2-DBCP-사용하기

[Spring] MyBatis 와 Spring 연동하기(2) : DBCP 사용하기

 

 

쿼리 작성 시 사용하는 파일의 역할

1. Controller에서 DB 작업을 DAO에게 위임한다.

2. 객체간 결합을 위해 interface로 선언한 DAO에서는 메소드명만 선언한다.

3. DAOImpl 파일에서는 DAO에서 선언한 메소드에 mybatis.xml에서 작성한 쿼리문을 호출하는 메소드를 작성한다.

4. mybatis.xml 파일에서 직접적인 쿼리문을 작성한다.

 

 

 

🔻쿼리의 경우의 수

반환값과 매개변수 유무에 따라 사용하는 메서드가 다르다.

이전 Servlet에서 사용했던 excuteUpdate, excuteQuery 메서드가 insert, update, delete, selectOne, selectList 으로 5가지로 세분화 되었다.

상황에 따라 5가지 메서드 중에서 골라 사용한다.

• 반환값이 없고 매개변수도 없는 쿼리
• 반환값이 없고 매개변수가 있는 쿼리
• 반환값이 있고 매개변수가 없는 쿼리
  • 반환값이 단일값일 때
  • 반환값이 레코드 1줄일 때
  • 반환값이 레코드 n줄일 때
• 반환값이 있고 매개변수가 있는 쿼리
  • 반환값이 단일값일 때
  • 반환값이 레코드 1줄일 때
  • 반환값이 레코드 n줄일 때

---

1. 반환값이 없고 매개변수도 없는 쿼리

변화없이 항상 똑같이 실행하는 쿼리를 정적쿼리라고 한다.

 

 

Controller.java

	@GetMapping(value="/m1.do")
	public String m1() {
		this.dao.m1();
		return "list";
	}

 

MyBatisDAO.java

public interface MyBatisDAO {
	void m1();
}

 

MyBatisDAOImpl.java

	@Override
	public void m1() {
		int result = this.template.update("mybatis.m1");
		System.out.println("적용된 행의 개수: " + result);
	}

 

MyBatis의 SqlSessionTemplate을 사용하여 SQL 매핑 파일에 정의된 "mybatis.m1"이라는 SQL 쿼리를 실행한다. mybaits 는 매핑 파일의 namespace를 의미하며 m1은 쿼리문의 id 명을 의미한다.

실행결과로는 적용된 행의 갯수를 반환(피드백)한다.

 

mybatis.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="mybatis"> 
	<update id="m1">
    		<!-- update tblMyBatis set age = age + 1; -->
		update tblMyBatis set age = age + 1
	</update>
</mapper>

 

id명은 해당 sql문을 사용할 메서드 이름을 주로 사용한다. 

결과

 

 

2. 반환값이 없고 매개변수가 있는 쿼리(단일값 매개변수)

Controller.java

	@GetMapping(value="/m2.do")
	public String m2(String seq, Model model) {
		int result = this.dao.m2(seq);
		model.addAttribute("result", result);
		return "list";
	}

 

매개변수 seq 앞에 @RequestParam(name="seq") 생략 되었다. 
m2.do?seq=5 와 같이 매개변수와 함께 m2 메소드를 호출한다.

 

MyBatisDAO.java

int m2(String seq);

 

 

MyBatisDAOImpl.java

	@Override
	public int m2(String seq) {
		return this.template.delete("mybatis.m2", seq);
	}

 

 

mybatis.xml

	<delete id="m2" parameterType="String">
		delete from tblMyBatis where seq = #{seq}
	</delete>

 

mybatis는 넘어온 값을 #{key}로 표현하지만 나중에 JDBC에서 #{key}에서 ?로 바뀐다.
데이터가 하나만 넘어왔기때문에 바인딩을 자동으로 해준다. 바인딩으로 key는 아무거나 써도 상관지만 가독성을 높이기위해 컬럼명과 동일하게 사용한다.

 

또한, 파라미터가 있을 때는 parameterType를 기재하는 것이 좋은데 클래스 자료형에 어디에 위치해있는지 패키지명을 반드시 기재해야한다.

String 이 속한 java.lang은 자바에서 기본적인 패키지로 유일하게 생략가능한 패키지이다.

 

결과

아래 주소로 seq 데이터를 송신하면서 m2를 호출한다.

http://localhost:8090/mybatis/m2.do?seq=2

 

삭제가 올바르게 되었다면서 작업된 행의 갯수인 1를 반환하였고,

 

mybatis 테이블을 select 해보면 seq가 2인 행이 삭제된 것을 볼 수 있다.

 

 

 

3. 반환값이 없고 매개변수가 있는 쿼리(다중값 매개변수)

Controller.java

	@GetMapping(value="/m3.do")
	public String m3(Model model) {
		
		MyBatisDTO dto = new MyBatisDTO();
		dto.setName("수수깡");
		dto.setAge("26");
		dto.setAddress("서울시 강남구");
		dto.setGender("f");
		
		int result = this.dao.m3(dto);
		
		model.addAttribute("result", result);
		
		return "list";
	}

 

MyBatisDAO.java

int m3(MyBatisDTO dto);

 

MyBatisDAOImpl.java

	@Override
	public int m3(MyBatisDTO dto) {
		return this.template.insert("mybatis.m3", dto);
	}

 

데이터를 보낼 때는 하나이던, 여러개이던 인자값을 하나만 넘길 수 있다. 그래서 여러개의 값을 넘길 때는 dto로 포장해서 넘긴다.

 

mybatis.xml

	<insert id="m3" parameterType="com.test.domain.MyBatisDTO">
		insert into tblMyBatis (seq, name, age, address, gender) values (seqMyBatis.nextVal, #{name}, #{age}, #{address}, #{gender})
	</insert>

 

파라미터 타입이 DTO인 경우 패키지명을 반드시 기재한다.

 

결과

DB 반영 완료

 

 

 

 

4. 반환값이 없고 매개변수가 있는 쿼리(다중값 매개변수)

Controller.java

	@GetMapping(value="/m4.do")
	public String m4(Model model) {
		HashMap<String, String>map = new HashMap<String, String>(); 
		
		map.put("seq", "4");
		map.put("address", "서울시 강남구 역삼동");
		
		int result = this.dao.m4(map);
		
		model.addAttribute("result", result);
		
		return "list";
	}

 

MyBatisDAO.java

int m4(HashMap<String, String> map);

 

MyBatisDAOImpl.java

	@Override
	public int m4(HashMap<String, String> map) {
		return this.template.update("mybatis.m4", map);
	}

 

mybatis.xml

	<!-- <update id="m4" parameterType="java.util.HashMap"> -->
	<update id="m4" parameterType="map">
		update tblMyBatis set address = #{address} where seq = #{seq}
	</update>

 

파라미터 타입이 HashMap일 때 패키지명을 풀로 기재하는 방법과 생략하여 map으로 기재하는 방법이 있다.

 

결과

주소 변경 완료

 

 

 

5. 반환값이 있고 매개변수가 없는 쿼리 (반환값 - 단일값)

Controller.java

	@GetMapping(value="/m5.do")
	public String m5(Model model) {
		int count = this.dao.m5();
		
		model.addAttribute("count", count);
		
		return "list";
	}

 

MyBatisDAO.java

	int m5();

 

MyBatisDAOImpl.java

	@Override
	public int m5() {
		return this.template.selectOne("mybatis.m5");
	}

 

selectOne 실행한 결과값은 담는 매개변수의 자료형에 따라 변한다.
String 변수에 담으면 String으로 반환하고, int 변수에 담으면 int로 반환한다. 
이전 JDBC 방법과 달리, resultset에 담아서 조회할 필요 없이 selectOne 하나의 메서드로 해결할 수 있다.

 

mybatis.xml

	<select id="m5" resultType="Integer">
		select count(*) from tblMyBatis
	</select>

 

반환값이 있을 때는 resultType으로 반환값의 형식을 지정한다. Integer도 java.lang 패키지에 속하므로 생략이 가능하다.

 

결과

 

 

6. 반환값이 있고 매개변수가 없는 쿼리 (반환값 - 레코드 1줄)

Controller.java

	@GetMapping(value="/m6.do")
	public String m6(String seq, Model model) {
		MyBatisDTO dto = this.dao.m6(seq);
		
		model.addAttribute("dto", dto);
		
		return "list";
	}

 

MyBatisDAO.java

MyBatisDTO m6(String seq);

 

MyBatisDAOImpl.java

	@Override
	public MyBatisDTO m6(String seq) {
		return this.template.selectOne("mybatis.m6", seq);
	}

 

mybatis.xml

	<select id="m6" parameterType="String" resultType="com.test.domain.MyBatisDTO">
		select * from tblMyBatis where seq = #{seq}
	</select>

 

행 1줄을 반환받을 때는 dto로 받는다.

자동으로 컬럼명과 변수를 매핑하기 위해서는 태그 네임, 멤버 변수 이름, 컬럼명 3가지가 같아야 한다.

 

결과

seq가 1번인 레코드 1줄

 

 

 

7. 반환값이 있고 매개변수가 없는 쿼리 (반환값 - 레코드 n줄, 컬럼 1개)

Controller.java

	@GetMapping(value="/m7.do")
	public String m7(Model model) {
		List<String> names = this.dao.m7();
		
		model.addAttribute("names", names);
		
		return "list";
	}

 

MyBatisDAO.java

List<String> m7();

 

MyBatisDAOImpl.java

	@Override
	public List<String> m7() {

		/*
		String sql = "";
		stat = conn.createStatment();
		rs = stat.excuteQuery(sql);
		
		List<String> names = new ArrayList<String>();
		
		while(rs.next()) {
			names.add(rs.getString("name"));
		}
		
		return list;
		
		 */
		
		return this.template.selectList("mybatis.m7");
	}

 

JDBC에서는 조회한 쿼리문의 결과값이 resultSet을 list나 dto로 옮겨담아 반환했다.

하지만 MyBatis에서는 번거로운 작업없이 한 줄로 작성이 가능하다. 

 

mybatis.xml

	<select id="m7" resultType="String">
		select name from tblMyBatis
	</select>

 

n행을 조회할 때는 resultType에는 1행의 자료형만 기재한다.

name를 조회하는 쿼리문으로 이름 하나는 자료형이 String이기에 List<String>이 아닌 String으로 기재한다.

 

결과

 

 

 

8. 반환값이 있고 매개변수가 없는 쿼리 (반환값 - 레코드 n줄, 컬럼 n개)

Controller.java

	@GetMapping(value="/m8.do")
	public String m8(Model model) {
		List<String> list = this.dao.m8();
		
		model.addAttribute("list", list);
		
		return "list";
	}

 

MyBatisDAO.java

List<String> m8();

 

MyBatisDAOImpl.java

	@Override
	public List<String> m8() {
		
		/*
		String sql = "";
		stat = conn.createStatment();
		rs = stat.excuteQuery(sql);
		
		List<MyBatisDTO> names = new ArrayList<MyBatisDTO>();
		
		while(rs.next()) {
			MyBatisDTO dto = new MyBatisDTO();
			dto.setSeq(rs.getString("seq"));
			dto.setName(rs.getString("name"));
			dto.setAge(rs.getString("age"));
			
			list.add(dto);
		}
		
		return list;
		
		 */

		return this.template.selectList("mybatis.m8");
	}

 

JDBC에서는 조회한 쿼리문의 결과값이 resultSet을 list나 dto로 옮겨담아 반환했다.

하지만 MyBatis에서는 번거로운 작업없이 한 줄로 작성이 가능하다. 

 

mybatis.xml

	<select id="m8" resultType="com.test.domain.MyBatisDTO">
		select * from tblMyBatis
	</select>

 

 

결과

 

 

 

 

9. 매개변수 있고, 반환값도 있는 쿼리

경우에 따라 조회할 테이블이 다른데 하나의 메소드 안에서 해결하고 싶을 때, 주소에 테이블명도 함께 넘긴다.

'm9.do?table=테이블명' 와 같이 매개변수로 테이블명을 입력받고 입력한 테이블명에 따라 다르게 조회한다.

	@GetMapping(value="/m9.do")
	public String m9(Model model, String table) {
		
		int count = this.dao.m9(table);
		
		model.addAttribute("count", count);
		
		return "list";
	}

 

MyBatisDAO.java

int m9(String table);

 

MyBatisDAOImpl.java

	@Override
	public int m9(String table) {
		return this.template.selectOne("mybatis.m9", table);
	}

 

mybatis.xml

	<select id="m9" parameterType="String" resultType="Integer">
		select count(*) from ${table}
	</select>

 

식별자 바인딩

mybatis에서 #{key}로 데이터 바인딩을 한다. 하지만 자료형에 따라 표기가 달라지기도 한다. #{key}을 parameterType="String"으로 넘기면 자동으로 쿼리문에 꽃따옴표(')를 붙인다.

만약, 식별자를 String으로 넘기면 쿼리문에 꽃따옴표가 붙어 원하는대로 조회되지않는다. 그래서 식별자를 매개변수로 넘기고 싶으면 식별자 바인딩인 ${key}로 표기한다.

 

결과

 

테이블 마다 레코드 수가 잘 출력된다.

 

 

 

10. 쿼리에 비교연산자 사용하기

Controller.java

	
	@GetMapping(value="/m10.do")
	public String m10(Model model) {
		
		int count = this.dao.m10();
		
		model.addAttribute("count", count);
		
		return "list";
	}

 

MyBatisDAO.java

int m10();

 

MyBatisDAOImpl.java

	@Override
	public int m10() {
		return this.template.selectOne("mybatis.m10");
	}

 

mybatis.xml

	<select id="m10" resultType="Integer">
		<!-- select count(*) from tblMyBatis where age &lt;= 25 -->		<!-- 가독성이 떨어진다. -->
		
		select count(*) from tblMyBatis 
		<![CDATA[
		where age <= 25
		]]>
	</select>

 

CDATA 섹션

마크업 언어에서는 비교연산자(<, >)는 태그의 꺽쇠와 분별을 못해 인식을 못한다. 

그래서 문자 엔티티를 사용하는데 이는 가독성이 떨어진다는 문제가 있다.

이럴 때 CDATA 섹션을 사용한다.

CDATA 섹션을 사용하면 XML 파서가 해당 부분을 문자 데이터로 취급하게 되어, XML 예약 문자나 특수 문자를 그대로 사용할 수 있다.

 

 

결과

 

25세 이하인 쿼리의 수는 2개이므로 레코드 수 2개가 잘 출력되었다.

 

 

 

11. 주소 검색 (like 절 사용하기)

Controller.java

	
	@GetMapping(value="/m11.do")
	public String m11(Model model, String word) {
		
		//주소 검색 (like 절 사용)
		List<MyBatisDTO> list = this.dao.m11(word);
		
		model.addAttribute("list", list);
		
		return "list";
	}

 

MyBatisDAO.java

List<MyBatisDTO> m11(String word);

 

MyBatisDAOImpl.java

	@Override
	public List<MyBatisDTO> m11(String word) {
		return this.template.selectList("mybatis.m11", word);
	}

 

mybatis.xml

	<select id="m11" parameterType="String" resultType="com.test.domain.MyBatisDTO">
		select * from tblMyBatis where address like '%${word}%'
	</select>

 

 

결과

 

 

 

12. 동적 쿼리(if 문)

 

m12.do?type=1 일때는 select first_name from employees;
m12.do?type=2 일 때는 select last_name from employees;

 

Controller.java

	@GetMapping(value="/m12.do")
	public String m12(Model model, String type) {
		
		List<String> names = dao.m12(type);
		model.addAttribute("names", names);
		return "list";
	}

 

MyBatisDAO.java

List<String> m12(String type);

 

MyBatisDAOImpl.java

	@Override
	public List<String> m12(String type) {
		return this.template.selectList("mybatis.m12", type);
	}

 

mybatis.xml

	<select id="m12" parameterType="String" resultType="String">
	
		<!-- 
		<if test="type == 1">
			select first_name from employees
		</if>
		
		<if test="type == 2">
			select last_name from employees
		</if>
		 -->
		select
			<if test="type == 1"> first_name</if>
			<if test="type == 2"> last_name</if>
		from employees
		
	</select>

 

if 문을 사용하여 type ==1 또는 type==2 일 때 해당 쿼리를 실행하게 한다.

 

 

13. 동적 쿼리(choose 문)

Controller.java

이름 검색 시, m13.do?column=name&word=홍길동
주소 검색 시, m13.do?column=address&word=역삼
나이 검색 시, m13.do?column=age&word=25

	//동적쿼리
	@GetMapping(value="/m13.do")
	public String m13(Model model, String column, String word) {
		
		HashMap<String, String> map = new HashMap<String, String>();
		map.put("column", column);
		map.put("word", word);
		
		List<MyBatisDTO> list = this.dao.m13(map);
		
		model.addAttribute("list", list);
		
		return "list";
	}

 

MyBatisDAO.java

List<MyBatisDTO> m13(HashMap<String, String> map);

 

MyBatisDAOImpl.java

	@Override
	public List<MyBatisDTO> m13(HashMap<String, String> map) {
		return this.template.selectList("mybatis.m13", map);
	}

 

mybatis.xml

	<select id="m13" parameterType="map" resultType="com.test.domain.MyBatisDTO">
		select * from tblMyBatis
		
			<choose>
				<when test="column == 'name'">
					where name = #{word}
				</when>
				<when test="column == 'address'">
					where address like '%' || #{word} || '%'
				</when>
				<otherwise>
					<![CDATA[ where age <= #{word} ]]>
				</otherwise>
			</choose>
			
	</select>

 

map의 key를 사용할 때는 #이나 $를 붙일 필요없이 바로 사용한다. 

 

 

결과

 

 

---

+) Error : Mapped Statements collection does not contain value for '매퍼.메서드'

mapper의 id를 틀리게 기재하였을 경우 발생한다. 

DAOImpl.java 파일의 mapper명, 매핑 xml 파일의 mpper namespace 명이 동일한지와 메서드 명이 동일한지 확인한다.

 

mapper 명은 대소문자 구별을 하므로 주의하여 작성한다.