Dynamic JSON Filtering using @JsonView

Snippet

Dynamic JSON Filtering using @JsonView

@JsonView allows you to control which fields of an object are serialized into JSON depending on the context. You can define marker interfaces to create 'views' (e.g., Public vs. Admin) and apply them to both the data model and the controller method.

snippet.java

java

public class Views {
    public interface Public {}
    public interface Internal extends Public {}
}
 
public class User {
    @JsonView(Views.Public.class) private String username;
    @JsonView(Views.Internal.class) private String email;
}
 
@RestController
public class UserController {
    @GetMapping("/public/user")
    @JsonView(Views.Public.class)
    public User getPublicUser() { return new User("dev", "[email protected]"); }
}

spring

Breakdown

interface Internal extends Public

Inheritance allows the Internal view to include all fields marked as Public.

@JsonView(Views.Public.class)

Indicates that the annotated field or method should only use fields associated with this view.

@RestController

Combined with @JsonView, Spring will filter the response body before sending it.

Previous snippet Next snippet

More Intermediate Java exercises →

From your library

Dynamic JSON Filtering using @JsonView

Related