[스프링 DB 2편] #1. 데이터 접근 기술 - 시작

[YONGHYNG]

데이터 접근 기술

• JdbcTemplate
• MyBatis
• JPA, Hibernate
• 스프링 데이터 JPA
• Querydsl

SQLMapper

• 개발자가 SQL만 작성하면 해당 SQL 결과를 객체로 매핑해줌
• JDBC를 직접 사용할 때 발생하는 여러가지 중복 제거, 기타 개발자에게 편리한 기능 제공
• JdbcTemplate, MyBatis

ORM 주요 기능

• 객체 지향 프로그래밍 언어에서 사용하는 객체와 데이터베이스 테이블을 매핑, 개발자가 SQL을 직접 작성하지 않고 디비 조작 가능
• JPA는 자바 진영의 ORM 표준, Hibernate(하이버네이트)는 JPA에서 가장 많이 사용하는 구현체, 자바에서 ORM을 사용할 때는 JPA 인터페이스 사용하고 그 구현체로 하이버네이트를 사용한다고 생각하면 됨
• JPA, Hibernate, 스프링 데이터 JPA, Querydsl

Item

package hello.itemservice.domain;

import lombok.Data;

@Data
public class Item {

    private Long id;

    private String itemName;
    private Integer price;
    private Integer quantity;

    public Item() {
    }

    public Item(String itemName, Integer price, Integer quantity) {
        this.itemName = itemName;
        this.price = price;
        this.quantity = quantity;
    }
}

• 상품 정보를 관리하기 위한 간단한 데이터 클래스
• @DaTa : Lombok 어노테이션, Getter/Setter 생성, toString() 객체 문자열로 표현
• public Item() 선언 외부에서 접근 허용
• 파라미터 생성자를 통해 필드 값을 초기화하면서 객체를 생성

ItemRepository

package hello.itemservice.repository;

import hello.itemservice.domain.Item;

import java.util.List;;
import java.util.Optional;

public interface ItemRepository {

    Item save(Item item); //객체를 저장하는 메서드, 매개변수: Item 객체를 받아 저장소에 저장
    void update(Long itemId, ItemUpdateDto updateParam); //특정 ID의 상품 정보를 수정하는 메서드

    Optional<Item> findById(Long id); //객체 조회

    List<Item> findAll(ItemSearchCond cond); //조건에 맞는 모든 Item 객체 리스트 반환
}

• 인터페이스는 메서드 이름, 매개변수, 반환값 등만 선언하고 구현하지 않음
• 구현 클래스에서 이 인터페이스를 구현(implements)해야 실제 동작 가능
• 데이터 저장(save), 데이터 수정(update), 단일 조회(findById), 다중 조회(findAll)
• 인터페이스 구현 이유 데이터베이스, 메모리, 파일 등 다양한 저장소 구현 방식을 쉽게 교체 가능

ItemSearchCond

package hello.itemservice.repository;

import lombok.Data;

@Data
public class ItemSearchCond{
    private String itemName;
    private Integer maxPrice;

    public ItemSearchCond(){} //아무 값도 전달받지 않는 기본 생성자

    public ItemSearchCond(String itemName, Integer maxPrice){ //필드 초기화 생성자
        this.itemName = itemName;
        this.maxPrice = maxPrice;
    }
}

• ItemSearchCond 검색 조건을 저장하는 DTO 역할
• 검색 조건이 많아지더라도 클래스 확장 및 수정이 쉬움, 코드 가독성 유지보수성 향상

DTO(data transfer object)

• 데이터 전송 객체
• DTO는 기능은 없고 데이터를 전달만 하는 용도로 사용되는 객체

MemoryItemRepository

package hello.itemservice.repository.memory;
import hello.itemservice.domain.Item;
import hello.itemservice.repository.ItemRepository;
import hello.itemservice.repository.ItemSearchCond;
import hello.itemservice.repository.ItemUpdateDto;
import org.springframework.stereotype.Repository;
import org.springframework.util.ObjectUtils;
import java.util.*;
import java.util.stream.Collectors;

@Repository
public class MemoryItemRepository implements ItemRepository {
    private static final Map<Long, Item> store = new HashMap<>(); 
    private static long sequence = 0L; //static
    @Override
    public Item save(Item item) { //저장
        item.setId(++sequence);
        store.put(item.getId(), item);
        return item;
    }
    @Override
    public void update(Long itemId, ItemUpdateDto updateParam) { //조회
        Item findItem = findById(itemId).orElseThrow();
        findItem.setItemName(updateParam.getItemName());
        findItem.setPrice(updateParam.getPrice());
        findItem.setQuantity(updateParam.getQuantity());
    }
    @Override
    public Optional<Item> findById(Long id) { //조회, 개별 찾기 
        return Optional.ofNullable(store.get(id));
    }
    @Override
    public List<Item> findAll(ItemSearchCond cond) { //조회, 모두 찾기
        String itemName = cond.getItemName();
        Integer maxPrice = cond.getMaxPrice();
        return store.values().stream()
                .filter(item -> {
                    if (ObjectUtils.isEmpty(itemName)) {
                        return true;
                    }
                    return item.getItemName().contains(itemName);
                }).filter(item -> {
                    if (maxPrice == null) {
                        return true;
                    }
                    return item.getPrice() <= maxPrice;
                })
                .collect(Collectors.toList());
    }
    public void clearStore() { //수정
        store.clear();
    }
}

