기본 콘텐츠로 건너뛰기

냉장고 가계부 프로젝트 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
라벨:

이 블로그의 인기 게시물

레거시 코드 활용 전략 - 마이클 C. 페더스

2장. 효과적인 피드백 활용 레거시 코드 변경 알고리즘 변경 지점을 식별한다. 테스트 지점을 찾는다. 의존관계를 깬다. 테스트 루틴을 작성한다. 변경시키고 리팩토링한다. 3장. 감지와 분리 레거시코드를 원자 단위까지 분리하여 변경지점을 식별한다. 의존관계를 가진 객체의 경우 Mock/Fake 객체를 사용하기 위해 인터페이스로 의존성을 깬다. 테스트 루틴을 작성 -> 수정 -> 테스트 성공 -> 리팩토링 단계를 반복한다. 4장. 봉합 자바에서는 클래스패스를 이용한 다른 버전의 클래스를 만들수 있다. 5장. 레거시 코드를 위한 도구 JUnit 6장. 고칠 건 많고 시간은 없고 발아(Sprout) Method / Class: 메서드/클래스를 추가 포장(Wrap) Method / Class: 기존 메서드/클래스를 포장하는 메서드/클래스를 추가(데코레이터 패턴) 7장. 코드 하나 바꾸는데 왜 이리 오래 걸리지? 의존관계 반전 원칙 당신의 코드가 인터페이스에 종속되는 경우, 그 의존관계는 사실 경미한 수준으로 눈에 잘 띄지 않는다. 인터페이스가 변하지 않는 한, 코드를 변경시킬 필요는 없다. 또한 인터페이스들은 그들 아래에 위치한 코드에 비해 훨씬 적은 빈도로 변경된다. 인터페이스를 하나 가지고 있는 경우, 그 인터페이스를 구현하는 클래스들을 편집하거나 그 인터페이스를 구현하기 위한 새로운 클래스들을 추가할 수 있다. 물론 그 인터페이스를 사용하는 코드에 영향을 주지도 않는다. 이런 이유 때문에 구체 클래스보다는 인터페이스나 추상 클래스에 종속되는 편이 좋다. 덜 변하는 것들에 종속됨으로써 특정 변경이 초래할지도 모를 대규모 재컴파일 사태의 위험을 최소화할 수 있다. 8장. 특징, 어떻게 추가할까? 테스트 주도 개발 실패 테스트 케이스를 작성한다. 컴파일되게 만든다. 테스트에 통과하도록 만든다. 중복을 제거한다. 반복한다....
댓글 쓰기
자세한 내용 보기

Dolphin 2

별도의 회원가입 없이 소셜 로그인 기능 제공으로 간편한 로그인 가능. Dolphin 프론트엔드는 회원가입 절차가 따로 없고, 간단하게 소셜 로그인 기능을 제공함으로써 회원가입, 인증절차를 생략했습니다. 우선, 간단하게 국내에서 잘 알려진 네이버의 API를 사용합니다. 네이버 개발자센터 웹사이트 에서 네이버 아이디로 로그인 기능을 살펴봅니다. 개발 문서를 자세히 살펴보고 API 신청을 합니다. 애플리케이션의 이름을 정하고 필요한 정보를 필수/선택에 체크합니다. 밑으로 내려보면 로그인 API 서비스 환경 부분에서 환경 추가 셀렉트박스에서 PC 웹을 선택하면 다음과 같은 입력폼이 나타납니다. 서비스 URL은 내 웹애플리케이션의 URL이 될 예정입니다. 지금은 개발상태이므로 localhost를 입력했습니다. Callback URL은 네이버 OAuth 인증 url로 호출하면, 인증절차 후 네이버에서 리다이렉트해줄 url을 뜻합니다. 저는 /naver/login 으로 했습니다. 등록이 완료되면 client-id와 client-secret 값을 제공해줍니다. 이 값을 이용해서 인증처리를 할 수 있습니다. spring.io 웹사이트의 튜토리얼 문서를 보면 Facebook 소셜 로그인 기능에 대한 설명이 자세하게 나와있습니다. 이 부분을 참고합니다. Spring Boot and OAuth2 pom.xml 파일에 의존성을 추가하고 Application 클래스에 @EnableOAuth2Sso 애너테이션을 선언합니다. 튜토리얼대로 application.yaml 파일(application.properties)에 설정 정보를 입력합니다. clientId, clientSecret 값은 네이버 개발자센터에서 받은 대로 입력합니다. accessTokenUri는 네이버의 경우 https://nid.naver.com/oauth2.0/token 입니다. userAuthorizationUri는 네이버의 경우 https://ni...
자세한 내용 보기

Dolphin 3

100자 이내의 짧은 글을 쓸 수 있는 게시판 제공. Dolphin Project에서 가장 메인 서비스는 예적금 시뮬레이터이므로, 다른 기능 구현은 차후로 미뤄뒀지만, 사용자와 소통할 수 있는 최소한의 기능은 제공하는게 맞다는 생각이 들어 아주 단순한 게시판 기능을 제공합니다. 사용자가 글을 쓰려면 로그인을 먼저 해야합니다. 글을 등록 후 삭제할 때 글 작성자를 식별할 수 있어야 하기 때문입니다. 게시판은 Dolphin Frontend Main 페이지에 자리잡았습니다. 사용자가 가장 먼저 만나게 되는 웹페이지이므로 적당하다고 생각합니다. 다음은 로그인을 하기 전 사용자가 볼 수 있는 메인 페이지입니다. 글 상단에는 작성일(MMM-dd-yyyy)과 작성자 고유번호(#numbers)가 노출됩니다. Dolphin 은 네이버 로그인을 사용하기 때문에, 사용자를 식별할 수 있는 정보는 저 고유번호가 됩니다. 하단에는 글 내용이 자리잡습니다. 스크린샷에서는 Hello, world!! 라는 문구가 보이네요. 글은 최대 100자까지 허용합니다. 버튼 두개(Newer, Older) 는 페이징 버튼인데, Newer는 최근페이지로 이동을 하며, Older는 지나간 글을 보는 페이징버튼입니다. 기본 페이지 사이즈는 20개입니다. 오른쪽으로 보이는 글 작성 폼은 현재 로그인 하기 전이므로 textarea 는 disabled 처리되어 있고 Login버튼이 자리잡고 있습니다. 다음은 사용자가 로그인 한 뒤의 메인페이지입니다. 변경된 부분은 사용자 고유번호 뒤에 Remove 버튼이 나타났습니다. 해당 글 작성자가 로그인한 사용자일 경우에만 보이게 됩니다. 오른쪽 글 작성 폼도 이제 활성화 되었습니다. 아주 단순한 Textarea 창과 Submit 버튼이 자리잡고 있습니다. 다음은 작성자가 아닌 다른 사용자가 로그인한 경우 입니다. 사용자 고유번호(#54097272) 옆에 Remove 버튼이...
자세한 내용 보기