기본 콘텐츠로 건너뛰기

냉장고 가계부 프로젝트 4

목록표를 데이터베이스에 저장할 수 있다.
우선, 데이터베이스 저장 기능을 추가하기 전에 소스코드를 정리한다.
Food 클래스의 equals 메서드도 Guava의 equal메서드를 이용한다.
    @Override
    public boolean equals(Object obj) {
        if (this == obj)
            return true;
        if (obj == null || getClass() != obj.getClass())
            return false;
        Food other = (Food) obj;
        return Objects.equal(id, other.id);
    }

테스트하면서 생성했던 Food 클래스와 MemoryFoodService 클래스는 src/main/java로 옮긴다.
com.poseidon.fridge 패키지 아래에 model 과 service 패키지를 각각 생성하고 Food 클래스는 model 로 MemoryFoodService 는 service 패키지 아래로 옮긴다.

FoodTests 클래스에 Food 클래스 테스트 메서드와 MemoryFoodService 테스트 메서드가 섞여있는것도 정리한다. MemoryFoodServiceTests 클래스를 새로 만들고 FoodTests에서 MemoryFoodService 관련 테스트 메서드들을 옮기고 FoodTests를 정리한다.

DB는 간단하게 HSQLDB을 사용하고, JDBC는 스프링에서 제공하는 JdbcTemplate를 사용한다.
pom.xml 에 라이브러리 의존성을 추가/수정한다.
  <dependency>
   <groupId>org.springframework.boot</groupId>
   <artifactId>spring-boot-starter-jdbc</artifactId>
  </dependency>
  
  <dependency>
    <groupId>org.hsqldb</groupId>
    <artifactId>hsqldb</artifactId>
  </dependency>

HSQLDB에서 사용할 테이블 쿼리 파일을 src/main/resources 폴더에 작성한다. 파일명은 schema.sql 이다.
CREATE TABLE food (
    id BIGINT GENERATED BY DEFAULT AS IDENTITY(START WITH 1, INCREMENT BY 1) PRIMARY KEY,
    name VARCHAR(32) NOT NULL,
    quantity INTEGER DEFAULT 0 NOT NULL,
    expiry_date VARCHAR(10)
);

food 테이블은 Food객체의 멤버변수와 매칭된다. 여기서 좀 복잡해보이는 id 컬럼의 GENERATED BY ... 부분은 테이블내에서 로우가 생성되면 자동으로 증가하는 부분을 설정하며, 1부터 시작하고 1씩 증가한다.

JDBC 테스트 클래스를 작성해서 간단한 DB연동 테스트를 한다.
package com.poseidon.fridge;


import static org.hamcrest.CoreMatchers.equalTo;
import static org.junit.Assert.assertThat;

import javax.sql.DataSource;

import org.junit.Test;
import org.springframework.jdbc.core.JdbcTemplate;
import org.springframework.jdbc.datasource.embedded.EmbeddedDatabaseBuilder;
import org.springframework.jdbc.datasource.embedded.EmbeddedDatabaseType;

public class JdbcFoodServiceTests {
    
    @Test
    public void connect() {
        DataSource dataSource = new EmbeddedDatabaseBuilder()
                .setType(EmbeddedDatabaseType.HSQL)
                .addScript("classpath:schema.sql")
                .build();
        JdbcTemplate jdbcTemplate = new JdbcTemplate(dataSource);
        int count = jdbcTemplate.queryForObject("SELECT 1 FROM INFORMATION_SCHEMA.SYSTEM_USERS", int.class);
        assertThat(count, equalTo(1));
    }

}

EmbeddedDatabaseBuilder 클래스를 이용해서 내장데이터베이스를 생성한다. 데이터베이스 종류는 H2, Derby, HSQL 세가지중에서 선택할 수 있고, 쿼리파일의 경로를 addScript로 전달하면 객체가 생성될때 쿼리를 실행한다. build 메서드는 EmbeddedDatabase 인터페이스를 반환하는데, DataSource 를 상속받았으므로, DataSource 객체로 인스턴스를 할당한다.
JdbcTemplate 은 스프링에서 JDBC API를 추상화 해 놓은 JdbcOperations 인터페이스의 구현클래스이다.
기존의 Connection, PreparedStatement, Statement 와 같은 API를 깔끔하게 정리해놓아서 쓰기 편하다.
생성자 또는 setter 방식으로 DataSource를 전달받아서 객체를 생성하면 해당 DB에 접근할 수 있다.
간단한 접속 테스트 쿼리는 Oracle 의 SELECT 1 FROM DUAL 처럼 1을 리턴하는 HSQLDB 쿼리다. count 변수값은  1이 됨을 예상한다. 이를 테스트하면 성공한다.

