냉장고 가계부 프로젝트 6

JdbcTemplate 을 사용하여 DB에 객체 데이터를 저장하고 관리하는 것보다 Java Persistence API (JPA) 기술 표준을 사용하면 생산성이 훨씬 향상된다. JPA 를 구현하는 프레임워크들 중에서는 Hibernate가 가장 많이 사용되고 있다. 이제는 JPA와 Hibernate가 같은 의미로 불리기도 한다.
JdbcTemplate이나, MyBatis 를 이용하면 SQL Query문을 벤더에 맞게 직접 작성하게 되고, CRUD 같은 쿼리의 경우 단순하게 반복/중복적으로 표현된다.
ex)MyBatis

<select id="findByUsername" parameterType="String" resultType="User">
    SELECT * FROM users WHERE username = #{username}
</select>

ex)JPA

public interface UserRepository extends JpaRepository<User, String> {
    User findByUsername(String username);
}

위의 MyBatis는  보통 UserDao.xml 의 쿼리문을 저장하는 XML 파일이 있고, UserDao.java 인터페이스가 따로 존재한다.
이렇듯 JPA는 생산성이 좋고, MyBatis는 쿼리문을 직접 작성하니까 해당 벤더에 특화된 쿼리문을 작성해서 성능에 이점이 있다. 이 두가지 장점을 다 가져가려면 단순한 쿼리는 JPA를 이용하고, 통계나 리포트같은 부분은 MyBatis를 이용하면 된다.

JPA를 사용하기 위해서는 pom.xml 에 spring-boot-starter 를 data-jpa로 수정한다.

    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-data-jpa</artifactId>
    </dependency>

그리고 src/main/resource Application.properties에 애플리케이션 설정을 등록한다.

spring.jpa.hibernate.ddl-auto=validate

spring.jpa.show-sql=true

spring.jpa.properties.hibernate.format_sql=true

spring.jpa.hibernate.ddl-auto 프로퍼티는 다음과 같은 설정 값을 가진다.

• create : 테이블을 생성한다. (기존 테이블은 삭제)
• create-drop: create와 같으며, 종료시 drop한다.
• update: 기존 테이블구조에서 변경 부분만 반영한다.
• validate: Entity 클래스와 테이블 매핑이 정상적인지 확인한다.
• none: 아무것도 하지 않는다.

spring.jpa.show-sql 프로퍼티는 jpa 의 쿼리를 로그로 보일지 여부를 나타낸다.
spring.jpa.properties.hibernate.format_sql 프로퍼티는 쿼리 로그가 쿼리 포맷에 맞춰 로그를 보일지 나타낸다. false일 경우 쿼리가 한줄로 보인다.

JPA 기능을 테스트하기 위해서 JpaFoodRepositoryTests  클래스를 작성하고 다음과 같이 작성한다.

@RunWith(SpringRunner.class)
@DataJpaTest
public class JpaFoodRepositoryTests {
    
}

Spring Boot Test 프레임워크에서 제공하는 @DataJpaTest 애너테이션을 사용하면 디폴트 설정으로, 인메모리 DB를 사용하며, 트랜잭션 애너테이션이 선언되어 있고, ComponentScan으로 Entity 모델을 찾는다.

    @Autowired
    private JpaFoodRepository jpaFoodRepository;

    @Test
    public void save() {
        Food cola = new Food("코카콜라 500mL", 2, "2018-10-30");
        jpaFoodRepository.save(cola);
        Food food = jpaFoodRepository.findOne(cola.getId());
        assertThat(food.getName()).isEqualTo(cola.getName());
    }

콜라 객체를 저장하고, 다시 불러오는 테스트 메서드를 작성한다. 다음은 JpaFoodRepository 인터페이스이다.

public interface JpaFoodRepository extends JpaRepository<Food, Long> {

}

JpaRepository 인터페이스를 상속받는데, 첫번째 제네릭에  매핑할 Entity 모델 클래스 타입을 입력한다. 여기서는 Food 클래스를 넣고있다. 그리고 두번째에 Entity에서 ID 로 선언되어있는 멤버변수의 타입을 입력한다. Food 클래스가 DB테이블 food와 매핑되고 있으므로 Food 클래스를 Entity로 선언한다.

