기본 콘텐츠로 건너뛰기

냉장고 가계부 프로젝트 5

JdbcFoodServiceTests 클래스에 save 기능 테스트 메서드를 작성한다. save는 데이터가 존재하면 수정하고, 데이터가 없으면 등록한다.
save기능은 JdbcFoodService 클래스에서 제공한다. 아래는 테스트 메서드이다.
    @Test
    public void save() {
        JdbcFoodService jdbcFoodService = new JdbcFoodService();
        jdbcFoodService.setJdbcTemplate(dataSource);
        Food cola = new Food("코카콜라 500mL", 2, "2018-10-30");
        cola = jdbcFoodService.save(cola);
        assertThat(cola.getId(), notNullValue());
        
        cola.decreaseQuantity(1);
        jdbcFoodService.save(cola);
        
        Food savedCola = findById(cola.getId());
        assertThat(savedCola.getQuantity(), equalTo(1));
    }

jdbcFoodService 클래스를 생성하고 setJdbcTemplate 설정자 메서드로 dataSource 객체를 주입해주고있다. cola 객체를 새로 생성해서 save 메서드의 파라미터로 전달하면 기존 데이터베이스에 cola 정보가 없으므로(id 멤버변수가 null) insert 메서드를 호출한다.
그뒤에, cola 객체를 수정한 후 다시 save메서드를 호출하면 데이터베이스에 cola 정보가 이미 있으므로, update 메서드를 호출한다. 아래는 JdbcFoodService 클래스이다.
package com.poseidon.fridge;

import java.sql.Connection;
import java.sql.PreparedStatement;
import java.sql.SQLException;
import java.sql.Statement;

import javax.sql.DataSource;

import org.springframework.jdbc.core.JdbcTemplate;
import org.springframework.jdbc.core.PreparedStatementCreator;
import org.springframework.jdbc.support.GeneratedKeyHolder;
import org.springframework.jdbc.support.KeyHolder;

import com.poseidon.fridge.model.Food;

public class JdbcFoodService {
    
    private JdbcTemplate jdbcTemplate;
    
    public void setJdbcTemplate(DataSource dataSource) {
        this.jdbcTemplate = new JdbcTemplate(dataSource);
    }

    public Food save(Food food) {
        if(food.getId() == null) {
            insert(food);
        } else {
            update(food);
        }
        return food;
    }
    
    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;
    }
    
    private int update(Food food) {
        return jdbcTemplate.update("UPDATE food SET quantity=? WHERE id=?", food.getQuantity(), food.getId());
    }

}

JdbcFoodService 클래스 내부에 insert, update 메서드가 테스트 클래스에서 그대로 복사되어 쓰이고 있다. 일단, 테스트를 실행해서 정상 처리되는지 확인한다.
테스트를 확인했으면, 이제 중복을 제거할 차례다. 테스트 클래스에서 존재하는 JDBC API 메서드들을 JdbcFoodService 클래스로 옮기고 테스트 메서드 들은 jdbcFoorService 를 호출해서 JdbcAPI 를 이용하도록 정리한다.
    private JdbcFoodService jdbcFoodService;
    
    @Before
    public void setUp() {
        jdbcTemplate = new JdbcTemplate(dataSource);
        jdbcFoodService = new JdbcFoodService();
        jdbcFoodService.setJdbcTemplate(dataSource);
        jdbcFoodService.deleteAll();
    }

    @Test
    public void save() {
        Food cola = new Food("코카콜라 500mL", 2, "2018-10-30");
        cola = jdbcFoodService.save(cola);
        assertThat(cola.getId(), notNullValue());
        
        cola.decreaseQuantity(1);
        jdbcFoodService.save(cola);
        
        Food savedCola = jdbcFoodService.findById(cola.getId());
        assertThat(savedCola.getQuantity(), equalTo(1));
    }
    
    ...

다른 테스트 메서드들도 jdbcFoodService 인스턴스의 api들을 호출하도록 수정한다. 테스트를 실행해보면 성공적으로 수행된다.
관례상 Service 라는 클래스는 비지니스 로직이 담기는 클래스를 뜻한다. 아직 특별한 기능은 없는 CRUD 정도의 클래스이지만, 차후에 점점 살이 붙어가는데, 여기에 비지니스 로직과 Jdbc API가 혼재된다면 소스코드는 점점 단숨에 파악하기 힘들고 유지보수, 기능추가 등의 확장성에 제약이 생겨 유연하지 못한 프로그램이 된다.
이러한 문제점에 대비해서 JdbcAPI 를 별도의 클래스로 옮기고 비니지스 로직 사이에서 필요할때 호출해서 사용한다. 클래스명은 저장소라는 뜻의 JdbcFoodRepository 로 정한다.
    private JdbcTemplate jdbcTemplate;
    
    public void setJdbcTemplate(DataSource dataSource) {
        this.jdbcTemplate = new JdbcTemplate(dataSource);
    }
    
    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;
        }
    };
    
    public int update(Food food) {
        return jdbcTemplate.update("UPDATE food SET quantity=? WHERE id=?", food.getQuantity(), food.getId());
    }
    ...