JdbcTemplate API를 좀 더 간단하게 테스트하는 메서드를 만든다. 이번엔 insert 기능을 테스트해본다.
    @Test
    public void insert() {
        DataSource dataSource = new EmbeddedDatabaseBuilder()
                .setType(EmbeddedDatabaseType.HSQL)
                .addScript("classpath:schema.sql")
                .build();
        JdbcTemplate jdbcTemplate = new JdbcTemplate(dataSource);
        
        Food milk = new Food("파스퇴르 우유 1.8L", 1, "2018-09-28");
        int affectedRows = jdbcTemplate.update("INSERT INTO food (name, quantity, expiry_date) values (?,?,?)", 
                milk.getName(), milk.getQuantity(), milk.getExpiryDate());
        assertThat(affectedRows, equalTo(1));
        int count = jdbcTemplate.queryForObject("SELECT COUNT(*) FROM food", int.class);
        assertThat(count, equalTo(1));
    }

DataSource를 생성하고 JdbcTemplate 생성자에 주입하는 부분은 connect() 테스트 메서드와 동일하다.
insert 쿼리를 jdbcTemplate의 update메서드의 첫번째 파라미터로 전달하고, 두번째 파라미터부터는 가변인자들로 values의 순서에 맞게 milk의 getter메서드를 호출한다.
update 메서드의 리턴값은 int형 값을 반환하는데 쿼리의 영향을 받은 로우의 수를 의미한다.
뒤이어서 나오는 테스트에서는 1개의 레코드만 insert 하였으므로 affectedRows 변수값에는 1이 대입되는것을 예상한다.
테이블은 DB가 생성될때 아무런 데이터가 없으므로 insert 쿼리가 정상적으로 처리되었다면 queryForObject 메서드를 통해 count 쿼리가 1이됨을 예상하는 테스트 구문이다.
이번에는 insert() 테스트 메서드만 단독으로 수행해서 테스트 결과를 확인한다.

두개의 테스트 메서드를 작성하면서 DataSource와 JdbcTemplate이 중복된다. DataSource는 테이블 생성쿼리가 있으므로 한번만 실행되야 한다. jUnit은 테스트 메서드마다 독립 수행되고 어떤 테스트메서드가 먼저 실행될지는 알 수 없다. 독립시행을 원칙으로 하기때문에 앞의 테스트 메서드가 뒤의 테스트메서드에 의존되면 안된다. 따라서 dataSource 객체 생성 구문을 static 멤버 변수로 옮긴다.
그리고 JdbcTemplate 객체 생성구문도 jUnit before 애너테이션으로 테스트 수행전에 실행될 수 있도록 정리한다.
    private static DataSource dataSource = new EmbeddedDatabaseBuilder()
            .setType(EmbeddedDatabaseType.HSQL)
            .addScript("classpath:schema.sql")
            .build();
    private JdbcTemplate jdbcTemplate;
    
    @Before
    public void setUp() {
        jdbcTemplate = new JdbcTemplate(dataSource);
    }
    
    @Test
    public void connect() {
        int count = jdbcTemplate.queryForObject("SELECT 1 FROM INFORMATION_SCHEMA.SYSTEM_USERS", int.class);
        assertThat(count, equalTo(1));
    }
    
    @Test
    public void insert() {
        Food milk = new Food("파스퇴르 우유 1.8L", 1, "2018-09-28");
        int affectedRows = jdbcTemplate.update("INSERT INTO food (name, quantity, expiry_date) values (?,?,?)", 
                milk.getName(), milk.getQuantity(), milk.getExpiryDate());
        assertThat(affectedRows, equalTo(1));
        int count = jdbcTemplate.queryForObject("SELECT COUNT(*) FROM food", int.class);
        assertThat(count, equalTo(1));
    }

