将snake_case请求参数绑定到Spring表单

时间:2016-01-22 11:03:55

标签: spring spring-mvc

我使用Spring Boot实现一个简单的RESTful服务,其界面由.NET(我认为)客户端定义。他们的参数名称是snake_case,而不是camelCase,这显然意味着我需要自定义它们的映射方式。

在JSON输入/输出的情况下,这很好,我只是定制了ObjectMapper,如下所示:

@Bean
public ObjectMapper objectMapper() {
  ObjectMapper objectMapper = new ObjectMapper();
  objectMapper.setPropertyNamingStrategy(PropertyNamingStrategy.SNAKE_CASE);
  return objectMapper;
}

工作正常。现在我的问题是表单数据。我有一个Spring形式,如:

public class MyForm {
  private String myValue;

  public String getMyValue() {return myValue;}
  public void setMyValue(String myValue) {this.myValue = myValue;}
}

但我需要接受的请求如下:

POST /foo/bar HTTP/1.1
Host: localhost:8080
Content-Type: application/x-www-form-urlencoded

my_value=5

我觉得必须有一些简单的挂钩Spring的绑定,就像Jackon的ObjectMapper中的等效设置一样,但是我很难找到一个。我在这里找到的唯一有点相关的帖子是this one, about completely changing the parameter names,其中有一些建议对我的用例来说似乎有些过分。

简单的解决方案就是对MyForm中的字段使用snake case,效果很好,但有点难看。

我在其他地方看到的最后一个建议是使用拦截器来修改请求参数,这似乎很简单,但感觉肯定会有异常使其成为非琐碎的,我担心隐藏在拦截器中的代码使得当你遇到一个不起作用的模糊情况时很难找到它。

是否有一些适当的'处理这个问题的Spring-y方式我不知道,或者我只需要选择上述不完美的解决方案之一?

1 个答案:

答案 0 :(得分:1)

可能您已经解决了这个问题,我今天正在与之抗争,并在StackOverflow PT上回答了一个问题。

这是交易:

创建一个要在请求到达控制器之前执行的过滤器,并相应地格式化参数(在我的方案中,从蛇形到驼峰形)。

对话很便宜,请告诉我代码!

import java.io.IOException;
import java.util.Collections;
import java.util.Enumeration;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;

import javax.servlet.Filter;
import javax.servlet.FilterChain;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletRequestWrapper;
import javax.servlet.http.HttpServletResponse;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.filter.OncePerRequestFilter;

import com.google.common.base.CaseFormat;

@Configuration
public class AppConfig {

    @Bean
    public Filter snakeConverter() {
        return new OncePerRequestFilter() {

            @Override
            protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain)
                    throws ServletException, IOException {
                final Map<String, String[]> formattedParams = new ConcurrentHashMap<>();

                for (String param : request.getParameterMap().keySet()) {
                    String formattedParam = CaseFormat.LOWER_UNDERSCORE.to(CaseFormat.LOWER_CAMEL, param);
                    formattedParams.put(formattedParam, request.getParameterValues(param));
                }

                filterChain.doFilter(new HttpServletRequestWrapper(request) {
                    @Override
                    public String getParameter(String name) {
                        return formattedParams.containsKey(name) ? formattedParams.get(name)[0] : null;
                    }

                    @Override
                    public Enumeration<String> getParameterNames() {
                        return Collections.enumeration(formattedParams.keySet());
                    }

                    @Override
                    public String[] getParameterValues(String name) {
                        return formattedParams.get(name);
                    }

                    @Override
                    public Map<String, String[]> getParameterMap() {
                        return formattedParams;
                    }
                }, response);
            }
        };
    }

}

snakeConverter发挥了神奇作用。

在那里,doFilterInternal总是在请求到达控制器之前执行,参数以其格式存储在新的Map中,并通过{{1 }}。

filterChain.doFilter的工作是向控制器提供新参数。

此代码完全基于azhawkes过滤器。


使用以下网址中的简单控制器对其进行测试:http://localhost:8080/snakecase?foo_bar=123

enter image description here