JdbcTemplate 생성자 파라미터로 DataSource 를 전달해줄 수 있도록 DI방식으로 주입해준다. 다음은 JdbcFoodService 클래스의 소스코드다.
    private JdbcFoodRepository jdbcFoodRepository;
    
    public JdbcFoodService(JdbcFoodRepository jdbcFoodRepository) {
        this.jdbcFoodRepository = jdbcFoodRepository;
    }
    
    public Food save(Food food) {
        if(food.getId() == null) {
            jdbcFoodRepository.insert(food);
        } else {
            jdbcFoodRepository.update(food);
        }
        return food;
    }

기존에 JDBC API 를 위해서 존재하는 코드는 JdbcFoodRepository로 옮겨졌다. JdbcFoodRepository 를 통해서 JDBC 기능을 접근할 수 있는데 생성자에서 JdbcFoodRepository 를 주입받아서 사용하고 있다. 다음은 테스트 클래스 소스코드다.
    private JdbcFoodService jdbcFoodService;
    private JdbcFoodRepository jdbcFoodRepository;
    
    @Before
    public void setUp() {
        jdbcTemplate = new JdbcTemplate(dataSource);
        jdbcFoodRepository = new JdbcFoodRepository();
        jdbcFoodRepository.setJdbcTemplate(dataSource);
        jdbcFoodService = new JdbcFoodService(jdbcFoodRepository);
        jdbcFoodRepository.deleteAll();
    }

먼저 JdbcFoodRepository 클래스를 생성하고 dataSource를 전달한다. 그리고 JdbcFoodService 객체를 생성하는데 생성자 파라미터로 repository를 넘겨주고 있다.
테스트 메서드들은 JDBC API 를 테스트하는 메서드일 경우는 jdbcFoodRepository 인스턴스를 사용하고, 비지니스 로직을 테스트하는 save 메서드는 jdbcFoodService 인스턴스를 사용하도록 수정한다.
테스트를 실행해서 문제는 없는지 확인한다.

정리정돈을 하다보면 JdbcFoodServiceTests 클래스에 서비스 기능을 테스트하는 메서드와 JDBC API 기능을 테스트하는 메서드가 혼재함을 알 수 있다. JdbcFoodRepositoryTests 클래스로 테스트 메서드를 옮겨주면 좀 더 깔끔해진다. 다음은 JdbcFoodServiceTests 클래스 소스코드다. 
    private static DataSource dataSource = new EmbeddedDatabaseBuilder()
            .setType(EmbeddedDatabaseType.HSQL)
            .addScript("classpath:schema.sql")
            .build();
    
    private JdbcFoodService jdbcFoodService;
    private JdbcFoodRepository jdbcFoodRepository;
    
    @Before
    public void setUp() {
        jdbcFoodRepository = new JdbcFoodRepository();
        jdbcFoodRepository.setJdbcTemplate(dataSource);
        jdbcFoodService = new JdbcFoodService(jdbcFoodRepository);
        jdbcFoodRepository.deleteAll();
    }
    
    @Test
    public void save() {
        Food cola = new Food("코카콜라 500mL", 2, "2018-10-30");
        cola = jdbcFoodService.save(cola);
        assertThat(cola.getId(), notNullValue());
        
        cola.decreaseQuantity(1);
        jdbcFoodService.save(cola);
        
        Food savedCola = jdbcFoodRepository.findById(cola.getId());
        assertThat(savedCola.getQuantity(), equalTo(1));
    }

