스프링에서 Servlet Request에 포함된 parameter들의 모델 객체(또는 DTO 객체)로의 바인딩은 ServletRequestDataBinder에서 담당한다.

큰 흐름을 살펴보면 다음과 같다.

  1. parameterName을 key로, parameterValue를 value로 해서 request 내의 모든 parameter를 MutablePropertyValues에 넣은 후,
  2. MutablePropertyValues에 저장된 값을 DataBinder를 통해 모델 객체(또는 DTO 객체)로 바인딩힌다.

문제

parameterName이 특별한 점 없이 그냥 일반적이라면 모든 과정이 행복하게 끝나는데, parameterName이 아래와 같이

items[0][count]

같은 형식으로 들어오면 다음과 같은 에러를 만나게 되는데, 더 안타까운 것은 이 에러는 BindingResult로는 잡히지도 않는다는 점이다.

1
2
3
4
5
org.springframework.beans.InvalidPropertyException: 
  Invalid property 'items[0][count]' of bean class [어쩌구DTO]: 
    Property referenced in indexed property path 'items[0][count]' is neither an array nor a List nor a Map

`items[0][count]`가 가리키는 값이 배열도, 리스트도, 맵도 아니라서 예외 발생

참고로 위 예외가 발생하는 정확한 위치는 스프링의 AbstractNestablePropertyAccessor 클래스의 setPropertyValue 메서드다.

암튼, 저런 형식의 데이터가 들어올까?

들어온다. 브라우저에서 jQuery로 다음과 같이 데이터를 서버에 보내면,

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
$.ajax({
    url: '어쩌구-서버-API',
    contentType: 'application/json',
    method: 'GET',
    crossDomain: true,
    data: {
        id: "321",
        items: [
            {
                id: "abc987",
                count: 3
            }
        ],
        emails: ['abc@abc.com', 'sdf@sdf.com']
    }
}).done(function() {
    // 성공 시 처리 
});

다음과 같은 URL로 서버에 요청이 전달된다.

1
GET /어쩌구-서버-API?id=321&items%5B0%5D%5Bid%5D=abc987&items%5B0%5D%5Bcount%5D=3&emails%5B%5D=abc%40abc.com&emails%5B%5D=sdf%40sdf.com

눈으로 읽을 수 있도록 URL Decoding하면 다음과 같다.

1
GET /어쩌구-서버-API?id=321&items[0][id]=abc987&items[0][count]=3&emails[]=abc@abc.com&emails[]=sdf@sdf.com

물론 이런 경우라면 원론적으로는 GET 보다는 POST로 보내는 게 적절하다.

POST로 보냈다면(클라이언트에서도 JSON.stringify()를 이미 했을테고), @RequestBody로 읽어서 모델 객체에 문제 없이 바인딩 할 수 있다.

하지만 이미 클라이언트가 모두 GET 방식으로 보내고 있고, 클라이언트가 한 군데가 아니라 꽤 많다면, 현실적으로는 그냥 서버 쪽에서 해결하는 것이 좋다.

하지만 서버 쪽의 스프링은, 앞에서 얘기한 것처럼 이런 형식의 URL 파라미터를 자연스럽게 모델 객체로 바인딩 해 주지 못한다는..

해결

그래서 이를 보완할 수 있는 유틸 메서드를 만들어봤다.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
/**
 * @param parameterMap  request.getParameterMap()
 * @param dto           바인딩 할 DTO의 클래스 리터럴
 * @param <T>           바인딩 할 DTO의 타입
 */
public static <T> T getDTOFromParamMap(Map<String, String[]> parameterMap, Class<T> dto) 
        throws IllegalAccessException, InstantiationException {

    final MutablePropertyValues sourceProps = getPropsFrom(parameterMap);

    T targetDTO = dto.newInstance();
    DataBinder binder = new DataBinder(targetDTO);
    binder.bind(sourceProps);

    return targetDTO;
}

private static MutablePropertyValues getPropsFrom(Map<String, String[]> parameterMap) {
    
    final MutablePropertyValues mpvs = new MutablePropertyValues();

    parameterMap.forEach(
            (k, v) -> {
                String dotKey =
                        k.replaceAll("\\[]", "")
                         .replaceAll("\\[(\\D+)", ".$1")
                         .replaceAll("]\\[(\\D)", ".$1")
                         .replaceAll("(\\.\\w+)]", "$1");
                mpvs.addPropertyValue(dotKey, v);
            }
    );

    return mpvs;
}

핵심 로직은 private 메서드의 람다식 안의 정규표현식에 담겨 있는데, 테스트 코드를 보면 금방 이해할 수 있다.

1
2
3
4
5
6
7
8
9
10
11
12
13
@Test
public void object인덱스형_key를_dot형으로_변환() throws Exception {

    String k = "items[0][options][1][a][12][b][abc][c][1234][c1][33][_1][___][99][a33][b3][aa3]";

    String result =
            k.replaceAll("\\[]", "")
             .replaceAll("\\[(\\D+)", ".$1")
             .replaceAll("]\\[(\\D)", ".$1")
             .replaceAll("(\\.\\w+)]", "$1");

    assertThat(result, is("items[0].options[1].a[12].b.abc.c[1234].c1[33]._1.___[99].a33.b3.aa3"));
}

쉽게 말해 [ ]로 구성된 parameterName을 스프링이 이해할 수 있는 . 형식으로 적절하게 변환해서 MutablePropertyValues에 에러 없이 집어넣을 수 있게 하고, DataBinder를 통해 모델 객체로 바인딩 하게 해준다.

단, 한 가지 제약 조건이 있는데 [ ] 안에 들어가는 parameterName이 숫자로 시작하면 안된다는 점이다.