영속/비즈니스 계층의 CRUD 구현

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

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

8.1 영속 계층의 구현 준비

거의 모든 웹 애플리케이션의 최종 목적은 데이터베이스에 데이터를 기록하거나, 원하는 데이터를 가져오는 것이 목적이기 때문에 개발할 때 어느 정도의 설계가 진행되면 데이터베이스 관련 작업을 하게 된다.

 

 

8.1.1 VO 클래스의 작성

VO 클래스를 생성하는 작업은 테이블 설계를 기준으로 작성하면 된다.

현재 tb1_board 테이블의 구성은 아래와 같다.

프로젝트에 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 등 만들어 내는 방식을 사용했다. @Data 어노테이션 적용

 

 

8.1.2 Mapper 인터페이스와 Mapper XML

XML의 경우 단순 텍스트를 수정하는 과정만으로 처리가 끝나지만, 어노테이션의 경우 코드를 수정하고 다시 빌드 하는 등의 유지 보수성이 떨어지는 이유로 기피하는 경우가 있다.

 

◆ Mapper 인터페이스

Mapper 인터페이스를 작성할 때는 리스트(select)와 등록 (insert) 작업을 우선해서 작성한다.

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 tb1_board where bno >0")
    public List<BoardVO> getList();
}
 

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

 

# SQL Developer에서 먼저 확인하는 것이 좋다.

이유는 1) SQL이 문제가 없이 실행 가능한지를 확인하기 위한 용도

2) 데이터베이스의 commit을 하지 않았다면 나중에 테스트 결과가 달라지기 때문에 이를 먼저 비교할 수 있도록 하기 위함이다.

 

sql devleoper 에서 먼저 실행

 

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 인터페이스의 구현체를 주입받아서 동작하게 된다.

testGetList()의 결과는 SQL developer에서 실행된 것과 동일해야만 정상적으로 동작한 것이다.

 

실행 결과

 

◆ Mapper XML 파일

src/main/resources 내에 패키지에 동일한 org/zerock/mapper 단계의 폴더를 생성하고 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 tb1_board where bno>0
]]>
</select>
 
</mapper>

 

XML 을 작성할 때는 반드시 <mapper> 의 namespace 속성값을 Mapper 인터페이스와 동일한 이름으로 해줘야 한다.

<select> 태그의 id 속성값은 메서드의 이름과 일치하게 작성한다.

resultType 속성의 값은 select 쿼리의 결과를 특정 클래스의 객체로 만들기 위해 설정한다.

XML에 사용한 CDATA 부분은 XML에서 부등호를 사용하기 위해 사용한다.

 

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

인터페이스 수정 후에는 반드시 기존의 테스트 코드를 통해서 기존과 동일하게 동작하는지 확인해야 한다.

 

실행 결과

 

---

8.2 영속 영역의 CRUD 구현

웹 프로젝트 구조에서 마지막 영역이 영속 영역이지만, 실제로 구현을 가장 먼저 할 수 있는 영역도 영속 영역이다.

영속 영역은 기본적으로 CRUD 작업을 하기 때문에 테이블과 VO(DTO) 등 약간의 준비만으로도 비즈니스 로직과 무관하게 CRUD 작업을 작성할 수 있다.

MyBatis 는 내부적으로 JDBC의 PreparedStatement를 활용하고 필요한 파라미터를 처리하는 '?' 에 대한 치환은 '#{속성}' 을 이용해서 처리한다.

 

 

8.2.1 create (insert) 처리

tbl_board 테이블 → PK 칼럼으로 bno를 이용, 시퀀스를 이용해서 자동으로 데이터가 추가될 때 번호가 만들어지는 방식

이처럼 자동으로 PK 값이 정해지는 경우에 2가지 방식으로 처리할 수 있다.

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

 

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

 

<insert id="insert">
        insert into tb1_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 tb1_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}와 같이 이미 처리 된 결과를 이용하는 것을 볼 수 있다.

 

 

@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 멤버 변수의 값을 알아보기 위함이다.