• ItemRepository 인터페이스를 구현한 메모리 저장소, 메모리이기 때문에 자바를 다시 실행하면 기존에 저장된 데이터 모두 사라짐
• findAlldms ItemSearchCond 이라는 검색 조건을 받아서 내부에서 데이터를 검색하는 기능, 디비로 보면 where 구문을 사용 필요한 데이터를 필터링 하는 과정
• itemName 이나 maxPrice 가 null 비었으면 조건 무시
• itemName 이나 maxPrice 에 값이 있을 때만 해당 조건으로 필터링 기능 수행

ItemService

package hello.itemservice.service;

import hello.itemservice.domain.Item;
import hello.itemservice.repository.ItemSearchCond;
import hello.itemservice.repository.ItemUpdateDto;

import java.util.List;
import java.util.Optional;

public interface ItemService{
    
    Item save(Item item);
    
    void update(Long itemId, ItemUpdateDto updateParam);
    
    Optional<Item> findById(Long id);
    
    List<Item> findItems(ItemSearchCond itemSearch);
    
}

• 서비스의 구현체 쉽게 변경 위해 인터페이스 사용, 서비스에는 잘 사용하지 않음

ItemServiceV1

package hello.itemservice.service;

import hello.itemservice.domain.Item;
import hello.itemservice.repository.ItemRepository;
import hello.itemservice.repository.ItemSearchCond;
import hello.itemservice.repository.ItemUpdateDto;
import lombok.RequiredArgsConstructor;
import org.springframework.stereotype.Service;

import java.util.List;
import java.util.Optional;

@Service
@RequiredArgsConstructor //final이나 @NonNull 붙은 필드들 생성자 자동 생성
public class ItemServiceV1 implements ItemService {
    
    private final ItemRepository itemRepository;
    
    @Override
    public Item save(Item item){
        return itemRepository.save(item);
    }
    
    @Override
    public void update(Long itemId, ItemUpdateDto updateParam){
        itemRepository.update(itemId, updateParam);
    }
    
    @Override
    public Optional<Item> findById(Long id){
      return itemRepository.findById(id);   
    }
    
    @Override
    public List<Item> findItems(ItemSearchCond cond){
        return itemRepository.findAll(cond);
    }
}

• 서비스 구현체는 대부분의 기능을 단순히 리포지토리에 위임

**HomeController **

package hello.itemservice.web;

import lombok.RequiredArgsConstructor;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;

@Controller
@RequiredArgsConstructor
public class HomeController {

    @RequestMapping("/")
    public String home() {
        return "redirect:/items";
    }
}

• 홈으로 요청이 왔을 때 items로 이동하는 컨트롤러

**ItemController **

package hello.itemservice.web;

import hello.itemservice.domain.Item;
import hello.itemservice.repository.ItemSearchCond;
import hello.itemservice.repository.ItemUpdateDto;
import hello.itemservice.service.ItemService;
import lombok.RequiredArgsConstructor;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.*;
import org.springframework.web.servlet.mvc.support.RedirectAttributes;

import java.util.List;

@Controller //MVC에서 컨트롤러 동작
@RequestMapping("/items")
@RequiredArgsConstructor //롬복 애노테이션, final 필드에 대한 생성자 자동 생성
public class ItemController {

    private final ItemService itemService; //서비스 계층 호출 비즈니스 로직 처리
    
    @GetMapping //상품 목록 조회 HTTP GET 요청 처리
    public String items(@ModelAttribute("itemSearch") ItemSearchCond itemSearch, Model model){ //model 데이터 뷰
        List<Item> items = itemService.findItems(itemSearch); //검색 조건을 객체로 바인딩
        model.addAttribute("items", items);
        return "items";
    }

    @GetMapping("/{itemId}") //특정 상품의 상세 정보 조회
    public String item(@PathVariable long itemId, Model model){ //URL 경로에서 itemId 값 추출
        Item item = itemService.findById(itemId).get(); //상품 조회 값이 없으면 예외 발생
        model.addAttribute("item", item); //뷰에 상품 데이터 전달
        return "item";
    }

    @GetMapping("/add") //상품 추가 폼 홈페이지
    public String addForm(){
        return "addForm";
    }

    @PostMapping("/add") //상품 추가 처리
    public String additem(@ModelAttribute Item item, RedirectAttributes redirectAttributes){
        Item savedItem = itemService.save(item);
        redirectAttributes.addAttribute("itemId", savedItem.getId());
        redirectAttributes.addAttribute("status", true);
        return "redirect:/items/{itemId}";
    }

    @GetMapping("/{itemId}/edit") //상품 수정 폼
    public String edit(@PathVariable Long itemId, Model model){ //경로에서 상품 ID 추출
        Item item = itemService.findById(itemId).get(); //해당 상품 조회
        model.addAttribute("item", item); // 뷰에 상품 데이터 전달
        return "editForm"; //뷰 반환
    }
    