이번에는 insert 쿼리가 실행될때 Food 테이블에서 자동 증가하는 IDENTITY 증가 값을 받아오는 부분을 테스트한다. JdbcTemplate 클래스의 update 메서드 오버로딩 중에서 PreparedStatementCreator 인터페이스를 첫번째 파라미터로 받는 메서드가 있다. 이 메서드 두번째 파라미터는 KeyHolder 인터페이스를 받는다.
        Food cola = new Food("코카콜라 500mL", 2, "2018-10-30");
        final KeyHolder keyHolder = new GeneratedKeyHolder();
        affectedRows = jdbcTemplate.update(new PreparedStatementCreator() {
            @Override
            public PreparedStatement createPreparedStatement(Connection con) throws SQLException {
                PreparedStatement ps = con.prepareStatement(
                        "INSERT INTO food (name, quantity, expiry_date) values (?,?,?)", 
                        Statement.RETURN_GENERATED_KEYS);
                ps.setString(1, cola.getName());
                ps.setInt(2, cola.getQuantity());
                ps.setString(3, cola.getExpiryDate());
                return ps;
            }
        }, keyHolder);
        cola.setId(keyHolder.getKey().longValue());

cola 객체를 새로 생성해서 준비해둔다. KeyHolder 객체의 구현 클래스 GeneratedKeyHolder 를 생성해서 자동생성된 키를 받을 수 있도록 준비한다.
내부 익명 클래스를 생성해서 PreparedStatemet 객체를 반환하는 createPreparedStatement 메서드를 구현한다. insert 쿼리를 준비해주고, Statement 인터페이스의 static 변수 RETURN_GENERATED_KEYS 를 preparedStatement 두번째 파라미터로 전달한다.
jdbcTemplate.update 메서드 내부에서 콜백 형태로 keyHolder 의 값이 들어온다.
DB에서 자동생성된 키의 값을 getKey 메서드로 가져와서 milk에 setId 설정자에 넘겨준다.
insert 가 잘 반영되었는지 테스트를 작성한다.
        assertThat(affectedRows, equalTo(1));
        count = jdbcTemplate.queryForObject("SELECT COUNT(*) FROM food", int.class);
        assertThat(count, equalTo(2));
        assertThat(cola.getId(), notNullValue());

테스트가 성공했다. update, delete, select 기능을 테스트하기 전에 중복되는 코드를 정리정돈하고 테스트해서 망가진것은 없는지 확인 후 새로운 테스트를 작성한다.
food 테이블의 총 레코드 수를 반환하는 count 쿼리가 중복되고, insert 쿼리도 food 테이블에 한정해서는 자동생성키를 받아서 id 멤버변수에 set 해주는 두번째 insert 메서드 하나면 충분하다.
두 구문을 메서드로 빼내서 중복을 제거한다.
    @Test
    public void insert() {
        Food milk = new Food("파스퇴르 우유 1.8L", 1, "2018-09-28");
        int affectedRows = insert(milk);
        assertThat(affectedRows, equalTo(1));
        assertThat(count(), equalTo(1));
        
        Food cola = new Food("코카콜라 500mL", 2, "2018-10-30");
        affectedRows = insert(cola);
        
        assertThat(affectedRows, equalTo(1));
        assertThat(count(), equalTo(2));
        assertThat(cola.getId(), notNullValue());
    }

    private int count() {
        return jdbcTemplate.queryForObject("SELECT COUNT(*) FROM food", int.class);
    }

    private int insert(Food food) {
        int affectedRows;
        final KeyHolder keyHolder = new GeneratedKeyHolder();
        affectedRows = jdbcTemplate.update(new PreparedStatementCreator() {
            @Override
            public PreparedStatement createPreparedStatement(Connection con) throws SQLException {
                PreparedStatement ps = con.prepareStatement(
                        "INSERT INTO food (name, quantity, expiry_date) values (?,?,?)", 
                        Statement.RETURN_GENERATED_KEYS);
                ps.setString(1, food.getName());
                ps.setInt(2, food.getQuantity());
                ps.setString(3, food.getExpiryDate());
                return ps;
            }
        }, keyHolder);
        food.setId(keyHolder.getKey().longValue());
        return affectedRows;
    }

