Spring Boot, Jackson, @JsonView로 멀티 뷰 구성하기

@JsonView 정의

public class View {

    public static class Consumer {
    }

    public static class Repository {
    }
}

Copy

• @JsonView의 장점은 동일한 POJO 오브젝트에 대해서 선택적으로 서로 다른 프라퍼티가 조합된 JSON 문자열을 만들 수 있다는데 있다. 예를 들어 user라는 POJO 오브젝트가 있다고 가정할 경우 password_encrypted 프라퍼티는 API 사용자에게 노출되지 않아야 하지만 저장소에는 반드시 저장되어야할 데이터이다. 이런 서로 다른 상황을 위해 선택적으로 뷰를 적용할 수 있는 것이 바로 @JsonView이다.
• 위는 API 클라이언트에게 응답할 목적의 Consumer라는 뷰와, 저장소에 저장할 목적의 Repository라는 뷰를 정의하였다.

POJO에 @JsonView 명시

@Data
public class User {

    private Long id;

    @JsonProperty("user_id")
    @JsonView({View.Consumer.class, View.Repository.class})
    private String userId;

    @JsonProperty("passwordEncrypted")
    @JsonView({View.Repository.class})
    private String passwordEncrypted;
}

Copy

• 앞서 설명한대로 @JsonView를 목적에 맞게 명시하였다.

@JsonView 적용: Spring Boot

@RestController
public class UserController {

    @RequestMapping(value = "/users/{userId}", method = RequestMethod.GET)
    @JsonView(View.Consumer.class)
    public ResponseEntity<?> getUser(@PathVariable("userId") String userId) {
        ...
        return new ResponseEntity<>(user, HttpStatus.OK);
    }
}

Copy

• Spring Boot에서는 컨트롤러의 메써드 레벨에 적용할 @JsonView를 명시하면 된다. 위 예제의 경우 응답 JSON 문자열에 user_id만 노출된다.

@JsonView 적용: ObjectMapper

String user = new ObjectMapper()
        .disable(MapperFeature.DEFAULT_VIEW_INCLUSION)
        .writerWithView(View.Repository.class)
        .writeValueAsString(user);

Copy

• MapperFeature.DEFAULT_VIEW_INCLUSION 옵션을 활성화하면 @JsonView가 명시되지 않은 POJO의 프라퍼티들도 JSON 문자열에 포함된다. 기본값은 활성화되어 있으므로 이를 원치 않을 경우 비활성화 해주어야 한다.


• writerWithView()로 적용할 @JsonView를 명시하면 Jackson은 해당 @JsonView가 명시된 프라퍼티만 JSON 문자열에 포함한다.

참고 글

• Latest Jackson integration improvements in Spring
• Jackson JSON Views
• @JsonView doesn’t work in a simple test