냉장고 가계부 프로젝트 15

Fridge 클래스와 매핑되는 DB 테이블을 작성한다. resources 클래스패스에 있는 schema.sql 파일을 다음과 같이 편집한다.

CREATE TABLE fridge (
    id INTEGER GENERATED BY DEFAULT AS IDENTITY(START WITH 1, INCREMENT BY 1) PRIMARY KEY,
    nickname VARCHAR(45) NOT NULL
);

id 컬럼은 INTEGER 타입으로 Primary Key, AutoIncrement 속성을 가진다.
nickname은 문자열 타입을 가진다.

Fridge 클래스의 Jpa 테스트 클래스를 작성한다. 클래스명은 JpaFridgeRepositoryTests으로 정한다.

@RunWith(SpringRunner.class)
@DataJpaTest
public class JpaFridgeRepositoryTests {
    
    @Autowired
    JpaFridgeRepository jpaFridgeRepository;
    
    @Test
    public void createFridge() {
        String nickname = "myFridge";
        Fridge fridge = jpaFridgeRepository.save(new Fridge(nickname));
        assertThat(fridge).isNotNull();
        assertThat(fridge.getNickname()).isEqualTo(nickname);
        assertThat(fridge.getNickname()).isNotEqualTo("another nickname");
    }

}

JpaFoodRepositoryTests 클래스와 유사하다. createFridge 테스트 메서드는 간단하게 새로운 fridge를 만들어낸다. Fridge 클래스와 매핑할 수 있도록 JPA Repository 인터페이스를 작성한다.

@Repository
public interface JpaFridgeRepository extends JpaRepository<Fridge, Integer> {

}

org.springframework.data.jpa.repository.JpaRepository 를 상속받는다. 타입은 Fridge, 식별키 타입은 Integer로 한다.
Fridge 클래스는 다음과 같이 수정되었다.

@Entity
public class Fridge {
    @Id
    @GeneratedValue(strategy=GenerationType.IDENTITY)
    private Integer id;
    private String nickname;
    
    protected Fridge() {}
    
    public Fridge(String nickname) {
        this.nickname = nickname;
    }
    
    public Integer getId() {
        return id;
    }

    public void setId(Integer id) {
        this.id = id;
    }
    
    public String getNickname() {
        return nickname;
    }
    
}

빈 생성자 하나가 추가되었고, 식별을 위한 Integer 타입의 id 멤버변수가 추가되었다. id 변수의 접근자도 추가되었다.

Fridge의 비지니스 로직을 담을 서비스 클래스를 작성한다. 인터페이스와 구상클래스로 나눠구현한다.

@Transactional
public interface FridgeService {
    Fridge create(String nickname);
}

@Service
public class FridgeServiceImpl implements FridgeService {
    
    @Autowired
    JpaFridgeRepository jpaFridgeRepository;

    @Override
    public Fridge create(String nickname) {
        Fridge fridge = new Fridge(nickname);
        return jpaFridgeRepository.save(fridge);
    }

}

인터페이스에는 Transaction 애너테이션을 선언해서 구상클래스 전체에 적용되도록 한다. 추상메서드 create 메서드는 파라미터 nickname 문자열을 받고 리턴타입으로 Fridge 를 반환한다. 구상클래스에서 create 메서드는 JPA를 이용해서 Fridge 클래스를 DB에 등록한다.

Fridge 서비스를 테스트하는 클래스를 작성한다.

@RunWith(MockitoJUnitRunner.class)
public class FridgeServiceTests {
    
    @Mock
    FridgeService fridgeService;
    
    @Test
    public void create() {
        String nickname = "myFridge";
        when(fridgeService.create(anyString())).thenReturn(new Fridge(nickname));
        Fridge fridge = fridgeService.create(nickname);
        
        verify(fridgeService, times(1)).create(nickname);
        
        assertThat(fridge.getNickname()).isEqualTo(nickname);
    }

}