food 테이블의 count 쿼리 메서드는 count() 로 빼내고, insert쿼리도 insert(Food food)로 빼내면 테스트 메서드의 중복을 줄일 수 있다.

jdbcTemplate.update 메서드는 insert, update, delete 쿼리에 다 사용된다. delete 쿼리의 간단한 테스트는 다음과 같다.
    @Test
    public void deleteAll() {
        jdbcTemplate.update("DELETE FROM food");
        assertThat(count(), equalTo(0));
    }

food 테이블 전체 데이터를 다 삭제한 후 count 메서드를 통해 검증한다.
insert() 테스트 메서드의 내용을 보면 insert 후 테이블 전체 레코드 수를 통해 검증을 하는데, 이 부분은 다른 테스트 메서드에 의해 영향을 받을 수 있다. 즉, 다른 테스트 메서드에 의해서 food 테이블의 레코드 수가 0개가 아닐 경우, insert 테스트 메서드의 테스트는 실패하게 된다. 이를 방지하기 위해 delete 쿼리를 따로 메서드로 빼내고, @Before 애너테이션으로 선언된 setUp 메서드에 delete 메서드를 호출해서 매 테스트마다 데이터를 삭제하게 되면, 각 테스트 메서드들은 독립적이게 된다.
    @Test
    public void delete_all() {
        deleteAll();
        assertThat(count(), equalTo(0));
    }

    private void deleteAll() {
        jdbcTemplate.update("DELETE FROM food");
    }

테스트 메서드명이 중복되서 deleteAll 메서드를 delete_all 메서드로 변경했다.
    @Before
    public void setUp() {
        jdbcTemplate = new JdbcTemplate(dataSource);
        deleteAll();
    }

food 테이블의 전체 레코드를 반환하는 쿼리를 테스트한다. 
    @Test
    public void select_all() {
        List<Food> foods = Arrays.asList(
                new Food("파스퇴르 우유 1.8L", 1, "2018-09-28"),
                new Food("코카콜라 500mL", 2, "2018-10-30")
        );
        for(Food food : foods) {
            insert(food);
        }
        List<Food> storeFoods = jdbcTemplate.query("SELECT * FROM food", new RowMapper<Food>() {
            @Override
            public Food mapRow(ResultSet rs, int rowNum) throws SQLException {
                Food food = new Food(rs.getString("name"),
                        rs.getInt("quantity"),
                        rs.getString("expiry_date"));
                food.setId(rs.getLong("id"));
                return food;
            }
        });
        assertThat(storeFoods.size(), equalTo(2));
        assertThat(storeFoods.get(0).getName(), equalTo(foods.get(0).getName()));
    }

select쿼리는 jdbcTemplate의 query메서드를 이용하면 되는데, 두번째 파라미터가 RowMapper 인터페이스로 쿼리 결과를 자바 객체로 매핑해준다.
단일 Row를 결과로 받는 select 쿼리 테스트 메서드도 작성한다.
    @Test
    public void selectOne() {
        Food milk = new Food("파스퇴르 우유 1.8L", 1, "2018-09-28");
        int affectedRows = insert(milk);
        assertThat(affectedRows, equalTo(1));
        
        Food storeFood = jdbcTemplate.queryForObject("SELECT * FROM food WHERE id=?", 
                new RowMapper<Food>() {
                    @Override
                    public Food mapRow(ResultSet rs, int rowNum) throws SQLException {
                        Food food = new Food(rs.getString("name"),
                                rs.getInt("quantity"),
                                rs.getString("expiry_date"));
                        food.setId(rs.getLong("id"));
                        return food;
                    }
                }, 
                milk.getId());
        assertThat(storeFood.getId(), equalTo(milk.getId()));
    }

