[11] 기본적인 웹 게시물 관리 - 영속/비즈니스 계층의 CRUD 구현

영속 계층의 작업은 항상 다음과 같은 순서로 진행한다.

• 테이블의 칼럼 구조를 반영하는 VO 클래스의 생성
• MyBatis의 Mapper 인터페이스의 작성/XML 처리
• 작성한 Mapper 인터페이스의 테스트

위의 과정 전에 먼저 JDBC 연결을 테스트 하는 과정을 거치는 것이 좋지만, SQL Developer의 연결 자체가 이미 JDBC 연결을 이용하기 때문에 예제에서는 별도의 과정을 생략하고 진행하겠다.

 

1. 영속 계층의 구현 준비

1-1. VO 클래스의 작성

VO 클래스를 작성하는 작업은 테이블 설계를 기준으로 작성하면 된다. 현재 tbl_board 테이블의 구성은 아래와 같다.

1-2. 프로젝트에 org.zerock.domain 패키지를 생성하고, BoardVO클래스를 정의한다. 그리고 아래와 같은 코드를 작성한다.

package org.zerock.domain;

import java.util.Date;
import lombok.Data;

@Data
public class BoardVO {

		private Long bno;
		private String title;
		private String content;
		private String writer;
		private Date regdate;
		private Date updateDate;
}

 

BoardVO 클래스는 Lombok을 이용해서 생성자와 getter/setter, toString() 등을 만들어 내는 방식을 사용한다. 이를 위해 @Data 어노테이션을 적용한다.

 

1-3. Mapper 인터페이스와 Mapper XML

MyBatis는 SQL을 처리하는데 어노테이션이나 XML을 이용할 수 있다. 간단한 SQL이라면 어노테이션을 이용해서 처리하는 것이 무난하지만, SQL이 점점 복잡해지고 검색과 같이 상황에 따라 다른 SQL문이 처리되는 경우에는 어노테이션은 그다지 유용하지 못하다는 단점이 있다. XML의 경우 단순 텍스트를 수정하는 과정만으로 처리가 끝나지만, 어노테이션의 경우 코드를 수정하고 다시 빌드 하는 등의 유지 보수성이 떨어지는 이유로 기피하는 경우도 종종 있다. 

 

• Mapper 인터페이스 (약간 기피하는 방법 - 어노테이션 때문에)

1) Mapper 인터페이스를 작성할 때는 리스트와 등록 작업을 우선해서 작성한다. org.zerock.mapper 패키지를 작성하고 BoardMapper 인터페이스를 추가한다.

 

package org.zerock.mapper;

import java.util.List;

import org.apache.ibatis.annotations.Select;
import org.zerock.domain.BoardVO;

public interface BoardMapper {

	@Select("select * from tbl_board where bno > 0")
	public List<BoardVO> getList();
}

 

BoardMapper 인터페이스를 작성할 때는 이미 작성된 BoardVO 클래스를 적극적으로 활용해서 필요한 SQL을 어노테이션의 속성값으로 처리할 수있다.

 

2) 작성된 BoardMapper 인터페이스를 테스트 할 수 있게 테스트 환경인 'src/test/java'에 'org.zerock.mapper' 패키지를 작성하고 BoardMapperTests 클래스를 추가한다.

 

package org.zerock.mapper;

import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;

import lombok.Setter;
import lombok.extern.log4j.Log4j;

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration("file:src/main/webapp/WEB-INF/spring/root-context.xml")
@Log4j
public class BoardMapperTests {
	
	@Setter(onMethod_ = @Autowired)
	private BoardMapper mapper;
	
	@Test
	public void testGetList() {
		mapper.getList().forEach(board -> log.info(board));
	}
}

 

BoardMapperTests 클래스는 스프링을 이용해서 BoardMapper 인터페이스의 구현체를 주입받아서 동작하게 한다.

 

3) 실행 결과

 

• Mapper XML 파일

1) BoardMapperTests를 이용해서 테스트가 완료되었다면 src/main/resources 내에 패키지와 동일한 org/zerock/mapper 단계의 폴더를 생성하고 XML 파일을 작성한다. (폴더는 꼭 하나씩 생성하기! - 에러가 날 수도 있음)

파일의 폴더 구조나 이름은 무방하지만 패키지와 클래스 이름과 동일하게 해주면 나중에 혼란스러운 상황을 피할 수 있다!

 

2) BoardMapper.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="org.zerock.mapper.BoardMapper">

<select id = "getList" resultType="org.zerock.domain.BoardVO">
<![CDATA[
select * from tbl_board where bno > 0
]]>
</select>
</mapper>

 

XML을 작성할 때는 반드시 <mapper>의 namespace 속성값을 Mapper 인터페이스와 동일한 이름을 주는 것에 주의하고, <select> 태그의 id 속성값은 메서드의 이름과 일치하게 작성한다. resultType 송성의 값은 select 쿼리의 결과를 특정 클래스의 객체로 만들기 위해서 설정한다. XML에 사용한 CDATA 부분은 XML에서 부등호를 사용하기 위해서 사용한다.

 