@Mock 애너테이션을 사용하기 위해 MockitoJUnitRunner 를 junit RunWith애너테이션에 전달한다.
@Mock 애너테이션은 FridgeService 인터페이스를 mock 객체로 만든다.
create 테스트 메서드에서는 fridgeService.create메서드가 어떠한 문자열이든지 파라미터로 전달받으면 Fridge 클래스를 리턴하도록 조건을 걸었다.
Mockito.verify 정적메서드로 fridgeService의 create메서드가 1번 호출되었음을 검증한다.
create 메서드의 리턴 Fridge의 nickname 멤버 변수는 테스트 조건과 동일함을 assertThat으로 확인한다.

Fridge 클래스의 HTTP 통신을 위한 API 컨트롤러를 작성한다. 먼저 컨트롤러 테스트 클래스를 작성하는데, 클래스명은 FridgeControllerTests 으로 정한다.

@RunWith(SpringRunner.class)
@WebMvcTest(FridgeController.class)
public class FridgeControllerTests {
    
    @Autowired
    private MockMvc mvc;
    
    @Autowired
    private ObjectMapper mapper = new ObjectMapper();
    
    @MockBean
    private FridgeService fridgeService;
    
    private Fridge myFridge;
    
    @Before
    public void setUp() {
        myFridge = new Fridge("myFridge");
        myFridge.setId(1);
    }
    
    @Test
    public void create() throws Exception {
        when(fridgeService.create(anyString())).thenReturn(myFridge);
        
        final ResultActions resultAction = mvc.perform(post("/fridges")
                .contentType(MediaType.APPLICATION_JSON_UTF8)
                .content(mapper.writeValueAsString(myFridge)));
        resultAction.andExpect(status().isCreated())
            .andExpect(redirectedUrlPattern("**/fridges/{id:\\d+}"));
        verifyResultActions(resultAction);
    }

    private void verifyResultActions(final ResultActions resultAction) throws Exception {
        resultAction.andExpect(jsonPath("nickname", equalTo(myFridge.getNickname())));
    }

}

FoodControllerTests 클래스와 유사하다. post 방식으로 /fridges URL을 호출하며, request Body에는 Fridge 객체를 전달한다. 응답상태는 201 Created, redirectedUrlPattern은 /fridges/{id} 형태로 응답하는것을 예상한다. 나머지 응답결과는 verifyResultActions 메서드로 검증한다.

HATEOAS를 사용하기위해 Resource 클래스와 ResourceAssembler 클래스를 작성한다. Food 에서 이미 한번 작성해봤으므로 설명은 건너뛴다.

public class FridgeResource extends ResourceSupport {
    @JsonProperty
    Integer id;
    @JsonProperty
    String nickname;
}

public class FridgeResourceAssembler extends ResourceAssemblerSupport<Fridge, FridgeResource> {

    public FridgeResourceAssembler() {
        super(FridgeController.class, FridgeResource.class);
    }

    @Override
    public FridgeResource toResource(Fridge fridge) {
        FridgeResource resource = new FridgeResource();
        resource.id = fridge.getId();
        resource.nickname = fridge.getNickname();
        resource.add(linkTo(FridgeController.class).slash(resource.id).withSelfRel());
        return resource;
    }

}

FridgeController 클래스를 구현한다. FoodController 와 매우 유사하다.

@RestController
@RequestMapping("/fridges")
public class FridgeController {
    
    @Autowired
    FridgeService fridgeService;
    
    FridgeResourceAssembler assembler = new FridgeResourceAssembler();
    
    @PostMapping
    public ResponseEntity<FridgeResource> create(@RequestBody final String nickname) {
        Fridge fridge = fridgeService.create(nickname);
        URI location = MvcUriComponentsBuilder.fromController(getClass())
                .path("/{id}")    
                .buildAndExpand(fridge.getId())
                .toUri();
        return ResponseEntity.created(location).body(assembler.toResource(fridge));
    }

}

create 메서드는 /fridges URL, Post방식으로 매핑되어있고, request parameter로 nickname을 받는다.
fridgeService의 create 메서드가 Fridge 클래스를 생성하면 ResponseEntity를 응답한다.

이전글: 냉장고 가계부 프로젝트 14
다음글: 냉장고 가계부 프로젝트 16