테스트가 성공하고 나면 RowMapper 익명 클래스가 중복되고 있는것이 확인된다. RowMapper 익명 클래스를 외부로 꺼내서 멤버변수에 선언하면 중복이 제거된다.
    @Test
    public void select_all() {
        List<Food> foods = Arrays.asList(
                new Food("파스퇴르 우유 1.8L", 1, "2018-09-28"),
                new Food("코카콜라 500mL", 2, "2018-10-30")
        );
        for(Food food : foods) {
            insert(food);
        }
        List<Food> storeFoods = jdbcTemplate.query("SELECT * FROM food", foodRowMapper);
        assertThat(storeFoods.size(), equalTo(2));
        assertThat(storeFoods.get(0).getName(), equalTo(foods.get(0).getName()));
    }
    
    @Test
    public void selectOne() {
        Food milk = new Food("파스퇴르 우유 1.8L", 1, "2018-09-28");
        int affectedRows = insert(milk);
        assertThat(affectedRows, equalTo(1));
        
        Food storeFood = jdbcTemplate.queryForObject("SELECT * FROM food WHERE id=?", 
                foodRowMapper, 
                milk.getId());
        assertThat(storeFood.getId(), equalTo(milk.getId()));
    }
    
    private static RowMapper<Food> foodRowMapper = new RowMapper<Food>() {
        @Override
        public Food mapRow(ResultSet rs, int rowNum) throws SQLException {
            Food food = new Food(rs.getString("name"),
                    rs.getInt("quantity"),
                    rs.getString("expiry_date"));
            food.setId(rs.getLong("id"));
            return food;
        }
    };

insert메서드나 deleteAll메서드처럼 모듈의 재활용성을 위해 jdbcTemplate의 query, queryForObject 메서드 부분을 메서드로 추출한다.
    private Food findById(Long id) {
        return jdbcTemplate.queryForObject("SELECT * FROM food WHERE id=?", foodRowMapper, id);
    }
    
    private List<Food> findAll() {
        return jdbcTemplate.query("SELECT * FROM food", foodRowMapper);
    }

정리가 다되면 테스트를 한번 실행해서 초록불을 확인하고 다음 테스트 작성을 진행한다. 마지막 update 관련 테스트도 작성하고 수행한다. 성공하면 메서드로 추출하고 정리정돈한다.
    @Test
    public void updateFood() {
        Food cola = new Food("코카콜라 500mL", 2, "2018-10-30");
        int affectedRows = insert(cola);
        assertThat(affectedRows, equalTo(1));
        
        cola.decreaseQuantity(1);
        assertThat(cola.getQuantity(), equalTo(1));
        
        affectedRows = update(cola);
        assertThat(affectedRows, equalTo(1));
        
        Food storeFood = findById(cola.getId());
        assertThat(storeFood.getQuantity(), equalTo(cola.getQuantity()));
    }

    private int update(Food food) {
        return jdbcTemplate.update("UPDATE food SET quantity=? WHERE id=?", food.getQuantity(), food.getId());
    }

이전글: 냉장고 가계부 프로젝트 3
다음글: 냉장고 가계부 프로젝트 5
라벨:

이 블로그의 인기 게시물

Dolphin 1

금융감독원 OPEN API를 사용하여 데이터 수집 금융감독원 금융상품통합비교공시 사이트에서 제공하는 OPEN API 를 사용합니다. 먼저, API 키를 신청합니다. https://finlife.fss.or.kr/PageLink.do?link=openapi/certification&menuId=2000119  로 접속합니다. 약관에 동의하고 본인인증 후, 신상정보를 넘기면 바로 API 키를 받을 수 있습니다. 상세 및 테스트 페이지를 들어가보면 요청 파라미터와 응답 API 형태를 확인할 수 있습니다. 요청은 다음과 같습니다. 읽어보면 서비스 명에 따라 url이 달라지는 부분을 제외하면 요청 URL은 크게 달라지지 않습니다. 파라미터에 인증키, 권역코드, 페이지번호를 전달하면 됩니다. 응답부분은 서비스마다 다르지만 공통 응답 형태는 다음과 같습니다. 에러코드, 에러메시지, 전체 개수, 전체 페이지, 현재 페이지 번호 입니다. 예금상품 조회 서비스나 적금상품 조회 서비스의 경우 공통적으로 금융회사 코드와 이름을 전달해주는데 해당 금융회사의 상세한 정보를 보려면 금융회사 조회 서비스도 호출하는게 나중에 좋을것 같습니다. Spring으로 HTTP 통신을 위해서 Apache HttpComponent 라이브러리를 사용합니다. 메이븐에 다음과 같이 의존성을 추가합니다. <dependency> <groupId>org.apache.httpcomponents</groupId> <artifactId>httpclient</artifactId> </dependency> 다음은 API를 호출하는 간단한 소스코드 조각입니다. CloseableHttpClient httpClient = HttpClients.createDefault(); URI uri = new URIBuilder() .setScheme("http") .setHos...
자세한 내용 보기