3) XML에 SQL 문이 처리되었으니 BoardMapper 인터페이스에 SQL은 제거한다. 

 

4) 기존의 테스트 코드를 통해 동일하게 동작하는지 확인한다.

에러 없이 나오는 아주 흐뭇한 모습

 

2. 영속 영역의 CRUD 구현

웹 프로젝트 구조에서 마지막 영역이 영속 영역이지만, 실제로 구현을 가장 먼저 할 수 있는 영역도 영속 영역이다. 영속 영역은 기본적으로 CRUD 작업을 하기 때문에 테이블과 VO등 약간의 준비만으로 비즈니스 로직과 무관하게 CRUD 작업을 작성할 수 있다. MyBatis는 내부적으로 JDBC의 PreparedStatement를 활용하고 필요한 파라미터를 처리하는 '?'에 대한 치환은 '#{속성}'을 이용해서 처리한다.

 

2-1. create(insert) 처리

tbl_board 테이블은 PK 칼럼으로 bno를 이용하고, 시퀀스를 이용해서 자동으로 데이터가 추가될 때 번호가 만들어지는 방식을 사용한다. 이처럼 자동으로 PK 값이 정해지는 경우에는 다음과 같은 2가지 방식으로 처리할 수 있다.

• insert만 처리되고 생성된 PK 값을 알 필요가 없는 경우
• insert문이 실행되고 생성된 PK 값을 알아야 하는 경우

2-1-1. BoardMapper 인터페이스에는 위의 상황들을 고려해서 다음과 같이 메서드를 추가 선언한다.

	public void insert(BoardVO board);
	
	public void insertSelectKey(BoardVO board);

 

2-1-2. BoardMapper.xml도 다음과 같이 내용을 추가한다.

