[Spring] Response 데이터 제어를 위한 Filtering

 

Response 데이터 제어를 위한 Filtering

• 중요한 정보를 클라이언트에게 노출하지 않기 위해
• 특정 정보를 외부에 노출시키고 싶지 않을 때

 

1. 애노테이션으로 제어하는 Filtering 방법 - @JsonIgnoreProperties

📌 User

@Data
@AllArgsConstructor
@NoArgsConstructor
@JsonIgnoreProperties(value = {"password", "ssn"})  // @JsonIgnore 일괄 처리
public class User {

    private Long id;

    @Size(min = 2, message = "Name은 2글자 이상 입력해 주세요.")
    private String name;

    @Past  // 과거 날짜만 가능하도록 제약
    private LocalDateTime joinDate;

    private String password;
    private String ssn; // 주민등록번호

}

@JsonIgnoreProperties은 클레스 레벨 애노테이션이다. value 속성값에 노출하기 싫은 필드명을 적으면 된다.

📌 UserDaoService

package hello.demo.user;

import org.springframework.stereotype.Service;

import java.sql.PreparedStatement;
import java.time.LocalDateTime;
import java.util.ArrayList;
import java.util.Date;
import java.util.List;
import java.util.Optional;

@Service
public class UserDaoService {
    private static List<User> users = new ArrayList<>();

    private static Long userCount = 3L;

    static {
        users.add(new User(1L, "user1", LocalDateTime.now(), "pass1", "701010-1111111"));
        users.add(new User(2L, "user2", LocalDateTime.now(), "pass2", "801010-2222222"));
        users.add(new User(3L, "user3", LocalDateTime.now(), "pass3", "901010-1111111"));
    }

    ...

}

📌 UserController

@RestController
@RequiredArgsConstructor
public class UserController {

    private final UserDaoService service;

    @GetMapping("/users")
    public List<User> retrieveAllUsers() {
        return service.findAll();
    }

}

출력 결과를 보면 password 필드와 ssn 필드는 제외되고 출력된 것을 알 수 있다.

 

2. 프로그래밍으로 제어하는 Filtering 방법 - @JsonFilter

사용자에 따른 Json 형태로 데이터를 보낼 때 보내지 않아도 되는 데이터는 필터링하여 보내고 싶은 경우에 @JsonFilter를 사용한다.

📌 User

@Data
@AllArgsConstructor
@NoArgsConstructor
@JsonFilter("UserInfo")  // 필터 이름을 "UserInfo"로 이름 부여
public class User {

    private Long id;

    @Size(min = 2, message = "Name은 2글자 이상 입력해 주세요.")
    private String name;

    @Past  // 과거 날짜만 가능하도록 제약
    private LocalDateTime joinDate;

    private String password;
    private String ssn; // 주민등록번호

}

 

📌 AdminUserController

@RestController
@RequiredArgsConstructor
@RequestMapping("/admin")
public class AdminUserController {

    private final UserDaoService service;

    @GetMapping("/users")
    public MappingJacksonValue retrieveAllUsers() {
        List<User> users = service.findAll();

        SimpleBeanPropertyFilter filter = SimpleBeanPropertyFilter
                .filterOutAllExcept("id", "name", "joinDate", "ssn");

        FilterProvider filters = new SimpleFilterProvider().addFilter("UserInfo", filter);

        MappingJacksonValue mapping = new MappingJacksonValue(users);
        mapping.setFilters(filters);

        return mapping;

    }

    @GetMapping("/users/{id}")
    public MappingJacksonValue retrieveUser(@PathVariable Long id) {
        Optional<User> userOptional = service.findOne(id);

        if (userOptional.isEmpty()) {
            throw new UserNotFoundException(String.format("ID[%s] not found", id));
        }

        SimpleBeanPropertyFilter filter = SimpleBeanPropertyFilter
                .filterOutAllExcept("id", "name", "joinDate", "ssn");

        FilterProvider filters = new SimpleFilterProvider().addFilter("UserInfo", filter);

        User findUser = userOptional.orElse(null);
        MappingJacksonValue mapping = new MappingJacksonValue(findUser);
        mapping.setFilters(filters);

        return mapping;
    }

}

BeanProperty를 제어하기 위해 SimpleBeanPropertyFilter를 사용한다.
SimpleBeanPropertyFilter.filterOutAllExcept()를 통해 내가 사용자에게 보내고자 하는 필드를 정의한다.
SimpleBeanPropertyFilter를 사용할 수 있게 FilterProvider를 사용한다. 
Filter를 추가할 떄 SimpleBeanPropertyFilter.addFilter()를 사용하여 해당 필터가 어떤 bean을 대상으로 사용되어지는 필터인지 정의해야 한다.
이후 Mapping 데이터에 filter를 추가한다.