JdbcFoodRepositoryTests 클래스 소스코드다.
    private static DataSource dataSource = new EmbeddedDatabaseBuilder()
            .setType(EmbeddedDatabaseType.HSQL)
            .addScript("classpath:schema.sql")
            .build();
    private JdbcTemplate jdbcTemplate;
    
    private JdbcFoodRepository jdbcFoodRepository;
    
    @Before
    public void setUp() {
        jdbcTemplate = new JdbcTemplate(dataSource);
        jdbcFoodRepository = new JdbcFoodRepository();
        jdbcFoodRepository.setJdbcTemplate(dataSource);
        jdbcFoodRepository.deleteAll();
    }
    
    @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() {
    ...

JdbcFoodServiceTests 클래스와 JdbcFoodRepositoryTests 클래스에서 DataSource 객체를 생성하는 부분이 중복된다. 이제는 스프링 프레임워크를 이용해서 의존성을 관리한다.
JdbcFoodRepositoryTests 클래스 애너테이션을 아래와 같이 추가한다.
@RunWith(SpringRunner.class)
@SpringBootTest
public class JdbcFoodRepositoryTests {

이제 DataSource, JdbcTemplate 클래스를 Bean 설정 없이도 Autowired 애너테이션을 통해 사용할 수 있다.
    @Autowired
    private DataSource dataSource;
    
    @Autowired
    private JdbcTemplate jdbcTemplate;
    
    private JdbcFoodRepository jdbcFoodRepository;
    
    @Before
    public void setUp() {
        jdbcFoodRepository = new JdbcFoodRepository();
        jdbcFoodRepository.setJdbcTemplate(dataSource);
        jdbcFoodRepository.deleteAll();
    }

테스트를 수행하면 성공한다. JdbcFoodServiceTests 클래스도 마찬가지로 수정해서 확인한다.
JdbcFoodRepository 클래스의 JdbcTemplate DI 부분을 생략하려면 클래스에 @Repository 애너테이션을 선언해서 Component Scan에 걸릴 수 있도록 한다.
@Repository 는 @Component 애너테이션을 상속하는 애너테이션으로 Data Access Object 객체에 붙이는 일종의 마킹 애너테이션으로 볼 수 있다.
JdbcFoodRepository 클래스는 다음과 같이 수정한다.
@Repository
public class JdbcFoodRepository {
    @Autowired
    private JdbcTemplate jdbcTemplate;
    ...

JdbcFoodRepositoryTests 클래스에서는 JdbcFoodRepository 에 DataSource를 DI 해줄 필요가 없어지므로 DataSource 변수 선언부와 DI 부분을 삭제하고 Autowired 로 Bean객체를 불러온다.
    @Autowired
    private JdbcTemplate jdbcTemplate;
    
    @Autowired
    private JdbcFoodRepository jdbcFoodRepository;
    
    @Before
    public void setUp() {
        jdbcFoodRepository.deleteAll();
    }

이렇게 정리를 하고 다시 테스트를 수행해서 초록불을 확인한다. JdbcFoodService 클래스도 @Service 애너테이션을 붙이고 수정하고, 테스트 클래스까지 수정한다.
@Service
public class JdbcFoodService {
    
    @Autowired
    private JdbcFoodRepository jdbcFoodRepository;
    ...

테스트가 성공하는지 확인한다.

JdbcFoodService 클래스와 MemoryFoodService 클래스는 영속성을 구현하는 상세 기술이 다를 뿐이지, 목록표의 비지니스 로직을 수행한다. 이렇게 추상적인 표현은 인터페이스로 추상화시키면, 또 다른 상세 기술을 구현하는 구현 클래스가 필요할때도 인터페이스를 구현하여 작성하고 스프링의 DI 관리를 통해 손쉽게 교체할 수 있다.
FoodService 인터페이스를 작성하고, 메서드 시그니쳐들은 MemoryFoodService 를 옮긴다.
package com.poseidon.fridge;

import java.util.List;

import com.poseidon.fridge.model.Food;

public interface FoodService {
    List<Food> findAll();
    Food save(Food food);
    boolean remove(Food food);
    Food findById(Long id);
    void removeAll();
}

인터페이스가 다 완성되면 JdbcFoodService와 MemoryFoodService에 반영한다.
public class JdbcFoodService implements FoodService {
...


public class MemoryFoodService implements FoodService {
...

JdbcFoodService에 FoodService 인터페이스를 구현하면 미구현된 메서드들이 있으므로 전부 구현한다.
구현과정에서 JdbcFoodRepository 클래스에 없는 remove 메서드도 구현함과 동시에 테스트 메서드를 작성한다.
테스트 패키지에 존재하는 java파일들을 정리한다. Service 파일은 service 패키지로 이동하고, Repository 파일은 repository 패키지를 새로 생성해서 옮긴다.
이전글: 냉장고 가계부 프로젝트 4
다음글: 냉장고 가계부 프로젝트 6
라벨:

이 블로그의 인기 게시물

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 의존라이브러리도 다른곳에서는 사용하지 않으므로 정리한다. 식품에 대한 최소한의 기능은 구현하였다. 이번에는 냉장고 라는 개념을 모델링한다. 식품들이 들어가고 나가는 곳은 냉장고이기 때문에 냉장고라는...
자세한 내용 보기