    @PostMapping("/{itemId}/edit") //상품 수정 처리
    public String edit(@PathVariable Long itemId, @ModelAttribute ItemUpdateDto updateParam){ //수정할 상품 ID를 경로에서 추출 
        itemService.update(itemId, updateParam); //수정된 정보를 저장
        return "redirect:/items/{itemId}";
    }
}

MemoryConfig

package hello.itemservice.config;

import hello.itemservice.repository.ItemRepository;
import hello.itemservice.repository.memory.MemoryItemRepository;
import hello.itemservice.service.ItemService;
import hello.itemservice.service.ItemServiceV1;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration //스프링 설정 클래스, 빈 정의 포함, 스프링 컨테이너가 이 클래스 사용해 빈 생성 및 관리
public class MemoryConfig {

    @Bean //이 메서드가 반환하는 객체를 스프링 컨테이너에 빈으로 등록, 다른 빈에서 의존성 주입 받아 사용
    public ItemService itemService() {
        return new ItemServiceV1(itemRepository());
    }

    @Bean
    public ItemRepository itemRepository() {
        return new MemoryItemRepository();
    }

}

• ItemServiceV1, MemoryItemRepository를 스프링 빈으로 등록하고 생성자를 통해 의존관계 주입

테스트 코드

package hello.itemservice.domain;

import hello.itemservice.repository.ItemRepository;
import hello.itemservice.repository.ItemSearchCond;
import hello.itemservice.repository.ItemUpdateDto;
import hello.itemservice.repository.memory.MemoryItemRepository;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

import java.util.List;

import static org.assertj.core.api.Assertions.assertThat;

@SpringBootTest
class ItemRepositoryTest {

    @Autowired
    ItemRepository itemRepository;

    @AfterEach
    void afterEach() {
        //MemoryItemRepository 의 경우 제한적으로 사용
        if (itemRepository instanceof MemoryItemRepository) {
            ((MemoryItemRepository) itemRepository).clearStore();
        }
    }

    @Test
    void save() {
        //given
        Item item = new Item("itemA", 10000, 10);

        //when
        Item savedItem = itemRepository.save(item);

        //then
        Item findItem = itemRepository.findById(item.getId()).get();
        assertThat(findItem).isEqualTo(savedItem);
    }

    @Test
    void updateItem() {
        //given
        Item item = new Item("item1", 10000, 10);
        Item savedItem = itemRepository.save(item);
        Long itemId = savedItem.getId();

        //when
        ItemUpdateDto updateParam = new ItemUpdateDto("item2", 20000, 30);
        itemRepository.update(itemId, updateParam);

        //then
        Item findItem = itemRepository.findById(itemId).get();
        assertThat(findItem.getItemName()).isEqualTo(updateParam.getItemName());
        assertThat(findItem.getPrice()).isEqualTo(updateParam.getPrice());
        assertThat(findItem.getQuantity()).isEqualTo(updateParam.getQuantity());
    }

    @Test
    void findItems() {
        //given
        Item item1 = new Item("itemA-1", 10000, 10);
        Item item2 = new Item("itemA-2", 20000, 20);
        Item item3 = new Item("itemB-1", 30000, 30);

        itemRepository.save(item1);
        itemRepository.save(item2);
        itemRepository.save(item3);

        //둘 다 없음 검증
        test(null, null, item1, item2, item3);
        test("", null, item1, item2, item3);

        //itemName 검증
        test("itemA", null, item1, item2);
        test("temA", null, item1, item2);
        test("itemB", null, item3);

        //maxPrice 검증
        test(null, 10000, item1);

        //둘 다 있음 검증
        test("itemA", 10000, item1);
    }

    void test(String itemName, Integer maxPrice, Item... items) {
        List<Item> result = itemRepository.findAll(new ItemSearchCond(itemName, maxPrice));
        assertThat(result).containsExactly(items);
    }
}

• afterEach() : 테스트는 서로 영향을 주면 안 됨, 따라서 각각의 테스트가 끝나고 저장한 데이터 제거 필요, @AfterEach는 각각의 테스트의 실행이 끝나는 시점 호출, 메모리 저장소를 완전히 삭제해 다음 테스트에 영향 안 줌
• save() : 상품을 하나 저장하고 잘 저장 되었는지 검증
• updateItem() : 상품을 하나 수정하고 잘 수정되었는지 검증
• findItems() : 상품을 찾는 테스트

참고 - 권장하는 식별자 선택 전략

1. null 값을 허용하지 않음
2. 유일해야 함
3. 변해서는 안 됨

테이블 기본 키를 선택하는 전략은 크게 2가지

1. 자연 키(natural key) : 비즈니스에 의미가 있는 키, 주민번호, 이메일, 전화번호
2. 대리 키(surrogate key) : 비즈니스와 관련 없는 임의로 만들어진 키, 대체 키로 불림

[newh08]

고생하셨습니다~

[YuDeokRin]

고생하셨습니다! DB 2편 시작 ~!