Spring @RestController 응답 시, 정의 되지 않은 값도 같이 응답되는 이유

Spring @RestController 응답 시, 정의 되지 않은 값도 같이 응답되는 이유

@Getter
@Setter
public class UserDomain {
    private String name;
    private int age;

    public boolean isTwenties() {
        if (this.age >= 20 && this.age < 30){
            return true;
        }
        return false;
    }
}

• 위와 같이, 도메인 객체 안에 비즈니스 로직이 포함된 메서드가 존재한다고 상상해보자.
  • isTwenties() 는 현재 User의 나이를 판단하여 20대인지 아닌지를 알려주는 메서드이다.

 

@RestController
public class UserController {
    @GetMapping("/user/{name}")
    public UserDomain retrieveUserByName(String name){
        UserDomain user = new UserDomain():
        user.setName("test");
        user.setAge(10);
        return user;
    }
}

만약, RestController에서 UserDomain을 응답 객체로 사용하게 된다면 HTTP 응답으로 어떤 값이 응답될까?

 

나는 처음에 이와 같은 응답을 기대했다.

{
	"name": "test",
	"age" : 10
}

하지만, 실제로 응답 된 값은 그렇지 않았다. 🧐

{
	"name": "test",
	"age" : 10,
	"Twenties" : false
}

왜 이런 결과가 나오게 되었을까? 이유를 알기 위해선 @ResponseBody와 HttpMessageConverter에 대한 선행 지식이 살짝 필요하다.

 

@ResponseBody

Spring은 HTTP 요청을 받았을 때 그 응답으로 (1) 정적 리소스 (2) 뷰 템플릿을 응답하거나 혹은 (3) HTTP Body 값을 응답할 수 있다.

이때 (3) HTTP Body 값을 응답하려면, @ResponseBody 어노테이션을 메소드 상단에 붙여야 한다.

그리고, 클래스 상단에 @RestController 애노테이션을 사용하면 해당 컨트롤러에 모든 메서드에 @ResponseBody가 적용되는 효과가 있다

(@Controller는 method return type이 String이면 뷰 이름으로 인식해, 뷰를 찾고 뷰를 랜더링 한다. @RestController 는 반환 값으로 뷰를 찾는 것이 아니라, HTTP 메시지 바디에 바로 입력한다.)

 

HttpMessageConverter

Spring은 응답값을 생성할 때, ReturnValueHandler가 RequestMapping으로 식별된 메서드의 응답 타입을 확인하고, 해당 응답 타입을 직렬화 할 수 있는 HttpMessageConverter를 찾아 실행한다.

-> 위와 같은 상황일 때는 MappingJackson2HttpMessageConverter 가 실행 된다.

아무튼, 예시로 든 UserController가 @RestController이고 메서드의 응답값이 객체이기 때문에, MappingJackson2HttpMessageConverter 가 UserDomain 객체를 직렬화 하게 된다.

이때 문제는, 필드 기반으로 값을 직렬화 하는게 아니라 get 키워드로 시작하는 메서드를 '필드'라고 인식하고 직렬화 하게 된다는 점이다.

 

@Getter
@Setter
public class UserDomain {
    private String name;
    private int age;

    public boolean isTwenties() {
        if (this.age >= 20 && this.age < 30){
            return true;
        }
        return false;
    }
}

즉, 위의 예제에서 lombok의 @Getter 를 통해 각 필드의 getter가 생성되고

MappingJackson2HttpMessageConverter 의 ObjectMapper가 생성된 getter 들을 참조하여 JSON 형식으로 직렬화 하게 된다.

@Getter
@Setter
public class UserDomain {
    private String name;
    private int age;

    public boolean isTwenties() {
        if (this.age >= 20 && this.age < 30){
            return true;
        }
        return false;
    }

    // 롬복이 생성한 getter
    public String getName(){
        return this.name;
    }

    // 롬복이 생성한 getter
    public String getAge(){
        return this.age;
    }
}

이때, isTwenties 도 boolean 타입의 getter라고 인식되어, 메서드가 실행되고 해당 isTwenties 의 리턴값 또한 같이 JSON 데이터에 들어가게 된 것이다.

MappingJackson2HttpMessageConverter 의 ObjectMapper 가 어떤 함수를 getter로 인식하는지는 실제 코드를 까봐야 정확히 알 수 있겠지만, 아마 public + parameter는 없고 () + 메서드명이 get으로 시작한다면 getter로 인식하지 않을까 싶다. (boolean의 경우 is로 시작하는 경우도 포함)

• 추후, 실제로 코드를 확인해보고 추가해 놓겠다.
• 확인결과 ⬇️
• 요약 : 실제로 파라미터의 개수 확인 및 getterPrefix의 값으로 getter인지 확인하는 로직이 있다.
  • 자세한 로직은 디버깅과 함께 확인 가능하나 너무 복잡

