[Spring boot/RESTful] Response Filtering

Response 데이터 제어를 위한 Filtering

클라이언트에게 전달되는 정보의 값을 제어

비밀번호와 주민등록번호까지 같이 반환되고 있다

보통 3가지 방법이 있다. 오늘은 이 중 3번째에 대해 다룬다.

1. 값을 암호화하거나 치환하여 전달
2. null로 반환
3. 아예 제외하고 반환

 

@JsonIgnore

Response 반환 시 Json값에 포함되지 않도록 하는 annotation. 개별적으로 필드 값을 제어한다.

@JsonIgnore // 반환 시 Json값에 포함되지 않음 ->반환값 제어
privateString password;

@JsonIgnore
privateString ssn;

 

@JsonIgnoreProperties

해당 클래스 블록 단위로 필터링

@JsonIgnoreProperties(value={"password", "ssn"})
public class User { 
	
    private Integer id; 
   
    @Size(min=2, message = "Name은 2글자 이상 입력해주세요.") 
	
    private String name;
    
    @Past private Date joinDate; 
    
    private String password; 
    private String ssn; 
}

 

@JsonFilter

controller나 service 클래스에서 사용되는 annotation. 기본적으로 해당 클래스에 있는 모든 필드에 필터링을 걸고, 클래스 사용 시 필터링을 제외할 특정 필드를 선택해서 사용자에게 보여준다.

// domain
@JsonFilter("UserInfo") // 부여된 필터값은 controller나 service 클래스에서 사용된다
public class User { ... }

• setFilters나 setSerialView를 사용 시에는 꼭 MappingJacksonValue 타입으로 감싸서 반환해야 한다.

• SimpleBeanPropertyFilter : 포함시키고 싶은 필터값 선언
• FilterProvider : domain에서 지정한 필터 지정
• MappingJacksonValue에 FilterProvider를 적용하여 리턴

 

@GetMapping("/users/{id}")
	// setFilters나 setSerialView를 사용 시 꼭 MappingJacksonValue 타입으로 감싸서 반환
	public MappingJacksonValue retrieveUser(@PathVariable int id) {
		User user = service.findOne(id);
		if (user == null){
			throw new UserNotFoundException(String.format("ID[%s] is not found", id));
		}

		// bean의 property를 제어
		SimpleBeanPropertyFilter filter = SimpleBeanPropertyFilter
			.filterOutAllExcept("id", "name", "joinDate", "ssn");

		// User에 @JsonFilter("UserInfo") 지정
		FilterProvider filters = new SimpleFilterProvider().addFilter("UserInfo", filter);

		MappingJacksonValue mapping = new MappingJacksonValue(user); // 유저 데이터 전달
		mapping.setFilters(filters); // 필터 적용

		return mapping;
	}

filterOutAllExcept에 아무 값도 지정하지 않을 경우 오류 발생

 

정리

클라이언트에게 전달되는 정보의 값을 제어하는 방법

(1) 값을 암호화하거나 치환하여 전달

(2) null을 넣어 전달

(3) 특정 필드 필터링 -> @JsonIgnore, @JsonIgnoreProperties를 사용하여 값을 제어한다

1. @JsonIgnore : 단위 필드 값을 제어할 때 사용. 반환 시 json 값에 포함되지 않는다
2. @JsonIgnoreProperties(value={"필드값"}) : 클래스를 블록 단위로 필터링 -> 조금 더 효율적인 방법 :@JsonFilter 사용
3. domain에 @JsonFilter("필터명") 사용 : 부여된 필터값은 controller나 service 클래스에서 사용
4. controller에서 return값을 MappingJacksonValue로 선언

• SimpleBeanPropertyFilter를 이용하여 포함시키고 싶은 필터값 선언
• FilterProvider에 domain에서 지정한 필터 지정
• MappingJacksonValue에 FilterProvider를 적용하여 리턴

•