是否可以在 Spring 控制器中拆分请求参数？

Question

我有这样的要求：

example.com/search?sort=myfield1,-myfield2,myfield3

我想拆分这些参数以在我的控制器中绑定List<String> 排序或List<SortParam> 其中SortParam 是具有以下字段的类：name（字符串）和ask（布尔值）。

所以最终的控制器应该是这样的：

@RequestMapping(value = "/search", method = RequestMethod.GET)
public ResponseEntity<MyResponse> search(@RequestParam List<String> sort) {

    //...
}

或

@RequestMapping(value = "/search", method = RequestMethod.GET)
public ResponseEntity<MyResponse> search(@RequestParam List<SortParam> sort) {

    //...
}

有什么办法吗？

更新：

传递参数的标准方式不符合我的要求。 IE。我不能使用sort=myfield1&sort=-myfield2&sort=myfield3。我必须使用逗号分隔的名称。
另外，我明白我可以在我的控制器中接受@RequestParam String sort，然后像sort.split(",") 那样在控制器内拆分字符串，但这也不能解决上述问题。

Answer 1

是的，你当然可以做到，你就快到了。

@RequestMapping(value = "/search", method = RequestMethod.GET)
public ResponseEntity<MyResponse> participants(@RequestParam("sort") List<String> sort) {

    //...
}

您现在应该可以像这样调用您的服务（如果搜索位于您的根目录，否则根据您的情况进行调整）：

curl "localhost:8080/search?sort=sortField1&sort=sortField2&sort=sortField3"

希望这会有所帮助！

编辑 抱歉，我已经阅读了您的 cmets，并且您现在需要什么对我来说很清楚。我已经为您创建了一个解决方法，这几乎就是您想要的。

首先是一个 SortParams 类：

import java.util.Arrays;
import java.util.List;
import java.util.stream.Collectors;

public class SortParams {
  private List<SortParam> sortParamList;

  public SortParams(String commaSeparatedString) {
    sortParamList = Arrays.stream(commaSeparatedString.split(","))
      .map(p -> SortParam.valueOf(p))
      .collect(Collectors.toList());
  }

  public List<SortParam> getSortParamList() {
    return this.sortParamList;
  }

  public enum SortParam {
    FOO, BAR, FOOBAR;
  }
}

那么你的控制器可能看起来像这样：

@RequestMapping(value = "/search", method = RequestMethod.GET)
public ResponseEntity<List<SortParams.SortParam>> search(@RequestParam("sort") SortParams sort) {
    return ResponseEntity.ok(sort.getSortParamList());
}

现在您的 SortParams 对象有一个 SortParam 列表：

curl "localhost:8080/search?sort=FOO,BAR"

["FOO","BAR"]

这样的东西是否符合您的要求？

Answer 2

它只是一个简单的类型转换任务。 Spring定义了一个SPI（Service Provider Interface）来实现类型转换逻辑。对于您的具体问题，您可以通过实现Converter 接口来定义您的类型转换逻辑。

@Component
public class StringToListConverter implements Converter<String, List<String>> {

    @Override
    public List<String> convert(String source) {
        return Arrays.asList(source.split(","));
    }
}

您还可以根据您的逻辑将您的请求参数转换为List<SortPram>（但我不确定您的问题是否符合您的逻辑）。就是这个！现在 Spring 知道如何将您的请求参数绑定到列表。

@RequestMapping(value = "/search", method = RequestMethod.GET)
public ResponseEntity<MyResponse> participants(@RequestParam("sort") List<String> sort) {
     // .. do your logic
}

还有更多方法可以定义您的自定义数据绑定器。检查这个

• A Custom Data Binder in Spring MVC文章。
• 关于 Validation, Data Binding, and Type Conversion 的 Spring 文档