objectMapper.writeValueAsString(manager);

// 수행 결과

// POJOPropertiesCollector.collectAll 수행
protected void collectAll() {
    LinkedHashMap<String, POJOPropertyBuilder> props = new LinkedHashMap();
    this._addFields(props); // 필드값 가져와서 props에 추가
    this._addMethods(props); // 메서드로 필드값 추가함 <- 여기서 getter, setter 확인해서 getter만 있어도 추가됨
    if (!this._classDef.isNonStaticInnerClass()) {
        this._addCreators(props);
    }

	// 생략
}


protected void _addMethods(Map<String, POJOPropertyBuilder> props) {
    Iterator var2 = this._classDef.memberMethods().iterator();

    while(var2.hasNext()) {
        AnnotatedMethod m = (AnnotatedMethod)var2.next();
        int argCount = m.getParameterCount();
		// 파라미터가 0개이면 getter로 판단
        if (argCount == 0) {
            this._addGetterMethod(props, m, this._annotationIntrospector);
        } else if (argCount == 1) {
            this._addSetterMethod(props, m, this._annotationIntrospector);
        } else if (argCount == 2 && Boolean.TRUE.equals(this._annotationIntrospector.hasAnySetter(m))) {
            if (this._anySetters == null) {
                this._anySetters = new LinkedList();
            }

            this._anySetters.add(m);
        }
    }

}


protected void _addGetterMethod(Map<String, POJOPropertyBuilder> props, AnnotatedMethod m, AnnotationIntrospector ai) {
    Class<?> rt = m.getRawReturnType();
    if (rt != Void.TYPE && (rt != Void.class || this._config.isEnabled(MapperFeature.ALLOW_VOID_VALUED_PROPERTIES))) {
        if (Boolean.TRUE.equals(ai.hasAnyGetter(m))) {
            if (this._anyGetters == null) {
                this._anyGetters = new LinkedList();
            }

            this._anyGetters.add(m);
        } else if (Boolean.TRUE.equals(ai.hasAsKey(this._config, m))) {
            if (this._jsonKeyAccessors == null) {
                this._jsonKeyAccessors = new LinkedList();
            }

            this._jsonKeyAccessors.add(m);
        } else if (Boolean.TRUE.equals(ai.hasAsValue(m))) {
            if (this._jsonValueAccessors == null) {
                this._jsonValueAccessors = new LinkedList();
            }

            this._jsonValueAccessors.add(m);
        } else {
            PropertyName pn = ai.findNameForSerialization(m);
            boolean nameExplicit = pn != null;
            boolean visible;
            String implName;
            if (!nameExplicit) {
                implName = ai.findImplicitPropertyName(m);
                if (implName == null) {
					// 여기서 get으로 시작하는지 판단해서 implName에 세팅한다
                    implName = this._accessorNaming.findNameForRegularGetter(m, m.getName());
                }

                if (implName == null) {
                    implName = this._accessorNaming.findNameForIsGetter(m, m.getName());
                    if (implName == null) {
                        return;
                    }

                    visible = this._visibilityChecker.isIsGetterVisible(m);
                } else {
                    visible = this._visibilityChecker.isGetterVisible(m);
                }
            } else {
                implName = ai.findImplicitPropertyName(m);
                if (implName == null) {
                    implName = this._accessorNaming.findNameForRegularGetter(m, m.getName());
                    if (implName == null) {
                        implName = this._accessorNaming.findNameForIsGetter(m, m.getName());
                    }
                }

                if (implName == null) {
                    implName = m.getName();
                }

                if (pn.isEmpty()) {
                    pn = this._propNameFromSimple(implName);
                    nameExplicit = false;
                }

                visible = true;
            }

            implName = this._checkRenameByField(implName);
            boolean ignore = ai.hasIgnoreMarker(m);
            this._property(props, implName).addGetter(m, pn, nameExplicit, visible, ignore);
        }
    }
}

 

해결방법

이런 경우, 사실 가장 간단한 해결 방법은 DTO 객체를 생성하고 비즈니스 로직을 모두 제거 후 데이터 전달용으로 사용하는게 아닐까 싶다.

그럴수 없는 상황이라면 @JsonIgnore 를 붙이거나, ObjectMapper의 설정을 바꾸는 방법도 존재한다.

objectMapper.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.NONE);
objectMapper.setVisibility(PropertyAccessor.FIELD, JsonAutoDetect.Visibility.ANY);

 

 

👍 Reference

Does Jackson serialize getter property for an undefined field?

Does Jackson serialize getter property for an undefined field?