기본 콘텐츠로 건너뛰기

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

이 블로그의 인기 게시물

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 어노테이션은 일관되게 사용하라 자료형을 정의할 때 표식 인터페이스를 사용하라...
자세한 내용 보기

냉장고 가계부 프로젝트 27

스프링 Data 에서 제공하는 @CreatedDate, @LastModifedDate 애너테이션을 이용해서 작성일자, 수정일자를 도메인객체가 생성되고, 수정될 때 관리될 수 있도록 한다. Spring Data를 쓰기 전에는 DB컬럼에 Date 타입의 등록일 컬럼을 추가하고 DEFAULT 값으로 SYSDATE 를 줘서 DB에 Insert 되는 시간에 등록일자 컬럼이 채워지는 방식을 사용했었고, Update 쿼리가 실행될때 수정일자 컬럼에 SYSDATE를 직접 Update 해주는 방식을 자주 썼다. 그 뿐만아니라, 등록일자와 더불어 등록한 사용자(ex: registerUser)를 식별하는 식별키(ex: userId, username ...) 를 Insert 쿼리가 실행될때 등록해주고, 수정한 사용자(ex: modifedUser)를 Update 쿼리에 설정하는 방식은 차후에 있을지도 모를 일에 대비해서 늘 반복해서 작업했다. 스프링 Data 에서 제공하는 JPA Audit 기능은 이런 코드의 반복을 줄여준다. 사용자 같은 경우 객체로 넘기면 객체의 식별자가 담긴다. 등록시간은 날짜형 타입이다. public class Blog { @CreatedBy private User user; @CreatedDate private LocalDateTime creadtedDate; } Blog 클래스의 User 객체는 @CreatedBy 애너테이션으로 선언되서 등록한 사용자를 나타내는 컬럼에 값을 입력할것이다. createdDate 필드는 도메인객체가 영속성 저장소에 반영되는 시간을 나타낸다. Fridge, Food 클래스에 등록일, 수정일만 먼저 적용한다. 두 클래스에 createdDate, lastModifedDate 멤버변수를 선언한다. @Data @NoArgsConstructor @Entity @EntityListeners(AuditingEntityListener.class) public class Fridge { ...
자세한 내용 보기