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

Question

我正在使用 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's 中的等效设置ObjectMapper，但我正在努力寻找一个。我可以在这里找到的唯一有点相关的帖子是关于完全更改参数名称的帖子，其中有一些建议对于我的用例来说似乎有点过分。

简单的解决方案是简单地对 中的字段使用蛇形大小写MyForm，效果很好，但有点难看。

我在其他地方看到的最后一个建议是使用拦截器在传入的过程中修改请求参数，这看起来很简单，但感觉肯定会有例外使它变得不平凡，我我担心将代码隐藏在拦截器中会使您在遇到一个不起眼的情况时很难找到它。

是否有一些“正确”的 Spring-y 方式来处理我遗漏的这个问题，或者我是否只需要选择上述不太完美的解决方案之一？

Answer 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以其格式化的形式以新的形式存储，并通过filterChain.doFilter.

该HttpServletRequestWrapper做的我们提供了新的参数到控制器的工作。

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

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