[Spring Boot를 이용한 RESTful Web Services 개발] 32강

HAL Browser를 이용한 HATEOAS 기능 구현

HAL Browser란?
1. Hypertext Application Language의 약자
2. 하이퍼텍스트로 어플리케이션에 부가적인 기능을 부여하는 것
3. HAL은 API 리소스들 사이에서 쉽게 일반적인 하이퍼링크를 제공하는 방식

• API 설계시 HAL을 도입하면 쉽게 API 검색이 가능함
• API를 사용하는 개발자들에게 더 나은 개발 환경 제공 가능
• HAL을 API Response 메시지에 적용하면 메시지가 JSON 포맷이든 XML 포맷이든 API를 쉽게 사용할 수 있는 부가적인 정보, 즉 메타 정보를 하이퍼링크로 간단하게 포함할 수 있음

• 제공하고자 하는 리소스의 정보를 링크로 추가해서 제공할 수 있음
• 리소스랑 컴퓨터가 가지고 있는 자원을 의미하며 사용자 정보 엔티티나 해당하는 정보를 변경, 수정, 추가 등의 작업을 리소스 작업이라고 말함
• 이러한 리소스를 외부에 공개하기 RESTful의 서비스를 사용함
• 해당하는 요청작업에 부가적으로 사용할 수 있는 또다른 리소스를 보여주기 위해서 html 링크를 사용함
• Pom.xml 파일에 추가 (HAL 브라우저 대신 HAL explorer 사용)

<dependency>
    <groupId>org.springframework.data</groupId>
    <artifactId>spring-data-rest-hal-explorer</artifactId>
    <version>3.5.1</version>
</dependency>

localhost:8088/explorer 접속시 HAL 브라우저가 나오는 것을 확인할 수 있음

/actuator 검색

metrics 클릭

metrics 클릭시 나오는 화면 

jvm의 메모리의 사이즈를 알 수 있는 property가 있음

이 값을 복사해서 붙여넣기 후 검색

메모리의 현재 사이즈 최대값을 확인할 수 있음

• HAL 브라우저의 장점은 REST 자원을 표시하기 위한 자료구조를 생성하지 않아도 HATEOAS 기능을 사용할 수 있다는 점임

 

UserController에서 HATEOAS 기능 사용하기

• UserContoller 클래스 확인
• HATEOAS 기능을 사용하기 위해 링크 객체를 생성했던 것 확인
• 이처럼 필요한 리소스를 추가하기 위해 직접 작업하지 않아도 HATEOAS기능을 사용하면 추가로 사용할 수 있는 링크가 자동으로 추가됨

@GetMapping("/users/{id}")
public EntityModel<User> retrieveUser(@PathVariable int id){ //path variable을 사용하고 있기 때문에 @PathVariable 사용
    User user = service.findOne(id);
    if (user == null){
        throw new UserNotFoundException(String.format("ID[%s] not found", id));
    }

    // HATEOAS
    // EnityModel 객체 생성하여 위에서 받아온 user 객체를 매개변수로 넣어줌
    EntityModel<User> model = EntityModel.of(user);
    // user값을 반환할 때 클라이언트가 사용할 수 있는 추가적인 정보 링크를 하이퍼미디어 타입으로 넣어줌
    // 이 클래스가 가지고 있는 data 중에서 retrieveAllUsers()이라는 메소드를 넣어줌
    WebMvcLinkBuilder linkTo = linkTo(methodOn(this.getClass()).retrieveAllUsers());
    // 위에서 생성했던 model 객체에 "all-users"라는 이름으로 링크 추가
    model.add(linkTo.withRel("all-users"));

    return model;
}