Effective Java

생성자 대신 정적 팩터리 메서드를 사용할 수 없는지 생각해 보라 생성자 인자가 많을 때는 Builder 패턴 적용을 고려하라 private 생성자나 enum 자료형은 싱글턴 패턴을 따르도록 설계하라 객체 생성을 막을 때는 private 생성자를 사용하라 불필요한 객체는 만들지 말라 유효기간이 지난 객체 참조는 폐기하라 종료자 사용을 피하라 equals를 재정의할 때는 일반 규약을 따르라 equals를 재정의할 때는 반드시 hashCode도 재정의하라 toString은 항상 재정의하라 clone을 재정의할 때는 신중하라 Comparable 구현을 고려하라 클래스와 멤버의 접근 권한은 최소화하라 public 클래스 안에는 public 필드를 두지 말고 접근자 메서드를 사용하라 변경 가능성을 최소화하라 계승하는 대신 구성하라 계승을 위한 설계와 문서를 갖추거나, 그럴 수 없다면 계승을 금지하라 추상 클래스 대신 인터페이스를 사용하라 인터페이스는 자료형을 정의할 때만 사용하라 태그 달린 클래스 대신 클래스 계층을 활용하라 전략을 표현하고 싶을 때는 함수 객체를 사용하라 멤버 클래스는 가능하면 static으로 선언하라 새 코드에는 무인자 제네릭 자료형을 사용하지 마라 무점검 경고(unchecked warning)를 제거하라 배열 대신 리스트를 써라 가능하면 제네릭 자료형으로 만들 것 가능하면 제네릭 메서드로 만들 것 한정적 와일드카드를 써서 API 유연성을 높여라 형 안전 다형성 컨테이너를 쓰면 어떨지 따져보라 int 상수 대신 enum을 사용하라 ordinal 대신 객체 필드를 사용하라 비트 필드(bit field) 대신 EnumSet을 사용하라 ordinal을 배열 첨자로 사용하는 대신 EnumMap을 이용하라 확장 가능한 enum을 만들어야 한다면 인터페이스를 이용하라 작명 패턴 대신 어노테이션을 사용하라 Override 어노테이션은 일관되게 사용하라 자료형을 정의할 때 표식 인터페이스를 사용하라...
자세한 내용 보기

냉장고 가계부 프로젝트 14

fridge-web 프로젝트에서 api 서버와 통신할때 URL을 매번 중복해서 입력하는 부분을 제거하기 위해 RestTemplate 빈 등록메서드를 수정한다. @Bean public RestTemplate restTemplate(RestTemplateBuilder builder) { return builder.rootUri("http://localhost:8081").build(); } builder에 rootUri 메서드를 호출해서 api 서버 url을 미리 설정하고 build해서 RestTemplate 객체를 반환하면 RestTemplate을 사용하는 부분에서는 root 다음 경로만 넘겨주면 된다. WebFoodController 클래스의 restTemplate 사용부분을 전부 수정한다. @GetMapping public String foods(Model model) { ResponseEntity<Resources<FoodCommand>> response = restTemplate.exchange("/foods", HttpMethod.GET, null, new ParameterizedTypeReference<Resources<FoodCommand>>() {}, Collections.emptyMap()); .... 다른 메서드들도 동일하게 수정한다. Food 클래스에서도 이제 더이상 사용하지 않는 Cloneable과 hashCode, equals 메서드를 정리한다. Guava 의존라이브러리도 다른곳에서는 사용하지 않으므로 정리한다. 식품에 대한 최소한의 기능은 구현하였다. 이번에는 냉장고 라는 개념을 모델링한다. 식품들이 들어가고 나가는 곳은 냉장고이기 때문에 냉장고라는...
자세한 내용 보기