<insert id = "insert">
	insert into tbl_board (bno, title, content, writer)
	values (seq_board.nextval, #{title}, #{content}, #{writer})
</insert>

<insert id = "insertSelectKey">
	<selectKey keyProperty="bno" order="BEFORE"
		resultType="long">
		select seq_board.nextval from dual	
	</selectKey>
	
	insert into tbl_board (bno, title, content, writer)
	values (#{bno}, #{title}, #{content}, #{writer})
</insert>

 

BoardMapper의 insert()는 단순히 시퀀스의 다음 값을 구해서 insert 할 때 사용한다. insert 문은 몇 건의 데이터가 변경되었는지만을 알려주기 때문에 추가된 데이터의 PK 값을 알 수는 없지만, 1번의 SQL 처리만으로 작업이 완료되는 장점이 있다.

 

insertSelectKey()는 @SelectKey 라는 MyBatis의 어노테이션을 이용한다. @SelectKey는 주로 PK 값을 미리 SQL을 통해서 처리해 두고 특정한 이름으로 결과를 보관하는 방식이다. @Insert 할 때 SQL문을 보면 #{bno}와 같이 이미 처리된 결과를 이용하는 것을 볼 수 있다.

 

2-1-3. 우선 insert()에 대한 테스트 코드를 src/main/java/ 내에 BoardMapperTests 클래스에 새로운 메서드를 작성한다.

	@Test
	public void testInsert() {
		
		BoardVO board = new BoardVO();
		board.setTitle("새로 작성하는 글");
		board.setContent("새로 작성하는 내용");
		board.setWriter("newbie");
		
		mapper.insert(board);
		
		log.info(board);
	}

 

테스트 코드의 마지막에 log.info(board) 를 작성한 이유는 Lombok이 만들어주는 toString()을 이용해서 bno 멤버변수의 값을 알아보기 위함이다. 

 

2-1-4. 실행결과

 

테스트 결과의 마지막을 살펴보면 bno의 값이 null로 비어있는 것을 확인 할 수 있다.

 

2-1-5. @SelectKey를 이용하는 경우

	@Test
	public void testInsertSelectKey() {
		
		BoardVO board = new BoardVO();
		board.setTitle("새로 작성하는 글");
		board.setContent("새로 작성하는 내용");
		board.setWriter("newbie");
		
		mapper.insertSelectKey(board);
		
		log.info(board);
	}

 

실행되는 결과를 살펴보면 'select seq_board.nextval from dual'과 같은 쿼리가 먼저 실행되고 여기서 생성된 결과를 이용해서 bno 값으로 처리되는 것을 볼 수 있다. BoardMapper의 insertSelectKey()의 @Insert 문의 SQL을 보면 'insert into tbl_board (bno, title, content, writer) values (#{bno}, #{title}, #{content}, #{writer})와 같이 파라미터로 전달되는 BoardVO의 bno값을 사용하게 되었다.

 

테스트 코드의 마지막 부분을 보면 BoardVO 객체의 bno 값이 이전과 달리 지정된 것을 볼 수 있다. (시퀀스의 값이므로 현재 테스트하는 환경마다 다른 값이 나온다). @SelectKey를 이용하는 방식은 SQL을 한 번 더 실행하는 부담이 있기는 하지만 자동으로 추가되는 PK값을 확인해야 하는 상황에서는 유용하게 사용될 수 있다.

 

2-2. read(select) 처리

insert가 된 데이터를 조회하는 작업은 PK를 이용해서 처리하므로 BoardMapper의 파라미터 역시 BoardVO 클래스의 bno 타입 정보를 이용해서 처리한다.

 

2-2-1. BoardMapper.java 인터페이스에 추가한다.

	public BoardVO read(Long bno);

 

2-2-2. BoardMapper.xml 에 추가한다.

<select id = "read" resultType = "org.zerock.domain.BoardVO">
	select * from tbl_board where bno = #{bno}
</select>

 

MyBatis는 Mapper 인터페이스의 리턴 타입에 맞게 select 결과를 처리하기 때문에 tbl_board의 모든 칼럼은 BoardVO의 'bno, title, content, writer, regdate, updatDate' 속성값으로 처리된다. 좀 더 엄밀하게 말하면 MyBatis는 bno라는 칼럼이 존재하면 인스턴스의 'setBno()'를 호출하게 된다. MyBatis의 모든 파라미터와 리턴 타입의 처리는 get 파라미터명 (), set 칼럼명 () 의 규칙으로 호출된다. 다만 위와 같이 #{속성}이 1개만 존재하는 경우에는 별도의 get 파라미터명()을 사용하지 않고 처리된다.

 

2-2-3. 테스트 코드에 다음과 같은 메서드를 추가한다.

	@Test
	public void testRead() {
		
		// 존재하는 게시물 번호로 테스트
		BoardVO board = mapper.read(3L);
		
		log.info(board);
	}

 

mapper.read()를 호출할 경우에는 현재 테이블에 있는 데이터의 bno 값이 존재하는지 여부를 반드시 확인해야 한다.

 

2-2-4. 실행 결과

 

2-3. delete 처리

특정한 데이터를 삭제하는 작업 역시 PK 값을 이용해서 처리하므로 조회하는 작업과 유사하게 처리한다. 등록, 삭제, 수정과 같은 DML 작업은 '몇 건의 데이터가 삭제되었는지'를 반환할 수 있다.

 

2-3-1. BoardMapper 인터페이스에 다음과 같은 메서드를 추가한다.

	public int delete(Long bno);

 

2-3-2. BoardMapper.xml에 다음과 같은 코드를 추가한다.

<delete id = "delete">
	delete from tbl_board where bno = #{bno}
</delete>

 

delete() 메서드 리턴 타입은 int로 지정해서 만일 정상적으로 데이터가 삭제되면 1 이상의 값을 가지도록 작성한다. 테스트 코드는 현재 테이블에 존재하는 번호의 데이터를 삭제해 보고 '1'이라는 값이 출력되는지 확인한다. 만일 해당 번호의 게시물이 없다면 '0'이 출력된다.

 

2-3-3. 테스트 코드에 다음과 같은 메서드를 추가한다.

	@Test
	public void testDelete() {
		
		log.info("DELETE COUNT :" + mapper.delete(3L));
	}

 

2-3-4. 실행화면

 

2-4. Update 처리

Update는 Delete와 마찬가지로 '몇 개의 데이터가 수정되었는가'를 처리할 수 있게 int 타입으로 메서드를 설계할 수 있다.

 

2-4-1. 인터페이스에 다음과 같은 메서드를 추가한다.

	public int update(BoardVO board);

 

2-4-2. xml 파일에 다음과 같은 코드를 추가한다.

<update id = "update">
	update tbl_board
	set title = #{title},
	content = #{content},
	writer = #{writer},
	updateDate = sysdate
	where bno = #{bno}
</update>

 

SQL에서 주의 깊게 봐야 하는 부분은 update 칼럼이 최종 수정 시간을 위미하는 칼럼이기 때문에 현재 시간으로 반영해 주고 있다는 점과, regdate 칼럼은 최초 생성 시간이므로 건드리지 않는다는 점이다. #{title}과 같은 부분은 파라미터로 전달된 BoardVO 객체의 getTitle()과 같은 메서드들을 호출해서 파라미터들이 처리된다.

 

2-4-3. 테스트 코드를 작성한다.

	@Test
	public void testUpdate() {
		BoardVO board = new BoardVO();
		// 실행전 존재하는 번호인지 확인 할 것
		board.setBno(3L);
		board.setTitle("수정된 제목");
		board.setContent("수정된 내용");
		board.setWriter("user00");
		
		int count = mapper.update(board);
		log.info("UPDATE COUNT : " + count);
	}

 

2-4-4. 결과화면 

 

 

참고 자료