spring - 将snake_case请求参数绑定(bind)到Spring表单

Question

我正在使用 Spring Boot 实现一个简单的 RESTful 服务，其接口(interface)由 .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 的绑定(bind)中必须有一些简单的 Hook ，就像 Jackon 的 ObjectMapper 中的等效设置，但我正在努力寻找一个。我在这里可以找到的唯一有点相关的帖子是 this one, about completely changing the parameter names ，其中的一些建议对于我的用例来说似乎有点过分了。

简单的解决方案就是对 MyForm 中的字段使用蛇形命名法，效果很好，但有点难看。

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

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

Answer 1

可能你已经解决了这个问题，我今天正在解决这个问题并回答了StackOverflow PT上的问题.

所以这是交易:

创建一个在请求到达 Controller 之前执行的过滤器，并相应地格式化参数(在我的场景中从蛇形案例到 Camel 式案例)。

空谈很便宜，给我看看代码!

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 始终在请求到达 Controller 之前执行，参数以格式化形式存储在新的 Map 中，并转发到通过 filterChain.doFilter 进行 Controller 。

HttpServletRequestWrapper 负责向 Controller 提供新参数。

此代码完全基于azhawkes过滤。

<小时/>

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