@Entity
@Table(name="food")
public class Food implements Cloneable {
    @Id
    @GeneratedValue(strategy=GenerationType.IDENTITY)
    private Long id;

Food 클래스에 @Entity 애너테이션을 선언하고, @Table 애너테이션으로 Food클래스가 매핑되는 테이블명을 입력한다. id 멤버변수에는 해당 변수가 이 엔티티의 Primary Key를 나타내는 @Id 애너테이션이 선언되어있다. 뒤이어 @GeneratedValue 애너테이션은 해당 테이블이 자동증가되는 키 컬럼일 경우 선언하는데 생성전략은 GenerationType enum에서 선택할 수 있다.

• TABLE: 테이블에서 키를 생성해서 사용하는 경우
• SEQUENCE: 오라클처럼 Sequence를 사용하는 경우
• IDENTITY: MySQL처럼 auto_increment를 사용하는 경우
• AUTO: 오라클은 Sequence, MySQL 은 IDENTITY 처럼 벤더에 맞게 자동설정

이렇게 선언하고 테스트를 수행해서 문제가 없음을 확인한다.
Hibernate의 영속성 관리는 transient, managed, detached, removed 로 구분된다.
(자세한 설명은 여기를 참조.)
간단히 말하면,

• transient는 객체가 막 생겨나서 식별자도 없는 상태
• managed(persistent) 는 데이터가 DB에 존재하고 영속성이 관리되는 상태
• detached 는 식별자가 있지만 영속성 관리가 끝난 상태
• removed 는 영속성 관리가 되고 있지만, 삭제될 예정인 상태

다음의 update 테스트 메서드는 cola 객체를 save 한 후, 영속성 관리대상인 cola 인스턴스의 quantity값을 변경하고 flush 메서드로 버퍼를 비우면 insert 구문이 실행되고 뒤이어 update쿼리가 실행되는 것을 로그로 확인할 수 있다.

    @Test
    public void update() {
        Food cola = new Food("코카콜라 500mL", 2, "2018-10-30");
        jpaFoodRepository.save(cola);
        
        cola.decreaseQuantity(1);
        jpaFoodRepository.flush();
        Food savedCola = jpaFoodRepository.findOne(cola.getId());
        assertThat(savedCola.getQuantity()).isEqualTo(1);
    }

Entity 도메인 모델은 default 생성자가 있어야 한다. 지금은 모든 멤버변수를 생성자를 통해 받아서 문제가 없지만 향후 멤버변수가 늘어날것을 대비해서 Food클래스를 수정한다.
JpaFoodRepository 클래스는 src/main/java 의 repository 패키지로 옮긴다.

기존 FoodService 인터페이스에 트랜잭션이 필요없는 find 메서드들은 빼고, 인터페이스에 @Transactional 애너테이션을 선언해서 구현클래스에서 다시 선언할 필요가 없도록 중복을 제거한다. 그리고 find 메서드들은 필요시 repository에서 바로 호출할것이므로 서비스에서 불필요한 메서드들은 삭제한다.(MemoryFoodService 는 테스트 용도이므로 그냥 둔다)

public interface FoodService {
    @Transactional
    Food save(Food food);
    
    @Transactional
    boolean remove(Food food);
    
    @Transactional
    void removeAll();
}

JpaFoodService 클래스를 작성하고 추상메서드들을 구현한다. JpaFoodRepository에 위임하는 방식이다. JdbcFoodService 와 다를게 없다.

@Service
public class JpaFoodService implements FoodService {
    
    @Autowired
    private JpaFoodRepository jpaFoodRepository;

    @Override
    public Food save(Food food) {
        return jpaFoodRepository.save(food);
    }

    @Override
    public boolean remove(Food food) {
        jpaFoodRepository.delete(food);
        return true;
    }

    @Override
    public void removeAll() {
        jpaFoodRepository.deleteAll();
    }

}

이번에는 목록표를 클라이언트에서 조회하고 추가, 수정, 삭제할 수 있도록 웹서비스를 작성한다.
서비스를 요청받고 제공하는 계층은 컨트롤러에서 책임을 지고 있다. FoodControllerTests 클래스를 작성하고 테스트를 메서드를 만든다.

@RunWith(SpringRunner.class)
@WebMvcTest(FoodController.class)
public class FoodControllerTests {
    