테스트 결과의 마지막을 살펴보면 BoardVO 클래스의 toString()의 결과가 출력되는 것을 볼 수 있는데, bno의 값이 null로 비어 있는 것을 확인할 수 있다.

 

실행 결과

 

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

 

실행 결과

 

실행되는 결과를 살펴보면 'select seq_board.nextval from dual'과 같은 쿼리가 먼저 실행되고 여기서 생성된 결과를 이용해서 bno 값으로 처리되는 것을 볼 수 있다.

BoardMapper의 insertSelectKey()의 @Insert 문의 SQL을 보면 'insert into tb1_board (bno,title,content,writer) values (#{bno}, #{title}, #{content}, #{writer})와 같이 파라미터로 전달되는 BoardVO의 bno 값을 사용하게 되어 있다.

테스트 코드의 마지막 부분을 보면 BoardVO 객체의 bno 값이 이전과 달리 지정된 것을 볼 수 있다. (시퀀스 값은 중복 없는 값을 위한 것일 뿐 다른 의미가 있지 않다)

@SelectKey를 이용하는 방식은 SQL 을 한 번 더 실행하는 부담이 있기는 하지만 자동으로 추가되는 pk 값을 확인해야 하는 상황에서는 유용하게 사용될 수 있다.

 

 

8.2.2 read(select) 처리

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

 

public BoardVO read (Long bno);

 

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

MyBatis 는 Mapper 인터페이스의 리턴 타입에 맞게 select 결과를 처리하기 때문에 tb1_board의 모든 칼럼은  BoardVO의 'bno,title,content,writer,regdate,updateDate' 속성값으로 처리된다.

MyBatis는 bno라는 칼럼이 존재하면 인스턴스의 'setBno()'를 호출하게 된다.

MyBatis의 모든 파라미터와 리턴 타입의 처리는 get 파라미터명(), set 칼럼명()의 규칙으로 호출된다.

다만 위와 같이 #{속성}이 1개만 존재하는 경우에는 별도의 get 파라미터명()을 사용하지 않고 처리된다.

 

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

 

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

실행 결과

 

 

8.2.3 delete 처리

특정한 데이터를 삭제하는 작업 역시 PK 값을 이용해서 처리하므로 조회하는 작업과 유사하게 처리한다.

등록, 삭제, 수정과 같은 DML 작업은 '몇 건의 데이터가 삭제(혹은 수정) 되었는지'를 반환할 수 있다.

 

public int delete (Long bno);

 

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

 

delete()의 메서드 리턴 타입은 int 로 지정해서 만일 정상적으로 데이터가 삭제되면 1 이상의 값을 가지도록 작성한다.

테스트 코드는 현재 테이블에 존재하는 번호의 데이터를 삭제해 보고 '1' 이라는 값이 출력되는지 확인한다.

만일 해당 번호의 게시물이 없다면 '0'이 출력된다.

 

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

 

testDelete()의 경우 3번 데이터가 존재했다면 다음과 같은 로그가 기록된다.

 

 

 

8.2.4 update 처리

마지막으로 update 처리를 한다. 

게시물의 업데이트는 제목, 내용, 작성자를 수정한다고 가정한다.

업데이트할 때는 최종 수정시간을 데이터베이스 내 현재 시간으로 수정한다.

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

 

public int update(BoardVO board);

 

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

update 칼럼이 최종 수정시간을 의미하는 칼럼이기 때문에 현재 시간으로 변경해 주고 있다.

regdate 칼럼은 최초 생성 시간이므로 건드리지 않는다.

#{title}과 같은 부분은 파라미터로 전달된 BoardVO 객체의 getTitle()과 같은 메서드들을 호출해서 파라미터들이 처리된다.

 

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

 

테스트 코드는 read()를 이용해서 가져온 BoardVO 객체의 일부를 수정하는 방식이나 직접 BoardVO 객체를 생성해서 처리할 수 있다.

 

 

---

출처 : 코드로 배우는 스프링 웹 프로젝트 [구멍가게 코딩단]