    @Autowired
    private MockMvc mvc;
    
    private ObjectMapper mapper = new ObjectMapper();
    
    @Test
    public void findAllFoods() throws Exception {
        String expectedJson = mapper.writeValueAsString(Arrays.asList(new Food("파스퇴르 우유 1.8L", 1, "2018-09-28")));
        mvc.perform(get("/foods").accept(MediaType.APPLICATION_JSON))
            .andExpect(status().isOk())
            .andExpect(content().contentType(MediaType.APPLICATION_JSON_UTF8))
            .andExpect(content().json(expectedJson));
    }
    
}

테스트 클래스에 @WebMvcTest 라는 애너테이션이 선언되어있다. @WebMvcTest 애너테이션을 선언하면 스프링 MVC가 자동설정되고, @Controller 애너테이션을 ComponentScan하며 MockMvc 객체를 설정해서 사용할 수 있도록 한다. MockMvc는 컨트롤러들을 테스트할 수 있다.

findAllFoods 테스트 메서드는 Accept 헤더가 application/json 을 수용할 수 있는 /foods 경로를 Get 방식으로 호출을 실행한다.
그리고 응답으로 HttpStatus 상태코드가 200(ok), body 내용이 application/json; utf-8 타입이며, body의 json이 Food List를 json 형태로 되는것을 테스트한다.
아래는 FoodController 이다.

@RestController
@RequestMapping("/foods")
public class FoodController {
    
    @RequestMapping(method=RequestMethod.GET)
    public List<Food> findAllFoods() {
        return Arrays.asList(new Food("파스퇴르 우유 1.8L", 1, "2018-09-28"));
    }

}

@RestController 애너테이션으로 선언해서 @ResponseBody 애너테이션은 생략가능하다. 클래스에 @RequestMapping을 선언함으로써 FoodController의 mapping uri 는 /foods 로 시작하고 메서드마다 @RequestMapping으로 중첩선언할 수 있다. findAllFoods 메서드는 Get 방식으로만 호출가능하며, 별도로 선언된 url이 없으므로 /foods 가 된다. 응답 결과는 Food List 형태이다.

테스트가 정상 처리되었으면, FoodController 클래스의 findAllFoods 메서드가 Repository 의 데이터를 반환하도록 수정한다. 그리고 테스트 메서드도 수정한다.
컨트롤러는 다음과 같이 구현한다.

    @Autowired
    private JpaFoodRepository jpaFoodRepository;
    
    @RequestMapping(method=RequestMethod.GET)
    public List<Food> findAllFoods() {
        return jpaFoodRepository.findAll();
    }

테스트 클래스는 다음과 같이 수정한다.

    @MockBean
    JpaFoodRepository jpaFoodRepository;
    
    @Test
    public void findAllFoods() throws Exception {
        List<Food> foods = Arrays.asList(new Food("파스퇴르 우유 1.8L", 1, "2018-09-28"));
        given(jpaFoodRepository.findAll()).willReturn(foods);
        
        String expectedJson = mapper.writeValueAsString(foods);
        mvc.perform(get("/foods").accept(MediaType.APPLICATION_JSON))
            .andExpect(status().isOk())
            .andExpect(content().contentType(MediaType.APPLICATION_JSON_UTF8))
            .andExpect(content().json(expectedJson));
    }

@WebMvcTest 애너테이션은 @Controller 애너테이션만 ComponentScan 으로 Bean으로 관리하므로, 테스트 시작시간이 빠르다. 모든 빈을 다 등록하지 않기 때문이다. 그래서 FoodController 클래스에서 호출하는 JpaFoodRepository Bean 등록이 되지않기에 ApplicationContext 초기화에 실패하게 된다.
이부분을 @MockBean 이라는 애너테이션을 이용해서 클래스를 선언하고 mockito 의 mock() 메서드 처럼 jpaFoodRepository.findAll 메서드가 호출되었을 때(given), 결과로 foods 변수가 리턴된다고 선언해두면, MockMvc 클래스가 컨트롤러의 기능을 테스트할때 mockBean 이 bean 으로 등록되므로 테스트를 실행할 수 있다.
이전글: 냉장고 가계부 프로젝트 5
다음글: 냉장고 가계부 프로젝트 7